Code Coverage: vinyl-cache/bin/vinyld/cache/cache_int.h
 
82217aa4fc7094b3610340078afaf78cd95a8ec9
 
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
 *
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
 * Stuff that should *never* be exposed to a VMOD
31
 */
32
33
#include "cache.h"
34
35
#include "vsb.h"
36
37
#include <sys/socket.h>
38
39
#include <string.h>
40
#include <limits.h>
41
#include <unistd.h>
42
43
#include "common/common_param.h"
44
45
#ifdef NOT_IN_A_VMOD
46
#  include "VSC_main.h"
47
#endif
48
49
/*--------------------------------------------------------------------*/
50
51
struct vfp;
52
struct vdp;
53
struct cli_proto;
54
struct poolparam;
55
56
/*--------------------------------------------------------------------*/
57
58
typedef enum req_fsm_nxt req_state_f(struct worker *, struct req *);
59
struct req_step {
60
        const char      *name;
61
        req_state_f     *func;
62
};
63
64
extern const struct req_step R_STP_TRANSPORT[1];
65
extern const struct req_step R_STP_RECV[1];
66
67
struct vxid_pool {
68
        uint64_t                next;
69
        uint32_t                count;
70
};
71
72
/*--------------------------------------------------------------------
73
 * Private part of worker threads
74
 */
75
76
struct worker_priv {
77
        unsigned                magic;
78
#define WORKER_PRIV_MAGIC       0x3047db99
79
        struct objhead          *nobjhead;
80
        struct objcore          *nobjcore;
81
        void                    *nhashpriv;
82
        struct vxid_pool        vxid_pool[1];
83
        struct vcl              *vcl;
84
};
85
86
/*--------------------------------------------------------------------
87
 * HTTP Protocol connection structure
88
 *
89
 * This is the protocol independent object for a HTTP connection, used
90
 * both for backend and client sides.
91
 *
92
 */
93
94
struct http_conn {
95
        unsigned                magic;
96
#define HTTP_CONN_MAGIC         0x3e19edd1
97
98
        int                     *rfd;
99
        stream_close_t          doclose;
100
        body_status_t           body_status;
101
        struct ws               *ws;
102
        char                    *rxbuf_b;
103
        char                    *rxbuf_e;
104
        char                    *pipeline_b;
105
        char                    *pipeline_e;
106
        ssize_t                 content_length;
107
        void                    *priv;
108
109
        /* Timeouts */
110
        vtim_dur                first_byte_timeout;
111
        vtim_dur                between_bytes_timeout;
112
};
113
114
enum htc_status_e {
115
#define HTC_STATUS(e, n, s, l) HTC_S_ ## e = n,
116
#include "tbl/htc.h"
117
};
118
119
typedef enum htc_status_e htc_complete_f(struct http_conn *);
120
121
/* -------------------------------------------------------------------*/
122
123
extern volatile struct params * cache_param;
124
125
/* -------------------------------------------------------------------
126
 * The VCF facility is deliberately undocumented, use at your peril.
127
 */
128
129
struct vcf_return {
130
        const char              *name;
131
};
132
133
#define VCF_RETURNS()   \
134
                VCF_RETURN(CONTINUE) \
135
                VCF_RETURN(DEFAULT) \
136
                VCF_RETURN(MISS) \
137
                VCF_RETURN(HIT)
138
139
#define VCF_RETURN(x) extern const struct vcf_return VCF_##x[1];
140
VCF_RETURNS()
141
#undef VCF_RETURN
142
143
typedef const struct vcf_return *vcf_func_f(
144
        struct req *req,
145
        struct objcore **oc,
146
        struct objcore **oc_exp,
147
        int state);
