1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
/*-
* Copyright (c) 2006 Verdens Gang AS
* Copyright (c) 2006-2011 Varnish Software AS
* All rights reserved.
*
* Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
*
* SPDX-License-Identifier: BSD-2-Clause
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* Caching process CLI handling.
*
* We only have one CLI source, the stdin/stdout pipes from the manager
* process, but we complicate things by having undocumented commands that
* we do not want to show in a plain help, and by having commands that the
* manager has already shown in help before asking us.
*/
#include "config.h"
#include "cache_varnishd.h"
#include "common/heritage.h"
#include "vcli_serve.h"
pthread_t cli_thread;
static struct lock cli_mtx;
static int add_check;
static struct VCLS *cache_cls;
/*
* The CLI commandlist is split in three:
* - Commands we get from/share with the manager, we don't show these
* in help, as the manager already did that.
* - Cache process commands, show in help
* - Undocumented debug commands, show in undocumented "help -d"
*/
/*--------------------------------------------------------------------
* Add CLI functions to the appropriate command set
*/
void
CLI_AddFuncs(struct cli_proto *p)
{
AZ(add_check);
Lck_Lock(&cli_mtx);
VCLS_AddFunc(cache_cls, 0, p);
Lck_Unlock(&cli_mtx);
}
static void
cli_cb_before(const struct cli *cli)
{
ASSERT_CLI();
VSL(SLT_CLI, NO_VXID, "Rd %s", VSB_data(cli->cmd));
Lck_Lock(&cli_mtx);
VCL_Poll();
VCP_RelPoll();
}
static void
cli_cb_after(const struct cli *cli)
{
ASSERT_CLI();
Lck_Unlock(&cli_mtx);
VSL(SLT_CLI, NO_VXID, "Wr %03u %zd %s",
cli->result, VSB_len(cli->sb), VSB_data(cli->sb));
}
void
CLI_Run(void)
{
int i;
struct cli *cli;
add_check = 1;
/* Tell waiting MGT that we are ready to speak CLI */
AZ(VCLI_WriteResult(heritage.cli_fd, CLIS_OK, "Ready"));
cli = VCLS_AddFd(cache_cls,
heritage.cli_fd, heritage.cli_fd, NULL, NULL);
AN(cli);
cli->auth = 255; // Non-zero to disable paranoia in vcli_serve
do {
i = VCLS_Poll(cache_cls, cli, -1);
} while (i == 0);
VSL(SLT_CLI, NO_VXID, "EOF on CLI connection, worker stops");
}
/*--------------------------------------------------------------------*/
static struct cli_proto cli_cmds[] = {
{ CLICMD_PING, "i", VCLS_func_ping, VCLS_func_ping_json },
{ CLICMD_HELP, "i", VCLS_func_help, VCLS_func_help_json },
{ NULL }
};
/*--------------------------------------------------------------------
* Initialize the CLI subsystem
*/
void
CLI_Init(void)
{
Lck_New(&cli_mtx, lck_cli);
cli_thread = pthread_self();
cache_cls = VCLS_New(heritage.cls);
AN(cache_cls);
VCLS_SetLimit(cache_cls, &cache_param->cli_limit);
VCLS_SetHooks(cache_cls, cli_cb_before, cli_cb_after);
CLI_AddFuncs(cli_cmds);
}
|
