GCOV - Varnish Cache


/*-
 * 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.
 *
 * We maintain a number of worker thread pools, to spread lock contention.
 *
 * Pools can be added on the fly, as a means to mitigate lock contention,
 * but can only be removed again by a restart. (XXX: we could fix that)
 *
 */

#include "config.h"

#include <stdlib.h>

#include "cache_varnishd.h"
#include "cache_pool.h"

#include "vtim.h"

static pthread_t                thr_pool_herder;

static struct lock              wstat_mtx;
struct lock                     pool_mtx;
static VTAILQ_HEAD(,pool)       pools = VTAILQ_HEAD_INITIALIZER(pools);

/*--------------------------------------------------------------------
 * Summing of stats into global stats counters
 */

void
Pool_Sumstat(const struct worker *wrk)
{

        Lck_Lock(&wstat_mtx);
        VSC_main_Summ_wrk(VSC_C_main, wrk->stats);
        Lck_Unlock(&wstat_mtx);
        memset(wrk->stats, 0, sizeof *wrk->stats);
}

int
Pool_TrySumstat(const struct worker *wrk)
{
        if (Lck_Trylock(&wstat_mtx))
                return (0);
        VSC_main_Summ_wrk(VSC_C_main, wrk->stats);
        Lck_Unlock(&wstat_mtx);
        memset(wrk->stats, 0, sizeof *wrk->stats);
        return (1);
}

/*--------------------------------------------------------------------
 * Facility for scheduling a task on any convenient pool.
 */

int
Pool_Task_Any(struct pool_task *task, enum task_prio prio)
{
        struct pool *pp;

        Lck_Lock(&pool_mtx);
        pp = VTAILQ_FIRST(&pools);
        if (pp != NULL) {
                VTAILQ_REMOVE(&pools, pp, list);
                VTAILQ_INSERT_TAIL(&pools, pp, list);
        }
        Lck_Unlock(&pool_mtx);
        if (pp == NULL)
                return (-1);
        // NB: When we remove pools, is there a race here ?
        return (Pool_Task(pp, task, prio));
}

/*--------------------------------------------------------------------
 * Helper function to update stats for purges under lock
 */

void
Pool_PurgeStat(unsigned nobj)
{
        Lck_Lock(&wstat_mtx);
        VSC_C_main->n_purges++;
        VSC_C_main->n_obj_purged += nobj;
        Lck_Unlock(&wstat_mtx);
}

/*--------------------------------------------------------------------
 * Special function to summ stats
 */

void v_matchproto_(task_func_t)
pool_stat_summ(struct worker *wrk, void *priv)
{
        struct VSC_main_wrk *src;
        struct pool *pp;

        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
        pp = wrk->pool;
        CHECK_OBJ_NOTNULL(pp, POOL_MAGIC);
        AN(priv);
        src = priv;

        Lck_Lock(&wstat_mtx);
        VSC_main_Summ_wrk(VSC_C_main, src);

        Lck_Lock(&pp->mtx);
        VSC_main_Summ_pool(VSC_C_main, pp->stats);
        Lck_Unlock(&pp->mtx);
        memset(pp->stats, 0, sizeof pp->stats);

        Lck_Unlock(&wstat_mtx);
        memset(src, 0, sizeof *src);

        AZ(pp->b_stat);
        pp->b_stat = src;
}

/*--------------------------------------------------------------------
 * Add a thread pool
 */

