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 11061533
WS_Assert(const struct ws *ws)
43
{
44
45 11061533
        CHECK_OBJ_NOTNULL(ws, WS_MAGIC);
46 11061533
        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 11061533
        assert(ws->s != NULL);
51 11061533
        assert(PAOK(ws->s));
52 11061533
        assert(ws->e != NULL);
53 11061533
        assert(PAOK(ws->e));
54 11061533
        assert(ws->s < ws->e);
55 11061533
        assert(ws->f >= ws->s);
56 11061533
        assert(ws->f <= ws->e);
57 11061533
        assert(PAOK(ws->f));
58 11061533
        if (ws->r) {
59 3642353
                assert(ws->r >= ws->f);
60 3642353
                assert(ws->r <= ws->e);
61 3642353
        }
62 11061533
        assert(*ws->e == WS_REDZONE_END);
63 11061533
}
64
65
int
66 690942
WS_Allocated(const struct ws *ws, const void *ptr, ssize_t len)
67
{
68 690942
        const char *p = ptr;
69
70 690942
        WS_Assert(ws);
71 690942
        if (len < 0)
72 4186
                len = strlen(p) + 1;
73 690942
        assert(!(p > ws->f && p <= ws->e));
74 690942
        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 362802
WS_Init(struct ws *ws, const char *id, void *space, unsigned len)
84
{
85
        unsigned l;
86
87 362802
        DSLb(DBG_WORKSPACE,
88
            "WS_Init(%s, %p, %p, %u)", id, ws, space, len);
89 362802
        assert(space != NULL);
90 362802
        INIT_OBJ(ws, WS_MAGIC);
91 362802
        ws->s = space;
92 362802
        assert(PAOK(space));
93 362802
        l = PRNDDN(len - 1);
94 362802
        ws->e = ws->s + l;
95 362802
        memset(ws->e, WS_REDZONE_END, len - l);
96 362802
        ws->f = ws->s;
97 362802
        assert(id[0] & 0x20);           // cheesy islower()
98 362802
        bstrcpy(ws->id, id);
99 362802
        WS_Assert(ws);
100 362802
}
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 589783
WS_Reset(struct ws *ws, uintptr_t pp)
113
{
114
        char *p;
115
116 589783
        WS_Assert(ws);
117 589783
        AN(pp);
118 589783
        if (pp == snap_overflowed) {
119 13
                DSLb(DBG_WORKSPACE, "WS_Reset(%s, %p, overflowed)", ws->id, ws);
120 13
                AN(WS_Overflowed(ws));
121 13
                return;
122
        }
123 589770
        p = (char *)pp;
124 589770
        DSLb(DBG_WORKSPACE, "WS_Reset(%s, %p, %p)", ws->id, ws, p);
125 589770
        assert(ws->r == NULL);
126 589770
        assert(p >= ws->s);
127 589770
        assert(p <= ws->e);
128 589770
        ws->f = p;
129 589770
        WS_Assert(ws);
130 589783
}
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 109657
WS_Pipeline(struct ws *ws, const void *b, const void *e, unsigned rollback)
139
{
140
        unsigned r, l;
141
142 109657
        WS_Assert(ws);
143
144 109657
        if (rollback)
145 82073
                WS_Rollback(ws, 0);
146
147 109657
        r = WS_ReserveAll(ws);
148
149 109657
        if (b == NULL) {
150 105289
                AZ(e);
151 105289
                return (0);
152
        }
153
154 4368
        AN(e);
155 4368
        l = pdiff(b, e);
156 4368
        if (l > r)
157 0
                return (-1);
158 4368
        memmove(ws->f, b, l);
159 4368
        return (l);
160 109657
}
161
162
void *
163 237762
WS_Alloc(struct ws *ws, unsigned bytes)
164
{
165
        char *r;
166
167 237762
        WS_Assert(ws);
168 237762
        assert(bytes > 0);
169 237762
        bytes = PRNDUP(bytes);
170
171 237762
        assert(ws->r == NULL);
172 237762
        if (ws->f + bytes > ws->e) {
173 4472
                WS_MarkOverflow(ws);
174 4472
                return (NULL);
175
        }
176 233290
        r = ws->f;
177 233290
        ws->f += bytes;
178 233290
        DSLb(DBG_WORKSPACE, "WS_Alloc(%s, %p, %u) = %p", ws->id, ws, bytes, r);
179 233290
        WS_Assert(ws);
180 233290
        return (r);
181 237762
}
182
183
void *
184 220581
WS_Copy(struct ws *ws, const void *str, int len)
185
{
186
        char *r;
187
        unsigned bytes;
188
189 220581
        WS_Assert(ws);
190 220581
        assert(ws->r == NULL);
191
192 220581
        if (len == -1)
193 4783
                len = strlen(str) + 1;
194 220581
        assert(len > 0);
195
196 220581
        bytes = PRNDUP((unsigned)len);
197 220581
        if (ws->f + bytes > ws->e) {
198 52
                WS_MarkOverflow(ws);
199 52
                return (NULL);
200
        }
201 220529
        r = ws->f;
202 220529
        ws->f += bytes;
203 220529
        memcpy(r, str, len);
204 220529
        DSLb(DBG_WORKSPACE, "WS_Copy(%s, %p, %d) = %p", ws->id, ws, len, r);
205 220529
        WS_Assert(ws);
206 220529
        return (r);
207 220581
}
208
209
uintptr_t
210 676497
WS_Snapshot(struct ws *ws)
211
{
212
213 676497
        WS_Assert(ws);
214 676497
        assert(ws->r == NULL);
215 676497
        if (WS_Overflowed(ws)) {
216 39
                DSLb(DBG_WORKSPACE, "WS_Snapshot(%s, %p) = overflowed",
217
                    ws->id, ws);
218 39
                return (snap_overflowed);
219
        }
220 676458
        DSLb(DBG_WORKSPACE, "WS_Snapshot(%s, %p) = %p", ws->id, ws, ws->f);
221 676458
        return ((uintptr_t)ws->f);
222 676497
}
223
224
/*
225
 * WS_Release() must be called in all cases
226
 */
227
unsigned
228 749368
WS_ReserveAll(struct ws *ws)
229
{
230
        unsigned b;
231
232 749368
        WS_Assert(ws);
233 749368
        assert(ws->r == NULL);
234
235 749368
        ws->r = ws->e;
236 749368
        b = pdiff(ws->f, ws->r);
237
238 749368
        WS_Assert(ws);
239 749368
        DSLb(DBG_WORKSPACE, "WS_ReserveAll(%s, %p) = %u", ws->id, ws, b);
240
241 749368
        return (b);
242
}
243
244
/*
245
 * WS_Release() must be called for retval > 0 only
246
 */
247
unsigned
248 202081
WS_ReserveSize(struct ws *ws, unsigned bytes)
249
{
250
        unsigned l;
251
252 202081
        WS_Assert(ws);
253 202081
        assert(ws->r == NULL);
254 202081
        assert(bytes > 0);
255
256 202081
        l = pdiff(ws->f, ws->e);
257 202081
        if (bytes > l) {
258 871
                WS_MarkOverflow(ws);
259 871
                return (0);
260
        }
261 201210
        ws->r = ws->f + bytes;
262 201210
        DSLb(DBG_WORKSPACE, "WS_ReserveSize(%s, %p, %u/%u) = %u", ws->id,
263
            ws, bytes, l, bytes);
264 201210
        WS_Assert(ws);
265 201210
        return (bytes);
266 202081
}
267
268
void
269 774796
WS_Release(struct ws *ws, unsigned bytes)
270
{
271 774796
        WS_Assert(ws);
272 774796
        assert(bytes <= ws->e - ws->f);
273 774796
        DSLb(DBG_WORKSPACE, "WS_Release(%s, %p, %u)", ws->id, ws, bytes);
274 774796
        assert(ws->r != NULL);
275 774796
        assert(ws->f + bytes <= ws->r);
276 774796
        ws->f += PRNDUP(bytes);
277 774796
        ws->r = NULL;
278 774796
        WS_Assert(ws);
279 774796
}
280
281
void
282 175614
WS_ReleaseP(struct ws *ws, const char *ptr)
283
{
284 175614
        WS_Assert(ws);
285 175614
        DSLb(DBG_WORKSPACE, "WS_ReleaseP(%s, %p, %p (%zd))", ws->id, ws, ptr,
286
            ptr - ws->f);
287 175614
        assert(ws->r != NULL);
288 175614
        assert(ptr >= ws->f);
289 175614
        assert(ptr <= ws->r);
290 175614
        ws->f += PRNDUP(ptr - ws->f);
291 175614
        ws->r = NULL;
292 175614
        WS_Assert(ws);
293 175614
}
294
295
void *
296 452009
WS_AtOffset(const struct ws *ws, unsigned off, unsigned len)
297
{
298
        char *ptr;
299
300 452009
        WS_Assert(ws);
301 452009
        ptr = ws->s + off;
302 452009
        AN(WS_Allocated(ws, ptr, len));
303 452009
        return (ptr);
304
}
305
306
unsigned
307 143552
WS_ReservationOffset(const struct ws *ws)
308
{
309
310 143552
        AN(ws->r);
311 143552
        return (ws->f - ws->s);
312
}
313
314
/*--------------------------------------------------------------------*/
315
316
unsigned
317 156
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 156
        WS_Assert(ws);
323 156
        AN(buf);
324 156
        AN(len);
325
326 156
        switch (where) {
327 0
        case 's': p = ws->s; break;
328 156
        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 156
        if (p == NULL) {
336 0
                errno = EAGAIN;
337 0
                return (0);
338
        }
339
340 156
        p += off;
341 156
        if (p >= ws->e) {
342 0
                errno = EFAULT;
343 0
                return (0);
344
        }
345
346 156
        l = pdiff(p, ws->e);
347 156
        if (len <= l) {
348 156
                memcpy(buf, p, len);
349 156
                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 156
}
357
358
/*--------------------------------------------------------------------*/
359
360
static inline void
361 819
ws_printptr(struct vsb *vsb, const char *s, const char *p)
362
{
363 819
        if (p >= s)
364 546
                VSB_printf(vsb, ", +%ld", (long) (p - s));
365
        else
366 273
                VSB_printf(vsb, ", %p", p);
367 819
}
368
369
void
370 494
WS_Panic(struct vsb *vsb, const struct ws *ws)
371
{
372
373 494
        if (PAN_dump_struct(vsb, ws, WS_MAGIC, "ws"))
374 221
                return;
375 273
        if (ws->id[0] != '\0' && (!(ws->id[0] & 0x20))) // cheesy islower()
376 0
                VSB_cat(vsb, "OVERFLOWED ");
377 273
        VSB_printf(vsb, "id = \"%s\",\n", ws->id);
378 273
        VSB_printf(vsb, "{s, f, r, e} = {%p", ws->s);
379 273
        ws_printptr(vsb, ws->s, ws->f);
380 273
        ws_printptr(vsb, ws->s, ws->r);
381 273
        ws_printptr(vsb, ws->s, ws->e);
382 273
        VSB_cat(vsb, "},\n");
383 273
        VSB_indent(vsb, -2);
384 273
        VSB_cat(vsb, "},\n");
385 494
}