GCOV - Varnish Cache


/*-
 * Copyright (c) 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.
 *
 * (TCP|UDS) connection pools.
 *
 */

#include "config.h"

#include <stdlib.h>

#include "cache_varnishd.h"

#include "vsa.h"
#include "vsha256.h"
#include "vtcp.h"
#include "vus.h"
#include "vtim.h"
#include "waiter/waiter.h"

#include "cache_conn_pool.h"
#include "cache_pool.h"

#include "VSC_vcp.h"

struct conn_pool;
static inline int vcp_cmp(const struct conn_pool *a, const struct conn_pool *b);

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

struct pfd {
        unsigned                magic;
#define PFD_MAGIC               0x0c5e6593
        int                     fd;
        VTAILQ_ENTRY(pfd)       list;
        VCL_IP                  addr;
        uint8_t                 state;
        struct waited           waited[1];
        struct conn_pool        *conn_pool;

        pthread_cond_t          *cond;
};

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

typedef int cp_open_f(const struct conn_pool *, vtim_dur tmo, VCL_IP *ap);
typedef void cp_close_f(struct pfd *);
typedef void cp_name_f(const struct pfd *, char *, unsigned, char *, unsigned);

struct cp_methods {
        cp_open_f                               *open;
        cp_close_f                              *close;
        cp_name_f                               *local_name;
        cp_name_f                               *remote_name;
};

struct conn_pool {
        unsigned                                magic;
#define CONN_POOL_MAGIC                         0x85099bc3

        const struct cp_methods                 *methods;

        struct vrt_endpoint                     *endpoint;
        char                                    ident[VSHA256_DIGEST_LENGTH];

        VRBT_ENTRY(conn_pool)                   entry;
        int                                     refcnt;
        struct lock                             mtx;

        VTAILQ_HEAD(, pfd)                      connlist;
        int                                     n_conn;

        int                                     n_kill;

        int                                     n_used;

        vtim_mono                               holddown;
        int                                     holddown_errno;
};

static struct lock conn_pools_mtx;
static struct lock dead_pools_mtx;
static struct VSC_vcp *vsc;

VRBT_HEAD(vrb, conn_pool);
VRBT_GENERATE_REMOVE_COLOR(vrb, conn_pool, entry, static)
VRBT_GENERATE_REMOVE(vrb, conn_pool, entry, static)
VRBT_GENERATE_INSERT_COLOR(vrb, conn_pool, entry, static)
VRBT_GENERATE_INSERT_FINISH(vrb, conn_pool, entry, static)
VRBT_GENERATE_INSERT(vrb, conn_pool, entry, vcp_cmp, static)
VRBT_GENERATE_NEXT(vrb, conn_pool, entry, static)
VRBT_GENERATE_MINMAX(vrb, conn_pool, entry, static)

static struct vrb conn_pools = VRBT_INITIALIZER(&conn_pools);
static struct vrb dead_pools = VRBT_INITIALIZER(&dying_cps);

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

unsigned
PFD_State(const struct pfd *p)
{
        CHECK_OBJ_NOTNULL(p, PFD_MAGIC);
        return (p->state);
}

int *
PFD_Fd(struct pfd *p)
{
        CHECK_OBJ_NOTNULL(p, PFD_MAGIC);
        return (&(p->fd));
}

void
PFD_LocalName(const struct pfd *p, char *abuf, unsigned alen, char *pbuf,
              unsigned plen)
{
        CHECK_OBJ_NOTNULL(p, PFD_MAGIC);
        CHECK_OBJ_NOTNULL(p->conn_pool, CONN_POOL_MAGIC);
        p->conn_pool->methods->local_name(p, abuf, alen, pbuf, plen);
}

void
PFD_RemoteName(const struct pfd *p, char *abuf, unsigned alen, char *pbuf,
               unsigned plen)
{
        CHECK_OBJ_NOTNULL(p, PFD_MAGIC);
        CHECK_OBJ_NOTNULL(p->conn_pool, CONN_POOL_MAGIC);
        p->conn_pool->methods->remote_name(p, abuf, alen, pbuf, plen);
}

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

static inline int
vcp_cmp(const struct conn_pool *a, const struct conn_pool *b)
{
        return (memcmp(a->ident, b->ident, sizeof b->ident));
}

/*--------------------------------------------------------------------
 * Waiter-handler
 */

static void  v_matchproto_(waiter_handle_f)
vcp_handle(struct waited *w, enum wait_event ev, vtim_real now)
{
        struct pfd *pfd;
        struct conn_pool *cp;

        CHECK_OBJ_NOTNULL(w, WAITED_MAGIC);
        CAST_OBJ_NOTNULL(pfd, w->priv1, PFD_MAGIC);
        (void)ev;
        (void)now;
        CHECK_OBJ_NOTNULL(pfd->conn_pool, CONN_POOL_MAGIC);
        cp = pfd->conn_pool;

        Lck_Lock(&cp->mtx);

        switch (pfd->state) {
        case PFD_STATE_STOLEN:
                pfd->state = PFD_STATE_USED;
                VTAILQ_REMOVE(&cp->connlist, pfd, list);
                AN(pfd->cond);
                PTOK(pthread_cond_signal(pfd->cond));
                break;
        case PFD_STATE_AVAIL:
                cp->methods->close(pfd);
                VTAILQ_REMOVE(&cp->connlist, pfd, list);
                cp->n_conn--;
                FREE_OBJ(pfd);
                break;
        case PFD_STATE_CLEANUP:
                cp->methods->close(pfd);
                cp->n_kill--;
                memset(pfd, 0x11, sizeof *pfd);
                free(pfd);
                break;
        default:
                WRONG("Wrong pfd state");
        }
        Lck_Unlock(&cp->mtx);
}


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