static struct pool *
pool_mkpool(unsigned pool_no)
{
        struct pool *pp;
        int i;

        ALLOC_OBJ(pp, POOL_MAGIC);
        if (pp == NULL)
                return (NULL);
        pp->a_stat = calloc(1, sizeof *pp->a_stat);
        AN(pp->a_stat);
        pp->b_stat = calloc(1, sizeof *pp->b_stat);
        AN(pp->b_stat);
        Lck_New(&pp->mtx, lck_perpool);

        VTAILQ_INIT(&pp->idle_queue);
        VTAILQ_INIT(&pp->poolsocks);
        for (i = 0; i < TASK_QUEUE_RESERVE; i++)
                VTAILQ_INIT(&pp->queues[i]);
        PTOK(pthread_cond_init(&pp->herder_cond, NULL));
        PTOK(pthread_create(&pp->herder_thr, NULL, pool_herder, pp));

        while (VTAILQ_EMPTY(&pp->idle_queue))
                VTIM_sleep(0.01);

        SES_NewPool(pp, pool_no);
        VCA_NewPool(pp);

        return (pp);
}

/*--------------------------------------------------------------------
 * This thread adjusts the number of pools to match the parameter.
 *
 * NB: This is quite silly.  The master should tell the child through
 * NB: CLI when parameters change and an appropriate call-out table
 * NB: be maintained for params which require action.
 */

static void * v_matchproto_()
pool_poolherder(void *priv)
{
        unsigned nwq;
        struct pool *pp, *ppx;
        uint64_t u;
        void *rvp;

        THR_SetName("pool_poolherder");
        THR_Init();
        (void)priv;

        nwq = 0;
        while (1) {
                if (nwq < cache_param->wthread_pools) {
                        pp = pool_mkpool(nwq);
                        if (pp != NULL) {
                                Lck_Lock(&pool_mtx);
                                VTAILQ_INSERT_TAIL(&pools, pp, list);
                                Lck_Unlock(&pool_mtx);
                                VSC_C_main->pools++;
                                nwq++;
                                continue;
                        }
                } else if (nwq > cache_param->wthread_pools &&
                                EXPERIMENT(EXPERIMENT_DROP_POOLS)) {
                        Lck_Lock(&pool_mtx);
                        pp = VTAILQ_FIRST(&pools);
                        CHECK_OBJ_NOTNULL(pp, POOL_MAGIC);
                        VTAILQ_REMOVE(&pools, pp, list);
                        VTAILQ_INSERT_TAIL(&pools, pp, list);
                        if (!pp->die)
                                nwq--;
                        Lck_Unlock(&pool_mtx);
                        if (!pp->die) {
                                VSL(SLT_Debug, NO_VXID, "XXX Kill Pool %p", pp);
                                pp->die = 1;
                                VCA_DestroyPool(pp);
                                PTOK(pthread_cond_signal(&pp->herder_cond));
                        }
                }
                (void)sleep(1);
                u = 0;
                ppx = NULL;
                Lck_Lock(&pool_mtx);
                VTAILQ_FOREACH(pp, &pools, list) {
                        CHECK_OBJ_NOTNULL(pp, POOL_MAGIC);

                        if (pp->die && pp->nthr == 0)
                                ppx = pp;
                        u += pp->lqueue;
                }
                if (ppx != NULL) {
                        VTAILQ_REMOVE(&pools, ppx, list);
                        PTOK(pthread_join(ppx->herder_thr, &rvp));
                        PTOK(pthread_cond_destroy(&ppx->herder_cond));
                        free(ppx->a_stat);
                        free(ppx->b_stat);
                        SES_DestroyPool(ppx);
                        Lck_Delete(&ppx->mtx);
                        FREE_OBJ(ppx);
                        VSC_C_main->pools--;
                }
                Lck_Unlock(&pool_mtx);
                VSC_C_main->thread_queue_len = u;
        }
        NEEDLESS(return (NULL));
}

/*--------------------------------------------------------------------*/
void
pan_pool(struct vsb *vsb)
{
        struct pool *pp;

        VSB_cat(vsb, "pools = {\n");
        VSB_indent(vsb, 2);
        VTAILQ_FOREACH(pp, &pools, list) {
                if (PAN_dump_struct(vsb, pp, POOL_MAGIC, "pool"))
                        continue;
                VSB_printf(vsb, "nidle = %u,\n", pp->nidle);
                VSB_printf(vsb, "nthr = %u,\n", pp->nthr);
                VSB_printf(vsb, "lqueue = %u\n", pp->lqueue);
                VSB_indent(vsb, -2);
                VSB_cat(vsb, "},\n");
        }
        VSB_indent(vsb, -2);
        VSB_cat(vsb, "},\n");
}

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