148
149
struct vcf {
150
        unsigned                magic;
151
#define VCF_MAGIC               0x183285d1
152
        vcf_func_f              *func;
153
        void                    *priv;
154
};
155
156
/* Prototypes etc ----------------------------------------------------*/
157
158
/* cache_backend_cfg.c */
159
void VBE_InitCfg(void);
160
161
/* cache_ban.c */
162
163
/* for stevedoes resurrecting bans */
164
void BAN_Hold(void);
165
void BAN_Release(void);
166
void BAN_Reload(const uint8_t *ban, unsigned len);
167
struct ban *BAN_FindBan(vtim_real t0);
168
void BAN_RefBan(struct objcore *oc, struct ban *);
169
vtim_real BAN_Time(const struct ban *ban);
170
171
/* cache_busyobj.c */
172
struct busyobj *VBO_GetBusyObj(const struct worker *, const struct req *);
173
void VBO_ReleaseBusyObj(struct worker *wrk, struct busyobj **busyobj);
174
void VBO_SetState(struct worker *wrk, struct busyobj *bo,
175
    enum boc_state_e next);
176
177
/* cache_director.c */
178
int VDI_GetHdr(struct busyobj *);
179
VCL_IP VDI_GetIP(struct busyobj *);
180
void VDI_Finish(struct busyobj *bo);
181
stream_close_t VDI_Http1Pipe(struct req *, struct busyobj *);
182
void VDI_Panic(const struct director *, struct vsb *, const char *nm);
183
void VDI_Event(const struct director *d, enum vcl_event_e ev);
184
void VDI_Init(void);
185
186
/* cache_deliver_proc.c */
187
void VDP_Fini(const struct vdp_ctx *vdc);
188
void VDP_Init(struct vdp_ctx *vdc, struct worker *wrk, struct vsl_log *vsl,
189
    const struct req *req, const struct busyobj *bo, intmax_t *cl);
190
uint64_t VDP_Close(struct vdp_ctx *, struct objcore *, struct boc *);
191
void VDP_Panic(struct vsb *vsb, const struct vdp_ctx *vdc);
192
int VDP_Push(VRT_CTX, struct vdp_ctx *, struct ws *, const struct vdp *,
193
    void *priv);
194
int VDP_ObjIterate(void *priv, unsigned flush, const void *ptr, ssize_t len);
195
int VDP_DeliverObj(struct vdp_ctx *vdc, struct objcore *oc);
196
extern const struct vdp VDP_gunzip;
197
extern const struct vdp VDP_esi;
198
extern const struct vdp VDP_range;
199
200
uint64_t VDPIO_Close(struct vdp_ctx *, struct objcore *, struct boc *);
201
int VDPIO_Upgrade(VRT_CTX, struct vdp_ctx *vdc);
202
int VDPIO_Push(VRT_CTX, struct vdp_ctx *, struct ws *, const struct vdp *,
203
    void *priv);
204
205
206
/* cache_exp.c */
207
vtim_real EXP_Ttl(const struct req *, const struct objcore *);
208
vtim_real EXP_Ttl_grace(const struct req *, const struct objcore *oc);
209
void EXP_RefNewObjcore(struct objcore *);
210
void EXP_Insert(struct worker *wrk, struct objcore *oc);
211
void EXP_Remove(struct objcore *, const struct objcore *);
212
213 2222
#define EXP_Dttl(req, oc) (oc->ttl - (req->t_req - oc->t_origin))
214
215
/* cache_expire.c */
216
217
/*
218
 * The set of variables which control object expiry are inconveniently
219
 * 24 bytes long (double+3*float) and this causes alignment waste if
220
 * we put then in a struct.
221
 * These three macros operate on the struct we don't use.
222
 */
223
224
#define EXP_ZERO(xx)                                                    \
225 23
        do {                                                            \
226 23
                (xx)->t_origin = 0.0;                                   \
227 23
                (xx)->ttl = 0.0;                                        \
228 23
                (xx)->grace = 0.0;                                      \
229 23
                (xx)->keep = 0.0;                                       \
230 23
        } while (0)