void
VCP_AddRef(struct conn_pool *cp)
{
        CHECK_OBJ_NOTNULL(cp, CONN_POOL_MAGIC);

        Lck_Lock(&conn_pools_mtx);
        assert(cp->refcnt > 0);
        cp->refcnt++;
        Lck_Unlock(&conn_pools_mtx);
}

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

static void
vcp_destroy(struct conn_pool **cpp)
{
        struct conn_pool *cp;

        TAKE_OBJ_NOTNULL(cp, cpp, CONN_POOL_MAGIC);
        AZ(cp->n_conn);
        AZ(cp->n_kill);
        Lck_Delete(&cp->mtx);
        FREE_OBJ(cp->endpoint);
        FREE_OBJ(cp);
}

/*--------------------------------------------------------------------
 * Release Conn pool, destroy or stash for future destruction if last
 * reference.
 */

void
VCP_Rel(struct conn_pool **cpp)
{
        struct conn_pool *cp;
        struct pfd *pfd, *pfd2;
        int n_kill;

        TAKE_OBJ_NOTNULL(cp, cpp, CONN_POOL_MAGIC);

        Lck_Lock(&conn_pools_mtx);
        assert(cp->refcnt > 0);
        if (--cp->refcnt > 0) {
                Lck_Unlock(&conn_pools_mtx);
                return;
        }
        AZ(cp->n_used);
        VRBT_REMOVE(vrb, &conn_pools, cp);
        Lck_Unlock(&conn_pools_mtx);

        Lck_Lock(&cp->mtx);
        VTAILQ_FOREACH_SAFE(pfd, &cp->connlist, list, pfd2) {
                VTAILQ_REMOVE(&cp->connlist, pfd, list);
                cp->n_conn--;
                assert(pfd->state == PFD_STATE_AVAIL);
                pfd->state = PFD_STATE_CLEANUP;
                (void)shutdown(pfd->fd, SHUT_RDWR);
                cp->n_kill++;
        }
        n_kill = cp->n_kill;
        Lck_Unlock(&cp->mtx);
        if (n_kill == 0) {
                vcp_destroy(&cp);
                return;
        }
        Lck_Lock(&dead_pools_mtx);
        /*
         * Here we reuse cp's entry but it will probably not be correctly
         * indexed because of the hack in VCP_RelPoll
         */
        VRBT_INSERT(vrb, &dead_pools, cp);
        Lck_Unlock(&dead_pools_mtx);
}

void
VCP_RelPoll(void)
{
        struct vrb dead;
        struct conn_pool *cp, *cp2;
        int n_kill;

        ASSERT_CLI();

        Lck_Lock(&dead_pools_mtx);
        if (VRBT_EMPTY(&dead_pools)) {
                Lck_Unlock(&dead_pools_mtx);
                return;
        }
        dead = dead_pools;
        VRBT_INIT(&dead_pools);
        Lck_Unlock(&dead_pools_mtx);

        VRBT_FOREACH_SAFE(cp, vrb, &dead, cp2) {
                CHECK_OBJ_NOTNULL(cp, CONN_POOL_MAGIC);
                Lck_Lock(&cp->mtx);
                n_kill = cp->n_kill;
                Lck_Unlock(&cp->mtx);
                if (n_kill > 0)
                        continue;
                VRBT_REMOVE(vrb, &dead, cp);
                vcp_destroy(&cp);
        }

        if (VRBT_EMPTY(&dead))
                return;

        Lck_Lock(&dead_pools_mtx);
        /*
         * The following insertion will most likely result in an
         * unordered tree, but in this case it does not matter
         * as we just want to iterate over all the elements
         * in the tree in order to delete them.
         */
        VRBT_INSERT(vrb, &dead_pools, dead.rbh_root);
        Lck_Unlock(&dead_pools_mtx);
}

/*--------------------------------------------------------------------
 * Recycle a connection.
 */

void
VCP_Recycle(const struct worker *wrk, struct pfd **pfdp)
{
        struct pfd *pfd;
        struct conn_pool *cp;
        int i = 0;

        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
        TAKE_OBJ_NOTNULL(pfd, pfdp, PFD_MAGIC);
        cp = pfd->conn_pool;
        CHECK_OBJ_NOTNULL(cp, CONN_POOL_MAGIC);

        assert(pfd->state == PFD_STATE_USED);
        assert(pfd->fd > 0);

        Lck_Lock(&cp->mtx);
        cp->n_used--;

        pfd->waited->priv1 = pfd;
        pfd->waited->fd = pfd->fd;
        pfd->waited->idle = VTIM_real();
        pfd->state = PFD_STATE_AVAIL;
        pfd->waited->func = vcp_handle;
        pfd->waited->tmo = cache_param->backend_idle_timeout;
        if (Wait_Enter(wrk->pool->waiter, pfd->waited)) {
                cp->methods->close(pfd);
                memset(pfd, 0x33, sizeof *pfd);
                free(pfd);
                // XXX: stats
                pfd = NULL;
        } else {
                VTAILQ_INSERT_HEAD(&cp->connlist, pfd, list);
                i++;
        }

        if (pfd != NULL)
                cp->n_conn++;
        Lck_Unlock(&cp->mtx);

        if (i && DO_DEBUG(DBG_VTC_MODE)) {
                /*
                 * In varnishtest we do not have the luxury of using
                 * multiple backend connections, so whenever we end up
                 * in the "pending" case, take a short nap to let the
                 * waiter catch up and put the pfd back into circulations.
                 *
                 * In particular ESI:include related tests suffer random
                 * failures without this.
                 *
                 * In normal operation, the only effect is that we will
                 * have N+1 backend connections rather than N, which is
                 * entirely harmless.
                 */
                VTIM_sleep(0.01);
        }
}

