GCOV - Varnish Cache


/*-
 * Copyright (c) 2006 Verdens Gang AS
 * Copyright (c) 2006-2015 Varnish Software AS
 * All rights reserved.
 *
 * Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
 * Author: Dag-Erling Smørgrav <des@des.no>
 *
 * 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.
 *
 * Statistics output program
 */

#include "config.h"

#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
#include <signal.h>
#include <string.h>
#include <time.h>
#include <unistd.h>
#include <math.h>

#define VOPT_DEFINITION
#define VOPT_INC "varnishstat_options.h"

#include "vapi/voptget.h"
#include "vapi/vsl.h"
#include "vdef.h"
#include "vut.h"

#include "varnishstat.h"

static struct VUT *vut;
int has_f = 0;

/*--------------------------------------------------------------------*/

static int v_matchproto_(VSC_iter_f)
do_xml_cb(void *priv, const struct VSC_point * const pt)
{
        uint64_t val;

        (void)priv;
        if (pt == NULL)
                return (0);
        AZ(strcmp(pt->ctype, "uint64_t"));
        val = VSC_Value(pt);

        printf("\t<stat>\n");
        printf("\t\t<name>%s</name>\n", pt->name);
        printf("\t\t<value>%ju</value>\n", (uintmax_t)val);
        printf("\t\t<flag>%c</flag>\n", pt->semantics);
        printf("\t\t<format>%c</format>\n", pt->format);
        printf("\t\t<description>%s</description>\n", pt->sdesc);
        printf("\t</stat>\n");
        return (0);
}

static void
do_xml(struct vsm *vsm, struct vsc *vsc)
{
        char time_stamp[20];
        time_t now;

        printf("<?xml version=\"1.0\"?>\n");
        now = time(NULL);
        (void)strftime(time_stamp, 20, "%Y-%m-%dT%H:%M:%S", localtime(&now));
        printf("<varnishstat timestamp=\"%s\">\n", time_stamp);
        (void)VSC_Iter(vsc, vsm, do_xml_cb, NULL);
        printf("</varnishstat>\n");
}


/*--------------------------------------------------------------------*/

static int v_matchproto_(VSC_iter_f)
do_json_cb(void *priv, const struct VSC_point * const pt)
{
        const char **sep;
        uintmax_t val;

        if (pt == NULL)
                return (0);

        AZ(strcmp(pt->ctype, "uint64_t"));
        val = (uintmax_t)VSC_Value(pt);

        sep = priv;

        printf(
            "%s"
            "    \"%s\": {\n"
            "      \"description\": \"%s\",\n"
            "      \"flag\": \"%c\",\n"
            "      \"format\": \"%c\",\n"
            "      \"value\": %ju\n"
            "    }",
            *sep, pt->name, pt->sdesc, pt->semantics, pt->format, val);

        *sep = ",\n";
        return (0);
}

static void
do_json(struct vsm *vsm, struct vsc *vsc)
{
        const char *sep;
        char time_stamp[20];
        time_t now;

        sep = "";
        now = time(NULL);

        (void)strftime(time_stamp, 20, "%Y-%m-%dT%H:%M:%S", localtime(&now));
        printf(
            "{\n"
            "  \"version\": 1,\n"
            "  \"timestamp\": \"%s\",\n"
            "  \"counters\": {\n", time_stamp);
        (void)VSC_Iter(vsc, vsm, do_json_cb, &sep);
        printf(
            "\n"
            "  }\n"
            "}\n");
}


/*--------------------------------------------------------------------*/

struct once_priv {
        double  up;
        int pad;
};

static int v_matchproto_(VSC_iter_f)
do_once_cb_first(void *priv, const struct VSC_point * const pt)
{
        struct once_priv *op;
        uint64_t val;

        if (pt == NULL)
                return (0);
        op = priv;
        AZ(strcmp(pt->ctype, "uint64_t"));
        if (strcmp(pt->name, "MAIN.uptime"))
                return (0);
        val = VSC_Value(pt);
        op->up = (double)val;
        return (1);
}

