varnish-cache/bin/varnishstat/varnishstat.c
0
/*-
1
 * Copyright (c) 2006 Verdens Gang AS
2
 * Copyright (c) 2006-2015 Varnish Software AS
3
 * All rights reserved.
4
 *
5
 * Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
6
 * Author: Dag-Erling Smørgrav <des@des.no>
7
 *
8
 * SPDX-License-Identifier: BSD-2-Clause
9
 *
10
 * Redistribution and use in source and binary forms, with or without
11
 * modification, are permitted provided that the following conditions
12
 * are met:
13
 * 1. Redistributions of source code must retain the above copyright
14
 *    notice, this list of conditions and the following disclaimer.
15
 * 2. Redistributions in binary form must reproduce the above copyright
16
 *    notice, this list of conditions and the following disclaimer in the
17
 *    documentation and/or other materials provided with the distribution.
18
 *
19
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22
 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
23
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29
 * SUCH DAMAGE.
30
 *
31
 * Statistics output program
32
 */
33
34
#include "config.h"
35
36
#include <stdarg.h>
37
#include <stdio.h>
38
#include <stdlib.h>
39
#include <signal.h>
40
#include <string.h>
41
#include <time.h>
42
#include <unistd.h>
43
#include <math.h>
44
45
#define VOPT_DEFINITION
46
#define VOPT_INC "varnishstat_options.h"
47
48
#include "vapi/voptget.h"
49
#include "vapi/vsl.h"
50
#include "vdef.h"
51
#include "vut.h"
52
53
#include "varnishstat.h"
54
55
static struct VUT *vut;
56
int has_f = 0;
57
58
/*--------------------------------------------------------------------*/
59
60
static int v_matchproto_(VSC_iter_f)
61 760
do_xml_cb(void *priv, const struct VSC_point * const pt)
62
{
63
        uint64_t val;
64
65 760
        (void)priv;
66 760
        if (pt == NULL)
67 0
                return (0);
68 760
        AZ(strcmp(pt->ctype, "uint64_t"));
69 760
        val = VSC_Value(pt);
70
71 760
        printf("\t<stat>\n");
72 760
        printf("\t\t<name>%s</name>\n", pt->name);
73 760
        printf("\t\t<value>%ju</value>\n", (uintmax_t)val);
74 760
        printf("\t\t<flag>%c</flag>\n", pt->semantics);
75 760
        printf("\t\t<format>%c</format>\n", pt->format);
76 760
        printf("\t\t<description>%s</description>\n", pt->sdesc);
77 760
        printf("\t</stat>\n");
78 760
        return (0);
79 760
}
80
81
static void
82 2
do_xml(struct vsm *vsm, struct vsc *vsc)
83
{
84
        char time_stamp[20];
85
        time_t now;
86
87 2
        printf("<?xml version=\"1.0\"?>\n");
88 2
        now = time(NULL);
89 2
        (void)strftime(time_stamp, 20, "%Y-%m-%dT%H:%M:%S", localtime(&now));
90 2
        printf("<varnishstat timestamp=\"%s\">\n", time_stamp);
91 2
        (void)VSC_Iter(vsc, vsm, do_xml_cb, NULL);
92 2
        printf("</varnishstat>\n");
93 2
}
94
95
96
/*--------------------------------------------------------------------*/
97
98
static int v_matchproto_(VSC_iter_f)
99 3040
do_json_cb(void *priv, const struct VSC_point * const pt)
100
{
101
        const char **sep;
102
        uintmax_t val;
103
104 3040
        if (pt == NULL)
105 0
                return (0);
106
107 3040
        AZ(strcmp(pt->ctype, "uint64_t"));
108 3040
        val = (uintmax_t)VSC_Value(pt);
109
110 3040
        sep = priv;
111
112 3040
        printf(
113
            "%s"
114
            "    \"%s\": {\n"
115
            "      \"description\": \"%s\",\n"
116
            "      \"flag\": \"%c\",\n"
117
            "      \"format\": \"%c\",\n"
118
            "      \"value\": %ju\n"
119
            "    }",
120 3040
            *sep, pt->name, pt->sdesc, pt->semantics, pt->format, val);
121
122 3040
        *sep = ",\n";
123 3040
        return (0);
124 3040
}
125
126
static void
127 8
do_json(struct vsm *vsm, struct vsc *vsc)
128
{
129
        const char *sep;
130
        char time_stamp[20];
131
        time_t now;
132
133 8
        sep = "";
134 8
        now = time(NULL);
135
136 8
        (void)strftime(time_stamp, 20, "%Y-%m-%dT%H:%M:%S", localtime(&now));
137 8
        printf(
138
            "{\n"
139
            "  \"version\": 1,\n"
140
            "  \"timestamp\": \"%s\",\n"
141 8
            "  \"counters\": {\n", time_stamp);
142 8
        (void)VSC_Iter(vsc, vsm, do_json_cb, &sep);
143 8
        printf(
144
            "\n"
145
            "  }\n"
146
            "}\n");
147 8
}
148
149
150
/*--------------------------------------------------------------------*/
151
152
struct once_priv {
153
        double  up;
154
        int pad;
155
};
156
157
static int v_matchproto_(VSC_iter_f)
158 20
do_once_cb_first(void *priv, const struct VSC_point * const pt)
159
{
160
        struct once_priv *op;
161
        uint64_t val;
162
163 20
        if (pt == NULL)
164 0
                return (0);
165 20
        op = priv;
166 20
        AZ(strcmp(pt->ctype, "uint64_t"));
167 20
        if (strcmp(pt->name, "MAIN.uptime"))
168 0
                return (0);
169 20
        val = VSC_Value(pt);
170 20
        op->up = (double)val;
171 20
        return (1);
172 20
}
173
174
static int v_matchproto_(VSC_iter_f)
175 7510
do_once_cb(void *priv, const struct VSC_point * const pt)
176
{
177
        struct once_priv *op;
178
        uint64_t val;
179
        int i;
180
181 7510
        if (pt == NULL)
182 0
                return (0);
183 7510
        op = priv;
184 7510
        AZ(strcmp(pt->ctype, "uint64_t"));
185 7510
        val = VSC_Value(pt);
186 7510
        i = 0;
187 7510
        i += printf("%s", pt->name);
188 7510
        if (i >= op->pad)
189 48
                op->pad = i + 1;
190 7510
        printf("%*.*s", op->pad - i, op->pad - i, "");
191 7510
        if (pt->semantics == 'c')
192 6658
                printf("%12ju %12.2f %s\n",
193 6658
                    (uintmax_t)val, op->up ? val / op->up : 0,
194 6658
                    pt->sdesc);
195
        else
196 852
                printf("%12ju %12s %s\n",
197 852
                    (uintmax_t)val, ".  ", pt->sdesc);
198 7510
        return (0);
199 7510
}
200
201
static void
202 20
do_once(struct vsm *vsm, struct vsc *vsc)
203
{
204 20
        struct vsc *vsconce = VSC_New();
205
        struct once_priv op;
206
207 20
        AN(vsconce);
208 20
        AN(VSC_Arg(vsconce, 'f', "MAIN.uptime"));
209
210 20
        memset(&op, 0, sizeof op);
211 20
        op.pad = 18;
212
213 20
        (void)VSC_Iter(vsconce, vsm, do_once_cb_first, &op);
214 20
        VSC_Destroy(&vsconce, vsm);
215 20
        (void)VSC_Iter(vsc, vsm, do_once_cb, &op);
216 20
}
217
218
/*--------------------------------------------------------------------*/
219
220
static int v_matchproto_(VSC_iter_f)
221 760
do_list_cb(void *priv, const struct VSC_point * const pt)
222
{
223
        int i;
224
225 760
        (void)priv;
226
227 760
        if (pt == NULL)
228 0
                return (0);
229
230 760
        i = 0;
231 760
        i += printf("%s", pt->name);
232 760
        if (i < 30)
233 754
                printf("%*s", i - 30, "");
234 760
        printf(" %s\n", pt->sdesc);
235 760
        return (0);
236 760
}
237
238
static void
239 2
list_fields(struct vsm *vsm, struct vsc *vsc)
240
{
241 2
        printf("Varnishstat -f option fields:\n");
242 2
        printf("Field name                     Description\n");
243 2
        printf("----------                     -----------\n");
244
245 2
        (void)VSC_Iter(vsc, vsm, do_list_cb, NULL);
246 2
}
247
248
/*--------------------------------------------------------------------*/
249
250
static void v_noreturn_
251 4
usage(int status)
252
{
253
        const char **opt;
254
255 4
        fprintf(stderr, "Usage: %s <options>\n\n", vut->progname);
256 4
        fprintf(stderr, "Options:\n");
257 56
        for (opt = vopt_spec.vopt_usage; *opt != NULL; opt +=2)
258 52
                fprintf(stderr, " %-25s %s\n", *opt, *(opt + 1));
259 4
        exit(status);
260
}
261
262
static int
263 2
key_bindings(void)
264
{
265
266
#define BINDING_KEY(chr, name, next)    \
267
        printf("<%s>" next, name);
268
#define BINDING(name, desc)             \
269
        printf("\n%s\n\n", desc);
270
#include "varnishstat_bindings.h"
271
        return (0);
272
}
273
274
int
275 62
main(int argc, char * const *argv)
276
{
277
        struct vsm *vd;
278 62
        int once = 0, xml = 0, json = 0, f_list = 0, curses = 0;
279
        signed char opt;
280
        int i;
281
        struct vsc *vsc;
282
283 62
        if (argc == 2 && !strcmp(argv[1], "--bindings"))
284 2
                exit(key_bindings());
285
286 60
        vut = VUT_InitProg(argc, argv, &vopt_spec);
287 60
        AN(vut);
288 60
        vd = VSM_New();
289 60
        AN(vd);
290 60
        vsc = VSC_New();
291 60
        AN(vsc);
292
293 180
        while ((opt = getopt(argc, argv, vopt_spec.vopt_optstring)) != -1) {
294 128
                switch (opt) {
295
                case '1':
296 20
                        once = 1;
297 20
                        break;
298
                case 'c':
299 0
                        curses = 1;
300 0
                        break;
301
                case 'h':
302
                        /* Usage help */
303 2
                        usage(0);
304
                        break;
305
                case 'l':
306 2
                        f_list = 1;
307 2
                        break;
308
                case 'x':
309 2
                        xml = 1;
310 2
                        break;
311
                case 'j':
312 8
                        json = 1;
313 8
                        break;
314
                case 'I':
315
                case 'X':
316
                case 'f':
317 38
                        AN(VSC_Arg(vsc, opt, optarg));
318 38
                        has_f = 1;
319 38
                        break;
320
                case 'r':
321 0
                        AN(VSC_Arg(vsc, opt, optarg));
322 0
                        break;
323
                case 'V':
324 0
                        AN(VUT_Arg(vut, opt, optarg));
325 0
                        break;
326
                default:
327 56
                        i = VSM_Arg(vd, opt, optarg);
328 56
                        if (i < 0)
329 6
                                VUT_Error(vut, 1, "%s", VSM_Error(vd));
330 50
                        if (!i)
331 0
                                usage(1);
332 50
                }
333
        }
334
335 52
        if (optind != argc)
336 2
                usage(1);
337
338 50
        if (!(curses || xml || json || once || f_list)) {
339 18
                curses = isatty(STDOUT_FILENO);
340 18
                once = !curses;
341 18
        }
342
343 50
        if (VSM_Attach(vd, STDERR_FILENO))
344 4
                VUT_Error(vut, 1, "%s", VSM_Error(vd));
345
346 46
        if (curses) {
347 14
                if (has_f) {
348 4
                        AN(VSC_Arg(vsc, 'R', "MGT.uptime"));
349 4
                        AN(VSC_Arg(vsc, 'R', "MAIN.uptime"));
350 4
                        AN(VSC_Arg(vsc, 'R', "MAIN.cache_hit"));
351 4
                        AN(VSC_Arg(vsc, 'R', "MAIN.cache_miss"));
352 4
                }
353 14
                do_curses(vd, vsc);
354 14
        }
355 32
        else if (xml)
356 2
                do_xml(vd, vsc);
357 30
        else if (json)
358 8
                do_json(vd, vsc);
359 22
        else if (once)
360 20
                do_once(vd, vsc);
361 2
        else if (f_list)
362 2
                list_fields(vd, vsc);
363
        else
364 0
                WRONG("undefined varnishstat mode");
365
366 46
        exit(0);
367
}