/*--------------------------------------------------------------------
 * Open a new connection from pool.
 */

int
VCP_Open(struct conn_pool *cp, vtim_dur tmo, VCL_IP *ap, int *err)
{
        int r;
        vtim_mono h;

        CHECK_OBJ_NOTNULL(cp, CONN_POOL_MAGIC);
        AN(err);

        while (cp->holddown > 0) {
                Lck_Lock(&cp->mtx);
                if (cp->holddown == 0) {
                        Lck_Unlock(&cp->mtx);
                        break;
                }

                if (VTIM_mono() >= cp->holddown) {
                        cp->holddown = 0;
                        Lck_Unlock(&cp->mtx);
                        break;
                }

                *err = 0;
                errno = cp->holddown_errno;
                Lck_Unlock(&cp->mtx);
                return (-1);
        }

        *err = errno = 0;
        r = cp->methods->open(cp, tmo, ap);

        if (r >= 0 && errno == 0 && cp->endpoint->preamble != NULL &&
             cp->endpoint->preamble->len > 0) {
                if (write(r, cp->endpoint->preamble->blob,
                    cp->endpoint->preamble->len) !=
                    cp->endpoint->preamble->len) {
                        *err = errno;
                        closefd(&r);
                }
        } else {
                *err = errno;
        }

        if (r >= 0)
                return (r);

        h = 0;

        switch (errno) {
        case EACCES:
        case EPERM:
                h = cache_param->backend_local_error_holddown;
                break;
        case EADDRNOTAVAIL:
                h = cache_param->backend_local_error_holddown;
                break;
        case ECONNREFUSED:
                h = cache_param->backend_remote_error_holddown;
                break;
        case ENETUNREACH:
                h = cache_param->backend_remote_error_holddown;
                break;
        default:
                break;
        }

        if (h == 0)
                return (r);

        Lck_Lock(&cp->mtx);
        h += VTIM_mono();
        if (cp->holddown == 0 || h < cp->holddown) {
                cp->holddown = h;
                cp->holddown_errno = errno;
        }

        Lck_Unlock(&cp->mtx);

        return (r);
}

/*--------------------------------------------------------------------
 * Close a connection.
 */

void
VCP_Close(struct pfd **pfdp)
{
        struct pfd *pfd;
        struct conn_pool *cp;

        TAKE_OBJ_NOTNULL(pfd, pfdp, PFD_MAGIC);
        cp = pfd->conn_pool;
        CHECK_OBJ_NOTNULL(cp, CONN_POOL_MAGIC);

        assert(pfd->fd > 0);

        Lck_Lock(&cp->mtx);
        assert(pfd->state == PFD_STATE_USED || pfd->state == PFD_STATE_STOLEN);
        cp->n_used--;
        if (pfd->state == PFD_STATE_STOLEN) {
                (void)shutdown(pfd->fd, SHUT_RDWR);
                VTAILQ_REMOVE(&cp->connlist, pfd, list);
                pfd->state = PFD_STATE_CLEANUP;
                cp->n_kill++;
        } else {
                assert(pfd->state == PFD_STATE_USED);
                cp->methods->close(pfd);
                memset(pfd, 0x44, sizeof *pfd);
                free(pfd);
        }
        Lck_Unlock(&cp->mtx);
}

/*--------------------------------------------------------------------
 * Get a connection, possibly recycled
 */

struct pfd *
VCP_Get(struct conn_pool *cp, vtim_dur tmo, struct worker *wrk,
    unsigned force_fresh, int *err)
{
        struct pfd *pfd;

        CHECK_OBJ_NOTNULL(cp, CONN_POOL_MAGIC);
        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
        AN(err);

        *err = 0;
        Lck_Lock(&cp->mtx);
        pfd = VTAILQ_FIRST(&cp->connlist);
        CHECK_OBJ_ORNULL(pfd, PFD_MAGIC);
        if (force_fresh || pfd == NULL || pfd->state == PFD_STATE_STOLEN) {
                pfd = NULL;
        } else {
                assert(pfd->conn_pool == cp);
                assert(pfd->state == PFD_STATE_AVAIL);
                VTAILQ_REMOVE(&cp->connlist, pfd, list);
                VTAILQ_INSERT_TAIL(&cp->connlist, pfd, list);
                cp->n_conn--;
                VSC_C_main->backend_reuse++;
                pfd->state = PFD_STATE_STOLEN;
                pfd->cond = &wrk->cond;
        }
        cp->n_used++;                   // Opening mostly works
        Lck_Unlock(&cp->mtx);

        if (pfd != NULL)
                return (pfd);

        ALLOC_OBJ(pfd, PFD_MAGIC);
        AN(pfd);
        INIT_OBJ(pfd->waited, WAITED_MAGIC);
        pfd->state = PFD_STATE_USED;
        pfd->conn_pool = cp;
        pfd->fd = VCP_Open(cp, tmo, &pfd->addr, err);
        if (pfd->fd < 0) {
                FREE_OBJ(pfd);
                Lck_Lock(&cp->mtx);
                cp->n_used--;           // Nope, didn't work after all.
                Lck_Unlock(&cp->mtx);
        } else
                VSC_C_main->backend_conn++;

        return (pfd);
}

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

