varnish-cache/bin/varnishd/cache/cache_mempool.c
0
/*-
1
 * Copyright (c) 2011 Varnish Software AS
2
 * All rights reserved.
3
 *
4
 * Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
5
 *
6
 * SPDX-License-Identifier: BSD-2-Clause
7
 *
8
 * Redistribution and use in source and binary forms, with or without
9
 * modification, are permitted provided that the following conditions
10
 * are met:
11
 * 1. Redistributions of source code must retain the above copyright
12
 *    notice, this list of conditions and the following disclaimer.
13
 * 2. Redistributions in binary form must reproduce the above copyright
14
 *    notice, this list of conditions and the following disclaimer in the
15
 *    documentation and/or other materials provided with the distribution.
16
 *
17
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20
 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
21
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27
 * SUCH DAMAGE.
28
 *
29
 * Generic memory pool
30
 */
31
32
#include "config.h"
33
34
#include "cache_varnishd.h"
35
36
#include <stdio.h>
37
#include <stdlib.h>
38
39
#include "vtim.h"
40
41
#include "VSC_mempool.h"
42
43
struct memitem {
44
        unsigned                        magic;
45
#define MEMITEM_MAGIC                   0x42e55401
46
        unsigned                        size;
47
        VTAILQ_ENTRY(memitem)           list;
48
        vtim_real                       touched;        // XXX -> mono?
49
};
50
51
VTAILQ_HEAD(memhead_s, memitem);
52
53
struct mempool {
54
        unsigned                        magic;
55
#define MEMPOOL_MAGIC                   0x37a75a8d
56
        char                            name[12];
57
        struct memhead_s                list;
58
        struct memhead_s                surplus;
59
        struct lock                     mtx;
60
        volatile struct poolparam       *param;
61
        volatile unsigned               *cur_size;
62
        uint64_t                        live;
63
        struct vsc_seg                  *vsc_seg;
64
        struct VSC_mempool              *vsc;
65
        unsigned                        n_pool;
66
        pthread_t                       thread;
67
        vtim_real                       t_now;  // XXX -> mono?
68
        int                             self_destruct;
69
};
70
71
/*---------------------------------------------------------------------
72
 */
73
74
static struct memitem *
75 46893
mpl_alloc(const struct mempool *mpl)
76
{
77
        unsigned tsz;
78
        struct memitem *mi;
79
80 46893
        CHECK_OBJ_NOTNULL(mpl, MEMPOOL_MAGIC);
81 46893
        tsz = *mpl->cur_size;
82 46893
        mi = calloc(1, tsz);
83 46893
        AN(mi);
84 46893
        mi->magic = MEMITEM_MAGIC;
85 46893
        mi->size = tsz;
86 46893
        mpl->vsc->sz_wanted = tsz;
87 46893
        mpl->vsc->sz_actual = tsz - sizeof *mi;
88 46893
        return (mi);
89
}
90
91
/*---------------------------------------------------------------------
92
 * Pool-guard
93
 *   Attempt to keep number of free items in pool inside bounds with
94
 *   minimum locking activity, and keep an eye on items at the tail
95
 *   of the list not getting too old.
96
 */
