/*-
 * Copyright (c) 2006 Verdens Gang AS
 * Copyright (c) 2006-2021 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.
 *
 * Runtime support for compiled VCL programs: private variables
 */

#include "config.h"


#include <stdlib.h>

#include "cache_varnishd.h"
#include "vcl.h"
#include "vcc_interface.h"

enum vrt_priv_storage_e {
	VRT_PRIV_ST_WS = 1,
	VRT_PRIV_ST_HEAP
};

struct vrt_priv {
	unsigned			magic;
#define VRT_PRIV_MAGIC			0x24157a52
	enum vrt_priv_storage_e		storage;
	VRBT_ENTRY(vrt_priv)		entry;
	struct vmod_priv		priv[1];
	uintptr_t			vmod_id;
};

struct vrt_privs cli_task_privs[1];

static inline int vrt_priv_dyncmp(const struct vrt_priv *,
    const struct vrt_priv *);

VRBT_GENERATE_INSERT_COLOR(vrt_privs, vrt_priv, entry, static)
VRBT_GENERATE_FIND(vrt_privs, vrt_priv, entry, vrt_priv_dyncmp, static)
VRBT_GENERATE_INSERT_FINISH(vrt_privs, vrt_priv, entry, static)
VRBT_GENERATE_INSERT(vrt_privs, vrt_priv, entry, vrt_priv_dyncmp, static)
VRBT_GENERATE_MINMAX(vrt_privs, vrt_priv, entry, static)
VRBT_GENERATE_NEXT(vrt_privs, vrt_priv, entry, static)

/*--------------------------------------------------------------------
 */

void
pan_privs(struct vsb *vsb, const struct vrt_privs *privs)
{
	struct vrt_priv *vp;
	const struct vmod_priv *p;
	const struct vmod_priv_methods *m;

	if (privs == NULL) {
		VSB_cat(vsb, "privs = NULL\n");
		return;
	}
	VSB_printf(vsb, "privs = %p {\n", privs);
	VSB_indent(vsb, 2);
	VRBT_FOREACH(vp, vrt_privs, privs) {
		if (PAN_dump_oneline(vsb, vp, VRT_PRIV_MAGIC, "priv"))
			continue;
		p = vp->priv;
		//lint -e{774}
		if (p == NULL) {
			// should never happen
			VSB_printf(vsb, "NULL vmod %jx},\n",
			    (uintmax_t)vp->vmod_id);
			continue;
		}
		m = p->methods;
		VSB_printf(vsb,
		    "{p %p l %ld m %p t \"%s\"} vmod %jx},\n",
		    p->priv, p->len, m,
		    m != NULL ? m->type : "",
		    (uintmax_t)vp->vmod_id
		);
	}
	VSB_indent(vsb, -2);
	VSB_cat(vsb, "},\n");
}

/*--------------------------------------------------------------------
 */

static void
VRTPRIV_init(struct vrt_privs *privs)
{

	VRBT_INIT(privs);
}

static inline int
vrt_priv_dyncmp(const struct vrt_priv *vp1, const struct vrt_priv *vp2)
{
	if (vp1->vmod_id < vp2->vmod_id)
		return (-1);
	if (vp1->vmod_id > vp2->vmod_id)
		return (1);
	return (0);
}

static struct vmod_priv *
vrt_priv_dynamic_get(const struct vrt_privs *privs, uintptr_t vmod_id)
{
	struct vrt_priv *vp;

	const struct vrt_priv needle = {.vmod_id = vmod_id};

	vp = VRBT_FIND(vrt_privs, privs, &needle);
	if (vp == NULL)
		return (NULL);

	CHECK_OBJ(vp, VRT_PRIV_MAGIC);
	assert(vp->vmod_id == vmod_id);
	return (vp->priv);
}

static struct vmod_priv *
vrt_priv_dynamic(struct ws *ws, struct vrt_privs *privs, uintptr_t vmod_id)
{
	//lint --e{593} vp allocated, vp->priv returned
	struct vrt_priv *vp, *ovp;
	enum vrt_priv_storage_e storage;

	AN(vmod_id);

	if (LIKELY(WS_ReserveSize(ws, sizeof *vp) != 0)) {
		vp = WS_Reservation(ws);
		storage = VRT_PRIV_ST_WS;
	}
	else {
		vp = malloc(sizeof *vp);
		storage = VRT_PRIV_ST_HEAP;
	}
	AN(vp);

	INIT_OBJ(vp, VRT_PRIV_MAGIC);
	vp->storage = storage;
	vp->vmod_id = vmod_id;
	ovp = VRBT_INSERT(vrt_privs, privs, vp);
	if (ovp == NULL) {
		if (storage == VRT_PRIV_ST_WS)
			WS_Release(ws, sizeof *vp);
		return (vp->priv);
	}
	if (storage == VRT_PRIV_ST_WS)
		WS_Release(ws, 0);
	else if (storage == VRT_PRIV_ST_HEAP)
		free(vp);
	else
		WRONG("priv storage");
	return (ovp->priv);
}