int
VCP_Wait(struct worker *wrk, struct pfd *pfd, vtim_real when)
{
        struct conn_pool *cp;
        int r;

        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
        CHECK_OBJ_NOTNULL(pfd, PFD_MAGIC);
        cp = pfd->conn_pool;
        CHECK_OBJ_NOTNULL(cp, CONN_POOL_MAGIC);
        assert(pfd->cond == &wrk->cond);
        Lck_Lock(&cp->mtx);
        while (pfd->state == PFD_STATE_STOLEN) {
                r = Lck_CondWaitUntil(&wrk->cond, &cp->mtx, when);
                if (r != 0) {
                        if (r == EINTR)
                                continue;
                        assert(r == ETIMEDOUT);
                        Lck_Unlock(&cp->mtx);
                        return (1);
                }
        }
        assert(pfd->state == PFD_STATE_USED);
        pfd->cond = NULL;
        Lck_Unlock(&cp->mtx);

        return (0);
}

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

VCL_IP
VCP_GetIp(struct pfd *pfd)
{

        CHECK_OBJ_NOTNULL(pfd, PFD_MAGIC);
        return (pfd->addr);
}

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

static void
vcp_panic_endpoint(struct vsb *vsb, const struct vrt_endpoint *vep)
{
        char h[VTCP_ADDRBUFSIZE];
        char p[VTCP_PORTBUFSIZE];

        if (PAN_dump_struct(vsb, vep, VRT_ENDPOINT_MAGIC, "vrt_endpoint"))
                return;
        if (vep->uds_path)
                VSB_printf(vsb, "uds_path = %s,\n", vep->uds_path);
        if (vep->ipv4 && VSA_Sane(vep->ipv4)) {
                VTCP_name(vep->ipv4, h, sizeof h, p, sizeof p);
                VSB_printf(vsb, "ipv4 = %s, ", h);
                VSB_printf(vsb, "port = %s,\n", p);
        }
        if (vep->ipv6 && VSA_Sane(vep->ipv6)) {
                VTCP_name(vep->ipv6, h, sizeof h, p, sizeof p);
                VSB_printf(vsb, "ipv6 = %s, ", h);
                VSB_printf(vsb, "port = %s,\n", p);
        }
        VSB_indent(vsb, -2);
        VSB_cat(vsb, "},\n");
}

void
VCP_Panic(struct vsb *vsb, struct conn_pool *cp)
{

        if (PAN_dump_struct(vsb, cp, CONN_POOL_MAGIC, "conn_pool"))
                return;
        VSB_cat(vsb, "ident = ");
        VSB_quote(vsb, cp->ident, VSHA256_DIGEST_LENGTH, VSB_QUOTE_HEX);
        VSB_cat(vsb, ",\n");
        vcp_panic_endpoint(vsb, cp->endpoint);
        VSB_indent(vsb, -2);
        VSB_cat(vsb, "},\n");
}

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

void
VCP_Init(void)
{
        Lck_New(&conn_pools_mtx, lck_conn_pool);
        Lck_New(&dead_pools_mtx, lck_dead_pool);

        AZ(vsc);
        vsc = VSC_vcp_New(NULL, NULL, "");
        AN(vsc);
}

/**********************************************************************/

static inline int
tmo2msec(vtim_dur tmo)
{
        return ((int)floor(tmo * 1000.0));
}

static int v_matchproto_(cp_open_f)
vtp_open(const struct conn_pool *cp, vtim_dur tmo, VCL_IP *ap)
{
        int s;
        int msec;

        CHECK_OBJ_NOTNULL(cp, CONN_POOL_MAGIC);

        msec = tmo2msec(tmo);
        if (cache_param->prefer_ipv6) {
                *ap = cp->endpoint->ipv6;
                s = VTCP_connect(*ap, msec);
                if (s >= 0)
                        return (s);
        }
        *ap = cp->endpoint->ipv4;
        s = VTCP_connect(*ap, msec);
        if (s >= 0)
                return (s);
        if (!cache_param->prefer_ipv6) {
                *ap = cp->endpoint->ipv6;
                s = VTCP_connect(*ap, msec);
        }
        return (s);
}


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

static void v_matchproto_(cp_close_f)
vtp_close(struct pfd *pfd)
{

        CHECK_OBJ_NOTNULL(pfd, PFD_MAGIC);
        VTCP_close(&pfd->fd);
}

static void v_matchproto_(cp_name_f)
vtp_local_name(const struct pfd *pfd, char *addr, unsigned alen, char *pbuf,
               unsigned plen)
{
        CHECK_OBJ_NOTNULL(pfd, PFD_MAGIC);
        VTCP_myname(pfd->fd, addr, alen, pbuf, plen);
}

static void v_matchproto_(cp_name_f)
vtp_remote_name(const struct pfd *pfd, char *addr, unsigned alen, char *pbuf,
                unsigned plen)
{
        CHECK_OBJ_NOTNULL(pfd, PFD_MAGIC);
        VTCP_hisname(pfd->fd, addr, alen, pbuf, plen);
}

static const struct cp_methods vtp_methods = {
        .open = vtp_open,
        .close = vtp_close,
        .local_name = vtp_local_name,
        .remote_name = vtp_remote_name,
};

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

