1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
|
/*-
* Copyright (c) 2013-2015 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.
*
*/
struct req;
struct vfp_entry;
struct vfp_ctx;
struct vdp_ctx;
/* Fetch processors --------------------------------------------------*/
#define VFP_DEBUG(ctx, fmt, ...) \
do { \
if (!DO_DEBUG(DBG_PROCESSORS)) \
break; \
VSLb((ctx)->wrk->vsl, SLT_Debug, "VFP:%s:%d: " fmt, \
__func__, __LINE__, __VA_ARGS__); \
} while (0)
enum vfp_status {
VFP_ERROR = -1,
VFP_OK = 0,
VFP_END = 1,
VFP_NULL = 2, // signal bypass, never returned by VFP_Suck()
};
typedef enum vfp_status vfp_init_f(VRT_CTX, struct vfp_ctx *,
struct vfp_entry *);
typedef enum vfp_status
vfp_pull_f(struct vfp_ctx *, struct vfp_entry *, void *ptr, ssize_t *len);
typedef void vfp_fini_f(struct vfp_ctx *, struct vfp_entry *);
struct vfp {
const char *name;
vfp_init_f *init;
vfp_pull_f *pull;
vfp_fini_f *fini;
const void *priv1;
};
struct vfp_entry {
unsigned magic;
#define VFP_ENTRY_MAGIC 0xbe32a027
enum vfp_status closed;
const struct vfp *vfp;
void *priv1; // XXX ambiguous with priv1 in struct vfp
ssize_t priv2;
VTAILQ_ENTRY(vfp_entry) list;
uint64_t calls;
uint64_t bytes_out;
};
/*--------------------------------------------------------------------
* VFP filter state
*/
VTAILQ_HEAD(vfp_entry_s, vfp_entry);
struct vfp_ctx {
unsigned magic;
#define VFP_CTX_MAGIC 0x61d9d3e5
int failed;
struct http *req;
struct http *resp;
struct worker *wrk;
struct objcore *oc; // Only first filter, if at all
struct vfp_entry_s vfp;
struct vfp_entry *vfp_nxt;
unsigned obj_flags;
};
enum vfp_status VFP_Suck(struct vfp_ctx *, void *p, ssize_t *lp);
enum vfp_status VFP_Error(struct vfp_ctx *, const char *fmt, ...)
v_printflike_(2, 3);
void v_deprecated_ VRT_AddVFP(VRT_CTX, const struct vfp *);
void v_deprecated_ VRT_RemoveVFP(VRT_CTX, const struct vfp *);
/* Deliver processors ------------------------------------------------*/
enum vdp_action {
VDP_NULL, /* Input buffer valid after call */
VDP_FLUSH, /* Input buffer will be invalidated */
VDP_END, /* Last buffer or after, implies VDP_FLUSH */
};
typedef int vdp_init_f(VRT_CTX, struct vdp_ctx *, void **priv);
/*
* Return value:
* negative: Error - abandon delivery
* zero: OK
* positive: Don't push this VDP anyway
*/
typedef int vdp_fini_f(struct vdp_ctx *, void **priv);
typedef int vdp_bytes_f(struct vdp_ctx *, enum vdp_action, void **priv,
const void *ptr, ssize_t len);
struct vdp {
const char *name;
vdp_init_f *init;
vdp_bytes_f *bytes;
vdp_fini_f *fini;
const void *priv1;
};
struct vdp_entry {
unsigned magic;
#define VDP_ENTRY_MAGIC 0x353eb781
enum vdp_action end; // VDP_NULL or VDP_END
const struct vdp *vdp;
void *priv;
VTAILQ_ENTRY(vdp_entry) list;
uint64_t calls;
uint64_t bytes_in;
};
VTAILQ_HEAD(vdp_entry_s, vdp_entry);
struct vdp_ctx {
unsigned magic;
#define VDP_CTX_MAGIC 0xee501df7
int retval;
uint64_t bytes_done;
struct vdp_entry_s vdp;
struct vdp_entry *nxt;
struct worker *wrk;
struct vsl_log *vsl;
// NULL'ed after the first filter has been pushed
struct objcore *oc;
// NULL'ed for delivery
struct http *hp;
intmax_t *clen;
};
int VDP_bytes(struct vdp_ctx *, enum vdp_action act, const void *, ssize_t);
void v_deprecated_ VRT_AddVDP(VRT_CTX, const struct vdp *);
void v_deprecated_ VRT_RemoveVDP(VRT_CTX, const struct vdp *);
/* Registry functions -------------------------------------------------*/
const char *VRT_AddFilter(VRT_CTX, const struct vfp *, const struct vdp *);
void VRT_RemoveFilter(VRT_CTX, const struct vfp *, const struct vdp *);
|