231
232
#define EXP_COPY(to,fm)                                                 \
233 105
        do {                                                            \
234 105
                (to)->t_origin = (fm)->t_origin;                        \
235 105
                (to)->ttl = (fm)->ttl;                                  \
236 105
                (to)->grace = (fm)->grace;                              \
237 105
                (to)->keep = (fm)->keep;                                \
238 105
        } while (0)
239
240
#define EXP_WHEN(to)                                                    \
241 1530
        ((to)->t_origin + (to)->ttl + (to)->grace + (to)->keep)
242
243
/* cache_exp.c */
244
void EXP_Rearm(struct objcore *oc, vtim_real now,
245
    vtim_dur ttl, vtim_dur grace, vtim_dur keep);
246
void EXP_Reduce(struct objcore *oc, vtim_real now,
247
    vtim_dur ttl, vtim_dur grace, vtim_dur keep);
248
249
/* From cache_main.c */
250
void BAN_Init(void);
251
void BAN_Compile(void);
252
void BAN_Shutdown(void);
253
254
/* From cache_hash.c */
255
void BAN_NewObjCore(struct objcore *oc);
256
void BAN_DestroyObj(struct objcore *oc);
257
int BAN_CheckObject(struct worker *, struct objcore *, struct req *);
258
259
/* cache_busyobj.c */
260
void VBO_Init(void);
261
262
/* cache_cli.c [CLI] */
263
void CLI_Init(void);
264
void CLI_Run(void);
265
void CLI_AddFuncs(struct cli_proto *p);
266
267
/* cache_expire.c */
268
void EXP_Init(void);
269
void EXP_Shutdown(void);
270
271
/* cache_fetch.c */
272
enum vbf_fetch_mode_e {
273
        VBF_NORMAL = 0,
274
        VBF_PASS = 1,
275
        VBF_BACKGROUND = 2,
276
};
277
void VBF_Fetch(struct worker *wrk, struct req *req,
278
    struct objcore *oc, struct objcore *oldoc, enum vbf_fetch_mode_e);
279
const char *VBF_Get_Filter_List(struct busyobj *);
280
void Bereq_Rollback(VRT_CTX);
281
282
/* cache_fetch_proc.c */
283
struct vfp_entry *VFP_Push(struct vfp_ctx *, const struct vfp *);
284
enum vfp_status VFP_GetStorage(struct vfp_ctx *, ssize_t *sz, uint8_t **ptr);
285
void VFP_Extend(const struct vfp_ctx *, ssize_t sz, enum vfp_status);
286
void VFP_Setup(struct vfp_ctx *vc, struct worker *wrk);
287
int VFP_Open(VRT_CTX, struct vfp_ctx *);
288
uint64_t VFP_Close(struct vfp_ctx *);
289
290
extern const struct vfp VFP_gunzip;
291
extern const struct vfp VFP_gzip;
292
extern const struct vfp VFP_testgunzip;
293
extern const struct vfp VFP_esi;
294
extern const struct vfp VFP_esi_gzip;
295
296
/* cache_http.c */
297
void HTTP_Init(void);
298
299
/* cache_http1_proto.c */
300
301
htc_complete_f HTTP1_Complete;
302
uint16_t HTTP1_DissectRequest(struct http_conn *, struct http *);
303
uint16_t HTTP1_DissectResponse(struct http_conn *, struct http *resp,
304
    const struct http *req);