static int v_matchproto_(cp_open_f)
vus_open(const struct conn_pool *cp, vtim_dur tmo, VCL_IP *ap)
{
        int s;
        int msec;

        CHECK_OBJ_NOTNULL(cp, CONN_POOL_MAGIC);
        AN(cp->endpoint->uds_path);

        msec = tmo2msec(tmo);
        *ap = bogo_ip;
        s = VUS_connect(cp->endpoint->uds_path, msec);
        return (s);
}

static void v_matchproto_(cp_name_f)
vus_name(const struct pfd *pfd, char *addr, unsigned alen, char *pbuf,
         unsigned plen)
{
        (void) pfd;
        assert(alen > strlen("0.0.0.0"));
        assert(plen > 1);
        strcpy(addr, "0.0.0.0");
        strcpy(pbuf, "0");
}

static const struct cp_methods vus_methods = {
        .open = vus_open,
        .close = vtp_close,
        .local_name = vus_name,
        .remote_name = vus_name,
};

/*--------------------------------------------------------------------
 * Reference a TCP pool given by {ip4, ip6} pair or a UDS.  Create if
 * it doesn't exist already.
 */

struct conn_pool *
VCP_Ref(const struct vrt_endpoint *vep, const char *ident)
{
        struct conn_pool *cp, *cp2;
        struct VSHA256Context cx[1];
        unsigned char digest[VSHA256_DIGEST_LENGTH];

        CHECK_OBJ_NOTNULL(vep, VRT_ENDPOINT_MAGIC);
        AN(ident);
        AN(vsc);

        VSHA256_Init(cx);
        VSHA256_Update(cx, ident, strlen(ident) + 1); // include \0
        if (vep->uds_path != NULL) {
                AZ(vep->ipv4);
                AZ(vep->ipv6);
                VSHA256_Update(cx, "UDS", 4); // include \0
                VSHA256_Update(cx, vep->uds_path, strlen(vep->uds_path));
        } else {
                assert(vep->ipv4 != NULL || vep->ipv6 != NULL);
                if (vep->ipv4 != NULL) {
                        assert(VSA_Sane(vep->ipv4));
                        VSHA256_Update(cx, "IP4", 4); // include \0
                        VSHA256_Update(cx, vep->ipv4, vsa_suckaddr_len);
                }
                if (vep->ipv6 != NULL) {
                        assert(VSA_Sane(vep->ipv6));
                        VSHA256_Update(cx, "IP6", 4); // include \0
                        VSHA256_Update(cx, vep->ipv6, vsa_suckaddr_len);
                }
        }
        if (vep->preamble != NULL && vep->preamble->len > 0) {
                VSHA256_Update(cx, "PRE", 4); // include \0
                VSHA256_Update(cx, vep->preamble->blob, vep->preamble->len);
        }
        VSHA256_Final(digest, cx);

        ALLOC_OBJ(cp, CONN_POOL_MAGIC);
        AN(cp);
        cp->refcnt = 1;
        cp->holddown = 0;
        cp->endpoint = VRT_Endpoint_Clone(vep);
        CHECK_OBJ_NOTNULL(cp->endpoint, VRT_ENDPOINT_MAGIC);
        memcpy(cp->ident, digest, sizeof cp->ident);
        if (vep->uds_path != NULL)
                cp->methods = &vus_methods;
        else
                cp->methods = &vtp_methods;
        Lck_New(&cp->mtx, lck_conn_pool);
        VTAILQ_INIT(&cp->connlist);

        Lck_Lock(&conn_pools_mtx);
        cp2 = VRBT_INSERT(vrb, &conn_pools, cp);
        if (cp2 == NULL) {
                vsc->ref_miss++;
                Lck_Unlock(&conn_pools_mtx);
                return (cp);
        }

        CHECK_OBJ(cp2, CONN_POOL_MAGIC);
        assert(cp2->refcnt > 0);
        cp2->refcnt++;
        vsc->ref_hit++;
        Lck_Unlock(&conn_pools_mtx);

        vcp_destroy(&cp);
        return (cp2);
}

		varnish-cache/bin/varnishd/cache/cache_conn_pool.c