97
98
static void *
99 4
mpl_guard(void *priv)
100
{
101
        struct mempool *mpl;
102 4
        struct memitem *mi = NULL;
103
        vtim_dur v_statevariable_(mpl_slp);
104 4
        vtim_real last = 0;
105
106 4
        CAST_OBJ_NOTNULL(mpl, priv, MEMPOOL_MAGIC);
107 4
        THR_SetName(mpl->name);
108 4
        THR_Init();
109 4
        mpl_slp = 0.15; // random
110 49336
        while (1) {
111 57521
                VTIM_sleep(mpl_slp);
112 57521
                mpl_slp = 0.814;        // random
113 57521
                mpl->t_now = VTIM_real();
114
115 57521
                if (mi != NULL && (mpl->n_pool > mpl->param->max_pool ||
116 0
                    mi->size < *mpl->cur_size)) {
117 0
                        CHECK_OBJ(mi, MEMITEM_MAGIC);
118 0
                        FREE_OBJ(mi);
119 0
                }
120
121 57521
                if (mi == NULL && mpl->n_pool < mpl->param->min_pool)
122 46153
                        mi = mpl_alloc(mpl);
123
124 57521
                if (mpl->n_pool < mpl->param->min_pool && mi != NULL) {
125
                        /* can do */
126 57521
                } else if (mpl->n_pool > mpl->param->max_pool && mi == NULL) {
127
                        /* can do */
128 10603
                } else if (!VTAILQ_EMPTY(&mpl->surplus)) {
129
                        /* can do */
130 10580
                } else if (last + .1 * mpl->param->max_age < mpl->t_now) {
131
                        /* should do */
132 10579
                } else if (mpl->self_destruct) {
133
                        /* can do */
134 0
                } else {
135 8119
                        continue;       /* nothing to do */
136
                }
137
138 49402
                mpl_slp = 0.314;        // random
139
140 49402
                if (Lck_Trylock(&mpl->mtx))
141 66
                        continue;
142
143 49336
                if (mpl->self_destruct) {
144 4
                        AZ(mpl->live);
145 44
                        while (1) {
146 44
                                if (mi == NULL) {
147 43
                                        mi = VTAILQ_FIRST(&mpl->list);
148 43
                                        if (mi != NULL) {
149 40
                                                mpl->vsc->pool = --mpl->n_pool;
150 40
                                                VTAILQ_REMOVE(&mpl->list,
151
                                                    mi, list);
152 40
                                        }
153 43
                                }
154 44
                                if (mi == NULL) {
155 4
                                        mi = VTAILQ_FIRST(&mpl->surplus);
156 4
                                        if (mi != NULL)
157 0
                                                VTAILQ_REMOVE(&mpl->surplus,
158
                                                    mi, list);
159 4
                                }
160 44
                                if (mi == NULL)
161 4
                                        break;
162 40
                                CHECK_OBJ(mi, MEMITEM_MAGIC);
163 40
                                FREE_OBJ(mi);
164
                        }
165 4
                        VSC_mempool_Destroy(&mpl->vsc_seg);
166 4
                        Lck_Unlock(&mpl->mtx);
167 4
                        Lck_Delete(&mpl->mtx);
168 4
                        FREE_OBJ(mpl);
169 4
                        break;
170
                }
171
172 96206
                if (mpl->n_pool < mpl->param->min_pool &&
173 46885
                    mi != NULL && mi->size >= *mpl->cur_size) {
174 46870
                        CHECK_OBJ(mi, MEMITEM_MAGIC);
175 46870
                        mpl->vsc->pool = ++mpl->n_pool;
176 46870
                        mi->touched = mpl->t_now;
177 46870
                        VTAILQ_INSERT_HEAD(&mpl->list, mi, list);
178 46870
                        mi = NULL;
179 46870
                        mpl_slp = .01;  // random
180
181 46870
                }
182 49332
                if (mpl->n_pool > mpl->param->max_pool && mi == NULL) {
183 23
                        mi = VTAILQ_FIRST(&mpl->list);
184 23
                        CHECK_OBJ_NOTNULL(mi, MEMITEM_MAGIC);
185 23
                        mpl->vsc->pool = --mpl->n_pool;
186 23
                        mpl->vsc->surplus++;
187 23
                        VTAILQ_REMOVE(&mpl->list, mi, list);
188 23
                        mpl_slp = .01;  // random
189 23
                }
190 49332
                if (mi == NULL) {
191 49312
                        mi = VTAILQ_FIRST(&mpl->surplus);
192 49312
                        if (mi != NULL) {
193 1
                                CHECK_OBJ(mi, MEMITEM_MAGIC);
194 1
                                VTAILQ_REMOVE(&mpl->surplus, mi, list);
195 1
                                mpl_slp = .01;  // random
196 1
                        }
197 49312
                }
198 49332
                if (mi == NULL && mpl->n_pool > mpl->param->min_pool) {
199 402
                        mi = VTAILQ_LAST(&mpl->list, memhead_s);
200 402
                        CHECK_OBJ_NOTNULL(mi, MEMITEM_MAGIC);
201 402
                        if (mi->touched + mpl->param->max_age < mpl->t_now) {
202 154
                                mpl->vsc->pool = --mpl->n_pool;
203 154
                                mpl->vsc->timeout++;
204 154
                                VTAILQ_REMOVE(&mpl->list, mi, list);
205 154
                                mpl_slp = .01;  // random
206 154
                        } else {
207 248
                                mi = NULL;
208 248
                                last = mpl->t_now;
209
                        }
210 49332
                } else if (mpl->n_pool <= mpl->param->min_pool) {
211 48915
                        last = mpl->t_now;
212 48915
                }
213
214 49332
                Lck_Unlock(&mpl->mtx);
215
216 49332
                if (mi != NULL) {
217 178
                        CHECK_OBJ(mi, MEMITEM_MAGIC);
218 178
                        FREE_OBJ(mi);
219 178
                }
220
        }
221 4
        return (NULL);
222
}
223
224
/*---------------------------------------------------------------------
225
 * Create a new memory pool, and start the guard thread for it.
226
 */
227
228
struct mempool *
229 4635
MPL_New(const char *name,
230
    volatile struct poolparam *pp, volatile unsigned *cur_size)