305
struct v1l;
306
unsigned HTTP1_Write(struct v1l *v1l, const struct http *hp, const int*);
307
308
/* cache_main.c */
309
vxid_t VXID_Get(const struct worker *, uint64_t marker);
310
extern pthread_key_t panic_key;
311
#ifdef ENABLE_WITNESS
312
extern pthread_key_t witness_key;
313
#endif
314
315
void THR_SetName(const char *name);
316
const char* THR_GetName(void);
317
void THR_SetBusyobj(const struct busyobj *);
318
struct busyobj * THR_GetBusyobj(void);
319
void THR_SetRequest(const struct req *);
320
struct req * THR_GetRequest(void);
321
void THR_SetWorker(const struct worker *);
322
struct worker * THR_GetWorker(void);
323
void THR_Init(void);
324
325
/* cache_lck.c */
326
void LCK_Init(void);
327
328
/* cache_mempool.c */
329
void MPL_AssertSane(const void *item);
330
struct mempool * MPL_New(const char *name, volatile struct poolparam *pp,
331
    volatile unsigned *cur_size);
332
void MPL_Destroy(struct mempool **mpp);
333
void *MPL_Get(struct mempool *mpl, unsigned *size);
334
void MPL_Free(struct mempool *mpl, void *item);
335
336
/* cache_obj.c */
337
void ObjInit(void);
338
struct objcore * ObjNew(const struct worker *);
339
void ObjDestroy(const struct worker *, struct objcore **);
340
int ObjGetSpace(struct worker *, struct objcore *, ssize_t *sz, uint8_t **ptr);
341
void ObjExtend(struct worker *, struct objcore *, ssize_t l, int final);
342
uint64_t ObjWaitExtend(const struct worker *, const struct objcore *,
343
    uint64_t l, enum boc_state_e *statep);
344
void ObjSetState(struct worker *, struct objcore *, enum boc_state_e next,
345
    unsigned broadcast);
346
enum boc_state_e ObjWaitState(const struct objcore *, enum boc_state_e want);
347
void ObjTouch(struct worker *, struct objcore *, vtim_real now);
348
void ObjFreeObj(struct worker *, struct objcore *);
349
void ObjSlim(struct worker *, struct objcore *);
350
void *ObjSetAttr(struct worker *, struct objcore *, enum obj_attr,
351
    ssize_t len, const void *);
352
int ObjCopyAttr(struct worker *, struct objcore *, struct objcore *,
353
    enum obj_attr attr);
354
void ObjBocDone(struct worker *, struct objcore *, struct boc **);
355
// VAI
356
uint64_t ObjVAIGetExtend(struct worker *, const struct objcore *, uint64_t,
357
    enum boc_state_e *, struct vai_qe *);
358
void ObjVAICancel(struct worker *, struct boc *, struct vai_qe *);
359
360
int ObjSetDouble(struct worker *, struct objcore *, enum obj_attr, double);
361
int ObjSetU64(struct worker *, struct objcore *, enum obj_attr, uint64_t);
362
int ObjSetXID(struct worker *, struct objcore *, vxid_t);
363
364
void ObjSetFlag(struct worker *, struct objcore *, enum obj_flags of, int val);
365
366
void ObjSendEvent(struct worker *, struct objcore *oc, unsigned event);
367
368 1692
#define OEV_INSERT      (1U<<1)
369 159
#define OEV_BANCHG      (1U<<2)
370 1618
#define OEV_TTLCHG      (1U<<3)
371 423
#define OEV_EXPIRE      (1U<<4)
372
373
#define OEV_MASK (OEV_INSERT|OEV_BANCHG|OEV_TTLCHG|OEV_EXPIRE)
374
375
typedef void obj_event_f(struct worker *, void *priv, struct objcore *,
376
    unsigned);
377
378
uintptr_t ObjSubscribeEvents(obj_event_f *, void *, unsigned mask);
379
void ObjUnsubscribeEvents(uintptr_t *);
380
381
/* cache_panic.c */
382
void PAN_Init(void);
383
int PAN__DumpStruct(struct vsb *vsb, int block, int track, const void *ptr,
384
    const char *smagic, unsigned magic, const char *fmt, ...)
385
    v_printflike_(7,8);