0		/*-
1		* Copyright (c) 2015 Varnish Software AS
2		* All rights reserved.
3		*
4		* Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
5		*
6		* SPDX-License-Identifier: BSD-2-Clause
7		*
8		* Redistribution and use in source and binary forms, with or without
9		* modification, are permitted provided that the following conditions
10		* are met:
11		* 1. Redistributions of source code must retain the above copyright
12		* notice, this list of conditions and the following disclaimer.
13		* 2. Redistributions in binary form must reproduce the above copyright
14		* notice, this list of conditions and the following disclaimer in the
15		* documentation and/or other materials provided with the distribution.
16		*
17		* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18		* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19		* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20		* ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
21		* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22		* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23		* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24		* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25		* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26		* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27		* SUCH DAMAGE.
28		*
29		* (TCP\|UDS) connection pools.
30		*
31		*/
32
33		#include "config.h"
34
35		#include <stdlib.h>
36
37		#include "cache_varnishd.h"
38
39		#include "vsa.h"
40		#include "vsha256.h"
41		#include "vtcp.h"
42		#include "vus.h"
43		#include "vtim.h"
44		#include "waiter/waiter.h"
45
46		#include "cache_conn_pool.h"
47		#include "cache_pool.h"
48
49		#include "VSC_vcp.h"
50
51		struct conn_pool;
52		static inline int vcp_cmp(const struct conn_pool a, const struct conn_pool b);
53
54		/*--------------------------------------------------------------------
55		*/
56
57		struct pfd {
58		unsigned magic;
59		#define PFD_MAGIC 0x0c5e6593
60		int fd;
61		VTAILQ_ENTRY(pfd) list;
62		VCL_IP addr;
63		uint8_t state;
64		struct waited waited[1];
65		struct conn_pool *conn_pool;
66
67		pthread_cond_t *cond;
68		};
69
70		/*--------------------------------------------------------------------
71		*/
72
73		typedef int cp_open_f(const struct conn_pool , vtim_dur tmo, VCL_IP ap);
74		typedef void cp_close_f(struct pfd *);
75		typedef void cp_name_f(const struct pfd , char , unsigned, char *, unsigned);
76
77		struct cp_methods {
78		cp_open_f *open;
79		cp_close_f *close;
80		cp_name_f *local_name;
81		cp_name_f *remote_name;
82		};
83
84		struct conn_pool {
85		unsigned magic;
86		#define CONN_POOL_MAGIC 0x85099bc3
87
88		const struct cp_methods *methods;
89
90		struct vrt_endpoint *endpoint;
91		char ident[VSHA256_DIGEST_LENGTH];
92
93		VRBT_ENTRY(conn_pool) entry;
94		int refcnt;
95		struct lock mtx;
96
97		VTAILQ_HEAD(, pfd) connlist;
98		int n_conn;
99
100		int n_kill;
101
102		int n_used;
103
104		vtim_mono holddown;
105		int holddown_errno;
106		};
107
108		static struct lock conn_pools_mtx;
109		static struct lock dead_pools_mtx;
110		static struct VSC_vcp *vsc;
111
112		VRBT_HEAD(vrb, conn_pool);
113	16	VRBT_GENERATE_REMOVE_COLOR(vrb, conn_pool, entry, static)
114	42	VRBT_GENERATE_REMOVE(vrb, conn_pool, entry, static)
115	218	VRBT_GENERATE_INSERT_COLOR(vrb, conn_pool, entry, static)
116	1027	VRBT_GENERATE_INSERT_FINISH(vrb, conn_pool, entry, static)
117	1559	VRBT_GENERATE_INSERT(vrb, conn_pool, entry, vcp_cmp, static)
118	3	VRBT_GENERATE_NEXT(vrb, conn_pool, entry, static)
119	6	VRBT_GENERATE_MINMAX(vrb, conn_pool, entry, static)
120
121		static struct vrb conn_pools = VRBT_INITIALIZER(&conn_pools);
122		static struct vrb dead_pools = VRBT_INITIALIZER(&dying_cps);
123
124		/*--------------------------------------------------------------------
125		*/
126
127		unsigned
128	10140	PFD_State(const struct pfd *p)
129		{
130	10140	CHECK_OBJ_NOTNULL(p, PFD_MAGIC);
131	10140	return (p->state);
132		}
133
134		int *
135	4288	PFD_Fd(struct pfd *p)
136		{
137	4288	CHECK_OBJ_NOTNULL(p, PFD_MAGIC);
138	4288	return (&(p->fd));
139		}
140
141		void
142	2133	PFD_LocalName(const struct pfd p, char abuf, unsigned alen, char *pbuf,
143		unsigned plen)
144		{
145	2133	CHECK_OBJ_NOTNULL(p, PFD_MAGIC);
146	2133	CHECK_OBJ_NOTNULL(p->conn_pool, CONN_POOL_MAGIC);
147	2133	p->conn_pool->methods->local_name(p, abuf, alen, pbuf, plen);
148	2133	}
149
150		void
151	2133	PFD_RemoteName(const struct pfd p, char abuf, unsigned alen, char *pbuf,
152		unsigned plen)
153		{
154	2133	CHECK_OBJ_NOTNULL(p, PFD_MAGIC);
155	2133	CHECK_OBJ_NOTNULL(p->conn_pool, CONN_POOL_MAGIC);
156	2133	p->conn_pool->methods->remote_name(p, abuf, alen, pbuf, plen);
157	2133	}
158
159		/*--------------------------------------------------------------------
160		*/
161
162		static inline int
163	532	vcp_cmp(const struct conn_pool a, const struct conn_pool b)
164		{
165	532	return (memcmp(a->ident, b->ident, sizeof b->ident));
166		}
167
168		/*--------------------------------------------------------------------
169		* Waiter-handler
170		*/
171
172		static void v_matchproto_(waiter_handle_f)
173	1728	vcp_handle(struct waited *w, enum wait_event ev, vtim_real now)
174		{
175		struct pfd *pfd;
176		struct conn_pool *cp;
177
178	1728	CHECK_OBJ_NOTNULL(w, WAITED_MAGIC);
179	1728	CAST_OBJ_NOTNULL(pfd, w->priv1, PFD_MAGIC);
180	1728	(void)ev;
181	1728	(void)now;
182	1728	CHECK_OBJ_NOTNULL(pfd->conn_pool, CONN_POOL_MAGIC);
183	1728	cp = pfd->conn_pool;
184
185	1728	Lck_Lock(&cp->mtx);
186
187	1728	switch (pfd->state) {
188		case PFD_STATE_STOLEN:
189	794	pfd->state = PFD_STATE_USED;
190	794	VTAILQ_REMOVE(&cp->connlist, pfd, list);
191	794	AN(pfd->cond);
192	794	PTOK(pthread_cond_signal(pfd->cond));
193	794	break;
194		case PFD_STATE_AVAIL:
195	930	cp->methods->close(pfd);
196	930	VTAILQ_REMOVE(&cp->connlist, pfd, list);
197	930	cp->n_conn--;
198	930	FREE_OBJ(pfd);
199	930	break;
200		case PFD_STATE_CLEANUP:
201	4	cp->methods->close(pfd);
202	4	cp->n_kill--;
203	4	memset(pfd, 0x11, sizeof *pfd);
204	4	free(pfd);
205	4	break;
206		default:
207	0	WRONG("Wrong pfd state");
208	0	}
209	1728	Lck_Unlock(&cp->mtx);
210	1728	}
211
212
213		/*--------------------------------------------------------------------
214		*/
215
216		void
217	37	VCP_AddRef(struct conn_pool *cp)
218		{
219	37	CHECK_OBJ_NOTNULL(cp, CONN_POOL_MAGIC);
220
221	37	Lck_Lock(&conn_pools_mtx);
222	37	assert(cp->refcnt > 0);
223	37	cp->refcnt++;
224	37	Lck_Unlock(&conn_pools_mtx);
225	37	}
226
227		/*--------------------------------------------------------------------
228		*/
229
230		static void
231	324	vcp_destroy(struct conn_pool **cpp)
232		{
233		struct conn_pool *cp;
234
235	324	TAKE_OBJ_NOTNULL(cp, cpp, CONN_POOL_MAGIC);
236	324	AZ(cp->n_conn);
237	324	AZ(cp->n_kill);
238	324	Lck_Delete(&cp->mtx);
239	324	FREE_OBJ(cp->endpoint);
240	324	FREE_OBJ(cp);
241	324	}
242
243		/*--------------------------------------------------------------------
244		* Release Conn pool, destroy or stash for future destruction if last
245		* reference.
246		*/
247
248		void
249	86	VCP_Rel(struct conn_pool **cpp)
250		{
251		struct conn_pool *cp;
252		struct pfd pfd, pfd2;
253		int n_kill;
254
255	86	TAKE_OBJ_NOTNULL(cp, cpp, CONN_POOL_MAGIC);
256
257	86	Lck_Lock(&conn_pools_mtx);
258	86	assert(cp->refcnt > 0);
259	86	if (--cp->refcnt > 0) {
260	59	Lck_Unlock(&conn_pools_mtx);
261	59	return;
262		}
263	27	AZ(cp->n_used);
264	27	VRBT_REMOVE(vrb, &conn_pools, cp);
265	27	Lck_Unlock(&conn_pools_mtx);
266
267	27	Lck_Lock(&cp->mtx);
268	29	VTAILQ_FOREACH_SAFE(pfd, &cp->connlist, list, pfd2) {
269	2	VTAILQ_REMOVE(&cp->connlist, pfd, list);
270	2	cp->n_conn--;
271	2	assert(pfd->state == PFD_STATE_AVAIL);
272	2	pfd->state = PFD_STATE_CLEANUP;
273	2	(void)shutdown(pfd->fd, SHUT_RDWR);
274	2	cp->n_kill++;
275	2	}
276	27	n_kill = cp->n_kill;
277	27	Lck_Unlock(&cp->mtx);
278	27	if (n_kill == 0) {
279	25	vcp_destroy(&cp);
280	25	return;
281		}
282	2	Lck_Lock(&dead_pools_mtx);
283		/*
284		* Here we reuse cp's entry but it will probably not be correctly
285		* indexed because of the hack in VCP_RelPoll
286		*/
287	2	VRBT_INSERT(vrb, &dead_pools, cp);
288	2	Lck_Unlock(&dead_pools_mtx);
289	86	}
290
291		void
292	7613	VCP_RelPoll(void)
293		{
294		struct vrb dead;
295		struct conn_pool cp, cp2;
296		int n_kill;
297
298	7613	ASSERT_CLI();
299
300	7613	Lck_Lock(&dead_pools_mtx);
301	7613	if (VRBT_EMPTY(&dead_pools)) {
302	7610	Lck_Unlock(&dead_pools_mtx);
303	7610	return;
304		}
305	3	dead = dead_pools;
306	3	VRBT_INIT(&dead_pools);
307	3	Lck_Unlock(&dead_pools_mtx);
308
309	6	VRBT_FOREACH_SAFE(cp, vrb, &dead, cp2) {
310	3	CHECK_OBJ_NOTNULL(cp, CONN_POOL_MAGIC);
311	3	Lck_Lock(&cp->mtx);
312	3	n_kill = cp->n_kill;
313	3	Lck_Unlock(&cp->mtx);
314	3	if (n_kill > 0)
315	1	continue;
316	2	VRBT_REMOVE(vrb, &dead, cp);
317	2	vcp_destroy(&cp);
318	2	}
319
320	3	if (VRBT_EMPTY(&dead))
321	2	return;
322
323	1	Lck_Lock(&dead_pools_mtx);
324		/*
325		* The following insertion will most likely result in an
326		* unordered tree, but in this case it does not matter
327		* as we just want to iterate over all the elements
328		* in the tree in order to delete them.
329		*/
330	1	VRBT_INSERT(vrb, &dead_pools, dead.rbh_root);
331	1	Lck_Unlock(&dead_pools_mtx);
332	7613	}
333
334		/*--------------------------------------------------------------------
335		* Recycle a connection.
336		*/
337
338		void
339	1748	VCP_Recycle(const struct worker wrk, struct pfd *pfdp)
340		{
341		struct pfd *pfd;
342		struct conn_pool *cp;
343	1748	int i = 0;
344
345	1748	CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
346	1748	TAKE_OBJ_NOTNULL(pfd, pfdp, PFD_MAGIC);
347	1748	cp = pfd->conn_pool;
348	1748	CHECK_OBJ_NOTNULL(cp, CONN_POOL_MAGIC);
349
350	1748	assert(pfd->state == PFD_STATE_USED);
351	1748	assert(pfd->fd > 0);
352
353	1748	Lck_Lock(&cp->mtx);
354	1748	cp->n_used--;
355
356	1748	pfd->waited->priv1 = pfd;
357	1748	pfd->waited->fd = pfd->fd;
358	1748	pfd->waited->idle = VTIM_real();
359	1748	pfd->state = PFD_STATE_AVAIL;
360	1748	pfd->waited->func = vcp_handle;
361	1748	pfd->waited->tmo = cache_param->backend_idle_timeout;
362	1748	if (Wait_Enter(wrk->pool->waiter, pfd->waited)) {
363	0	cp->methods->close(pfd);
364	0	memset(pfd, 0x33, sizeof *pfd);
365	0	free(pfd);
366		// XXX: stats
367	0	pfd = NULL;
368	0	} else {
369	1748	VTAILQ_INSERT_HEAD(&cp->connlist, pfd, list);
370	1748	i++;
371		}
372
373	1748	if (pfd != NULL)
374	1748	cp->n_conn++;
375	1748	Lck_Unlock(&cp->mtx);
376
377	1748	if (i && DO_DEBUG(DBG_VTC_MODE)) {
378		/*
379		* In varnishtest we do not have the luxury of using
380		* multiple backend connections, so whenever we end up
381		* in the "pending" case, take a short nap to let the
382		* waiter catch up and put the pfd back into circulations.
383		*
384		* In particular ESI:include related tests suffer random
385		* failures without this.
386		*
387		* In normal operation, the only effect is that we will
388		* have N+1 backend connections rather than N, which is
389		* entirely harmless.
390		*/
391	1748	VTIM_sleep(0.01);
392	1748	}
393	1748	}
394
395		/*--------------------------------------------------------------------
396		* Open a new connection from pool.
397		*/
398
399		int
400	1562	VCP_Open(struct conn_pool cp, vtim_dur tmo, VCL_IP ap, int *err)
401		{
402		int r;
403		vtim_mono h;
404
405	1562	CHECK_OBJ_NOTNULL(cp, CONN_POOL_MAGIC);
406	1562	AN(err);
407
408	1562	while (cp->holddown > 0) {
409	22	Lck_Lock(&cp->mtx);
410	22	if (cp->holddown == 0) {
411	0	Lck_Unlock(&cp->mtx);
412	0	break;
413		}
414
415	22	if (VTIM_mono() >= cp->holddown) {
416	3	cp->holddown = 0;
417	3	Lck_Unlock(&cp->mtx);
418	3	break;
419		}
420
421	19	*err = 0;
422	19	errno = cp->holddown_errno;
423	19	Lck_Unlock(&cp->mtx);
424	19	return (-1);
425		}
426
427	1543	*err = errno = 0;
428	1543	r = cp->methods->open(cp, tmo, ap);
429
430	1543	if (r >= 0 && errno == 0 && cp->endpoint->preamble != NULL &&
431	9	cp->endpoint->preamble->len > 0) {
432	27	if (write(r, cp->endpoint->preamble->blob,
433	18	cp->endpoint->preamble->len) !=
434	9	cp->endpoint->preamble->len) {
435	0	*err = errno;
436	0	closefd(&r);
437	0	}
438	9	} else {
439	1534	*err = errno;
440		}
441
442	1543	if (r >= 0)
443	1517	return (r);
444
445	26	h = 0;
446
447	26	switch (errno) {
448		case EACCES:
449		case EPERM:
450	0	h = cache_param->backend_local_error_holddown;
451	0	break;
452		case EADDRNOTAVAIL:
453	0	h = cache_param->backend_local_error_holddown;
454	0	break;
455		case ECONNREFUSED:
456	26	h = cache_param->backend_remote_error_holddown;
457	26	break;
458		case ENETUNREACH:
459	0	h = cache_param->backend_remote_error_holddown;
460	0	break;
461		default:
462	0	break;
463		}
464
465	26	if (h == 0)
466	0	return (r);
467
468	26	Lck_Lock(&cp->mtx);
469	26	h += VTIM_mono();
470	26	if (cp->holddown == 0 \|\| h < cp->holddown) {
471	23	cp->holddown = h;
472	23	cp->holddown_errno = errno;
473	23	}
474
475	26	Lck_Unlock(&cp->mtx);
476
477	26	return (r);
478	1562	}
479
480		/*--------------------------------------------------------------------
481		* Close a connection.
482		*/
483
484		void
485	384	VCP_Close(struct pfd **pfdp)
486		{
487		struct pfd *pfd;
488		struct conn_pool *cp;
489
490	384	TAKE_OBJ_NOTNULL(pfd, pfdp, PFD_MAGIC);
491	384	cp = pfd->conn_pool;
492	384	CHECK_OBJ_NOTNULL(cp, CONN_POOL_MAGIC);
493
494	384	assert(pfd->fd > 0);
495
496	384	Lck_Lock(&cp->mtx);
497	384	assert(pfd->state == PFD_STATE_USED \|\| pfd->state == PFD_STATE_STOLEN);
498	384	cp->n_used--;
499	384	if (pfd->state == PFD_STATE_STOLEN) {