void
Pool_Init(void)
{

        Lck_New(&wstat_mtx, lck_wstat);
        Lck_New(&pool_mtx, lck_wq);
        PTOK(pthread_create(&thr_pool_herder, NULL, pool_poolherder, NULL));
        while (!VSC_C_main->pools)
                VTIM_sleep(0.01);
}

		varnish-cache/bin/varnishd/cache/cache_pool.c
0		/*-
1		* Copyright (c) 2006 Verdens Gang AS
2		* Copyright (c) 2006-2011 Varnish Software AS
3		* All rights reserved.
4		*
5		* Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
6		*
7		* SPDX-License-Identifier: BSD-2-Clause
8		*
9		* Redistribution and use in source and binary forms, with or without
10		* modification, are permitted provided that the following conditions
11		* are met:
12		* 1. Redistributions of source code must retain the above copyright
13		* notice, this list of conditions and the following disclaimer.
14		* 2. Redistributions in binary form must reproduce the above copyright
15		* notice, this list of conditions and the following disclaimer in the
16		* documentation and/or other materials provided with the distribution.
17		*
18		* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19		* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20		* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21		* ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
22		* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23		* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24		* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25		* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26		* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27		* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28		* SUCH DAMAGE.
29		*
30		* We maintain a number of worker thread pools, to spread lock contention.
31		*
32		* Pools can be added on the fly, as a means to mitigate lock contention,
33		* but can only be removed again by a restart. (XXX: we could fix that)
34		*
35		*/
36
37		#include "config.h"
38
39		#include <stdlib.h>
40
41		#include "cache_varnishd.h"
42		#include "cache_pool.h"
43
44		#include "vtim.h"
45
46		static pthread_t thr_pool_herder;
47
48		static struct lock wstat_mtx;
49		struct lock pool_mtx;
50		static VTAILQ_HEAD(,pool) pools = VTAILQ_HEAD_INITIALIZER(pools);
51
52		/*--------------------------------------------------------------------
53		* Summing of stats into global stats counters
54		*/
55
56		void
57	17093	Pool_Sumstat(const struct worker *wrk)
58		{
59
60	17093	Lck_Lock(&wstat_mtx);
61	17093	VSC_main_Summ_wrk(VSC_C_main, wrk->stats);
62	17093	Lck_Unlock(&wstat_mtx);
63	17093	memset(wrk->stats, 0, sizeof *wrk->stats);
64	17093	}
65
66		int
67	0	Pool_TrySumstat(const struct worker *wrk)
68		{
69	0	if (Lck_Trylock(&wstat_mtx))
70	0	return (0);
71	0	VSC_main_Summ_wrk(VSC_C_main, wrk->stats);
72	0	Lck_Unlock(&wstat_mtx);
73	0	memset(wrk->stats, 0, sizeof *wrk->stats);
74	0	return (1);
75	0	}
76
77		/*--------------------------------------------------------------------
78		* Facility for scheduling a task on any convenient pool.
79		*/
80
81		int
82	602	Pool_Task_Any(struct pool_task *task, enum task_prio prio)
83		{
84		struct pool *pp;
85
86	602	Lck_Lock(&pool_mtx);
87	602	pp = VTAILQ_FIRST(&pools);
88	602	if (pp != NULL) {
89	602	VTAILQ_REMOVE(&pools, pp, list);
90	602	VTAILQ_INSERT_TAIL(&pools, pp, list);
91	602	}
92	602	Lck_Unlock(&pool_mtx);
93	602	if (pp == NULL)
94	0	return (-1);
95		// NB: When we remove pools, is there a race here ?
96	602	return (Pool_Task(pp, task, prio));
97	602	}
98
99		/*--------------------------------------------------------------------
100		* Helper function to update stats for purges under lock
101		*/
102
103		void
104	42	Pool_PurgeStat(unsigned nobj)
105		{
106	42	Lck_Lock(&wstat_mtx);
107	42	VSC_C_main->n_purges++;
108	42	VSC_C_main->n_obj_purged += nobj;
109	42	Lck_Unlock(&wstat_mtx);
110	42	}
111
112		/*--------------------------------------------------------------------
113		* Special function to summ stats
114		*/
115
116		void v_matchproto_(task_func_t)
117	15297	pool_stat_summ(struct worker wrk, void priv)
118		{
119		struct VSC_main_wrk *src;
120		struct pool *pp;
121
122	15297	CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
123	15297	pp = wrk->pool;
124	15297	CHECK_OBJ_NOTNULL(pp, POOL_MAGIC);
125	15297	AN(priv);
126	15297	src = priv;
127
128	15297	Lck_Lock(&wstat_mtx);
129	15297	VSC_main_Summ_wrk(VSC_C_main, src);
130
131	15297	Lck_Lock(&pp->mtx);
132	15297	VSC_main_Summ_pool(VSC_C_main, pp->stats);
133	15297	Lck_Unlock(&pp->mtx);
134	15297	memset(pp->stats, 0, sizeof pp->stats);
135
136	15297	Lck_Unlock(&wstat_mtx);
137	15297	memset(src, 0, sizeof *src);
138
139	15297	AZ(pp->b_stat);
140	15297	pp->b_stat = src;
141	15297	}
142
143		/*--------------------------------------------------------------------
144		* Add a thread pool
145		*/
146
147		static struct pool *
148	5652	pool_mkpool(unsigned pool_no)
149		{
150		struct pool *pp;
151		int i;
152
153	5652	ALLOC_OBJ(pp, POOL_MAGIC);
154	5652	if (pp == NULL)
155	0	return (NULL);
156	5652	pp->a_stat = calloc(1, sizeof *pp->a_stat);
157	5652	AN(pp->a_stat);
158	5652	pp->b_stat = calloc(1, sizeof *pp->b_stat);
159	5652	AN(pp->b_stat);
160	5652	Lck_New(&pp->mtx, lck_perpool);
161
162	5652	VTAILQ_INIT(&pp->idle_queue);
163	5652	VTAILQ_INIT(&pp->poolsocks);
164	33912	for (i = 0; i < TASK_QUEUE_RESERVE; i++)
165	28260	VTAILQ_INIT(&pp->queues[i]);
166	5652	PTOK(pthread_cond_init(&pp->herder_cond, NULL));
167	5652	PTOK(pthread_create(&pp->herder_thr, NULL, pool_herder, pp));
168
169	11304	while (VTAILQ_EMPTY(&pp->idle_queue))
170	5652	VTIM_sleep(0.01);
171
172	5652	SES_NewPool(pp, pool_no);
173	5652	VCA_NewPool(pp);
174
175	5652	return (pp);
176	5652	}
177
178		/*--------------------------------------------------------------------
179		* This thread adjusts the number of pools to match the parameter.
180		*
181		* NB: This is quite silly. The master should tell the child through
182		* NB: CLI when parameters change and an appropriate call-out table
183		* NB: be maintained for params which require action.
184		*/
185
186		static void * v_matchproto_()
187	0	pool_poolherder(void *priv)
188		{
189		unsigned nwq;
190		struct pool pp, ppx;
191		uint64_t u;
192		void *rvp;
193
194	0	THR_SetName("pool_poolherder");
195	0	THR_Init();
196	0	(void)priv;
197
198	0	nwq = 0;
199	7574	while (1) {
200	13226	if (nwq < cache_param->wthread_pools) {
201	5652	pp = pool_mkpool(nwq);
202	5652	if (pp != NULL) {
203	5652	Lck_Lock(&pool_mtx);
204	5652	VTAILQ_INSERT_TAIL(&pools, pp, list);
205	5652	Lck_Unlock(&pool_mtx);
206	5652	VSC_C_main->pools++;
207	5652	nwq++;
208	5652	continue;
209		}
210	7574	} else if (nwq > cache_param->wthread_pools &&
211	6	EXPERIMENT(EXPERIMENT_DROP_POOLS)) {
212	6	Lck_Lock(&pool_mtx);
213	6	pp = VTAILQ_FIRST(&pools);
214	6	CHECK_OBJ_NOTNULL(pp, POOL_MAGIC);
215	6	VTAILQ_REMOVE(&pools, pp, list);
216	6	VTAILQ_INSERT_TAIL(&pools, pp, list);
217	6	if (!pp->die)
218	6	nwq--;
219	6	Lck_Unlock(&pool_mtx);
220	6	if (!pp->die) {
221	6	VSL(SLT_Debug, NO_VXID, "XXX Kill Pool %p", pp);
222	6	pp->die = 1;
223	6	VCA_DestroyPool(pp);
224	6	PTOK(pthread_cond_signal(&pp->herder_cond));
225	6	}
226	6	}
227	7574	(void)sleep(1);
228	7574	u = 0;
229	7574	ppx = NULL;
230	7574	Lck_Lock(&pool_mtx);
231	16738	VTAILQ_FOREACH(pp, &pools, list) {
232	9164	CHECK_OBJ_NOTNULL(pp, POOL_MAGIC);
233
234	9164	if (pp->die && pp->nthr == 0)
235	6	ppx = pp;
236	9164	u += pp->lqueue;
237	9164	}
238	7574	if (ppx != NULL) {
239	6	VTAILQ_REMOVE(&pools, ppx, list);
240	6	PTOK(pthread_join(ppx->herder_thr, &rvp));
241	6	PTOK(pthread_cond_destroy(&ppx->herder_cond));
242	6	free(ppx->a_stat);
243	6	free(ppx->b_stat);
244	6	SES_DestroyPool(ppx);
245	6	Lck_Delete(&ppx->mtx);
246	6	FREE_OBJ(ppx);
247	6	VSC_C_main->pools--;
248	6	}
249	7574	Lck_Unlock(&pool_mtx);
250	7574	VSC_C_main->thread_queue_len = u;
251		}
252		NEEDLESS(return (NULL));
253		}
254
255		/--------------------------------------------------------------------/
256		void
257	39	pan_pool(struct vsb *vsb)
258		{
259		struct pool *pp;
260
261	39	VSB_cat(vsb, "pools = {\n");
262	39	VSB_indent(vsb, 2);
263	117	VTAILQ_FOREACH(pp, &pools, list) {
264	78	if (PAN_dump_struct(vsb, pp, POOL_MAGIC, "pool"))
265	0	continue;
266	78	VSB_printf(vsb, "nidle = %u,\n", pp->nidle);
267	78	VSB_printf(vsb, "nthr = %u,\n", pp->nthr);
268	78	VSB_printf(vsb, "lqueue = %u\n", pp->lqueue);
269	78	VSB_indent(vsb, -2);
270	78	VSB_cat(vsb, "},\n");
271	78	}
272	39	VSB_indent(vsb, -2);
273	39	VSB_cat(vsb, "},\n");
274	39	}
275
276		/--------------------------------------------------------------------/
277
278		void
279	2859	Pool_Init(void)
280		{
281
282	2859	Lck_New(&wstat_mtx, lck_wstat);
283	2859	Lck_New(&pool_mtx, lck_wq);
284	2859	PTOK(pthread_create(&thr_pool_herder, NULL, pool_poolherder, NULL));
285	8577	while (!VSC_C_main->pools)
286	5718	VTIM_sleep(0.01);
287	2859	}