blob: ec5283f27f5f7bc93a9cd4f2ff374f47cac77964 [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;
William Lallemand74c24fb2016-11-21 17:18:36 +0100444
445 kw = bind_find_kw(args[cur_arg]);
446 if (kw) {
447 if (!kw->parse) {
448 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
449 args[0], args[1], args[cur_arg]);
450 return -1;
451 }
452
Willy Tarreau4975d142021-03-13 11:00:33 +0100453 if (kw->parse(args, cur_arg, global.cli_fe, bind_conf, err) != 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100454 if (err && *err)
455 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
456 else
457 memprintf(err, "'%s %s' : error encountered while processing '%s'",
458 args[0], args[1], args[cur_arg]);
459 return -1;
460 }
461
462 cur_arg += 1 + kw->skip;
463 continue;
464 }
465
Willy Tarreau433b05f2021-03-12 10:14:07 +0100466 best = bind_find_best_kw(args[cur_arg]);
467 if (best)
468 memprintf(err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
469 args[0], args[1], args[cur_arg], best);
470 else
471 memprintf(err, "'%s %s' : unknown keyword '%s'.",
472 args[0], args[1], args[cur_arg]);
William Lallemand74c24fb2016-11-21 17:18:36 +0100473 return -1;
474 }
475
476 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100477 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +0100478 l->default_target = global.cli_fe->default_target;
William Lallemand74c24fb2016-11-21 17:18:36 +0100479 l->options |= LI_O_UNLIMITED; /* don't make the peers subject to global limits */
480 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +0100481 global.maxsock++; /* for the listening socket */
William Lallemand74c24fb2016-11-21 17:18:36 +0100482 }
483 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100484 else if (strcmp(args[1], "timeout") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100485 unsigned timeout;
486 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
487
Willy Tarreau9faebe32019-06-07 19:00:37 +0200488 if (res == PARSE_TIME_OVER) {
489 memprintf(err, "timer overflow in argument '%s' to '%s %s' (maximum value is 2147483647 ms or ~24.8 days)",
490 args[2], args[0], args[1]);
491 return -1;
492 }
493 else if (res == PARSE_TIME_UNDER) {
494 memprintf(err, "timer underflow in argument '%s' to '%s %s' (minimum non-null value is 1 ms)",
495 args[2], args[0], args[1]);
496 return -1;
497 }
498 else if (res) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100499 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
500 return -1;
501 }
502
503 if (!timeout) {
504 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
505 return -1;
506 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100507 if (!global.cli_fe) {
508 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100509 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
510 return -1;
511 }
512 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100513 global.cli_fe->timeout.client = MS_TO_TICKS(timeout);
William Lallemand74c24fb2016-11-21 17:18:36 +0100514 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100515 else if (strcmp(args[1], "maxconn") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100516 int maxconn = atol(args[2]);
517
518 if (maxconn <= 0) {
519 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
520 return -1;
521 }
522
Willy Tarreau4975d142021-03-13 11:00:33 +0100523 if (!global.cli_fe) {
524 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100525 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
526 return -1;
527 }
528 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100529 global.cli_fe->maxconn = maxconn;
William Lallemand74c24fb2016-11-21 17:18:36 +0100530 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100531 else if (strcmp(args[1], "bind-process") == 0) { /* enable the socket only on some processes */
William Lallemand74c24fb2016-11-21 17:18:36 +0100532 int cur_arg = 2;
533 unsigned long set = 0;
534
Willy Tarreau4975d142021-03-13 11:00:33 +0100535 if (!global.cli_fe) {
536 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100537 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
538 return -1;
539 }
540 }
541
542 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100543 if (strcmp(args[cur_arg], "all") == 0) {
544 set = 0;
545 break;
546 }
Willy Tarreau72faef32021-06-15 08:36:30 +0200547 if (parse_process_number(args[cur_arg], &set, 1, NULL, err)) {
Christopher Fauletf1f0c5f2017-11-22 12:06:43 +0100548 memprintf(err, "'%s %s' : %s", args[0], args[1], *err);
William Lallemand74c24fb2016-11-21 17:18:36 +0100549 return -1;
550 }
551 cur_arg++;
552 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100553 }
554 else {
555 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
556 return -1;
557 }
558 return 0;
559}
560
William Lallemand33d29e22019-04-01 11:30:06 +0200561/*
William Lallemand9a37fd02019-04-12 16:09:24 +0200562 * This function exports the bound addresses of a <frontend> in the environment
563 * variable <varname>. Those addresses are separated by semicolons and prefixed
564 * with their type (abns@, unix@, sockpair@ etc)
565 * Return -1 upon error, 0 otherwise
William Lallemand33d29e22019-04-01 11:30:06 +0200566 */
William Lallemand9a37fd02019-04-12 16:09:24 +0200567int listeners_setenv(struct proxy *frontend, const char *varname)
William Lallemand33d29e22019-04-01 11:30:06 +0200568{
569 struct buffer *trash = get_trash_chunk();
570 struct bind_conf *bind_conf;
571
William Lallemand9a37fd02019-04-12 16:09:24 +0200572 if (frontend) {
573 list_for_each_entry(bind_conf, &frontend->conf.bind, by_fe) {
William Lallemand33d29e22019-04-01 11:30:06 +0200574 struct listener *l;
575
576 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
577 char addr[46];
578 char port[6];
579
William Lallemand620072b2019-04-12 16:09:25 +0200580 /* separate listener by semicolons */
581 if (trash->data)
582 chunk_appendf(trash, ";");
583
Willy Tarreau37159062020-08-27 07:48:42 +0200584 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemand33d29e22019-04-01 11:30:06 +0200585 const struct sockaddr_un *un;
586
Willy Tarreau37159062020-08-27 07:48:42 +0200587 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemand33d29e22019-04-01 11:30:06 +0200588 if (un->sun_path[0] == '\0') {
589 chunk_appendf(trash, "abns@%s", un->sun_path+1);
590 } else {
591 chunk_appendf(trash, "unix@%s", un->sun_path);
592 }
Willy Tarreau37159062020-08-27 07:48:42 +0200593 } else if (l->rx.addr.ss_family == AF_INET) {
594 addr_to_str(&l->rx.addr, addr, sizeof(addr));
595 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200596 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200597 } else if (l->rx.addr.ss_family == AF_INET6) {
598 addr_to_str(&l->rx.addr, addr, sizeof(addr));
599 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200600 chunk_appendf(trash, "ipv6@[%s]:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200601 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
602 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemand33d29e22019-04-01 11:30:06 +0200603 }
William Lallemand33d29e22019-04-01 11:30:06 +0200604 }
605 }
606 trash->area[trash->data++] = '\0';
William Lallemand9a37fd02019-04-12 16:09:24 +0200607 if (setenv(varname, trash->area, 1) < 0)
William Lallemand33d29e22019-04-01 11:30:06 +0200608 return -1;
609 }
610
611 return 0;
612}
613
William Lallemand9a37fd02019-04-12 16:09:24 +0200614int cli_socket_setenv()
615{
Willy Tarreau4975d142021-03-13 11:00:33 +0100616 if (listeners_setenv(global.cli_fe, "HAPROXY_CLI") < 0)
William Lallemand9a37fd02019-04-12 16:09:24 +0200617 return -1;
618 if (listeners_setenv(mworker_proxy, "HAPROXY_MASTER_CLI") < 0)
619 return -1;
620
621 return 0;
622}
623
William Lallemand33d29e22019-04-01 11:30:06 +0200624REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
625
Willy Tarreaude57a572016-11-23 17:01:39 +0100626/* Verifies that the CLI at least has a level at least as high as <level>
627 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
628 * failure, an error message is prepared and the appctx's state is adjusted
629 * to print it so that a return 1 is enough to abort any processing.
630 */
631int cli_has_level(struct appctx *appctx, int level)
632{
Willy Tarreaude57a572016-11-23 17:01:39 +0100633
William Lallemandf630d012018-12-13 09:05:44 +0100634 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Willy Tarreau4975d142021-03-13 11:00:33 +0100635 cli_err(appctx, cli_permission_denied_msg);
Willy Tarreaude57a572016-11-23 17:01:39 +0100636 return 0;
637 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100638 return 1;
639}
640
William Lallemandb7ea1412018-12-13 09:05:47 +0100641/* same as cli_has_level but for the CLI proxy and without error message */
642int pcli_has_level(struct stream *s, int level)
643{
644 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
645 return 0;
646 }
647 return 1;
648}
649
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200650/* Returns severity_output for the current session if set, or default for the socket */
651static int cli_get_severity_output(struct appctx *appctx)
652{
653 if (appctx->cli_severity_output)
654 return appctx->cli_severity_output;
655 return strm_li(si_strm(appctx->owner))->bind_conf->severity_output;
656}
William Lallemand74c24fb2016-11-21 17:18:36 +0100657
Willy Tarreau41908562016-11-24 16:23:38 +0100658/* Processes the CLI interpreter on the stats socket. This function is called
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100659 * from the CLI's IO handler running in an appctx context. The function returns
660 * 1 if the request was understood, otherwise zero (in which case an error
661 * message will be displayed). It is called with appctx->st0
Willy Tarreau41908562016-11-24 16:23:38 +0100662 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
663 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
664 * have its own I/O handler called again. Most of the time, parsers will only
665 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100666 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
667 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100668 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200669static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100670{
Willy Tarreauf14c7572021-03-13 10:59:23 +0100671 char *args[MAX_CLI_ARGS + 1], *p, *end, *payload = NULL;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200672 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100673 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100674
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200675 appctx->st2 = 0;
676 memset(&appctx->ctx.cli, 0, sizeof(appctx->ctx.cli));
William Lallemand74c24fb2016-11-21 17:18:36 +0100677
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200678 p = appctx->chunk->area;
679 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100680
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200681 /*
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200682 * Get pointers on words.
683 * One extra slot is reserved to store a pointer on a null byte.
684 */
Willy Tarreauf14c7572021-03-13 10:59:23 +0100685 while (i < MAX_CLI_ARGS && p < end) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200686 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100687
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200688 /* skip leading spaces/tabs */
689 p += strspn(p, " \t");
690 if (!*p)
691 break;
Willy Tarreauf2dda522021-09-17 11:07:45 +0200692
693 if (strcmp(p, PAYLOAD_PATTERN) == 0) {
694 /* payload pattern recognized here, this is not an arg anymore,
695 * the payload starts at the first byte that follows the zero
696 * after the pattern.
697 */
698 payload = p + strlen(PAYLOAD_PATTERN) + 1;
699 break;
700 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100701
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200702 args[i] = p;
Yves Lafonb08c6d02020-06-08 16:08:06 +0200703 while (1) {
704 p += strcspn(p, " \t\\");
705 /* escaped chars using backlashes (\) */
706 if (*p == '\\') {
707 if (!*++p)
708 break;
709 if (!*++p)
710 break;
711 } else {
712 break;
713 }
714 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200715 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100716
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200717 /* unescape backslashes (\) */
718 for (j = 0, k = 0; args[i][k]; k++) {
719 if (args[i][k] == '\\') {
720 if (args[i][k + 1] == '\\')
721 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100722 else
723 continue;
724 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200725 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100726 j++;
727 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200728 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100729
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200730 i++;
731 }
732 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200733 p = appctx->chunk->area + appctx->chunk->data;
Willy Tarreauf14c7572021-03-13 10:59:23 +0100734 for (; i < MAX_CLI_ARGS + 1; i++)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200735 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100736
737 kw = cli_find_kw(args);
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100738 if (!kw ||
739 (kw->level & ~appctx->cli_level & ACCESS_MASTER_ONLY) ||
740 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) == (ACCESS_MASTER_ONLY|ACCESS_MASTER)) {
741 /* keyword not found in this mode */
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100742 cli_gen_usage_msg(appctx, args);
Willy Tarreau41908562016-11-24 16:23:38 +0100743 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100744 }
William Lallemand14721be2018-10-26 14:47:37 +0200745
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100746 /* don't handle expert mode commands if not in this mode. */
747 if (kw->level & ~appctx->cli_level & ACCESS_EXPERT) {
748 cli_err(appctx, "This command is restricted to expert mode only.\n");
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200749 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100750 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200751
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100752 if (kw->level & ~appctx->cli_level & ACCESS_EXPERIMENTAL) {
753 cli_err(appctx, "This command is restricted to experimental mode only.\n");
754 return 0;
755 }
756
Amaury Denoyellef4929922021-05-05 16:29:23 +0200757 if (kw->level == ACCESS_EXPERT)
758 mark_tainted(TAINTED_CLI_EXPERT_MODE);
759 else if (kw->level == ACCESS_EXPERIMENTAL)
760 mark_tainted(TAINTED_CLI_EXPERIMENTAL_MODE);
761
Willy Tarreau41908562016-11-24 16:23:38 +0100762 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200763 appctx->io_release = kw->io_release;
William Lallemand90b098c2019-10-25 21:10:14 +0200764
765 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
766 goto fail;
767
768 /* kw->parse could set its own io_handler or io_release handler */
769 if (!appctx->io_handler)
770 goto fail;
771
772 appctx->st0 = CLI_ST_CALLBACK;
773 return 1;
774fail:
775 appctx->io_handler = NULL;
776 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100777 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100778}
779
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200780/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
781static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
782{
Willy Tarreau83061a82018-07-13 11:56:34 +0200783 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200784
785 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200786 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200787
788 tmp = get_trash_chunk();
789 chunk_reset(tmp);
790
791 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100792 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200793 chunk_printf(tmp, "[%d]: ", severity);
794 }
795 else {
796 switch (severity_output) {
797 case CLI_SEVERITY_NUMBER:
798 chunk_printf(tmp, "[%d]: ", severity);
799 break;
800 case CLI_SEVERITY_STRING:
801 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
802 break;
803 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100804 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200805 }
806 }
807 chunk_appendf(tmp, "%s", msg);
808
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200809 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200810}
811
William Lallemand74c24fb2016-11-21 17:18:36 +0100812/* This I/O handler runs as an applet embedded in a stream interface. It is
813 * used to processes I/O from/to the stats unix socket. The system relies on a
814 * state machine handling requests and various responses. We read a request,
815 * then we process it and send the response, and we possibly display a prompt.
816 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100817 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100818 * or not.
819 */
820static void cli_io_handler(struct appctx *appctx)
821{
822 struct stream_interface *si = appctx->owner;
823 struct channel *req = si_oc(si);
824 struct channel *res = si_ic(si);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200825 struct bind_conf *bind_conf = strm_li(si_strm(si))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100826 int reql;
827 int len;
828
829 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
830 goto out;
831
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800832 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200833 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100834 /* buf.size==0 means we failed to get a buffer and were
835 * already subscribed to a wait list to get a buffer.
836 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100837 goto out;
838 }
839
William Lallemand74c24fb2016-11-21 17:18:36 +0100840 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100841 if (appctx->st0 == CLI_ST_INIT) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100842 /* Stats output not initialized yet */
843 memset(&appctx->ctx.stats, 0, sizeof(appctx->ctx.stats));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200844 /* reset severity to default at init */
845 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100846 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100847 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100848 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100849 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100850 /* Let's close for real now. We just close the request
851 * side, the conditions below will complete if needed.
852 */
853 si_shutw(si);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200854 free_trash_chunk(appctx->chunk);
Willy Tarreau18b2a9d2021-05-04 16:27:45 +0200855 appctx->chunk = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +0100856 break;
857 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100858 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200859 char *str;
860
861 /* use a trash chunk to store received data */
862 if (!appctx->chunk) {
863 appctx->chunk = alloc_trash_chunk();
864 if (!appctx->chunk) {
865 appctx->st0 = CLI_ST_END;
866 continue;
867 }
868 }
869
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200870 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200871
William Lallemand74c24fb2016-11-21 17:18:36 +0100872 /* ensure we have some output room left in the event we
873 * would want to return some info right after parsing.
874 */
875 if (buffer_almost_full(si_ib(si))) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100876 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100877 break;
878 }
879
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200880 /* '- 1' is to ensure a null byte can always be inserted at the end */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200881 reql = co_getline(si_oc(si), str,
882 appctx->chunk->size - appctx->chunk->data - 1);
William Lallemand74c24fb2016-11-21 17:18:36 +0100883 if (reql <= 0) { /* closed or EOL not found */
884 if (reql == 0)
885 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100886 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100887 continue;
888 }
889
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200890 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
891 /* seek for a possible unescaped semi-colon. If we find
892 * one, we replace it with an LF and skip only this part.
893 */
894 for (len = 0; len < reql; len++) {
895 if (str[len] == '\\') {
896 len++;
897 continue;
898 }
899 if (str[len] == ';') {
900 str[len] = '\n';
901 reql = len + 1;
902 break;
903 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100904 }
905 }
906
907 /* now it is time to check that we have a full line,
908 * remove the trailing \n and possibly \r, then cut the
909 * line.
910 */
911 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200912 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100913 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100914 continue;
915 }
916
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200917 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100918 len--;
919
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200920 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200921 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200922
923 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200924 appctx->chunk->area[appctx->chunk->data] = '\n';
925 appctx->chunk->area[appctx->chunk->data + 1] = 0;
926 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200927 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100928
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100929 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200930
931 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
932 /* empty line */
933 if (!len) {
934 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200935 appctx->chunk->data -= 2;
936 appctx->chunk->area[appctx->chunk->data] = 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100937 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200938 chunk_reset(appctx->chunk);
939 /* NB: cli_sock_parse_request() may have put
940 * another CLI_ST_O_* into appctx->st0.
941 */
942
943 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +0100944 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100945 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200946 else {
947 /*
948 * Look for the "payload start" pattern at the end of a line
949 * Its location is not remembered here, this is just to switch
950 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +0100951 */
Willy Tarreauf2dda522021-09-17 11:07:45 +0200952 if (strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN) == 0) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200953 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Willy Tarreauf2dda522021-09-17 11:07:45 +0200954 appctx->chunk->data++; // keep the trailing \0 after '<<'
955 }
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200956 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200957 /* no payload, the command is complete: parse the request */
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100958 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200959 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200960 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100961 }
962
963 /* re-adjust req buffer */
Willy Tarreau06d80a92017-10-19 14:32:15 +0200964 co_skip(si_oc(si), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +0100965 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
966 }
967 else { /* output functions */
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200968 const char *msg;
969 int sev;
970
William Lallemand74c24fb2016-11-21 17:18:36 +0100971 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100972 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +0100973 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200974 case CLI_ST_PRINT: /* print const message in msg */
975 case CLI_ST_PRINT_ERR: /* print const error in msg */
976 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
977 case CLI_ST_PRINT_FREE: /* print dyn error in err, free */
978 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
979 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
980 LOG_ERR : appctx->ctx.cli.severity;
981 msg = appctx->ctx.cli.msg;
982 }
983 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_FREE) {
984 sev = appctx->st0 == CLI_ST_PRINT_FREE ?
985 LOG_ERR : appctx->ctx.cli.severity;
986 msg = appctx->ctx.cli.err;
987 if (!msg) {
988 sev = LOG_ERR;
989 msg = "Out of memory.\n";
990 }
991 }
992 else {
993 sev = LOG_ERR;
994 msg = "Internal error.\n";
995 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +0200996
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200997 if (cli_output_msg(res, msg, sev, cli_get_severity_output(appctx)) != -1) {
998 if (appctx->st0 == CLI_ST_PRINT_FREE ||
999 appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001000 ha_free(&appctx->ctx.cli.err);
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001001 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001002 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001003 }
1004 else
Willy Tarreaudb398432018-11-15 11:08:52 +01001005 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001006 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001007
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001008 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +01001009 if (appctx->io_handler)
1010 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001011 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001012 if (appctx->io_release) {
1013 appctx->io_release(appctx);
1014 appctx->io_release = NULL;
1015 }
1016 }
1017 break;
1018 default: /* abnormal state */
1019 si->flags |= SI_FL_ERR;
1020 break;
1021 }
1022
1023 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001024 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001025 const char *prompt = "";
1026
1027 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
1028 /*
1029 * when entering a payload with interactive mode, change the prompt
1030 * to emphasize that more data can still be sent
1031 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001032 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001033 prompt = "+ ";
1034 else
1035 prompt = "\n> ";
1036 }
1037 else {
William Lallemandad032882019-07-01 10:56:15 +02001038 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001039 prompt = "\n";
1040 }
1041
1042 if (ci_putstr(si_ic(si), prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001043 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +01001044 else
Willy Tarreaudb398432018-11-15 11:08:52 +01001045 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001046 }
1047
1048 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001049 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +01001050 break;
1051
1052 /* Now we close the output if one of the writers did so,
1053 * or if we're not in interactive mode and the request
1054 * buffer is empty. This still allows pipelined requests
1055 * to be sent in non-interactive mode.
1056 */
William Lallemand3de09d52018-12-11 16:10:56 +01001057 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
1058 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001059 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +01001060 continue;
1061 }
1062
1063 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001064 appctx->st0 = CLI_ST_GETREQ;
William Lallemandad032882019-07-01 10:56:15 +02001065 /* reactivate the \n at the end of the response for the next command */
1066 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
William Lallemand74c24fb2016-11-21 17:18:36 +01001067 }
1068 }
1069
1070 if ((res->flags & CF_SHUTR) && (si->state == SI_ST_EST)) {
1071 DPRINTF(stderr, "%s@%d: si to buf closed. req=%08x, res=%08x, st=%d\n",
1072 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
1073 /* Other side has closed, let's abort if we have no more processing to do
1074 * and nothing more to consume. This is comparable to a broken pipe, so
1075 * we forward the close to the request side so that it flows upstream to
1076 * the client.
1077 */
1078 si_shutw(si);
1079 }
1080
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001081 if ((req->flags & CF_SHUTW) && (si->state == SI_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
William Lallemand74c24fb2016-11-21 17:18:36 +01001082 DPRINTF(stderr, "%s@%d: buf to si closed. req=%08x, res=%08x, st=%d\n",
1083 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
1084 /* We have no more processing to do, and nothing more to send, and
1085 * the client side has closed. So we'll forward this state downstream
1086 * on the response buffer.
1087 */
1088 si_shutr(si);
1089 res->flags |= CF_READ_NULL;
1090 }
1091
1092 out:
Christopher Faulet45073512018-07-20 10:16:29 +02001093 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 +01001094 __FUNCTION__, __LINE__,
Christopher Faulet45073512018-07-20 10:16:29 +02001095 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 +01001096}
1097
William Lallemand74c24fb2016-11-21 17:18:36 +01001098/* This is called when the stream interface is closed. For instance, upon an
1099 * external abort, we won't call the i/o handler anymore so we may need to
1100 * remove back references to the stream currently being dumped.
1101 */
1102static void cli_release_handler(struct appctx *appctx)
1103{
Willy Tarreau18b2a9d2021-05-04 16:27:45 +02001104 free_trash_chunk(appctx->chunk);
1105 appctx->chunk = NULL;
1106
William Lallemand74c24fb2016-11-21 17:18:36 +01001107 if (appctx->io_release) {
1108 appctx->io_release(appctx);
1109 appctx->io_release = NULL;
1110 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001111 else if (appctx->st0 == CLI_ST_PRINT_FREE || appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001112 ha_free(&appctx->ctx.cli.err);
William Lallemand74c24fb2016-11-21 17:18:36 +01001113 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001114}
1115
1116/* This function dumps all environmnent variables to the buffer. It returns 0
1117 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreauf6710f82016-12-16 17:45:44 +01001118 * non-zero. Dumps only one entry if st2 == STAT_ST_END. It uses cli.p0 as the
1119 * pointer to the current variable.
William Lallemand74c24fb2016-11-21 17:18:36 +01001120 */
Willy Tarreau0a739292016-11-22 20:21:23 +01001121static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +01001122{
Willy Tarreau0a739292016-11-22 20:21:23 +01001123 struct stream_interface *si = appctx->owner;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001124 char **var = appctx->ctx.cli.p0;
William Lallemand74c24fb2016-11-21 17:18:36 +01001125
1126 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1127 return 1;
1128
1129 chunk_reset(&trash);
1130
1131 /* we have two inner loops here, one for the proxy, the other one for
1132 * the buffer.
1133 */
Willy Tarreauf6710f82016-12-16 17:45:44 +01001134 while (*var) {
1135 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +01001136
Willy Tarreau06d80a92017-10-19 14:32:15 +02001137 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001138 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001139 return 0;
1140 }
1141 if (appctx->st2 == STAT_ST_END)
1142 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001143 var++;
1144 appctx->ctx.cli.p0 = var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001145 }
1146
1147 /* dump complete */
1148 return 1;
1149}
1150
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001151/* This function dumps all file descriptors states (or the requested one) to
1152 * the buffer. It returns 0 if the output buffer is full and it needs to be
1153 * called again, otherwise non-zero. Dumps only one entry if st2 == STAT_ST_END.
1154 * It uses cli.i0 as the fd number to restart from.
1155 */
1156static int cli_io_handler_show_fd(struct appctx *appctx)
1157{
1158 struct stream_interface *si = appctx->owner;
1159 int fd = appctx->ctx.cli.i0;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001160 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001161
1162 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001163 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001164
1165 chunk_reset(&trash);
1166
Willy Tarreauca1b1572018-12-18 15:45:11 +01001167 /* isolate the threads once per round. We're limited to a buffer worth
1168 * of output anyway, it cannot last very long.
1169 */
1170 thread_isolate();
1171
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001172 /* we have two inner loops here, one for the proxy, the other one for
1173 * the buffer.
1174 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001175 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001176 struct fdtab fdt;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001177 const struct listener *li = NULL;
1178 const struct server *sv = NULL;
1179 const struct proxy *px = NULL;
1180 const struct connection *conn = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001181 const struct mux_ops *mux = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001182 const struct xprt_ops *xprt = NULL;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001183 const void *ctx = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001184 const void *xprt_ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001185 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001186 int is_back = 0;
Willy Tarreau8050efe2021-01-21 08:26:06 +01001187 int suspicious = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001188
1189 fdt = fdtab[fd];
1190
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001191 /* When DEBUG_FD is set, we also report closed FDs that have a
1192 * non-null event count to detect stuck ones.
1193 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001194 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001195#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001196 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001197#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001198 goto skip; // closed
1199 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001200 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001201 conn = (const struct connection *)fdt.owner;
1202 conn_flags = conn->flags;
1203 mux = conn->mux;
1204 ctx = conn->ctx;
Willy Tarreau37be9532021-01-20 14:40:04 +01001205 xprt = conn->xprt;
1206 xprt_ctx = conn->xprt_ctx;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001207 li = objt_listener(conn->target);
1208 sv = objt_server(conn->target);
1209 px = objt_proxy(conn->target);
1210 is_back = conn_is_back(conn);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001211 if (atleast2(fdt.thread_mask))
1212 suspicious = 1;
1213 if (conn->handle.fd != fd)
1214 suspicious = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001215 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001216 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001217 li = fdt.owner;
1218
Willy Tarreaudacfde42021-01-21 09:07:29 +01001219 if (!fdt.thread_mask)
1220 suspicious = 1;
1221
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001222 chunk_printf(&trash,
Willy Tarreau184b2122021-04-07 08:48:12 +02001223 " %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 +02001224 fd,
1225 fdt.state,
Willy Tarreau184b2122021-04-07 08:48:12 +02001226 (fdt.state & FD_CLONED) ? 'C' : 'c',
1227 (fdt.state & FD_LINGER_RISK) ? 'L' : 'l',
Willy Tarreauf5090652021-04-06 17:23:40 +02001228 (fdt.state & FD_POLL_HUP) ? 'H' : 'h',
1229 (fdt.state & FD_POLL_ERR) ? 'E' : 'e',
1230 (fdt.state & FD_POLL_OUT) ? 'O' : 'o',
1231 (fdt.state & FD_POLL_PRI) ? 'P' : 'p',
1232 (fdt.state & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau184b2122021-04-07 08:48:12 +02001233 (fdt.state & FD_EV_SHUT_W) ? 'S' : 's',
1234 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1235 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1236 (fdt.state & FD_EV_SHUT_R) ? 'S' : 's',
1237 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1238 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreauc754b342018-03-30 15:00:15 +02001239 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001240 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001241 fdt.iocb);
1242 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001243
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001244 if (!fdt.owner) {
1245 chunk_appendf(&trash, ")");
1246 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001247 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001248 chunk_appendf(&trash, ") back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001249
1250 if (conn->handle.fd != fd) {
1251 chunk_appendf(&trash, " fd=%d(BOGUS)", conn->handle.fd);
1252 suspicious = 1;
Willy Tarreaued989202021-02-05 10:54:52 +01001253 } else {
1254 struct sockaddr_storage sa;
1255 socklen_t salen;
1256
1257 salen = sizeof(sa);
1258 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1259 if (sa.ss_family == AF_INET)
1260 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1261 else if (sa.ss_family == AF_INET6)
1262 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1263 else if (sa.ss_family == AF_UNIX)
1264 chunk_appendf(&trash, " fam=unix");
1265 }
1266
1267 salen = sizeof(sa);
1268 if (getpeername(fd, (struct sockaddr *)&sa, &salen) != -1) {
1269 if (sa.ss_family == AF_INET)
1270 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1271 else if (sa.ss_family == AF_INET6)
1272 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1273 }
Willy Tarreaudacfde42021-01-21 09:07:29 +01001274 }
1275
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001276 if (px)
1277 chunk_appendf(&trash, " px=%s", px->id);
1278 else if (sv)
Willy Tarreaudfb34a82021-07-06 11:41:10 +02001279 chunk_appendf(&trash, " sv=%s/%s", sv->proxy->id, sv->id);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001280 else if (li)
1281 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001282
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001283 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001284 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001285 if (!ctx)
1286 suspicious = 1;
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001287 if (mux->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001288 suspicious |= mux->show_fd(&trash, fdt.owner);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001289 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001290 else
1291 chunk_appendf(&trash, " nomux");
Willy Tarreau37be9532021-01-20 14:40:04 +01001292
1293 chunk_appendf(&trash, " xprt=%s", xprt ? xprt->name : "");
Willy Tarreau108a2712021-01-20 15:30:56 +01001294 if (xprt) {
1295 if (xprt_ctx || xprt->show_fd)
1296 chunk_appendf(&trash, " xprt_ctx=%p", xprt_ctx);
1297 if (xprt->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001298 suspicious |= xprt->show_fd(&trash, conn, xprt_ctx);
Willy Tarreau108a2712021-01-20 15:30:56 +01001299 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001300 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001301 else if (fdt.iocb == sock_accept_iocb) {
Willy Tarreaued989202021-02-05 10:54:52 +01001302 struct sockaddr_storage sa;
1303 socklen_t salen;
1304
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001305 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001306 listener_state_str(li),
1307 li->bind_conf->frontend->id);
Willy Tarreaued989202021-02-05 10:54:52 +01001308
1309 salen = sizeof(sa);
1310 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1311 if (sa.ss_family == AF_INET)
1312 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1313 else if (sa.ss_family == AF_INET6)
1314 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1315 else if (sa.ss_family == AF_UNIX)
1316 chunk_appendf(&trash, " fam=unix");
1317 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001318 }
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001319 else
1320 chunk_appendf(&trash, ")");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001321
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001322#ifdef DEBUG_FD
1323 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001324 if (fdtab[fd].event_count >= 1000000)
1325 suspicious = 1;
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001326#endif
Willy Tarreau8050efe2021-01-21 08:26:06 +01001327 chunk_appendf(&trash, "%s\n", suspicious ? " !" : "");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001328
Willy Tarreau06d80a92017-10-19 14:32:15 +02001329 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001330 si_rx_room_blk(si);
Willy Tarreauca1b1572018-12-18 15:45:11 +01001331 appctx->ctx.cli.i0 = fd;
1332 ret = 0;
1333 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001334 }
1335 skip:
1336 if (appctx->st2 == STAT_ST_END)
1337 break;
1338
1339 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001340 }
1341
Willy Tarreauca1b1572018-12-18 15:45:11 +01001342 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001343 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001344
1345 thread_release();
1346 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001347}
1348
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001349/* This function dumps some activity counters used by developers and support to
1350 * rule out some hypothesis during bug reports. It returns 0 if the output
1351 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
1352 * everything at once in the buffer and is not designed to do it in multiple
1353 * passes.
1354 */
1355static int cli_io_handler_show_activity(struct appctx *appctx)
1356{
1357 struct stream_interface *si = appctx->owner;
1358 int thr;
1359
1360 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1361 return 1;
1362
1363 chunk_reset(&trash);
1364
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001365#undef SHOW_TOT
1366#define SHOW_TOT(t, x) \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001367 do { \
1368 unsigned int _v[MAX_THREADS]; \
1369 unsigned int _tot; \
1370 const unsigned int _nbt = global.nbthread; \
1371 for (_tot = t = 0; t < _nbt; t++) \
1372 _tot += _v[t] = (x); \
1373 if (_nbt == 1) { \
1374 chunk_appendf(&trash, " %u\n", _tot); \
1375 break; \
1376 } \
1377 chunk_appendf(&trash, " %u [", _tot); \
1378 for (t = 0; t < _nbt; t++) \
1379 chunk_appendf(&trash, " %u", _v[t]); \
1380 chunk_appendf(&trash, " ]\n"); \
1381 } while (0)
1382
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001383#undef SHOW_AVG
1384#define SHOW_AVG(t, x) \
1385 do { \
1386 unsigned int _v[MAX_THREADS]; \
1387 unsigned int _tot; \
1388 const unsigned int _nbt = global.nbthread; \
1389 for (_tot = t = 0; t < _nbt; t++) \
1390 _tot += _v[t] = (x); \
1391 if (_nbt == 1) { \
1392 chunk_appendf(&trash, " %u\n", _tot); \
1393 break; \
1394 } \
1395 chunk_appendf(&trash, " %u [", (_tot + _nbt/2) / _nbt); \
1396 for (t = 0; t < _nbt; t++) \
1397 chunk_appendf(&trash, " %u", _v[t]); \
1398 chunk_appendf(&trash, " ]\n"); \
1399 } while (0)
1400
Willy Tarreaua0211b82019-05-28 15:09:08 +02001401 chunk_appendf(&trash, "thread_id: %u (%u..%u)\n", tid + 1, 1, global.nbthread);
1402 chunk_appendf(&trash, "date_now: %lu.%06lu\n", (long)now.tv_sec, (long)now.tv_usec);
Willy Tarreaua00cf9b2020-06-17 20:44:28 +02001403 chunk_appendf(&trash, "ctxsw:"); SHOW_TOT(thr, activity[thr].ctxsw);
1404 chunk_appendf(&trash, "tasksw:"); SHOW_TOT(thr, activity[thr].tasksw);
1405 chunk_appendf(&trash, "empty_rq:"); SHOW_TOT(thr, activity[thr].empty_rq);
1406 chunk_appendf(&trash, "long_rq:"); SHOW_TOT(thr, activity[thr].long_rq);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001407 chunk_appendf(&trash, "loops:"); SHOW_TOT(thr, activity[thr].loops);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001408 chunk_appendf(&trash, "wake_tasks:"); SHOW_TOT(thr, activity[thr].wake_tasks);
1409 chunk_appendf(&trash, "wake_signal:"); SHOW_TOT(thr, activity[thr].wake_signal);
Willy Tarreaue5451532020-06-17 20:25:18 +02001410 chunk_appendf(&trash, "poll_io:"); SHOW_TOT(thr, activity[thr].poll_io);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001411 chunk_appendf(&trash, "poll_exp:"); SHOW_TOT(thr, activity[thr].poll_exp);
Willy Tarreaue4063862020-06-17 20:35:33 +02001412 chunk_appendf(&trash, "poll_drop_fd:"); SHOW_TOT(thr, activity[thr].poll_drop_fd);
Willy Tarreaue4063862020-06-17 20:35:33 +02001413 chunk_appendf(&trash, "poll_skip_fd:"); SHOW_TOT(thr, activity[thr].poll_skip_fd);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001414 chunk_appendf(&trash, "conn_dead:"); SHOW_TOT(thr, activity[thr].conn_dead);
Willy Tarreau7af4fa92020-06-17 20:49:49 +02001415 chunk_appendf(&trash, "stream_calls:"); SHOW_TOT(thr, activity[thr].stream_calls);
Willy Tarreaua8b2ce02019-05-28 17:04:16 +02001416 chunk_appendf(&trash, "pool_fail:"); SHOW_TOT(thr, activity[thr].pool_fail);
1417 chunk_appendf(&trash, "buf_wait:"); SHOW_TOT(thr, activity[thr].buf_wait);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001418 chunk_appendf(&trash, "cpust_ms_tot:"); SHOW_TOT(thr, activity[thr].cpust_total / 2);
1419 chunk_appendf(&trash, "cpust_ms_1s:"); SHOW_TOT(thr, read_freq_ctr(&activity[thr].cpust_1s) / 2);
1420 chunk_appendf(&trash, "cpust_ms_15s:"); SHOW_TOT(thr, read_freq_ctr_period(&activity[thr].cpust_15s, 15000) / 2);
1421 chunk_appendf(&trash, "avg_loop_us:"); SHOW_AVG(thr, swrate_avg(activity[thr].avg_loop_us, TIME_STATS_SAMPLES));
1422 chunk_appendf(&trash, "accepted:"); SHOW_TOT(thr, activity[thr].accepted);
1423 chunk_appendf(&trash, "accq_pushed:"); SHOW_TOT(thr, activity[thr].accq_pushed);
1424 chunk_appendf(&trash, "accq_full:"); SHOW_TOT(thr, activity[thr].accq_full);
Willy Tarreaue6182842019-04-15 18:54:10 +02001425#ifdef USE_THREAD
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001426 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 +02001427 chunk_appendf(&trash, "fd_takeover:"); SHOW_TOT(thr, activity[thr].fd_takeover);
Willy Tarreaue6182842019-04-15 18:54:10 +02001428#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001429
Willy Tarreaud6a78502019-05-27 07:03:38 +02001430#if defined(DEBUG_DEV)
1431 /* keep these ones at the end */
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001432 chunk_appendf(&trash, "ctr0:"); SHOW_TOT(thr, activity[thr].ctr0);
1433 chunk_appendf(&trash, "ctr1:"); SHOW_TOT(thr, activity[thr].ctr1);
1434 chunk_appendf(&trash, "ctr2:"); SHOW_TOT(thr, activity[thr].ctr2);
Willy Tarreaud6a78502019-05-27 07:03:38 +02001435#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001436
1437 if (ci_putchk(si_ic(si), &trash) == -1) {
1438 chunk_reset(&trash);
1439 chunk_printf(&trash, "[output too large, cannot dump]\n");
Willy Tarreaudb398432018-11-15 11:08:52 +01001440 si_rx_room_blk(si);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001441 }
1442
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001443#undef SHOW_AVG
1444#undef SHOW_TOT
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001445 /* dump complete */
1446 return 1;
1447}
1448
William Lallemandeceddf72016-12-15 18:06:44 +01001449/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001450 * CLI IO handler for `show cli sockets`.
1451 * Uses ctx.cli.p0 to store the restart pointer.
William Lallemandeceddf72016-12-15 18:06:44 +01001452 */
1453static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1454{
1455 struct bind_conf *bind_conf;
1456 struct stream_interface *si = appctx->owner;
1457
1458 chunk_reset(&trash);
1459
1460 switch (appctx->st2) {
1461 case STAT_ST_INIT:
1462 chunk_printf(&trash, "# socket lvl processes\n");
Willy Tarreau06d80a92017-10-19 14:32:15 +02001463 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001464 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001465 return 0;
1466 }
William Lallemandeceddf72016-12-15 18:06:44 +01001467 appctx->st2 = STAT_ST_LIST;
Tim Duesterhus588b3142020-05-29 14:35:51 +02001468 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001469
1470 case STAT_ST_LIST:
Willy Tarreau4975d142021-03-13 11:00:33 +01001471 if (global.cli_fe) {
1472 list_for_each_entry(bind_conf, &global.cli_fe->conf.bind, by_fe) {
William Lallemandeceddf72016-12-15 18:06:44 +01001473 struct listener *l;
1474
1475 /*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001476 * get the latest dumped node in appctx->ctx.cli.p0
William Lallemandeceddf72016-12-15 18:06:44 +01001477 * if the current node is the first of the list
1478 */
1479
Willy Tarreau3af9d832016-12-16 12:58:09 +01001480 if (appctx->ctx.cli.p0 &&
Willy Tarreau4975d142021-03-13 11:00:33 +01001481 &bind_conf->by_fe == (&global.cli_fe->conf.bind)->n) {
William Lallemandeceddf72016-12-15 18:06:44 +01001482 /* change the current node to the latest dumped and continue the loop */
Willy Tarreau3af9d832016-12-16 12:58:09 +01001483 bind_conf = LIST_ELEM(appctx->ctx.cli.p0, typeof(bind_conf), by_fe);
William Lallemandeceddf72016-12-15 18:06:44 +01001484 continue;
1485 }
1486
1487 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
1488
1489 char addr[46];
1490 char port[6];
1491
Willy Tarreau37159062020-08-27 07:48:42 +02001492 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemandeceddf72016-12-15 18:06:44 +01001493 const struct sockaddr_un *un;
1494
Willy Tarreau37159062020-08-27 07:48:42 +02001495 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemande58915f2019-04-01 11:30:05 +02001496 if (un->sun_path[0] == '\0') {
William Lallemand75812a72019-04-01 11:30:04 +02001497 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
William Lallemande58915f2019-04-01 11:30:05 +02001498 } else {
1499 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1500 }
Willy Tarreau37159062020-08-27 07:48:42 +02001501 } else if (l->rx.addr.ss_family == AF_INET) {
1502 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1503 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001504 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001505 } else if (l->rx.addr.ss_family == AF_INET6) {
1506 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1507 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001508 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001509 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1510 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemandeceddf72016-12-15 18:06:44 +01001511 } else
William Lallemand26314342018-10-26 14:47:41 +02001512 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001513
William Lallemand07a62f72017-05-24 00:57:40 +02001514 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
William Lallemandeceddf72016-12-15 18:06:44 +01001515 chunk_appendf(&trash, "admin ");
William Lallemand07a62f72017-05-24 00:57:40 +02001516 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1517 chunk_appendf(&trash, "operator ");
1518 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1519 chunk_appendf(&trash, "user ");
William Lallemandeceddf72016-12-15 18:06:44 +01001520 else
1521 chunk_appendf(&trash, " ");
1522
Willy Tarreau72faef32021-06-15 08:36:30 +02001523 chunk_appendf(&trash, "all\n");
William Lallemandeceddf72016-12-15 18:06:44 +01001524
Willy Tarreau06d80a92017-10-19 14:32:15 +02001525 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001526 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001527 return 0;
1528 }
1529 }
Willy Tarreau3af9d832016-12-16 12:58:09 +01001530 appctx->ctx.cli.p0 = &bind_conf->by_fe; /* store the latest list node dumped */
William Lallemandeceddf72016-12-15 18:06:44 +01001531 }
1532 }
Tim Duesterhus588b3142020-05-29 14:35:51 +02001533 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001534 default:
1535 appctx->st2 = STAT_ST_FIN;
1536 return 1;
1537 }
1538}
1539
1540
Willy Tarreau0a739292016-11-22 20:21:23 +01001541/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreauf6710f82016-12-16 17:45:44 +01001542 * wants to stop here. It puts the variable to be dumped into cli.p0 if a single
1543 * variable is requested otherwise puts environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001544 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001545static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001546{
1547 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001548 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001549
1550 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1551 return 1;
1552
Willy Tarreauf6710f82016-12-16 17:45:44 +01001553 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001554
1555 if (*args[2]) {
1556 int len = strlen(args[2]);
1557
Willy Tarreauf6710f82016-12-16 17:45:44 +01001558 for (; *var; var++) {
1559 if (strncmp(*var, args[2], len) == 0 &&
1560 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001561 break;
1562 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001563 if (!*var)
1564 return cli_err(appctx, "Variable not found\n");
1565
Willy Tarreau0a739292016-11-22 20:21:23 +01001566 appctx->st2 = STAT_ST_END;
1567 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001568 appctx->ctx.cli.p0 = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001569 return 0;
1570}
1571
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001572/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
1573 * wants to stop here. It puts the FD number into cli.i0 if a specific FD is
1574 * requested and sets st2 to STAT_ST_END, otherwise leaves 0 in i0.
1575 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001576static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001577{
1578 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1579 return 1;
1580
1581 appctx->ctx.cli.i0 = 0;
1582
1583 if (*args[2]) {
1584 appctx->ctx.cli.i0 = atoi(args[2]);
1585 appctx->st2 = STAT_ST_END;
1586 }
1587 return 0;
1588}
1589
Willy Tarreau599852e2016-11-22 20:33:32 +01001590/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001591static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001592{
1593 struct stream_interface *si = appctx->owner;
1594 struct stream *s = si_strm(si);
1595
1596 if (strcmp(args[2], "cli") == 0) {
1597 unsigned timeout;
1598 const char *res;
1599
Willy Tarreau9d008692019-08-09 11:21:01 +02001600 if (!*args[3])
1601 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001602
1603 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001604 if (res || timeout < 1)
1605 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001606
1607 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1608 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1609 return 1;
1610 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001611
1612 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001613}
1614
Willy Tarreau2af99412016-11-23 11:10:59 +01001615/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001616static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001617{
1618 int v;
1619
1620 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1621 return 1;
1622
Willy Tarreau9d008692019-08-09 11:21:01 +02001623 if (!*args[3])
1624 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001625
1626 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001627 if (v > global.hardmaxconn)
1628 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001629
1630 /* check for unlimited values */
1631 if (v <= 0)
1632 v = global.hardmaxconn;
1633
1634 global.maxconn = v;
1635
1636 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001637 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001638
1639 return 1;
1640}
1641
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001642static int set_severity_output(int *target, char *argument)
1643{
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001644 if (strcmp(argument, "none") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001645 *target = CLI_SEVERITY_NONE;
1646 return 1;
1647 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001648 else if (strcmp(argument, "number") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001649 *target = CLI_SEVERITY_NUMBER;
1650 return 1;
1651 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001652 else if (strcmp(argument, "string") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001653 *target = CLI_SEVERITY_STRING;
1654 return 1;
1655 }
1656 return 0;
1657}
1658
1659/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001660static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001661{
1662 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1663 return 0;
1664
Willy Tarreau9d008692019-08-09 11:21:01 +02001665 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001666}
William Lallemandeceddf72016-12-15 18:06:44 +01001667
William Lallemand67a234f2018-12-13 09:05:45 +01001668
1669/* show the level of the current CLI session */
1670static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1671{
William Lallemand67a234f2018-12-13 09:05:45 +01001672 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001673 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001674 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001675 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001676 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001677 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001678 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001679 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001680}
1681
1682/* parse and set the CLI level dynamically */
1683static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1684{
William Lallemandad032882019-07-01 10:56:15 +02001685 /* this will ask the applet to not output a \n after the command */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001686 if (strcmp(args[1], "-") == 0)
William Lallemandad032882019-07-01 10:56:15 +02001687 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1688
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001689 if (strcmp(args[0], "operator") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001690 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1691 return 1;
1692 }
1693 appctx->cli_level &= ~ACCESS_LVL_MASK;
1694 appctx->cli_level |= ACCESS_LVL_OPER;
1695
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001696 } else if (strcmp(args[0], "user") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001697 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1698 return 1;
1699 }
1700 appctx->cli_level &= ~ACCESS_LVL_MASK;
1701 appctx->cli_level |= ACCESS_LVL_USER;
1702 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001703 appctx->cli_level &= ~(ACCESS_EXPERT|ACCESS_EXPERIMENTAL);
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001704 return 1;
1705}
1706
1707
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001708/* parse and set the CLI expert/experimental-mode dynamically */
1709static int cli_parse_expert_experimental_mode(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001710{
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001711 int level;
1712 char *level_str;
1713 char *output = NULL;
1714
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001715 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1716 return 1;
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001717
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001718 if (strcmp(args[0], "expert-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001719 level = ACCESS_EXPERT;
1720 level_str = "expert-mode";
1721 }
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001722 else if (strcmp(args[0], "experimental-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001723 level = ACCESS_EXPERIMENTAL;
1724 level_str = "experimental-mode";
1725 }
1726 else {
1727 return 1;
1728 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001729
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001730 if (!*args[1]) {
1731 memprintf(&output, "%s is %s\n", level_str,
1732 (appctx->cli_level & level) ? "ON" : "OFF");
1733 return cli_dynmsg(appctx, LOG_INFO, output);
1734 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001735
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001736 appctx->cli_level &= ~level;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001737 if (strcmp(args[1], "on") == 0)
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001738 appctx->cli_level |= level;
William Lallemand67a234f2018-12-13 09:05:45 +01001739 return 1;
1740}
1741
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001742int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001743{
1744 return 0;
1745}
1746
Willy Tarreau45c742b2016-11-24 14:51:17 +01001747/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001748static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001749{
1750 int v;
1751 int *res;
1752 int mul = 1;
1753
1754 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1755 return 1;
1756
1757 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1758 res = &global.cps_lim;
1759 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1760 res = &global.sps_lim;
1761#ifdef USE_OPENSSL
1762 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1763 res = &global.ssl_lim;
1764#endif
1765 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1766 res = &global.comp_rate_lim;
1767 mul = 1024;
1768 }
1769 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001770 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001771 "'set rate-limit' only supports :\n"
1772 " - 'connections global' to set the per-process maximum connection rate\n"
1773 " - 'sessions global' to set the per-process maximum session rate\n"
1774#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001775 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001776#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001777 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001778 }
1779
Willy Tarreau9d008692019-08-09 11:21:01 +02001780 if (!*args[4])
1781 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001782
1783 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001784 if (v < 0)
1785 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001786
1787 *res = v * mul;
1788
1789 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001790 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001791
1792 return 1;
1793}
1794
William Lallemandf6975e92017-05-26 17:42:10 +02001795/* parse the "expose-fd" argument on the bind lines */
1796static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1797{
1798 if (!*args[cur_arg + 1]) {
1799 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1800 return ERR_ALERT | ERR_FATAL;
1801 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001802 if (strcmp(args[cur_arg + 1], "listeners") == 0) {
William Lallemandf6975e92017-05-26 17:42:10 +02001803 conf->level |= ACCESS_FD_LISTENERS;
1804 } else {
1805 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1806 args[cur_arg], args[cur_arg+1]);
1807 return ERR_ALERT | ERR_FATAL;
1808 }
1809
1810 return 0;
1811}
1812
William Lallemand74c24fb2016-11-21 17:18:36 +01001813/* parse the "level" argument on the bind lines */
1814static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1815{
1816 if (!*args[cur_arg + 1]) {
1817 memprintf(err, "'%s' : missing level", args[cur_arg]);
1818 return ERR_ALERT | ERR_FATAL;
1819 }
1820
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001821 if (strcmp(args[cur_arg + 1], "user") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001822 conf->level &= ~ACCESS_LVL_MASK;
1823 conf->level |= ACCESS_LVL_USER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001824 } else if (strcmp(args[cur_arg + 1], "operator") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001825 conf->level &= ~ACCESS_LVL_MASK;
1826 conf->level |= ACCESS_LVL_OPER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001827 } else if (strcmp(args[cur_arg + 1], "admin") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001828 conf->level &= ~ACCESS_LVL_MASK;
1829 conf->level |= ACCESS_LVL_ADMIN;
1830 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001831 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1832 args[cur_arg], args[cur_arg+1]);
1833 return ERR_ALERT | ERR_FATAL;
1834 }
1835
1836 return 0;
1837}
1838
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001839static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1840{
1841 if (!*args[cur_arg + 1]) {
1842 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1843 return ERR_ALERT | ERR_FATAL;
1844 }
1845
1846 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1847 return 0;
1848 else {
1849 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1850 args[cur_arg], args[cur_arg+1]);
1851 return ERR_ALERT | ERR_FATAL;
1852 }
1853}
1854
Olivier Houchardf886e342017-04-05 22:24:59 +02001855/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001856static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001857{
1858 char *cmsgbuf = NULL;
1859 unsigned char *tmpbuf = NULL;
1860 struct cmsghdr *cmsg;
1861 struct stream_interface *si = appctx->owner;
William Lallemandf6975e92017-05-26 17:42:10 +02001862 struct stream *s = si_strm(si);
Olivier Houchard9aaf7782017-09-13 18:30:23 +02001863 struct connection *remote = cs_conn(objt_cs(si_opposite(si)->end));
Olivier Houchardf886e342017-04-05 22:24:59 +02001864 struct msghdr msghdr;
1865 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001866 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001867 const char *ns_name, *if_name;
1868 unsigned char ns_nlen, if_nlen;
1869 int nb_queued;
1870 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001871 int *tmpfd;
1872 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001873 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001874 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001875 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001876 int ret;
1877
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001878 if (!remote) {
1879 ha_warning("Only works on real connections\n");
1880 goto out;
1881 }
1882
1883 fd = remote->handle.fd;
1884
Olivier Houchardf886e342017-04-05 22:24:59 +02001885 /* Temporary set the FD in blocking mode, that will make our life easier */
1886 old_fcntl = fcntl(fd, F_GETFL);
1887 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001888 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001889 goto out;
1890 }
1891 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1892 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001893 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001894 goto out;
1895 }
1896 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001897 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001898 goto out;
1899 }
Olivier Houchard54740872017-04-06 14:45:14 +02001900 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001901 iov.iov_base = &tot_fd_nb;
1902 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02001903 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02001904 goto out;
1905 memset(&msghdr, 0, sizeof(msghdr));
1906 /*
1907 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05001908 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02001909 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001910 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
Willy Tarreau9063a662021-04-06 18:09:06 +02001911 tot_fd_nb += !!(fdtab[cur_fd].state & FD_EXPORTED);
William Lallemand5fd3b282020-01-16 15:32:08 +01001912
Olivier Houchardf886e342017-04-05 22:24:59 +02001913 if (tot_fd_nb == 0)
1914 goto out;
1915
1916 /* First send the total number of file descriptors, so that the
1917 * receiving end knows what to expect.
1918 */
1919 msghdr.msg_iov = &iov;
1920 msghdr.msg_iovlen = 1;
1921 ret = sendmsg(fd, &msghdr, 0);
1922 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001923 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001924 goto out;
1925 }
1926
1927 /* Now send the fds */
1928 msghdr.msg_control = cmsgbuf;
1929 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
1930 cmsg = CMSG_FIRSTHDR(&msghdr);
1931 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
1932 cmsg->cmsg_level = SOL_SOCKET;
1933 cmsg->cmsg_type = SCM_RIGHTS;
1934 tmpfd = (int *)CMSG_DATA(cmsg);
1935
Olivier Houchardf886e342017-04-05 22:24:59 +02001936 /* For each socket, e message is sent, containing the following :
1937 * Size of the namespace name (or 0 if none), as an unsigned char.
1938 * The namespace name, if any
1939 * Size of the interface name (or 0 if none), as an unsigned char
1940 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02001941 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02001942 */
1943 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05001944 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02001945 */
Olivier Houchardf143b802017-11-04 15:13:01 +01001946 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02001947 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05001948 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001949 goto out;
1950 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001951
1952 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001953 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001954 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
Willy Tarreau9063a662021-04-06 18:09:06 +02001955 if (!(fdtab[cur_fd].state & FD_EXPORTED))
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001956 continue;
1957
1958 ns_name = if_name = "";
1959 ns_nlen = if_nlen = 0;
1960
1961 /* for now we can only retrieve namespaces and interfaces from
1962 * pure listeners.
1963 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02001964 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001965 const struct listener *l = fdtab[cur_fd].owner;
1966
Willy Tarreau818a92e2020-09-03 07:50:19 +02001967 if (l->rx.settings->interface) {
1968 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001969 if_nlen = strlen(if_name);
1970 }
1971
1972#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02001973 if (l->rx.settings->netns) {
1974 ns_name = l->rx.settings->netns->node.key;
1975 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001976 }
1977#endif
1978 }
1979
1980 /* put the FD into the CMSG_DATA */
1981 tmpfd[nb_queued++] = cur_fd;
1982
1983 /* first block is <ns_name_len> <ns_name> */
1984 tmpbuf[curoff++] = ns_nlen;
1985 if (ns_nlen)
1986 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
1987 curoff += ns_nlen;
1988
1989 /* second block is <if_name_len> <if_name> */
1990 tmpbuf[curoff++] = if_nlen;
1991 if (if_nlen)
1992 memcpy(tmpbuf + curoff, if_name, if_nlen);
1993 curoff += if_nlen;
1994
1995 /* we used to send the listener options here before 2.3 */
1996 memset(tmpbuf + curoff, 0, sizeof(int));
1997 curoff += sizeof(int);
1998
1999 /* there's a limit to how many FDs may be sent at once */
2000 if (nb_queued == MAX_SEND_FD) {
2001 iov.iov_len = curoff;
2002 if (sendmsg(fd, &msghdr, 0) != curoff) {
2003 ha_warning("Failed to transfer sockets\n");
2004 return -1;
2005 }
2006
2007 /* Wait for an ack */
2008 do {
2009 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
2010 } while (ret == -1 && errno == EINTR);
2011
2012 if (ret <= 0) {
2013 ha_warning("Unexpected error while transferring sockets\n");
2014 return -1;
2015 }
2016 curoff = 0;
2017 nb_queued = 0;
2018 }
William Lallemand5fd3b282020-01-16 15:32:08 +01002019 }
2020
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002021 /* flush pending stuff */
2022 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02002023 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002024 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
2025 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02002026 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002027 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002028 goto out;
2029 }
2030 }
2031
2032out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002033 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002034 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002035 goto out;
2036 }
2037 appctx->st0 = CLI_ST_END;
2038 free(cmsgbuf);
2039 free(tmpbuf);
2040 return 1;
2041}
2042
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002043static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
2044{
2045 if (*args[0] == 'h')
2046 /* help */
Willy Tarreau0b1b8302021-05-09 20:59:23 +02002047 cli_gen_usage_msg(appctx, args);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002048 else if (*args[0] == 'p')
2049 /* prompt */
2050 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
2051 else if (*args[0] == 'q')
2052 /* quit */
2053 appctx->st0 = CLI_ST_END;
2054
2055 return 1;
2056}
Olivier Houchardf886e342017-04-05 22:24:59 +02002057
William Lallemand2f4ce202018-10-26 14:47:47 +02002058void pcli_write_prompt(struct stream *s)
2059{
2060 struct buffer *msg = get_trash_chunk();
2061 struct channel *oc = si_oc(&s->si[0]);
2062
William Lallemanddc12c2e2018-12-13 09:05:46 +01002063 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01002064 return;
2065
William Lallemanddc12c2e2018-12-13 09:05:46 +01002066 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002067 chunk_appendf(msg, "+ ");
2068 } else {
2069 if (s->pcli_next_pid == 0)
Willy Tarreau52880f92018-12-15 13:30:03 +01002070 chunk_appendf(msg, "master%s> ",
William Lallemand3ba7c7b2021-11-10 10:57:18 +01002071 (proc_self->failedreloads > 0) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01002072 else
2073 chunk_appendf(msg, "%d> ", s->pcli_next_pid);
2074 }
William Lallemand2f4ce202018-10-26 14:47:47 +02002075 co_inject(oc, msg->area, msg->data);
2076}
2077
William Lallemand291810d2018-10-26 14:47:38 +02002078
William Lallemandcf62f7e2018-10-26 14:47:40 +02002079/* The pcli_* functions are used for the CLI proxy in the master */
2080
William Lallemanddeeaa592018-10-26 14:47:48 +02002081void pcli_reply_and_close(struct stream *s, const char *msg)
2082{
2083 struct buffer *buf = get_trash_chunk();
2084
2085 chunk_initstr(buf, msg);
Willy Tarreau14bfe9a2018-12-19 15:19:27 +01002086 si_retnclose(&s->si[0], buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02002087}
2088
William Lallemand291810d2018-10-26 14:47:38 +02002089static enum obj_type *pcli_pid_to_server(int proc_pid)
2090{
2091 struct mworker_proc *child;
2092
William Lallemand99e0bb92020-11-05 10:28:53 +01002093 /* return the mCLI applet of the master */
William Lallemandbddd33a2018-12-11 16:10:53 +01002094 if (proc_pid == 0)
William Lallemand99e0bb92020-11-05 10:28:53 +01002095 return &mcli_applet.obj_type;
William Lallemandbddd33a2018-12-11 16:10:53 +01002096
William Lallemand291810d2018-10-26 14:47:38 +02002097 list_for_each_entry(child, &proc_list, list) {
2098 if (child->pid == proc_pid){
2099 return &child->srv->obj_type;
2100 }
2101 }
2102 return NULL;
2103}
2104
2105/* Take a CLI prefix in argument (eg: @!1234 @master @1)
2106 * Return:
2107 * 0: master
2108 * > 0: pid of a worker
2109 * < 0: didn't find a worker
2110 */
2111static int pcli_prefix_to_pid(const char *prefix)
2112{
2113 int proc_pid;
2114 struct mworker_proc *child;
2115 char *errtol = NULL;
2116
2117 if (*prefix != '@') /* not a prefix, should not happen */
2118 return -1;
2119
2120 prefix++;
2121 if (!*prefix) /* sent @ alone, return the master */
2122 return 0;
2123
2124 if (strcmp("master", prefix) == 0) {
2125 return 0;
2126 } else if (*prefix == '!') {
2127 prefix++;
2128 if (!*prefix)
2129 return -1;
2130
2131 proc_pid = strtol(prefix, &errtol, 10);
2132 if (*errtol != '\0')
2133 return -1;
2134 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002135 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002136 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002137 if (child->pid == proc_pid){
2138 return child->pid;
2139 }
2140 }
2141 } else {
2142 struct mworker_proc *chosen = NULL;
2143 /* this is a relative pid */
2144
2145 proc_pid = strtol(prefix, &errtol, 10);
2146 if (*errtol != '\0')
2147 return -1;
2148
2149 if (proc_pid == 0) /* return the master */
2150 return 0;
2151
2152 /* chose the right process, the current one is the one with the
2153 least number of reloads */
2154 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002155 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002156 continue;
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002157 if (child->reloads == 0)
2158 return child->pid;
2159 else if (chosen == NULL || child->reloads < chosen->reloads)
2160 chosen = child;
William Lallemand291810d2018-10-26 14:47:38 +02002161 }
2162 if (chosen)
2163 return chosen->pid;
2164 }
2165 return -1;
2166}
2167
William Lallemandbddd33a2018-12-11 16:10:53 +01002168/* Return::
2169 * >= 0 : number of words to escape
2170 * = -1 : error
2171 */
2172
2173int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2174{
2175 if (argl < 1)
2176 return 0;
2177
2178 /* there is a prefix */
2179 if (args[0][0] == '@') {
2180 int target_pid = pcli_prefix_to_pid(args[0]);
2181
2182 if (target_pid == -1) {
2183 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2184 return -1;
2185 }
2186
2187 /* if the prefix is alone, define a default target */
2188 if (argl == 1)
2189 s->pcli_next_pid = target_pid;
2190 else
2191 *next_pid = target_pid;
2192 return 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002193 } else if (strcmp("prompt", args[0]) == 0) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01002194 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002195 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01002196
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002197 } else if (strcmp("quit", args[0]) == 0) {
William Lallemand5f610682018-12-11 16:10:55 +01002198 channel_shutr_now(&s->req);
2199 channel_shutw_now(&s->res);
2200 return argl; /* return the number of elements in the array */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002201 } else if (strcmp(args[0], "operator") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002202 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2203 memprintf(errmsg, "Permission denied!\n");
2204 return -1;
2205 }
2206 s->pcli_flags &= ~ACCESS_LVL_MASK;
2207 s->pcli_flags |= ACCESS_LVL_OPER;
2208 return argl;
2209
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002210 } else if (strcmp(args[0], "user") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002211 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2212 memprintf(errmsg, "Permission denied!\n");
2213 return -1;
2214 }
2215 s->pcli_flags &= ~ACCESS_LVL_MASK;
2216 s->pcli_flags |= ACCESS_LVL_USER;
2217 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002218 }
2219
2220 return 0;
2221}
2222
2223/*
2224 * Parse the CLI request:
2225 * - It does basically the same as the cli_io_handler, but as a proxy
2226 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002227 *
2228 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002229 * - the number of characters to forward or
2230 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002231 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002232int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002233{
William Lallemandbddd33a2018-12-11 16:10:53 +01002234 char *str = (char *)ci_head(req);
2235 char *end = (char *)ci_stop(req);
Willy Tarreauf14c7572021-03-13 10:59:23 +01002236 char *args[MAX_CLI_ARGS + 1]; /* +1 for storing a NULL */
William Lallemandbddd33a2018-12-11 16:10:53 +01002237 int argl; /* number of args */
2238 char *p;
2239 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002240 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002241 int wtrim = 0; /* number of words to trim */
2242 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002243 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002244 int i = 0;
2245
2246 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002247
William Lallemanddc12c2e2018-12-13 09:05:46 +01002248 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002249
2250 /* Looks for the end of one command */
2251 while (p+reql < end) {
2252 /* handle escaping */
2253 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002254 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002255 continue;
2256 }
2257 if (p[reql] == ';' || p[reql] == '\n') {
2258 /* found the end of the command */
2259 p[reql] = '\n';
2260 reql++;
2261 break;
2262 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002263 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002264 }
William Lallemandebf61802018-12-11 16:10:57 +01002265 } else {
2266 while (p+reql < end) {
2267 if (p[reql] == '\n') {
2268 /* found the end of the line */
2269 reql++;
2270 break;
2271 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002272 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002273 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002274 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002275
William Lallemandbddd33a2018-12-11 16:10:53 +01002276 /* set end to first byte after the end of the command */
2277 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002278
William Lallemandbddd33a2018-12-11 16:10:53 +01002279 /* there is no end to this command, need more to parse ! */
2280 if (*(end-1) != '\n') {
2281 return -1;
2282 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002283
William Lallemand3301f3e2018-12-13 09:05:48 +01002284 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2285 if (reql == 1) /* last line of the payload */
2286 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002287 return reql;
2288 }
2289
William Lallemandbddd33a2018-12-11 16:10:53 +01002290 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002291
William Lallemandbddd33a2018-12-11 16:10:53 +01002292 /* splits the command in words */
Willy Tarreauf14c7572021-03-13 10:59:23 +01002293 while (i < MAX_CLI_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002294 /* skip leading spaces/tabs */
2295 p += strspn(p, " \t");
2296 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002297 break;
2298
William Lallemandbddd33a2018-12-11 16:10:53 +01002299 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002300 while (1) {
2301 p += strcspn(p, " \t\\");
2302 /* escaped chars using backlashes (\) */
2303 if (*p == '\\') {
2304 if (!*++p)
2305 break;
2306 if (!*++p)
2307 break;
2308 } else {
2309 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002310 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002311 }
William Lallemandfe249c32020-06-18 18:03:57 +02002312 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002313 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002314 }
2315
William Lallemandbddd33a2018-12-11 16:10:53 +01002316 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002317
Willy Tarreauf14c7572021-03-13 10:59:23 +01002318 for (; i < MAX_CLI_ARGS + 1; i++)
William Lallemandbddd33a2018-12-11 16:10:53 +01002319 args[i] = NULL;
2320
2321 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2322
2323 /* End of words are ending by \0, we need to replace the \0s by spaces
23241 before forwarding them */
2325 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002326 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002327 if (*p == '\0')
2328 *p = ' ';
2329 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002330 }
2331
William Lallemand3301f3e2018-12-13 09:05:48 +01002332 payload = strstr(str, PAYLOAD_PATTERN);
2333 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2334 /* if the payload pattern is at the end */
2335 s->pcli_flags |= PCLI_F_PAYLOAD;
William Lallemand3301f3e2018-12-13 09:05:48 +01002336 }
2337
William Lallemandbddd33a2018-12-11 16:10:53 +01002338 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002339
William Lallemandbddd33a2018-12-11 16:10:53 +01002340 if (wtrim > 0) {
2341 trim = &args[wtrim][0];
2342 if (trim == NULL) /* if this was the last word in the table */
2343 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002344
William Lallemandbddd33a2018-12-11 16:10:53 +01002345 b_del(&req->buf, trim - str);
2346
William Lallemandb7ea1412018-12-13 09:05:47 +01002347 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002348 } else if (wtrim < 0) {
2349 /* parsing error */
2350 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002351 } else {
2352 /* the whole string */
2353 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002354 }
2355
William Lallemandb7ea1412018-12-13 09:05:47 +01002356 if (ret > 1) {
2357 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2358 goto end;
2359 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002360 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2361 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002362 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002363 ci_insert_line2(req, 0, "user -", strlen("user -"));
2364 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002365 }
2366 }
2367end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002368
William Lallemandb7ea1412018-12-13 09:05:47 +01002369 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002370}
2371
2372int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2373{
William Lallemandbddd33a2018-12-11 16:10:53 +01002374 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002375 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002376 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002377
William Lallemandb7ea1412018-12-13 09:05:47 +01002378 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2379 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2380
William Lallemandcf62f7e2018-10-26 14:47:40 +02002381read_again:
2382 /* if the channel is closed for read, we won't receive any more data
2383 from the client, but we don't want to forward this close to the
2384 server */
2385 channel_dont_close(req);
2386
2387 /* We don't know yet to which server we will connect */
2388 channel_dont_connect(req);
2389
2390
2391 /* we are not waiting for a response, there is no more request and we
2392 * receive a close from the client, we can leave */
2393 if (!(ci_data(req)) && req->flags & CF_SHUTR) {
2394 channel_shutw_now(&s->res);
2395 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2396 return 1;
2397 }
2398
2399 req->flags |= CF_READ_DONTWAIT;
2400
2401 /* need more data */
2402 if (!ci_data(req))
2403 return 0;
2404
2405 /* If there is data available for analysis, log the end of the idle time. */
2406 if (c_data(req) && s->logs.t_idle == -1)
2407 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2408
William Lallemandbddd33a2018-12-11 16:10:53 +01002409 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002410 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002411 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002412 /* enough data */
2413
William Lallemandcf62f7e2018-10-26 14:47:40 +02002414 /* forward only 1 command */
2415 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002416
William Lallemanddc12c2e2018-12-13 09:05:46 +01002417 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002418 /* we send only 1 command per request, and we write close after it */
2419 channel_shutw_now(req);
2420 } else {
2421 pcli_write_prompt(s);
2422 }
2423
2424 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002425
2426 /* remove the XFER_DATA analysers, which forwards all
2427 * the data, we don't want to forward the next requests
2428 * We need to add CF_FLT_ANALYZE to abort the forward too.
2429 */
2430 req->analysers &= ~(AN_REQ_FLT_XFER_DATA|AN_REQ_WAIT_CLI);
2431 req->analysers |= AN_REQ_FLT_END|CF_FLT_ANALYZE;
2432 s->res.analysers |= AN_RES_WAIT_CLI;
2433
William Lallemandebf61802018-12-11 16:10:57 +01002434 if (!(s->flags & SF_ASSIGNED)) {
2435 if (next_pid > -1)
2436 target_pid = next_pid;
2437 else
2438 target_pid = s->pcli_next_pid;
2439 /* we can connect now */
2440 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002441
William Lallemandebf61802018-12-11 16:10:57 +01002442 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2443 channel_auto_connect(req);
2444 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002445
2446 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002447 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002448 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002449 goto read_again;
William Lallemandbddd33a2018-12-11 16:10:53 +01002450 } else if (to_forward == -1 && errmsg) {
2451 /* there was an error during the parsing */
2452 pcli_reply_and_close(s, errmsg);
2453 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002454 } else if (to_forward == -1 && channel_full(req, global.tune.maxrewrite)) {
2455 /* buffer is full and we didn't catch the end of a command */
2456 goto send_help;
2457 }
2458
2459 return 0;
2460
2461send_help:
2462 b_reset(&req->buf);
2463 b_putblk(&req->buf, "help\n", 5);
2464 goto read_again;
2465}
2466
2467int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2468{
2469 struct proxy *fe = strm_fe(s);
2470 struct proxy *be = s->be;
2471
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002472 if (rep->flags & CF_READ_ERROR) {
2473 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2474 s->res.analysers &= ~AN_RES_WAIT_CLI;
2475 return 0;
2476 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002477 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2478 rep->flags |= CF_NEVER_WAIT;
2479
2480 /* don't forward the close */
2481 channel_dont_close(&s->res);
2482 channel_dont_close(&s->req);
2483
William Lallemanddc12c2e2018-12-13 09:05:46 +01002484 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002485 s->req.analysers |= AN_REQ_WAIT_CLI;
2486 s->res.analysers &= ~AN_RES_WAIT_CLI;
2487 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2488 return 0;
2489 }
2490
William Lallemandcf62f7e2018-10-26 14:47:40 +02002491 /* forward the data */
2492 if (ci_data(rep)) {
2493 c_adv(rep, ci_data(rep));
2494 return 0;
2495 }
2496
2497 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2498 /* stream cleanup */
2499
William Lallemand2f4ce202018-10-26 14:47:47 +02002500 pcli_write_prompt(s);
2501
William Lallemandcf62f7e2018-10-26 14:47:40 +02002502 s->si[1].flags |= SI_FL_NOLINGER | SI_FL_NOHALF;
2503 si_shutr(&s->si[1]);
2504 si_shutw(&s->si[1]);
2505
2506 /*
2507 * starting from there this the same code as
2508 * http_end_txn_clean_session().
2509 *
2510 * It allows to do frontend keepalive while reconnecting to a
2511 * new server for each request.
2512 */
2513
2514 if (s->flags & SF_BE_ASSIGNED) {
Willy Tarreau4781b152021-04-06 13:53:36 +02002515 HA_ATOMIC_DEC(&be->beconn);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002516 if (unlikely(s->srv_conn))
2517 sess_change_server(s, NULL);
2518 }
2519
2520 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2521 stream_process_counters(s);
2522
2523 /* don't count other requests' data */
2524 s->logs.bytes_in -= ci_data(&s->req);
2525 s->logs.bytes_out -= ci_data(&s->res);
2526
2527 /* we may need to know the position in the queue */
2528 pendconn_free(s);
2529
2530 /* let's do a final log if we need it */
2531 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2532 !(s->flags & SF_MONITOR) &&
2533 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2534 s->do_log(s);
2535 }
2536
2537 /* stop tracking content-based counters */
2538 stream_stop_content_counters(s);
2539 stream_update_time_stats(s);
2540
2541 s->logs.accept_date = date; /* user-visible date for logging */
2542 s->logs.tv_accept = now; /* corrected date for internal use */
2543 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2544 s->logs.t_idle = -1;
2545 tv_zero(&s->logs.tv_request);
2546 s->logs.t_queue = -1;
2547 s->logs.t_connect = -1;
2548 s->logs.t_data = -1;
2549 s->logs.t_close = 0;
2550 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2551 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2552
2553 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2554 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2555
2556 stream_del_srv_conn(s);
2557 if (objt_server(s->target)) {
2558 if (s->flags & SF_CURR_SESS) {
2559 s->flags &= ~SF_CURR_SESS;
Willy Tarreau4781b152021-04-06 13:53:36 +02002560 HA_ATOMIC_DEC(&__objt_server(s->target)->cur_sess);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002561 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002562 if (may_dequeue_tasks(__objt_server(s->target), be))
Willy Tarreau9ab78292021-06-22 18:47:51 +02002563 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002564 }
2565
2566 s->target = NULL;
2567
2568 /* only release our endpoint if we don't intend to reuse the
2569 * connection.
2570 */
2571 if (!si_conn_ready(&s->si[1])) {
2572 si_release_endpoint(&s->si[1]);
2573 s->srv_conn = NULL;
2574 }
2575
Christopher Faulet16f16af2021-10-27 09:34:56 +02002576 sockaddr_free(&s->si[1].dst);
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002577
William Lallemandcf62f7e2018-10-26 14:47:40 +02002578 s->si[1].state = s->si[1].prev_state = SI_ST_INI;
2579 s->si[1].err_type = SI_ET_NONE;
2580 s->si[1].conn_retries = 0; /* used for logging too */
2581 s->si[1].exp = TICK_ETERNITY;
2582 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 +02002583 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 +02002584 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 +02002585 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_ADDR_SET|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
2586 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2587 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
2588 /* reinitialise the current rule list pointer to NULL. We are sure that
2589 * any rulelist match the NULL pointer.
2590 */
2591 s->current_rule_list = NULL;
2592
2593 s->be = strm_fe(s);
2594 s->logs.logwait = strm_fe(s)->to_log;
2595 s->logs.level = 0;
2596 stream_del_srv_conn(s);
2597 s->target = NULL;
2598 /* re-init store persistence */
2599 s->store_count = 0;
2600 s->uniq_id = global.req_count++;
2601
2602 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2603
2604 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2605
2606 s->req.analysers |= AN_REQ_WAIT_CLI;
2607 s->res.analysers &= ~AN_RES_WAIT_CLI;
2608
2609 /* We must trim any excess data from the response buffer, because we
2610 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002611 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002612 * we want those data to come along with next response. A typical
2613 * example of such data would be from a buggy server responding to
2614 * a HEAD with some data, or sending more than the advertised
2615 * content-length.
2616 */
2617 if (unlikely(ci_data(&s->res)))
2618 b_set_data(&s->res.buf, co_data(&s->res));
2619
2620 /* Now we can realign the response buffer */
2621 c_realign_if_empty(&s->res);
2622
2623 s->req.rto = strm_fe(s)->timeout.client;
2624 s->req.wto = TICK_ETERNITY;
2625
2626 s->res.rto = TICK_ETERNITY;
2627 s->res.wto = strm_fe(s)->timeout.client;
2628
2629 s->req.rex = TICK_ETERNITY;
2630 s->req.wex = TICK_ETERNITY;
2631 s->req.analyse_exp = TICK_ETERNITY;
2632 s->res.rex = TICK_ETERNITY;
2633 s->res.wex = TICK_ETERNITY;
2634 s->res.analyse_exp = TICK_ETERNITY;
2635 s->si[1].hcto = TICK_ETERNITY;
2636
2637 /* we're removing the analysers, we MUST re-enable events detection.
2638 * We don't enable close on the response channel since it's either
2639 * already closed, or in keep-alive with an idle connection handler.
2640 */
2641 channel_auto_read(&s->req);
2642 channel_auto_close(&s->req);
2643 channel_auto_read(&s->res);
2644
2645
2646 return 1;
2647 }
2648 return 0;
2649}
2650
William Lallemand8a022572018-10-26 14:47:35 +02002651/*
2652 * The mworker functions are used to initialize the CLI in the master process
2653 */
2654
William Lallemand309dc9a2018-10-26 14:47:45 +02002655 /*
2656 * Stop the mworker proxy
2657 */
2658void mworker_cli_proxy_stop()
2659{
William Lallemand550db6d2018-11-06 17:37:12 +01002660 if (mworker_proxy)
2661 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002662}
2663
William Lallemand8a022572018-10-26 14:47:35 +02002664/*
2665 * Create the mworker CLI proxy
2666 */
2667int mworker_cli_proxy_create()
2668{
2669 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002670 char *msg = NULL;
2671 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002672
William Lallemandae787ba2021-07-29 15:13:22 +02002673 mworker_proxy = alloc_new_proxy("MASTER", PR_CAP_LISTEN|PR_CAP_INT, &errmsg);
William Lallemand8a022572018-10-26 14:47:35 +02002674 if (!mworker_proxy)
William Lallemandae787ba2021-07-29 15:13:22 +02002675 goto error_proxy;
William Lallemand8a022572018-10-26 14:47:35 +02002676
William Lallemandcf62f7e2018-10-26 14:47:40 +02002677 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002678 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2679 mworker_proxy->timeout.client = 0; /* no timeout */
2680 mworker_proxy->conf.file = strdup("MASTER");
2681 mworker_proxy->conf.line = 0;
2682 mworker_proxy->accept = frontend_accept;
2683 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2684
2685 /* Does not init the default target the CLI applet, but must be done in
2686 * the request parsing code */
2687 mworker_proxy->default_target = NULL;
2688
William Lallemand8a022572018-10-26 14:47:35 +02002689 /* create all servers using the mworker_proc list */
2690 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002691 struct server *newsrv = NULL;
2692 struct sockaddr_storage *sk;
2693 int port1, port2, port;
2694 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002695
William Lallemanda31b09e2020-01-14 15:25:02 +01002696 /* only the workers support the master CLI */
2697 if (!(child->options & PROC_O_TYPE_WORKER))
2698 continue;
2699
William Lallemand8a022572018-10-26 14:47:35 +02002700 newsrv = new_server(mworker_proxy);
2701 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002702 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002703
2704 /* we don't know the new pid yet */
2705 if (child->pid == -1)
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002706 memprintf(&msg, "cur-%d", 1);
William Lallemand8a022572018-10-26 14:47:35 +02002707 else
2708 memprintf(&msg, "old-%d", child->pid);
2709
2710 newsrv->next = mworker_proxy->srv;
2711 mworker_proxy->srv = newsrv;
2712 newsrv->conf.file = strdup(msg);
2713 newsrv->id = strdup(msg);
2714 newsrv->conf.line = 0;
2715
2716 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02002717 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02002718 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002719 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002720 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002721 ha_free(&msg);
William Lallemand8a022572018-10-26 14:47:35 +02002722
Willy Tarreau5fc93282020-09-16 18:25:03 +02002723 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002724 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002725 }
2726
2727 /* no port specified */
2728 newsrv->flags |= SRV_F_MAPPORTS;
2729 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002730 /* don't let the server participate to load balancing */
2731 newsrv->iweight = 0;
2732 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002733 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002734
2735 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002736 }
William Lallemandae787ba2021-07-29 15:13:22 +02002737
2738 mworker_proxy->next = proxies_list;
2739 proxies_list = mworker_proxy;
2740
William Lallemand8a022572018-10-26 14:47:35 +02002741 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002742
2743error:
William Lallemand744a0892018-11-22 16:46:51 +01002744
2745 list_for_each_entry(child, &proc_list, list) {
2746 free((char *)child->srv->conf.file); /* cast because of const char * */
2747 free(child->srv->id);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002748 ha_free(&child->srv);
William Lallemand744a0892018-11-22 16:46:51 +01002749 }
William Lallemandae787ba2021-07-29 15:13:22 +02002750 free_proxy(mworker_proxy);
William Lallemand744a0892018-11-22 16:46:51 +01002751 free(msg);
2752
William Lallemandae787ba2021-07-29 15:13:22 +02002753error_proxy:
2754 ha_alert("%s\n", errmsg);
2755 free(errmsg);
2756
William Lallemand744a0892018-11-22 16:46:51 +01002757 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002758}
Olivier Houchardf886e342017-04-05 22:24:59 +02002759
William Lallemandce83b4a2018-10-26 14:47:30 +02002760/*
William Lallemande7361152018-10-26 14:47:36 +02002761 * Create a new listener for the master CLI proxy
2762 */
2763int mworker_cli_proxy_new_listener(char *line)
2764{
2765 struct bind_conf *bind_conf;
2766 struct listener *l;
2767 char *err = NULL;
2768 char *args[MAX_LINE_ARGS + 1];
2769 int arg;
2770 int cur_arg;
2771
William Lallemand2e945c82019-11-25 09:58:37 +01002772 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002773 args[0] = line;
2774
2775 /* args is a bind configuration with spaces replaced by commas */
2776 while (*line && arg < MAX_LINE_ARGS) {
2777
2778 if (*line == ',') {
2779 *line++ = '\0';
2780 while (*line == ',')
2781 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01002782 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02002783 }
2784 line++;
2785 }
2786
William Lallemand2e945c82019-11-25 09:58:37 +01002787 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02002788
2789 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002790 if (!bind_conf)
2791 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002792
2793 bind_conf->level &= ~ACCESS_LVL_MASK;
2794 bind_conf->level |= ACCESS_LVL_ADMIN;
Willy Tarreaue283ee62021-03-12 15:00:57 +01002795 bind_conf->level |= ACCESS_MASTER | ACCESS_MASTER_ONLY;
William Lallemande7361152018-10-26 14:47:36 +02002796
2797 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
2798 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01002799 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002800 }
2801
2802 cur_arg = 1;
2803
2804 while (*args[cur_arg]) {
William Lallemande7361152018-10-26 14:47:36 +02002805 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +01002806 const char *best;
William Lallemande7361152018-10-26 14:47:36 +02002807
2808 kw = bind_find_kw(args[cur_arg]);
2809 if (kw) {
2810 if (!kw->parse) {
2811 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
2812 args[0], args[1], args[cur_arg]);
2813 goto err;
2814 }
2815
Willy Tarreau4975d142021-03-13 11:00:33 +01002816 if (kw->parse(args, cur_arg, global.cli_fe, bind_conf, &err) != 0) {
William Lallemande7361152018-10-26 14:47:36 +02002817 if (err)
2818 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
2819 else
2820 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
2821 args[0], args[1], args[cur_arg]);
2822 goto err;
2823 }
2824
2825 cur_arg += 1 + kw->skip;
2826 continue;
2827 }
2828
Willy Tarreau433b05f2021-03-12 10:14:07 +01002829 best = bind_find_best_kw(args[cur_arg]);
2830 if (best)
2831 memprintf(&err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
2832 args[0], args[1], args[cur_arg], best);
2833 else
2834 memprintf(&err, "'%s %s' : unknown keyword '%s'.",
2835 args[0], args[1], args[cur_arg]);
William Lallemande7361152018-10-26 14:47:36 +02002836 goto err;
2837 }
2838
2839
2840 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02002841 l->accept = session_accept_fd;
2842 l->default_target = mworker_proxy->default_target;
2843 /* don't make the peers subject to global limits and don't close it in the master */
Willy Tarreau18c20d22020-10-09 16:11:46 +02002844 l->options |= LI_O_UNLIMITED;
2845 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
William Lallemande7361152018-10-26 14:47:36 +02002846 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002847 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02002848 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01002849 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02002850
2851 return 0;
2852
2853err:
2854 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01002855 free(err);
2856 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02002857 return -1;
2858
2859}
2860
2861/*
William Lallemandce83b4a2018-10-26 14:47:30 +02002862 * Create a new CLI socket using a socketpair for a worker process
2863 * <mworker_proc> is the process structure, and <proc> is the process number
2864 */
2865int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
2866{
2867 struct bind_conf *bind_conf;
2868 struct listener *l;
2869 char *path = NULL;
2870 char *err = NULL;
2871
2872 /* master pipe to ensure the master is still alive */
2873 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
2874 ha_alert("Cannot create worker socketpair.\n");
2875 return -1;
2876 }
2877
2878 /* XXX: we might want to use a separate frontend at some point */
Willy Tarreau4975d142021-03-13 11:00:33 +01002879 if (!global.cli_fe) {
2880 if ((global.cli_fe = cli_alloc_fe("GLOBAL", "master-socket", 0)) == NULL) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002881 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01002882 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002883 }
2884 }
2885
Willy Tarreau4975d142021-03-13 11:00:33 +01002886 bind_conf = bind_conf_alloc(global.cli_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002887 if (!bind_conf)
2888 goto error;
2889
William Lallemandce83b4a2018-10-26 14:47:30 +02002890 bind_conf->level &= ~ACCESS_LVL_MASK;
2891 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
2892
William Lallemandce83b4a2018-10-26 14:47:30 +02002893 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
2894 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01002895 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002896 }
2897
Willy Tarreau4975d142021-03-13 11:00:33 +01002898 if (!str2listener(path, global.cli_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002899 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002900 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01002901 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002902 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002903 ha_free(&path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002904
2905 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002906 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +01002907 l->default_target = global.cli_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01002908 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
Willy Tarreau4781b152021-04-06 13:53:36 +02002909 HA_ATOMIC_INC(&unstoppable_jobs);
William Lallemandce83b4a2018-10-26 14:47:30 +02002910 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02002911 l->rx.flags &= ~RX_F_INHERITED;
William Lallemandce83b4a2018-10-26 14:47:30 +02002912 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002913 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02002914 }
2915
2916 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002917
2918error:
2919 close(mworker_proc->ipc_fd[0]);
2920 close(mworker_proc->ipc_fd[1]);
2921 free(err);
2922
2923 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02002924}
2925
William Lallemand74c24fb2016-11-21 17:18:36 +01002926static struct applet cli_applet = {
2927 .obj_type = OBJ_TYPE_APPLET,
2928 .name = "<CLI>", /* used for logging */
2929 .fct = cli_io_handler,
2930 .release = cli_release_handler,
2931};
2932
William Lallemand99e0bb92020-11-05 10:28:53 +01002933/* master CLI */
2934static struct applet mcli_applet = {
2935 .obj_type = OBJ_TYPE_APPLET,
2936 .name = "<MCLI>", /* used for logging */
2937 .fct = cli_io_handler,
2938 .release = cli_release_handler,
2939};
2940
Willy Tarreau0a739292016-11-22 20:21:23 +01002941/* register cli keywords */
2942static struct cli_kw_list cli_kws = {{ },{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02002943 { { "help", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
2944 { { "prompt", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
2945 { { "quit", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
2946 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
2947 { { "expert-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL }, // not listed
2948 { { "experimental-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL }, // not listed
2949 { { "set", "maxconn", "global", NULL }, "set maxconn global <value> : change the per-process maxconn setting", cli_parse_set_maxconn_global, NULL },
2950 { { "set", "rate-limit", NULL }, "set rate-limit <setting> <value> : change a rate limiting value", cli_parse_set_ratelimit, NULL },
2951 { { "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 },
2952 { { "set", "timeout", NULL }, "set timeout [cli] <delay> : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
2953 { { "show", "env", NULL }, "show env [var] : dump environment variables known to the process", cli_parse_show_env, cli_io_handler_show_env, NULL },
2954 { { "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 },
2955 { { "show", "cli", "level", NULL }, "show cli level : display the level of the current CLI session", cli_parse_show_lvl, NULL, NULL, NULL, ACCESS_MASTER},
2956 { { "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 },
2957 { { "show", "activity", NULL }, "show activity : show per-thread activity stats (for support/developers)", cli_parse_default, cli_io_handler_show_activity, NULL },
2958 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
2959 { { "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 +01002960 {{},}
2961}};
2962
Willy Tarreau0108d902018-11-25 19:14:37 +01002963INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
2964
William Lallemand74c24fb2016-11-21 17:18:36 +01002965static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau4975d142021-03-13 11:00:33 +01002966 { CFG_GLOBAL, "stats", cli_parse_global },
William Lallemand74c24fb2016-11-21 17:18:36 +01002967 { 0, NULL, NULL },
2968}};
2969
Willy Tarreau0108d902018-11-25 19:14:37 +01002970INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
2971
William Lallemand74c24fb2016-11-21 17:18:36 +01002972static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02002973 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
2974 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002975 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01002976 { NULL, NULL, 0 },
2977}};
2978
Willy Tarreau0108d902018-11-25 19:14:37 +01002979INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01002980
2981/*
2982 * Local variables:
2983 * c-indent-level: 8
2984 * c-basic-offset: 8
2985 * End:
2986 */