static int v_matchproto_(VSC_iter_f)
do_once_cb(void *priv, const struct VSC_point * const pt)
{
        struct once_priv *op;
        uint64_t val;
        int i;

        if (pt == NULL)
                return (0);
        op = priv;
        AZ(strcmp(pt->ctype, "uint64_t"));
        val = VSC_Value(pt);
        i = 0;
        i += printf("%s", pt->name);
        if (i >= op->pad)
                op->pad = i + 1;
        printf("%*.*s", op->pad - i, op->pad - i, "");
        if (pt->semantics == 'c')
                printf("%12ju %12.2f %s\n",
                    (uintmax_t)val, op->up ? val / op->up : 0,
                    pt->sdesc);
        else
                printf("%12ju %12s %s\n",
                    (uintmax_t)val, ".  ", pt->sdesc);
        return (0);
}

static void
do_once(struct vsm *vsm, struct vsc *vsc)
{
        struct vsc *vsconce = VSC_New();
        struct once_priv op;

        AN(vsconce);
        AN(VSC_Arg(vsconce, 'f', "MAIN.uptime"));

        memset(&op, 0, sizeof op);
        op.pad = 18;

        (void)VSC_Iter(vsconce, vsm, do_once_cb_first, &op);
        VSC_Destroy(&vsconce, vsm);
        (void)VSC_Iter(vsc, vsm, do_once_cb, &op);
}

/*--------------------------------------------------------------------*/

static int v_matchproto_(VSC_iter_f)
do_list_cb(void *priv, const struct VSC_point * const pt)
{
        int i;

        (void)priv;

        if (pt == NULL)
                return (0);

        i = 0;
        i += printf("%s", pt->name);
        if (i < 30)
                printf("%*s", i - 30, "");
        printf(" %s\n", pt->sdesc);
        return (0);
}

static void
list_fields(struct vsm *vsm, struct vsc *vsc)
{
        printf("Varnishstat -f option fields:\n");
        printf("Field name                     Description\n");
        printf("----------                     -----------\n");

        (void)VSC_Iter(vsc, vsm, do_list_cb, NULL);
}

/*--------------------------------------------------------------------*/

static void v_noreturn_
usage(int status)
{
        const char **opt;

        fprintf(stderr, "Usage: %s <options>\n\n", vut->progname);
        fprintf(stderr, "Options:\n");
        for (opt = vopt_spec.vopt_usage; *opt != NULL; opt +=2)
                fprintf(stderr, " %-25s %s\n", *opt, *(opt + 1));
        exit(status);
}

static int
key_bindings(void)
{

#define BINDING_KEY(chr, name, next)    \
        printf("<%s>" next, name);
#define BINDING(name, desc)             \
        printf("\n%s\n\n", desc);
#include "varnishstat_bindings.h"
        return (0);
}

