mirror of
https://git.haproxy.org/git/haproxy.git/
synced 2025-08-18 13:06:58 +02:00
1c0715b12a
Now that the CLI's print context is alone in the appctx, it's possible to refine the appctx's ctx layout so that the cli part matches exactly a regular svcctx, and as such move the CLI context into an svcctx like other applets. External code will still build and work because the struct cli perfectly maps onto the struct cli_print_ctx that's located into svc.storage. This is of course only to make a smooth transition during 2.6 and will disappear immediately after. A tiny change had to be applied to the opentracing addon which performs direct accesses to the CLI's err pointer in its own print function. The rest uses the standard cli_print_* which were the only ones that needed a small change. The whole "ctx.cli" struct could be tagged as deprecated so that any possibly existing external code that relies on it will get build warnings, and the comments in the struct are pretty clear about the way to fix it, and the lack of future of this old API.
111 lines
3.5 KiB
C
111 lines
3.5 KiB
C
/*
|
|
* include/haproxy/cli.h
|
|
* This file contains definitions of some primitives to dedicated to
|
|
* statistics output.
|
|
*
|
|
* Copyright (C) 2000-2011 Willy Tarreau - w@1wt.eu
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation, version 2.1
|
|
* exclusively.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*/
|
|
|
|
#ifndef _HAPROXY_CLI_H
|
|
#define _HAPROXY_CLI_H
|
|
|
|
#include <haproxy/applet.h>
|
|
#include <haproxy/channel-t.h>
|
|
#include <haproxy/cli-t.h>
|
|
#include <haproxy/global.h>
|
|
#include <haproxy/mworker-t.h>
|
|
#include <haproxy/stream-t.h>
|
|
|
|
|
|
void cli_register_kw(struct cli_kw_list *kw_list);
|
|
struct cli_kw* cli_find_kw_exact(char **args);
|
|
void cli_list_keywords(void);
|
|
|
|
int cli_has_level(struct appctx *appctx, int level);
|
|
|
|
int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private);
|
|
|
|
/* mworker proxy functions */
|
|
|
|
int mworker_cli_proxy_create(void);
|
|
int mworker_cli_proxy_new_listener(char *line);
|
|
int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc);
|
|
void mworker_cli_proxy_stop(void);
|
|
|
|
/* proxy mode cli functions */
|
|
|
|
/* analyzers */
|
|
int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit);
|
|
int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit);
|
|
|
|
/* updates the CLI's context to log <msg> at <severity> and returns 1. This is
|
|
* for use in CLI parsers to deal with quick response messages.
|
|
*/
|
|
static inline int cli_msg(struct appctx *appctx, int severity, const char *msg)
|
|
{
|
|
struct cli_print_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
|
|
|
|
ctx->severity = severity;
|
|
ctx->msg = msg;
|
|
appctx->st0 = CLI_ST_PRINT;
|
|
return 1;
|
|
}
|
|
|
|
/* updates the CLI's context to log error message <err> and returns 1. The
|
|
* message will be logged at level LOG_ERR. This is for use in CLI parsers to
|
|
* deal with quick response messages.
|
|
*/
|
|
static inline int cli_err(struct appctx *appctx, const char *err)
|
|
{
|
|
struct cli_print_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
|
|
|
|
ctx->msg = err;
|
|
appctx->st0 = CLI_ST_PRINT_ERR;
|
|
return 1;
|
|
}
|
|
|
|
/* updates the CLI's context to log <msg> at <severity> and returns 1. The
|
|
* message must have been dynamically allocated and will be freed. This is
|
|
* for use in CLI parsers to deal with quick response messages.
|
|
*/
|
|
static inline int cli_dynmsg(struct appctx *appctx, int severity, char *msg)
|
|
{
|
|
struct cli_print_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
|
|
|
|
ctx->severity = severity;
|
|
ctx->err = msg;
|
|
appctx->st0 = CLI_ST_PRINT_DYN;
|
|
return 1;
|
|
}
|
|
|
|
/* updates the CLI's context to log error message <err> and returns 1. The
|
|
* message must have been dynamically allocated and will be freed. The message
|
|
* will be logged at level LOG_ERR. This is for use in CLI parsers to deal with
|
|
* quick response messages.
|
|
*/
|
|
static inline int cli_dynerr(struct appctx *appctx, char *err)
|
|
{
|
|
struct cli_print_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
|
|
|
|
ctx->err = err;
|
|
appctx->st0 = CLI_ST_PRINT_FREE;
|
|
return 1;
|
|
}
|
|
|
|
|
|
#endif /* _HAPROXY_CLI_H */
|