varnish-cache/bin/varnishd/cache/cache_ws.c
0
/*-
1
 * Copyright (c) 2006 Verdens Gang AS
2
 * Copyright (c) 2006-2021 Varnish Software AS
3
 * All rights reserved.
4
 *
5
 * Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
6
 * Author: Dridi Boukelmoune <dridi.boukelmoune@gmail.com>
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
 */
32
33
#include "config.h"
34
35
#include "cache_varnishd.h"
36
37
#define WS_REDZONE_END          '\x15'
38
39
static const uintptr_t snap_overflowed = (uintptr_t)&snap_overflowed;
40
41
void
42 4071942
WS_Assert(const struct ws *ws)
43
{
44
45 4071942
        CHECK_OBJ_NOTNULL(ws, WS_MAGIC);
46 4071942
        DSLb(DBG_WORKSPACE, "WS(%s, %p) = {%p %zu %zu %zu}",
47
            ws->id, ws, ws->s, pdiff(ws->s, ws->f),
48
            ws->r == NULL ? 0 : pdiff(ws->f, ws->r),
49
            pdiff(ws->s, ws->e));
50 4071942
        assert(ws->s != NULL);
51 4071942
        assert(PAOK(ws->s));
52 4071942
        assert(ws->e != NULL);
53 4071942
        assert(PAOK(ws->e));
54 4071942
        assert(ws->s < ws->e);
55 4071942
        assert(ws->f >= ws->s);
56 4071942
        assert(ws->f <= ws->e);
57 4071942
        assert(PAOK(ws->f));
58 4071942
        if (ws->r) {
59 1338915
                assert(ws->r >= ws->f);
60 1338915
                assert(ws->r <= ws->e);
61 1338915
        }
62 4071942
        assert(*ws->e == WS_REDZONE_END);
63 4071942
}
64
65
int
66 253944
WS_Allocated(const struct ws *ws, const void *ptr, ssize_t len)
67
{
68 253944
        const char *p = ptr;
69
70 253944
        WS_Assert(ws);
71 253944
        if (len < 0)
72 1480
                len = strlen(p) + 1;
73 253944
        assert(!(p > ws->f && p <= ws->e));
74 253944
        return (p >= ws->s && (p + len) <= ws->f);
75
}
76
77
/*
78
 * NB: The id must be max 3 char and lower-case.
79
 * (upper-case the first char to indicate overflow)
80
 */
81
82
void
83 134649
WS_Init(struct ws *ws, const char *id, void *space, unsigned len)
84
{
85
        unsigned l;
86
87 134649
        DSLb(DBG_WORKSPACE,
88
            "WS_Init(%s, %p, %p, %u)", id, ws, space, len);
89 134649
        assert(space != NULL);
90 134649
        INIT_OBJ(ws, WS_MAGIC);
91 134649
        ws->s = space;
92 134649
        assert(PAOK(space));
93 134649
        l = PRNDDN(len - 1);
94 134649
        ws->e = ws->s + l;
95 134649
        memset(ws->e, WS_REDZONE_END, len - l);
96 134649
        ws->f = ws->s;
97 134649
        assert(id[0] & 0x20);           // cheesy islower()
98 134649
        bstrcpy(ws->id, id);
99 134649
        WS_Assert(ws);
100 134649
}
101
102
/*
103
 * Reset a WS to a cookie from WS_Snapshot
104
 *
105
 * for use by any code using cache.h
106
 *
107
 * does not reset the overflow bit and asserts that, if WS_Snapshot had found
108
 * the workspace overflown, the marker is intact
109
 */
110
111
void
112 217952
WS_Reset(struct ws *ws, uintptr_t pp)
113
{
114
        char *p;
115
116 217952
        WS_Assert(ws);
117 217952
        AN(pp);
118 217952
        if (pp == snap_overflowed) {
119 5
                DSLb(DBG_WORKSPACE, "WS_Reset(%s, %p, overflowed)", ws->id, ws);
120 5
                AN(WS_Overflowed(ws));
121 5
                return;
122
        }
123 217947
        p = (char *)pp;
124 217947
        DSLb(DBG_WORKSPACE, "WS_Reset(%s, %p, %p)", ws->id, ws, p);
125 217947
        assert(ws->r == NULL);
126 217947
        assert(p >= ws->s);
127 217947
        assert(p <= ws->e);
128 217947
        ws->f = p;
129 217947
        WS_Assert(ws);
130 217952
}
131
132
/*
133
 * Make a reservation and optionally pipeline a memory region that may or
134
 * may not originate from the same workspace.
135
 */