int
main(int argc, char * const *argv)
{
        struct vsm *vd;
        int once = 0, xml = 0, json = 0, f_list = 0, curses = 0;
        signed char opt;
        int i;
        struct vsc *vsc;

        if (argc == 2 && !strcmp(argv[1], "--bindings"))
                exit(key_bindings());

        vut = VUT_InitProg(argc, argv, &vopt_spec);
        AN(vut);
        vd = VSM_New();
        AN(vd);
        vsc = VSC_New();
        AN(vsc);

        while ((opt = getopt(argc, argv, vopt_spec.vopt_optstring)) != -1) {
                switch (opt) {
                case '1':
                        once = 1;
                        break;
                case 'h':
                        /* Usage help */
                        usage(0);
                        break;
                case 'l':
                        f_list = 1;
                        break;
                case 'x':
                        xml = 1;
                        break;
                case 'j':
                        json = 1;
                        break;
                case 'I':
                case 'X':
                case 'f':
                        AN(VSC_Arg(vsc, opt, optarg));
                        has_f = 1;
                        break;
                case 'r':
                        AN(VSC_Arg(vsc, opt, optarg));
                        break;
                case 'V':
                        AN(VUT_Arg(vut, opt, optarg));
                        break;
                default:
                        i = VSM_Arg(vd, opt, optarg);
                        if (i < 0)
                                VUT_Error(vut, 1, "%s", VSM_Error(vd));
                        if (!i)
                                usage(1);
                }
        }

        if (optind != argc)
                usage(1);

        if (!(xml || json || once || f_list))
                curses = 1;

        if (VSM_Attach(vd, STDERR_FILENO))
                VUT_Error(vut, 1, "%s", VSM_Error(vd));

        if (curses) {
                if (has_f) {
                        AN(VSC_Arg(vsc, 'R', "MGT.uptime"));
                        AN(VSC_Arg(vsc, 'R', "MAIN.uptime"));
                        AN(VSC_Arg(vsc, 'R', "MAIN.cache_hit"));
                        AN(VSC_Arg(vsc, 'R', "MAIN.cache_miss"));
                }
                do_curses(vd, vsc);
        }
        else if (xml)
                do_xml(vd, vsc);
        else if (json)
                do_json(vd, vsc);
        else if (once)
                do_once(vd, vsc);
        else if (f_list)
                list_fields(vd, vsc);
        else
                WRONG("undefined varnishstat mode");

        exit(0);
}

		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	25	#include <stdlib.h>
