blob: 13490afb2c2e92d551fd67c444965ed6252d852c [file] [log] [blame]
William Lallemand9ed62032016-11-21 17:49:11 +01001/*
2 * include/proto/cli.h
3 * This file contains definitions of some primitives to dedicated to
4 * statistics output.
5 *
6 * Copyright (C) 2000-2011 Willy Tarreau - w@1wt.eu
7 *
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation, version 2.1
11 * exclusively.
12 *
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 */
22
23#ifndef _PROTO_CLI_H
24#define _PROTO_CLI_H
25
Willy Tarreauf268ee82020-06-04 17:05:57 +020026#include <haproxy/global.h>
Willy Tarreau17306b92018-11-22 11:45:04 +010027#include <types/applet.h>
28#include <types/channel.h>
29#include <types/cli.h>
Willy Tarreau17306b92018-11-22 11:45:04 +010030#include <types/stream.h>
31
William Lallemand9ed62032016-11-21 17:49:11 +010032
William Lallemand9ed62032016-11-21 17:49:11 +010033void cli_register_kw(struct cli_kw_list *kw_list);
34
Willy Tarreaude57a572016-11-23 17:01:39 +010035int cli_has_level(struct appctx *appctx, int level);
36
William Lallemand7175e682019-04-01 11:30:00 +020037int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private);
38
William Lallemand309dc9a2018-10-26 14:47:45 +020039/* mworker proxy functions */
40
William Lallemand8a022572018-10-26 14:47:35 +020041int mworker_cli_proxy_create();
William Lallemande7361152018-10-26 14:47:36 +020042int mworker_cli_proxy_new_listener(char *line);
William Lallemandce83b4a2018-10-26 14:47:30 +020043int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc);
William Lallemand309dc9a2018-10-26 14:47:45 +020044void mworker_cli_proxy_stop();
William Lallemandce83b4a2018-10-26 14:47:30 +020045
William Lallemandcf62f7e2018-10-26 14:47:40 +020046/* proxy mode cli functions */
47
48/* analyzers */
49int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit);
50int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit);
51
Willy Tarreauedb91ad2019-08-08 19:09:21 +020052/* updates the CLI's context to log <msg> at <severity> and returns 1. This is
53 * for use in CLI parsers to deal with quick response messages.
54 */
55static inline int cli_msg(struct appctx *appctx, int severity, const char *msg)
56{
57 appctx->ctx.cli.severity = severity;
58 appctx->ctx.cli.msg = msg;
59 appctx->st0 = CLI_ST_PRINT;
60 return 1;
61}
62
63/* updates the CLI's context to log error message <err> and returns 1. The
64 * message will be logged at level LOG_ERR. This is for use in CLI parsers to
65 * deal with quick response messages.
66 */
67static inline int cli_err(struct appctx *appctx, const char *err)
68{
69 appctx->ctx.cli.msg = err;
70 appctx->st0 = CLI_ST_PRINT_ERR;
71 return 1;
72}
73
74/* updates the CLI's context to log <msg> at <severity> and returns 1. The
75 * message must have been dynamically allocated and will be freed. This is
76 * for use in CLI parsers to deal with quick response messages.
77 */
78static inline int cli_dynmsg(struct appctx *appctx, int severity, char *msg)
79{
80 appctx->ctx.cli.severity = severity;
81 appctx->ctx.cli.err = msg;
82 appctx->st0 = CLI_ST_PRINT_DYN;
83 return 1;
84}
85
86/* updates the CLI's context to log error message <err> and returns 1. The
87 * message must have been dynamically allocated and will be freed. The message
88 * will be logged at level LOG_ERR. This is for use in CLI parsers to deal with
89 * quick response messages.
90 */
91static inline int cli_dynerr(struct appctx *appctx, char *err)
92{
93 appctx->ctx.cli.err = err;
94 appctx->st0 = CLI_ST_PRINT_FREE;
95 return 1;
96}
97
William Lallemandcf62f7e2018-10-26 14:47:40 +020098
William Lallemand9ed62032016-11-21 17:49:11 +010099#endif /* _PROTO_CLI_H */
100