231
{
232
        struct mempool *mpl;
233
234 4635
        ALLOC_OBJ(mpl, MEMPOOL_MAGIC);
235 4635
        AN(mpl);
236 4635
        bprintf(mpl->name, "MPL_%s", name);
237 4635
        mpl->param = pp;
238 4635
        mpl->cur_size = cur_size;
239 4635
        VTAILQ_INIT(&mpl->list);
240 4635
        VTAILQ_INIT(&mpl->surplus);
241 4635
        Lck_New(&mpl->mtx, lck_mempool);
242
        /* XXX: prealloc min_pool */
243 4635
        mpl->vsc = VSC_mempool_New(NULL, &mpl->vsc_seg, mpl->name + 4);
244 4635
        AN(mpl->vsc);
245 4635
        PTOK(pthread_create(&mpl->thread, NULL, mpl_guard, mpl));
246 4635
        PTOK(pthread_detach(mpl->thread));
247 4635
        return (mpl);
248
}
249
250
/*---------------------------------------------------------------------
251
 * Destroy a memory pool.  There must be no live items, and we cheat
252
 * and leave all the hard work to the guard thread.
253
 */
254
255
void
256 4
MPL_Destroy(struct mempool **mpp)
257
{
258
        struct mempool *mpl;
259
260 4
        TAKE_OBJ_NOTNULL(mpl, mpp, MEMPOOL_MAGIC);
261 4
        Lck_Lock(&mpl->mtx);
262 4
        AZ(mpl->live);
263 4
        mpl->self_destruct = 1;
264 4
        Lck_Unlock(&mpl->mtx);
265 4
}
266
267
/*---------------------------------------------------------------------
268
 */
269
270
void *
271 7463
MPL_Get(struct mempool *mpl, unsigned *size)
272
{
273
        struct memitem *mi;
274
275 7463
        CHECK_OBJ_NOTNULL(mpl, MEMPOOL_MAGIC);
276 7463
        AN(size);
277
278 7463
        Lck_Lock(&mpl->mtx);
279
280 7463
        mpl->vsc->allocs++;
281 7463
        mpl->vsc->live = ++mpl->live;
282
283 7463
        do {
284 7463
                mi = VTAILQ_FIRST(&mpl->list);
285 7463
                if (mi == NULL) {
286 27
                        mpl->vsc->randry++;
287 27
                        break;
288
                }
289 7436
                mpl->vsc->pool = --mpl->n_pool;
290 7436
                CHECK_OBJ(mi, MEMITEM_MAGIC);
291 7436
                VTAILQ_REMOVE(&mpl->list, mi, list);
292 7436
                if (mi->size < *mpl->cur_size) {
293 1
                        mpl->vsc->toosmall++;
294 1
                        VTAILQ_INSERT_HEAD(&mpl->surplus, mi, list);
295 1
                        mi = NULL;
296 1
                } else {
297 7435
                        mpl->vsc->recycle++;
298
                }
299 7436
        } while (mi == NULL);
300
301 7463
        Lck_Unlock(&mpl->mtx);
302
303 7463
        if (mi == NULL)
304 27
                mi = mpl_alloc(mpl);
305 7463
        *size = mi->size - sizeof *mi;
306
307 7463
        CHECK_OBJ(mi, MEMITEM_MAGIC);
308
        /* Throw away sizeof info for FlexeLint: */
309 7463
        return ((void *)(uintptr_t)(mi + 1));
310
}
311
312
void
313 7426
MPL_Free(struct mempool *mpl, void *item)
314
{
315
        struct memitem *mi;
316
317 7426
        CHECK_OBJ_NOTNULL(mpl, MEMPOOL_MAGIC);
318 7426
        AN(item);
319
320 7426
        mi = (void*)((uintptr_t)item - sizeof(*mi));
321 7426
        CHECK_OBJ_NOTNULL(mi, MEMITEM_MAGIC);
322 7426
        memset(item, 0, mi->size - sizeof *mi);
323
324 7426
        Lck_Lock(&mpl->mtx);
325
326 7426
        mpl->vsc->frees++;
327 7426
        mpl->vsc->live = --mpl->live;
328
329 7426
        if (mi->size < *mpl->cur_size) {
330 0
                mpl->vsc->toosmall++;
331 0
                VTAILQ_INSERT_HEAD(&mpl->surplus, mi, list);
332 0
        } else {
333 7426
                mpl->vsc->pool = ++mpl->n_pool;
334 7426
                mi->touched = mpl->t_now;
335 7426
                VTAILQ_INSERT_HEAD(&mpl->list, mi, list);
336
        }
337
338 7426
        Lck_Unlock(&mpl->mtx);
339 7426
}
340
341
void
342 2998
MPL_AssertSane(const void *item)
343
{
344
        struct memitem *mi;
345 2998
        mi = (void*)((uintptr_t)item - sizeof(*mi));
346 2998
        CHECK_OBJ_NOTNULL(mi, MEMITEM_MAGIC);
347 2998
}