136
137
int
138 40328
WS_Pipeline(struct ws *ws, const void *b, const void *e, unsigned rollback)
139
{
140
        unsigned r, l;
141
142 40328
        WS_Assert(ws);
143
144 40328
        if (rollback)
145 30093
                WS_Rollback(ws, 0);
146
147 40328
        r = WS_ReserveAll(ws);
148
149 40328
        if (b == NULL) {
150 38677
                AZ(e);
151 38677
                return (0);
152
        }
153
154 1651
        AN(e);
155 1651
        l = pdiff(b, e);
156 1651
        if (l > r)
157 0
                return (-1);
158 1651
        memmove(ws->f, b, l);
159 1651
        return (l);
160 40328
}
161
162
void *
163 87832
WS_Alloc(struct ws *ws, unsigned bytes)
164
{
165
        char *r;
166
167 87832
        WS_Assert(ws);
168 87832
        assert(bytes > 0);
169 87832
        bytes = PRNDUP(bytes);
170
171 87832
        assert(ws->r == NULL);
172 87832
        if (ws->f + bytes > ws->e) {
173 1720
                WS_MarkOverflow(ws);
174 1720
                return (NULL);
175
        }
176 86112
        r = ws->f;
177 86112
        ws->f += bytes;
178 86112
        DSLb(DBG_WORKSPACE, "WS_Alloc(%s, %p, %u) = %p", ws->id, ws, bytes, r);
179 86112
        WS_Assert(ws);
180 86112
        return (r);
181 87832
}
182
183
void *
184 81559
WS_Copy(struct ws *ws, const void *str, int len)
185
{
186
        char *r;
187
        unsigned bytes;
188
189 81559
        WS_Assert(ws);
190 81559
        assert(ws->r == NULL);
191
192 81559
        if (len == -1)
193 1554
                len = strlen(str) + 1;
194 81559
        assert(len > 0);
195
196 81559
        bytes = PRNDUP((unsigned)len);
197 81559
        if (ws->f + bytes > ws->e) {
198 20
                WS_MarkOverflow(ws);
199 20
                return (NULL);
200
        }
201 81539
        r = ws->f;
202 81539
        ws->f += bytes;
203 81539
        memcpy(r, str, len);
204 81539
        DSLb(DBG_WORKSPACE, "WS_Copy(%s, %p, %d) = %p", ws->id, ws, len, r);
205 81539
        WS_Assert(ws);
206 81539
        return (r);
207 81559
}
208
209
uintptr_t
210 248760
WS_Snapshot(struct ws *ws)
211
{
212
213 248760
        WS_Assert(ws);
214 248760
        assert(ws->r == NULL);
215 248760
        if (WS_Overflowed(ws)) {
216 15
                DSLb(DBG_WORKSPACE, "WS_Snapshot(%s, %p) = overflowed",
217
                    ws->id, ws);
218 15
                return (snap_overflowed);
219
        }
220 248745
        DSLb(DBG_WORKSPACE, "WS_Snapshot(%s, %p) = %p", ws->id, ws, ws->f);
221 248745
        return ((uintptr_t)ws->f);
222 248760
}
223
224
/*
225
 * WS_Release() must be called in all cases
226
 */
227
unsigned
228 275253
WS_ReserveAll(struct ws *ws)
229
{
230
        unsigned b;
231
232 275253
        WS_Assert(ws);
233 275253
        assert(ws->r == NULL);
234
235 275253
        ws->r = ws->e;
236 275253
        b = pdiff(ws->f, ws->r);
237
238 275253
        WS_Assert(ws);
239 275253
        DSLb(DBG_WORKSPACE, "WS_ReserveAll(%s, %p) = %u", ws->id, ws, b);
240
241 275253
        return (b);
242
}
243
244
/*
245
 * WS_Release() must be called for retval > 0 only
246
 */