static struct vrt_privs *
vrt_priv_task_context(VRT_CTX)
{

	CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);

	/* In pipe mode, both req and bo are set. We use req */

	assert(ctx->req == NULL || ctx->bo == NULL ||
	    ctx->method == VCL_MET_PIPE || ctx->method == 0);

	if (ctx->req) {
		CHECK_OBJ(ctx->req, REQ_MAGIC);
		return (ctx->req->privs);
	}
	if (ctx->bo) {
		CHECK_OBJ(ctx->bo, BUSYOBJ_MAGIC);
		return (ctx->bo->privs);
	}
	ASSERT_CLI();
	return (cli_task_privs);
}

struct vmod_priv *
VRT_priv_task_get(VRT_CTX, const void *vmod_id)
{
	CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);

	return (vrt_priv_dynamic_get(
	    vrt_priv_task_context(ctx),
	    (uintptr_t)vmod_id));
}

struct vmod_priv *
VRT_priv_task(VRT_CTX, const void *vmod_id)
{

	CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);

	return (vrt_priv_dynamic(
	    ctx->ws,
	    vrt_priv_task_context(ctx),
	    (uintptr_t)vmod_id));
}

/*
 * XXX #3498 on VRT_fail(): Would be better to move the PRIV_TOP check to VCC
 *
 * This will fail in the preamble of any VCL SUB containing a call to a vmod
 * function with a PRIV_TOP argument, which might not exactly be pola
 */

#define VRT_PRIV_TOP_PREP(ctx, req, sp, top)	do {			\
		CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);			\
		req = (ctx)->req;					\
		if (req == NULL) {					\
			VRT_fail(ctx, "PRIV_TOP is only accessible "	\
			    "in client VCL context");			\
			return (NULL);					\
		}							\
		CHECK_OBJ(req, REQ_MAGIC);				\
		sp = (ctx)->sp;						\
		CHECK_OBJ_NOTNULL(sp, SESS_MAGIC);			\
		top = (req)->top;					\
		CHECK_OBJ_NOTNULL(top, REQTOP_MAGIC);			\
		req = (top)->topreq;					\
		CHECK_OBJ_NOTNULL(req, REQ_MAGIC);			\
	} while(0)

struct vmod_priv *
VRT_priv_top_get(VRT_CTX, const void *vmod_id)
{
	struct req *req;
	struct sess *sp;
	struct reqtop *top;
	struct vmod_priv *priv;

	VRT_PRIV_TOP_PREP(ctx, req, sp, top);

	Lck_Lock(&sp->mtx);
	priv = vrt_priv_dynamic_get(top->privs, (uintptr_t)vmod_id);
	Lck_Unlock(&sp->mtx);
	return (priv);
}

struct vmod_priv *
VRT_priv_top(VRT_CTX, const void *vmod_id)
{
	struct req *req;
	struct sess *sp;
	struct reqtop *top;
	struct vmod_priv *priv;

	VRT_PRIV_TOP_PREP(ctx, req, sp, top);

	Lck_Lock(&sp->mtx);
	priv = vrt_priv_dynamic(req->ws, top->privs, (uintptr_t)vmod_id);
	Lck_Unlock(&sp->mtx);
	return (priv);
}

/*--------------------------------------------------------------------
 */

void
VRT_priv_fini(VRT_CTX, const struct vmod_priv *p)
{
	const struct vmod_priv_methods *m;

	CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);

	m = p->methods;
	if (m == NULL)
		return;

	CHECK_OBJ(m, VMOD_PRIV_METHODS_MAGIC);
	if (p->priv == NULL || m->fini == NULL)
		return;

	// XXX remove me after soak in
	VRT_CTX_Assert(ctx);

	m->fini(ctx, p->priv);
	assert(ctx->vpi->handling == 0 || ctx->vpi->handling == VCL_RET_FAIL);
}

/*--------------------------------------------------------------------*/

void
VCL_TaskEnter(struct vrt_privs *privs)
{

	VRTPRIV_init(privs);
}

void
VCL_TaskLeave(VRT_CTX, struct vrt_privs *privs)
{
	struct vrt_priv *vp, *vp1;

	CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
	AN(ctx->vpi);
	assert(ctx->vpi->handling == 0 || ctx->vpi->handling == VCL_RET_FAIL);

	/*
	 * NB: We don't bother removing entries as we finish them because it's
	 * a costly operation. Instead we safely walk the whole tree and clear
	 * the head at the very end.
	 */
	VRBT_FOREACH_SAFE(vp, vrt_privs, privs, vp1) {
		CHECK_OBJ(vp, VRT_PRIV_MAGIC);
		VRT_priv_fini(ctx, vp->priv);
		if (vp->storage == VRT_PRIV_ST_HEAP)
			free(vp);
	}
	ZERO_OBJ(privs, sizeof *privs);
}