386
387
#define PAN_CheckMagic(vsb, ptr, exp)                                   \
388 14
        do {                                                            \
389 14
                if ((ptr)->magic != (exp))                              \
390 14
                        VSB_printf((vsb),                               \
391 0
                            "MAGIC at %p is 0x%08x (Should be: %s/0x%08x)\n", \
392 0
                            ptr, (ptr)->magic, #exp, exp);              \
393 14
        } while(0)
394
395
#define PAN_dump_struct(vsb, ptr, magic, ...)           \
396 199
    PAN__DumpStruct(vsb, 1, 1, ptr, #magic, magic, __VA_ARGS__)
397
398
#define PAN_dump_oneline(vsb, ptr, magic, ...)          \
399 3
    PAN__DumpStruct(vsb, 0, 1, ptr, #magic, magic, __VA_ARGS__)
400
401
#define PAN_dump_once(vsb, ptr, magic, ...)             \
402 0
    PAN__DumpStruct(vsb, 1, 0, ptr, #magic, magic, __VA_ARGS__)
403
404
#define PAN_dump_once_oneline(vsb, ptr, magic, ...)             \
405 0
    PAN__DumpStruct(vsb, 0, 0, ptr, #magic, magic, __VA_ARGS__)
406
407
/* cache_pool.c */
408
void Pool_Sumstat(const struct worker *w);
409
int Pool_TrySumstat(const struct worker *wrk);
410
int Pool_Task_Any(struct pool_task *task, enum task_prio prio);
411
void Pool_PurgeStat(unsigned nobj);
412
void pan_pool(struct vsb *);
413
void Pool_Init(void);
414
void Pool_Stop(void);
415
void Pool_Fini(void);
416
417
/* cache_range.c */
418
int VRG_CheckBo(struct busyobj *);
419
420
/* cache_req.c */
421
struct req *Req_New(struct sess *, const struct req *);
422
void Req_Release(struct req *);
423
void Req_Rollback(VRT_CTX);
424
void Req_Cleanup(struct sess *sp, struct worker *wrk, struct req *req);
425
void Req_Fail(struct req *req, stream_close_t reason);
426
void Req_AcctLogCharge(struct VSC_main_wrk *, struct req *);
427
void Req_LogHit(struct worker *, struct req *, struct objcore *, intmax_t);
428
const char *Req_LogStart(const struct worker *, struct req *);
429
void Req_StashObjcore(const struct req *, struct objcore **);
430
int Resp_l_storage(struct req *req, const struct stevedore *stv);
431
void Resp_u_storage(struct req *req);
432
433
/* cache_req_body.c */
434
int VRB_Ignore(struct req *);
435
ssize_t VRB_Cache(struct req *, ssize_t maxsize);
436
void VRB_Free(struct req *);
437
438
/* cache_req_fsm.c [CNT] */
439
440
int Resp_Setup_Deliver(struct req *);
441
void Resp_Setup_Synth(struct req *);
442
443
enum req_fsm_nxt {
444
        REQ_FSM_MORE,
445
        REQ_FSM_DONE,
446
        REQ_FSM_DISEMBARK,
447
};
448
449
void CNT_Embark(struct worker *, struct req *);
450
enum req_fsm_nxt CNT_Request(struct req *);
451
452
/* cache_session.c */
453
void SES_NewPool(struct pool *, unsigned pool_no);
454
void SES_DestroyPool(struct pool *);
455
void SES_Wait(struct sess *, const struct transport *);
456
void SES_Ref(struct sess *sp);
457
void SES_Rel(struct sess *sp);
458
459
void HTC_Status(enum htc_status_e, const char **, const char **);
460
void HTC_RxInit(struct http_conn *htc, struct ws *ws);
461
void HTC_RxPipeline(struct http_conn *htc, char *);
462
enum htc_status_e HTC_RxStuff(struct http_conn *, htc_complete_f *,
463
    vtim_real *t1, vtim_real *t2, vtim_real ti, vtim_real tn, vtim_dur td,
464
    int maxbytes);
465
466
#define SESS_ATTR(UP, low, typ, len)                                    \
467
        int SES_Set_##low(const struct sess *sp, const typ *src);       \
468
        int SES_Reserve_##low(struct sess *sp, typ **dst, ssize_t *sz);
469
#include "tbl/sess_attr.h"
470
int SES_Set_String_Attr(struct sess *sp, enum sess_attr a, const char *src);
471
472
/* cache_shmlog.c */
473
extern struct VSC_main *VSC_C_main;
474
void VSM_Init(void);
475
void VSL_Init(struct vsl_log *vsl, void *ptr, size_t len);
476
void VSL_Alloc(struct vsl_log *vsl);
477
void VSL_Free(struct vsl_log *vsl);
478
void VSL_ChgId(struct vsl_log *vsl, const char *typ, const char *why,
479
    vxid_t vxid);
480
void VSL_End(struct vsl_log *vsl);
481
void VSL_Flush(struct vsl_log *, int overflow);
482
483
/* cache_conn_pool.c */
484
struct conn_pool;
485
void VCP_Init(void);
486
void VCP_Panic(struct vsb *, struct conn_pool *);
487
void VCP_RelPoll(void);
488
489
/* cache_backend_probe.c */
490
void VBP_Init(void);
491
492
/* cache_vary.c */
493
int VRY_Create(struct busyobj *bo, struct vsb **psb);
494
int VRY_Match(const struct req *, const uint8_t *vary);
495
void VRY_Prep(struct req *);
496
void VRY_Clear(struct req *);
497
enum vry_finish_flag { KEEP, DISCARD };
498
void VRY_Finish(struct req *req, enum vry_finish_flag);
499
500
/* cache_vcl.c */
501
void VCL_Bo2Ctx(struct vrt_ctx *, struct busyobj *);
502
void VCL_Req2Ctx(struct vrt_ctx *, struct req *);
503
struct vrt_ctx *VCL_Get_CliCtx(int);
504
struct vsb *VCL_Rel_CliCtx(struct vrt_ctx **);
505
void VCL_Panic(struct vsb *, const char *nm, const struct vcl *);
506
void VCL_Poll(void);
507
void VCL_Init(void);
508
void VCL_Shutdown(void);
509
510
#define VCL_MET_MAC(l,u,t,b) \
511
    void VCL_##l##_method(struct vcl *, struct worker *, struct req *, \
512
        struct busyobj *bo, void *specific);
513
#include "tbl/vcl_returns.h"
514
515
516
typedef int vcl_be_func(struct cli *, struct director *, void *);
517
518
int VCL_IterDirector(struct cli *, const char *, vcl_be_func *, void *);
519
520
/* cache_vrt.c */
521
void pan_privs(struct vsb *, const struct vrt_privs *);
522
523
/* cache_vrt_filter.c */
524
int VCL_StackVFP(struct vfp_ctx *, const struct vcl *, const char *);
525
int VCL_StackVDP(struct vdp_ctx *vdc, const struct vcl *vcl, const char *fl,
526
    struct req *req, struct busyobj *bo);
527
const char *resp_Get_Filter_List(struct req *req);
528
void VCL_VRT_Init(void);
529
530
/* cache_vrt_vcl.c */
531
const char *VCL_Return_Name(unsigned);
532
const char *VCL_Method_Name(unsigned);
533
void VCL_Refresh(struct vcl **);
534
void VCL_Recache(const struct worker *, struct vcl **);
535
void VCL_Ref(struct vcl *);
536
void VCL_Rel(struct vcl **);
537
VCL_BACKEND VCL_DefaultDirector(const struct vcl *);
538
const struct vrt_backend_probe *VCL_DefaultProbe(const struct vcl *);
539
540
/* cache_vrt_priv.c */
541
extern struct vrt_privs cli_task_privs[1];
542
void VCL_TaskEnter(struct vrt_privs *);
543
void VCL_TaskLeave(VRT_CTX, struct vrt_privs *);
544
545
/* cache_vrt_vmod.c */
546
void VMOD_Init(void);
547
void VMOD_Panic(struct vsb *);
548
549
#if defined(ENABLE_COVERAGE) || defined(ENABLE_SANITIZER)
550
#  define DONT_DLCLOSE_VMODS
551
#endif
552
553
/* cache_wrk.c */
554
void WRK_Cleanup(const struct worker *);
555
void WRK_Init(void);
556
void WRK_AddStat(const struct worker *);
557
void WRK_Log(enum VSL_tag_e, const char *, ...);
558
int Pool_Task(struct pool *pp, struct pool_task *task, enum task_prio prio);
559
int Pool_Task_Arg(struct worker *, enum task_prio, task_func_t *,
560
    const void *arg, size_t arg_len);
561
562
/* cache_vpi.c */
563
extern const size_t vpi_wrk_len;
564
void VPI_wrk_init(struct worker *, void *, size_t);
565
void VPI_Panic(struct vsb *, const struct wrk_vpi *, const struct vcl *);
566
567
/* cache_ws.c */
568
void WS_Panic(struct vsb *, const struct ws *);
569
static inline int
570
WS_IsReserved(const struct ws *ws)
571 35191
{
572
573 35191
        return (ws->r != NULL);
574 35191
}
575
576
void *WS_AtOffset(const struct ws *ws, unsigned off, unsigned len);
577
unsigned WS_ReservationOffset(const struct ws *ws);
578
int WS_Pipeline(struct ws *, const void *b, const void *e, unsigned rollback);
579
580
/* cache_ws_common.c */
581
void WS_Id(const struct ws *ws, char *id);
582
void WS_Rollback(struct ws *, uintptr_t);
583
584
/* http1/cache_http1_pipe.c */
585
void V1P_Init(void);
586
587
/* cache_http2_deliver.c */
588
void V2D_Init(void);
589
590
/* stevedore.c */
591
void STV_open(void);
592
void STV_warn(void);
593
void STV_close(void);
594
const struct stevedore *STV_next(void);
595
int STV_BanInfoDrop(const uint8_t *ban, unsigned len);
596
int STV_BanInfoNew(const uint8_t *ban, unsigned len);
597
void STV_BanExport(const uint8_t *banlist, unsigned len);
598
// STV_NewObject() len is space for OBJ_VARATTR
599
int STV_NewObject(struct worker *, struct objcore *,
600
    const struct stevedore *, unsigned len);
601
602
struct stv_buffer;
603
struct stv_buffer *STV_AllocBuf(struct worker *wrk, const struct stevedore *stv,
604
    size_t size);
605
void STV_FreeBuf(struct worker *wrk, struct stv_buffer **pstvbuf);
606
void *STV_GetBufPtr(struct stv_buffer *stvbuf, size_t *psize);
607
608
#ifdef WITH_PERSISTENT_STORAGE
609
/* storage_persistent.c */
610
void SMP_Ready(void);
611
#endif
612
613 105411
#define FEATURE(x)      COM_FEATURE(cache_param->feature_bits, x)
614
#define EXPERIMENT(x)   COM_EXPERIMENT(cache_param->experimental_bits, x)
615 4236984
#define DO_DEBUG(x)     COM_DO_DEBUG(cache_param->debug_bits, x)
616
617
#define DSL(debug_bit, id, ...)                                 \
618 60
        do {                                                    \
619 60
                if (DO_DEBUG(debug_bit))                        \
620 60
                        VSL(SLT_Debug, (id), __VA_ARGS__);      \
621 60
        } while (0)
622
623
#define DSLb(debug_bit, ...)                                    \
624 1839359
        do {                                                    \
625 1839359
                if (DO_DEBUG(debug_bit))                        \
626 1839359
                        WRK_Log(SLT_Debug, __VA_ARGS__);        \
627 1839359
        } while (0)