247
unsigned
248 74654
WS_ReserveSize(struct ws *ws, unsigned bytes)
249
{
250
        unsigned l;
251
252 74654
        WS_Assert(ws);
253 74654
        assert(ws->r == NULL);
254 74654
        assert(bytes > 0);
255
256 74654
        l = pdiff(ws->f, ws->e);
257 74654
        if (bytes > l) {
258 335
                WS_MarkOverflow(ws);
259 335
                return (0);
260
        }
261 74319
        ws->r = ws->f + bytes;
262 74319
        DSLb(DBG_WORKSPACE, "WS_ReserveSize(%s, %p, %u/%u) = %u", ws->id,
263
            ws, bytes, l, bytes);
264 74319
        WS_Assert(ws);
265 74319
        return (bytes);
266 74654
}
267
268
void
269 285309
WS_Release(struct ws *ws, unsigned bytes)
270
{
271 285309
        WS_Assert(ws);
272 285309
        assert(bytes <= ws->e - ws->f);
273 285309
        DSLb(DBG_WORKSPACE, "WS_Release(%s, %p, %u)", ws->id, ws, bytes);
274 285309
        assert(ws->r != NULL);
275 285309
        assert(ws->f + bytes <= ws->r);
276 285309
        ws->f += PRNDUP(bytes);
277 285309
        ws->r = NULL;
278 285309
        WS_Assert(ws);
279 285309
}
280
281
void
282 64209
WS_ReleaseP(struct ws *ws, const char *ptr)
283
{
284 64209
        WS_Assert(ws);
285 64209
        DSLb(DBG_WORKSPACE, "WS_ReleaseP(%s, %p, %p (%zd))", ws->id, ws, ptr,
286
            ptr - ws->f);
287 64209
        assert(ws->r != NULL);
288 64209
        assert(ptr >= ws->f);
289 64209
        assert(ptr <= ws->r);
290 64209
        ws->f += PRNDUP(ptr - ws->f);
291 64209
        ws->r = NULL;
292 64209
        WS_Assert(ws);
293 64209
}
294
295
void *
296 165499
WS_AtOffset(const struct ws *ws, unsigned off, unsigned len)
297
{
298
        char *ptr;
299
300 165499
        WS_Assert(ws);
301 165499
        ptr = ws->s + off;
302 165499
        AN(WS_Allocated(ws, ptr, len));
303 165499
        return (ptr);
304
}
305
306
unsigned
307 52924
WS_ReservationOffset(const struct ws *ws)
308
{
309
310 52924
        AN(ws->r);
311 52924
        return (ws->f - ws->s);
312
}
313
314
/*--------------------------------------------------------------------*/
315
316
unsigned
317 60
WS_Dump(const struct ws *ws, char where, size_t off, void *buf, size_t len)
318
{
319
        char *b, *p;
320
        size_t l;
321
322 60
        WS_Assert(ws);
323 60
        AN(buf);
324 60
        AN(len);
325
326 60
        switch (where) {
327 0
        case 's': p = ws->s; break;
328 60
        case 'f': p = ws->f; break;
329 0
        case 'r': p = ws->r; break;
330
        default:
331 0
                errno = EINVAL;
332 0
                return (0);
333
        }
334
335 60
        if (p == NULL) {
336 0
                errno = EAGAIN;
337 0
                return (0);
338
        }
339
340 60
        p += off;
341 60
        if (p >= ws->e) {
342 0
                errno = EFAULT;
343 0
                return (0);
344
        }
345
346 60
        l = pdiff(p, ws->e);
347 60
        if (len <= l) {
348 60
                memcpy(buf, p, len);
349 60
                return (len);
350
        }
351
352 0
        b = buf;
353 0
        memcpy(b, p, l);
354 0
        memset(b + l, WS_REDZONE_END, len - l);
355 0
        return (l);
356 60
}
357
358
/*--------------------------------------------------------------------*/
359
360
static inline void
361 315
ws_printptr(struct vsb *vsb, const char *s, const char *p)
362
{
363 315
        if (p >= s)
364 210
                VSB_printf(vsb, ", +%ld", (long) (p - s));
365
        else
366 105
                VSB_printf(vsb, ", %p", p);
367 315
}
368
369
void
370 190
WS_Panic(struct vsb *vsb, const struct ws *ws)
371
{
372
373 190
        if (PAN_dump_struct(vsb, ws, WS_MAGIC, "ws"))
374 85
                return;
375 105
        if (ws->id[0] != '\0' && (!(ws->id[0] & 0x20))) // cheesy islower()
376 0
                VSB_cat(vsb, "OVERFLOWED ");
377 105
        VSB_printf(vsb, "id = \"%s\",\n", ws->id);
378 105
        VSB_printf(vsb, "{s, f, r, e} = {%p", ws->s);
379 105
        ws_printptr(vsb, ws->s, ws->f);
380 105
        ws_printptr(vsb, ws->s, ws->r);
381 105
        ws_printptr(vsb, ws->s, ws->e);
382 105
        VSB_cat(vsb, "},\n");
383 105
        VSB_indent(vsb, -2);
384 105
        VSB_cat(vsb, "},\n");
385 190
}