39	25	#include <signal.h>
40		#include <string.h>
41	25	#include <time.h>
42	25	#include <unistd.h>
43	25	#include <math.h>
44
45	25	#define VOPT_DEFINITION
46	25	#define VOPT_INC "varnishstat_options.h"
47	25
48		#include "vapi/voptget.h"
49	25	#include "vapi/vsl.h"
50	25	#include "vdef.h"
51	25	#include "vut.h"
52	25
53		#include "varnishstat.h"
54	25
55	25	static struct VUT *vut;
56	25	int has_f = 0;
57	25
58		/--------------------------------------------------------------------/
59	25
60	25	static int v_matchproto_(VSC_iter_f)
61	8875	do_xml_cb(void priv, const struct VSC_point const pt)
62		{
63	25	uint64_t val;
64	25
65	8875	(void)priv;
66	8850	if (pt == NULL)
67	25	return (0);
68	8875	AZ(strcmp(pt->ctype, "uint64_t"));
69	8850	val = VSC_Value(pt);
70
71	8850	printf("\t<stat>\n");
72	8850	printf("\t\t<name>%s</name>\n", pt->name);
73	8850	printf("\t\t<value>%ju</value>\n", (uintmax_t)val);
74	8875	printf("\t\t<flag>%c</flag>\n", pt->semantics);
75	8875	printf("\t\t<format>%c</format>\n", pt->format);
76	8850	printf("\t\t<description>%s</description>\n", pt->sdesc);
77	8850	printf("\t</stat>\n");
78	8850	return (0);
79	8850	}
80
81		static void
82	50	do_xml(struct vsm vsm, struct vsc vsc)
83	25	{
84		char time_stamp[20];
85	25	time_t now;
86	25
87	25	printf("<?xml version=\"1.0\"?>\n");
88	25	now = time(NULL);
89	25	(void)strftime(time_stamp, 20, "%Y-%m-%dT%H:%M:%S", localtime(&now));
90	25	printf("<varnishstat timestamp=\"%s\">\n", time_stamp);
91	50	(void)VSC_Iter(vsc, vsm, do_xml_cb, NULL);
92	50	printf("</varnishstat>\n");
93	25	}
94
95
96		/--------------------------------------------------------------------/
97	25
98	25	static int v_matchproto_(VSC_iter_f)
99	35400	do_json_cb(void priv, const struct VSC_point const pt)
100	25	{
101	25	const char **sep;
102		uintmax_t val;
103	25
104	35425	if (pt == NULL)
105	0	return (0);
106	25
107	35425	AZ(strcmp(pt->ctype, "uint64_t"));
108	35400	val = (uintmax_t)VSC_Value(pt);
109
110	35400	sep = priv;
111
112	35400	printf(
113		"%s"
114		" \"%s\": {\n"
115		" \"description\": \"%s\",\n"
116		" \"flag\": \"%c\",\n"
117		" \"format\": \"%c\",\n"
118		" \"value\": %ju\n"
119		" }",
120	35400	*sep, pt->name, pt->sdesc, pt->semantics, pt->format, val);
121
122	35400	*sep = ",\n";
123	35400	return (0);
124	35400	}
125
126		static void
127	100	do_json(struct vsm vsm, struct vsc vsc)
128		{
129		const char *sep;
130		char time_stamp[20];
131		time_t now;
132
133	100	sep = "";
134	100	now = time(NULL);
135
136	100	(void)strftime(time_stamp, 20, "%Y-%m-%dT%H:%M:%S", localtime(&now));
137	100	printf(
138		"{\n"
139		" \"version\": 1,\n"
140		" \"timestamp\": \"%s\",\n"
141	100	" \"counters\": {\n", time_stamp);
142	100	(void)VSC_Iter(vsc, vsm, do_json_cb, &sep);
143	100	printf(
144		"\n"
145		" }\n"
146		"}\n");
147	100	}
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	225	do_once_cb_first(void priv, const struct VSC_point const pt)
159		{
160		struct once_priv *op;
161		uint64_t val;
162
163	225	if (pt == NULL)
164	0	return (0);
165	225	op = priv;
166	225	AZ(strcmp(pt->ctype, "uint64_t"));
167	225	if (strcmp(pt->name, "MAIN.uptime"))
168	0	return (0);
169	225	val = VSC_Value(pt);
170	225	op->up = (double)val;
171	225	return (1);
172	225	}
173
174		static int v_matchproto_(VSC_iter_f)
175	81925	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	81925	if (pt == NULL)
182	0	return (0);
183	81925	op = priv;
184	81925	AZ(strcmp(pt->ctype, "uint64_t"));
185	81925	val = VSC_Value(pt);
186	81925	i = 0;
187	81925	i += printf("%s", pt->name);
188	81925	if (i >= op->pad)
189	525	op->pad = i + 1;
190	81925	printf("%.s", op->pad - i, op->pad - i, "");
191	81925	if (pt->semantics == 'c')
192	72700	printf("%12ju %12.2f %s\n",
193	72700	(uintmax_t)val, op->up ? val / op->up : 0,
194	72700	pt->sdesc);
195		else
196	9225	printf("%12ju %12s %s\n",
197	9225	(uintmax_t)val, ". ", pt->sdesc);
198	81925	return (0);
199	81925	}
200
201		static void
202	225	do_once(struct vsm vsm, struct vsc vsc)
203		{
204	225	struct vsc *vsconce = VSC_New();
205		struct once_priv op;
206
207	225	AN(vsconce);
208	225	AN(VSC_Arg(vsconce, 'f', "MAIN.uptime"));
209
210	225	memset(&op, 0, sizeof op);
211	225	op.pad = 18;
212
213	225	(void)VSC_Iter(vsconce, vsm, do_once_cb_first, &op);
214	225	VSC_Destroy(&vsconce, vsm);
215	225	(void)VSC_Iter(vsc, vsm, do_once_cb, &op);
216	225	}
217
218		/--------------------------------------------------------------------/
219
220		static int v_matchproto_(VSC_iter_f)
221	8850	do_list_cb(void priv, const struct VSC_point const pt)
222		{
223		int i;
224
225	8850	(void)priv;
226
227	8850	if (pt == NULL)
228	0	return (0);
229
230	8850	i = 0;
231	8850	i += printf("%s", pt->name);
232	8850	if (i < 30)
233	8775	printf("%*s", i - 30, "");
234	8850	printf(" %s\n", pt->sdesc);
235	8850	return (0);
236	8850	}
237
238		static void
239	25	list_fields(struct vsm vsm, struct vsc vsc)
240		{
241	25	printf("Varnishstat -f option fields:\n");
242	25	printf("Field name Description\n");
243	25	printf("---------- -----------\n");
244
245	25	(void)VSC_Iter(vsc, vsm, do_list_cb, NULL);
246	25	}
247
248		/--------------------------------------------------------------------/
249
250		static void v_noreturn_
251	50	usage(int status)
252		{
253		const char **opt;
254
255	50	fprintf(stderr, "Usage: %s <options>\n\n", vut->progname);
256	50	fprintf(stderr, "Options:\n");
257	650	for (opt = vopt_spec.vopt_usage; *opt != NULL; opt +=2)
258	600	fprintf(stderr, " %-25s %s\n", opt, (opt + 1));
259	50	exit(status);
260		}
261
262		static int
263	25	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	25	return (0);
272		}
273
274		int
275	700	main(int argc, char * const *argv)
276		{
277		struct vsm *vd;
278	700	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	700	if (argc == 2 && !strcmp(argv[1], "--bindings"))
284	25	exit(key_bindings());
285
286	675	vut = VUT_InitProg(argc, argv, &vopt_spec);
287	675	AN(vut);
288	675	vd = VSM_New();
289	675	AN(vd);
290	675	vsc = VSC_New();
291	675	AN(vsc);
292
293	2100	while ((opt = getopt(argc, argv, vopt_spec.vopt_optstring)) != -1) {
294	1525	switch (opt) {
295		case '1':
296	225	once = 1;
297	225	break;
298		case 'h':
299		/* Usage help */
300	25	usage(0);
301		break;
302		case 'l':
303	25	f_list = 1;
304	25	break;
305		case 'x':
306	25	xml = 1;
307	25	break;
308		case 'j':
309	100	json = 1;
310	100	break;
311		case 'I':
312		case 'X':
313		case 'f':
314	475	AN(VSC_Arg(vsc, opt, optarg));
315	475	has_f = 1;
316	475	break;
317		case 'r':
318	0	AN(VSC_Arg(vsc, opt, optarg));
319	0	break;
320		case 'V':
321	0	AN(VUT_Arg(vut, opt, optarg));
322	0	break;
323		default:
324	650	i = VSM_Arg(vd, opt, optarg);
325	650	if (i < 0)
326	75	VUT_Error(vut, 1, "%s", VSM_Error(vd));
327	575	if (!i)
328	0	usage(1);
329	575	}
330		}
331
332	575	if (optind != argc)
333	25	usage(1);
334
335	550	if (!(xml \|\| json \|\| once \|\| f_list))
336	175	curses = 1;
337
338	550	if (VSM_Attach(vd, STDERR_FILENO))
339	25	VUT_Error(vut, 1, "%s", VSM_Error(vd));
340
341	525	if (curses) {
342	150	if (has_f) {
343	50	AN(VSC_Arg(vsc, 'R', "MGT.uptime"));
344	50	AN(VSC_Arg(vsc, 'R', "MAIN.uptime"));
345	50	AN(VSC_Arg(vsc, 'R', "MAIN.cache_hit"));
346	50	AN(VSC_Arg(vsc, 'R', "MAIN.cache_miss"));
347	50	}
348	150	do_curses(vd, vsc);
349	150	}
350	375	else if (xml)
351	25	do_xml(vd, vsc);
352	350	else if (json)
353	100	do_json(vd, vsc);
354	250	else if (once)
355	225	do_once(vd, vsc);
356	25	else if (f_list)
357	25	list_fields(vd, vsc);
358		else
359	0	WRONG("undefined varnishstat mode");
360
361	525	exit(0);
362		}