GCOV - Varnish Cache


/*-
 * Copyright (c) 2013-2016 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.
 *
 * Lifetime of an objcore:
 *      phase 0 - nonexistent
 *      phase 1 - created, but no stevedore associated
 *      phase 2 - stevedore associated, being filled out
 *      phase 3 - stable, no changes happening
 *      phase 4 - unavailable, being dismantled
 *      phase 5 - stevedore disassociated
 *      phase 6 - nonexistent
 *
 * 0->1 ObjNew()        creates objcore
 *
 * 1->2 STV_NewObject() associates a stevedore
 *
 * 2    ObjSetState()   sets state
 * 2    ObjWaitState()  waits for particular state
 *                      INVALID->REQ_DONE->STREAM->FINISHED->FAILED
 *
 * 2    ObjGetSpace()   allocates space
 * 2    ObjExtend()     commits content
 * 2    ObjWaitExtend() waits for content - used to implement ObjIterate())
 *
 * 2    ObjSetAttr()
 * 2      ObjCopyAttr()
 * 2      ObjSetFlag()
 * 2      ObjSetDouble()
 * 2      ObjSetU32()
 * 2      ObjSetU64()
 *
 * 2->3 ObjBocDone()    Boc removed from OC, clean it up
 *
 * 23   ObjHasAttr()
 * 23   ObjGetAttr()
 * 23     ObjCheckFlag()
 * 23     ObjGetDouble()
 * 23     ObjGetU32()
 * 23     ObjGetU64()
 * 23     ObjGetLen()
 * 23     ObjGetXID()
 *
 * 23   ObjIterate()    ... over body
 *
 * 23   ObjTouch()      Signal to LRU(-like) facilities
 *
 * 3->4 HSH_Snipe()     kill if not in use
 * 3->4 HSH_Kill()      make unavailable
 *
 * 234  ObjSlim()       Release body storage (but retain attribute storage)
 *
 * 4->5 ObjFreeObj()    disassociates stevedore
 *
 * 5->6 FREE_OBJ()      ...in HSH_DerefObjCore()
 */

#include "config.h"

#include <stdlib.h>

#include "cache_varnishd.h"
#include "cache_obj.h"
#include "vend.h"
#include "storage/storage.h"

static const struct obj_methods *
obj_getmethods(const struct objcore *oc)
{

        CHECK_OBJ_NOTNULL(oc, OBJCORE_MAGIC);
        CHECK_OBJ_NOTNULL(oc->stobj->stevedore, STEVEDORE_MAGIC);
        AN(oc->stobj->stevedore->methods);
        return (oc->stobj->stevedore->methods);
}

static struct boc *
obj_newboc(void)
{
        struct boc *boc;

        ALLOC_OBJ(boc, BOC_MAGIC);
        AN(boc);
        Lck_New(&boc->mtx, lck_busyobj);
        PTOK(pthread_cond_init(&boc->cond, NULL));
        boc->refcount = 1;
        boc->transit_buffer = cache_param->transit_buffer;
        return (boc);
}

static void
obj_deleteboc(struct boc **p)
{
        struct boc *boc;

        TAKE_OBJ_NOTNULL(boc, p, BOC_MAGIC);
        Lck_Delete(&boc->mtx);
        PTOK(pthread_cond_destroy(&boc->cond));
        free(boc->vary);
        FREE_OBJ(boc);
}

/*====================================================================
 * ObjNew()
 *
 */

struct objcore *
ObjNew(const struct worker *wrk)
{
        struct objcore *oc;

        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);

        ALLOC_OBJ(oc, OBJCORE_MAGIC);
        AN(oc);
        wrk->stats->n_objectcore++;
        oc->last_lru = NAN;
        oc->flags = OC_F_BUSY;

        oc->boc = obj_newboc();

        return (oc);
}

/*====================================================================
 * ObjDestroy()
 *
 */

void
ObjDestroy(const struct worker *wrk, struct objcore **p)
{
        struct objcore *oc;

        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
        TAKE_OBJ_NOTNULL(oc, p, OBJCORE_MAGIC);
        if (oc->boc != NULL)
                obj_deleteboc(&oc->boc);
        FREE_OBJ(oc);
        wrk->stats->n_objectcore--;
}

/*====================================================================
 * ObjIterate()
 *
 */

int
ObjIterate(struct worker *wrk, struct objcore *oc,
    void *priv, objiterate_f *func, int final)
{
        const struct obj_methods *om = obj_getmethods(oc);

        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
        AN(func);
        AN(om->objiterator);
        return (om->objiterator(wrk, oc, priv, func, final));
}

/*====================================================================
 * ObjVAI...(): Asynchronous Iteration
 *
 *
 * ObjVAIinit() returns an opaque handle, or NULL if not supported
 *
 *      A VAI handle must not be used concurrently
 *
 *      the vai_notify_cb(priv) will be called asynchronously by the storage
 *      engine when a -EAGAIN / -ENOBUFS condition is over and ObjVAIlease()
 *      can be called again.
 *
 *      Note:
 *      - the callback gets executed by an arbitrary thread
 *      - WITH the boc mtx held
 *      so it should never block and only do minimal work
 *
 * ObjVAIlease() fills the vscarab with leases. returns:
 *
 *      -EAGAIN:  nothing available at the moment, storage will notify, no use to
 *                call again until notification
 *      -ENOBUFS: caller needs to return leases, storage will notify
 *      -EPIPE:   BOS_FAILED for busy object
 *      -(errno): other problem, fatal
 *
 *      >= 0:     number of viovs added (== scarab->capacity - scarab->used)
 *
 *      struct vscarab:
 *
 *      the leases can be used by the caller until returned with
 *      ObjVAIreturn(). The storage guarantees that the lease member is a
 *      multiple of 8 (that is, the lower three bits are zero). These can be
 *      used by the caller between lease and return, but must be cleared to
 *      zero before returning.
 *
 * ObjVAIbuffer() allocates temporary buffers, returns:
 *
 *      -EAGAIN:  allocation can not be fulfilled immediately, storage will notify,
 *                no use to call again until notification
 *      -EINVAL:  size larger than UINT_MAX requested
 *      -(errno): other problem, fatal
 *      n:        n > 0, number of viovs filled
 *
 *      The struct vscarab is used on the way in and out: On the way in, the
 *      iov.iov_len members contain the sizes the caller requests, all other
 *      members of the struct viovs are expected to be zero initialized.
 *
 *      The maximum size to be requested is UINT_MAX.
 *
 *      ObjVAIbuffer() may return sizes larger than requested. The returned n
 *      might be smaller than requested.
 *
 * ObjVAIreturn() returns leases collected in a struct vscaret
 *
 *      it must be called with a vscaret, which holds an array of lease values
 *      received via ObjVAIlease() or ObjVAIbuffer() when the caller can
 *      guarantee that they are no longer accessed.
 *
 *      ObjVAIreturn() may retain leases in the vscaret if the implementation
 *      still requires them, iow, the vscaret might not be empty upon return.
 *
 * ObjVAIfini() finalized iteration
 *
 *      it must be called when iteration is done, irrespective of error status
 */

vai_hdl
ObjVAIinit(struct worker *wrk, struct objcore *oc, struct ws *ws,
    vai_notify_cb *cb, void *cb_priv)
{
        const struct obj_methods *om = obj_getmethods(oc);

        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);

        if (om->vai_init == NULL)
                return (NULL);
        return (om->vai_init(wrk, oc, ws, cb, cb_priv));
}

int
ObjVAIlease(struct worker *wrk, vai_hdl vhdl, struct vscarab *scarab)
{
        struct vai_hdl_preamble *vaip = vhdl;

        AN(vaip);
        assert(vaip->magic2 == VAI_HDL_PREAMBLE_MAGIC2);
        AN(vaip->vai_lease);
        return (vaip->vai_lease(wrk, vhdl, scarab));
}

int
ObjVAIbuffer(struct worker *wrk, vai_hdl vhdl, struct vscarab *scarab)
{
        struct vai_hdl_preamble *vaip = vhdl;

        AN(vaip);
        assert(vaip->magic2 == VAI_HDL_PREAMBLE_MAGIC2);
        AN(vaip->vai_buffer);
        return (vaip->vai_buffer(wrk, vhdl, scarab));
}

void
ObjVAIreturn(struct worker *wrk, vai_hdl vhdl, struct vscaret *scaret)
{
        struct vai_hdl_preamble *vaip = vhdl;

        AN(vaip);
        assert(vaip->magic2 == VAI_HDL_PREAMBLE_MAGIC2);
        AN(vaip->vai_return);
        vaip->vai_return(wrk, vhdl, scaret);
}

void
ObjVAIfini(struct worker *wrk, vai_hdl *vhdlp)
{
        AN(vhdlp);
        struct vai_hdl_preamble *vaip = *vhdlp;

        AN(vaip);
        assert(vaip->magic2 == VAI_HDL_PREAMBLE_MAGIC2);
        AN(vaip->vai_lease);
        vaip->vai_fini(wrk, vhdlp);
}

/*====================================================================
 * ObjGetSpace()
 *
 * This function returns a pointer and length of free space.  If there
 * is no free space, some will be added first.
 *
 * The "sz" argument is an input hint of how much space is desired.
 * 0 means "unknown", return some default size (maybe fetch_chunksize)
 */

int
ObjGetSpace(struct worker *wrk, struct objcore *oc, ssize_t *sz, uint8_t **ptr)
{
        const struct obj_methods *om = obj_getmethods(oc);

        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
        CHECK_OBJ_NOTNULL(oc->boc, BOC_MAGIC);
        AN(sz);
        AN(ptr);
        assert(*sz >= 0);

        AN(om->objgetspace);
        return (om->objgetspace(wrk, oc, sz, ptr));
}

/*====================================================================
 * ObjExtend()
 *
 * This function extends the used part of the object a number of bytes
 * into the last space returned by ObjGetSpace()
 *
 * The final flag must be set on the last call, and it will release any
 * surplus space allocated.
 */

static void
obj_extend_condwait(const struct objcore *oc)
{

        if (oc->boc->transit_buffer == 0)
                return;

        assert(oc->flags & OC_F_TRANSIENT);
        while (!(oc->flags & OC_F_CANCEL) && oc->boc->fetched_so_far >
            oc->boc->delivered_so_far + oc->boc->transit_buffer)
                (void)Lck_CondWait(&oc->boc->cond, &oc->boc->mtx);
}

// notify of an extension of the boc or state change
//lint -sem(obj_boc_notify_Unlock, thread_unlock)

static void
obj_boc_notify_Unlock(struct boc *boc)
{
        struct vai_qe *qe, *next;

        PTOK(pthread_cond_broadcast(&boc->cond));
        qe = VSLIST_FIRST(&boc->vai_q_head);
        VSLIST_FIRST(&boc->vai_q_head) = NULL;
        while (qe != NULL) {
                CHECK_OBJ(qe, VAI_Q_MAGIC);
                AN(qe->flags & VAI_QF_INQUEUE);
                qe->flags &= ~VAI_QF_INQUEUE;
                next = VSLIST_NEXT(qe, list);
                VSLIST_NEXT(qe, list) = NULL;
                qe->cb(qe->hdl, qe->priv);
                qe = next;
        }
        Lck_Unlock(&boc->mtx);
}

void
ObjExtend(struct worker *wrk, struct objcore *oc, ssize_t l, int final)
{
        const struct obj_methods *om = obj_getmethods(oc);

        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
        CHECK_OBJ_NOTNULL(oc->boc, BOC_MAGIC);
        AN(om->objextend);
        assert(l >= 0);

        if (l > 0) {
                Lck_Lock(&oc->boc->mtx);
                obj_extend_condwait(oc);
                om->objextend(wrk, oc, l);
                oc->boc->fetched_so_far += l;
                obj_boc_notify_Unlock(oc->boc);
        }

        assert(oc->boc->state < BOS_FINISHED);
        if (final && om->objtrimstore != NULL)
                om->objtrimstore(wrk, oc);
}

/*====================================================================
 */

static inline void
objSignalFetchLocked(const struct objcore *oc, uint64_t l)
{
        if (oc->boc->transit_buffer > 0) {
                assert(oc->flags & OC_F_TRANSIENT);
                /* Signal the new client position */
                oc->boc->delivered_so_far = l;
                PTOK(pthread_cond_signal(&oc->boc->cond));
        }
}

uint64_t
ObjWaitExtend(const struct worker *wrk, const struct objcore *oc, uint64_t l,
    enum boc_state_e *statep)
{
        enum boc_state_e state;
        uint64_t rv;

        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
        CHECK_OBJ_NOTNULL(oc, OBJCORE_MAGIC);
        CHECK_OBJ_NOTNULL(oc->boc, BOC_MAGIC);
        Lck_Lock(&oc->boc->mtx);
        while (1) {
                rv = oc->boc->fetched_so_far;
                assert(l <= rv || oc->boc->state == BOS_FAILED);
                state = oc->boc->state;
                objSignalFetchLocked(oc, l);
                if (rv > l || state >= BOS_FINISHED)
                        break;
                (void)Lck_CondWait(&oc->boc->cond, &oc->boc->mtx);
        }
        Lck_Unlock(&oc->boc->mtx);
        if (statep != NULL)
                *statep = state;
        return (rv);
}

// get a new extension _or_ register a notification
uint64_t
ObjVAIGetExtend(struct worker *wrk, const struct objcore *oc, uint64_t l,
    enum boc_state_e *statep, struct vai_qe *qe)
{
        enum boc_state_e state;
        uint64_t rv;

        (void) wrk;
        CHECK_OBJ_NOTNULL(oc, OBJCORE_MAGIC);
        CHECK_OBJ_NOTNULL(oc->boc, BOC_MAGIC);
        CHECK_OBJ_NOTNULL(qe, VAI_Q_MAGIC);
        Lck_Lock(&oc->boc->mtx);
        rv = oc->boc->fetched_so_far;
        assert(l <= rv || oc->boc->state == BOS_FAILED);
        state = oc->boc->state;
        objSignalFetchLocked(oc, l);
        if (l == rv && state < BOS_FINISHED &&
            (qe->flags & VAI_QF_INQUEUE) == 0) {
                qe->flags |= VAI_QF_INQUEUE;
                VSLIST_INSERT_HEAD(&oc->boc->vai_q_head, qe, list);
        }
        Lck_Unlock(&oc->boc->mtx);
        if (statep != NULL)
                *statep = state;
        return (rv);
}

void
ObjVAICancel(struct worker *wrk, struct boc *boc, struct vai_qe *qe)
{

        (void) wrk;
        CHECK_OBJ_NOTNULL(boc, BOC_MAGIC);
        CHECK_OBJ_NOTNULL(qe, VAI_Q_MAGIC);

        Lck_Lock(&boc->mtx);
        // inefficient, but should be rare
        if ((qe->flags & VAI_QF_INQUEUE) != 0)
                VSLIST_REMOVE(&boc->vai_q_head, qe, vai_qe, list);
        qe->flags = 0;
        Lck_Unlock(&boc->mtx);
}

/*====================================================================
 */

void
ObjSetState(struct worker *wrk, const struct objcore *oc,
    enum boc_state_e next)
{
        const struct obj_methods *om;

        CHECK_OBJ_NOTNULL(oc, OBJCORE_MAGIC);
        CHECK_OBJ_NOTNULL(oc->boc, BOC_MAGIC);
        assert(next > oc->boc->state);

        CHECK_OBJ_ORNULL(oc->stobj->stevedore, STEVEDORE_MAGIC);
        assert(next != BOS_STREAM || oc->boc->state == BOS_PREP_STREAM);
        assert(next != BOS_FINISHED || (oc->oa_present & (1 << OA_LEN)));

        if (oc->stobj->stevedore != NULL) {
                om = oc->stobj->stevedore->methods;
                if (om->objsetstate != NULL)
                        om->objsetstate(wrk, oc, next);
        }

        Lck_Lock(&oc->boc->mtx);
        oc->boc->state = next;
        obj_boc_notify_Unlock(oc->boc);
}

/*====================================================================
 */

void
ObjWaitState(const struct objcore *oc, enum boc_state_e want)
{

        CHECK_OBJ_NOTNULL(oc, OBJCORE_MAGIC);
        CHECK_OBJ_NOTNULL(oc->boc, BOC_MAGIC);

        Lck_Lock(&oc->boc->mtx);
        /* wake up obj_extend_condwait() */
        if (oc->flags & OC_F_CANCEL)
                PTOK(pthread_cond_signal(&oc->boc->cond));
        while (1) {
                if (oc->boc->state >= want)
                        break;
                (void)Lck_CondWait(&oc->boc->cond, &oc->boc->mtx);
        }
        Lck_Unlock(&oc->boc->mtx);
}

/*====================================================================
 * ObjGetlen()
 *
 * This is a separate function because it may need locking
 */

uint64_t
ObjGetLen(struct worker *wrk, struct objcore *oc)
{
        uint64_t len;

        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);

        AZ(ObjGetU64(wrk, oc, OA_LEN, &len));
        return (len);
}

/*====================================================================
 * ObjSlim()
 *
 * Free the whatever storage can be freed, without freeing the actual
 * object yet.
 */

void
ObjSlim(struct worker *wrk, struct objcore *oc)
{
        const struct obj_methods *om = obj_getmethods(oc);

        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);

        if (om->objslim != NULL)
                om->objslim(wrk, oc);
}

/*====================================================================
 * Called when the boc used to populate the objcore is going away.
 * Useful for releasing any leftovers from Trim.
 */

void
ObjBocDone(struct worker *wrk, struct objcore *oc, struct boc **boc)
{
        const struct obj_methods *m;

        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
        CHECK_OBJ_NOTNULL(oc, OBJCORE_MAGIC);
        AN(boc);
        CHECK_OBJ_NOTNULL(*boc, BOC_MAGIC);
        CHECK_OBJ_ORNULL(oc->stobj->stevedore, STEVEDORE_MAGIC);
        if (oc->stobj->stevedore != NULL) {
                m = obj_getmethods(oc);
                if (m->objbocdone != NULL)
                        m->objbocdone(wrk, oc, *boc);
        }
        obj_deleteboc(boc);
}

/*====================================================================
 */
void
ObjFreeObj(struct worker *wrk, struct objcore *oc)
{
        const struct obj_methods *m = obj_getmethods(oc);

        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);

        AN(m->objfree);
        m->objfree(wrk, oc);
        AZ(oc->stobj->stevedore);
}

/*====================================================================
 * ObjHasAttr()
 *
 * Check if object has this attribute
 */

int
ObjHasAttr(struct worker *wrk, struct objcore *oc, enum obj_attr attr)
{

        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
        CHECK_OBJ_NOTNULL(oc, OBJCORE_MAGIC);

        if (oc->oa_present)
                return (oc->oa_present & (1 << attr));

        /* resurrected persistent objects don't have oa_present set */
        return (ObjGetAttr(wrk, oc, attr, NULL) != NULL ? 1 : 0);
}

/*====================================================================
 * ObjGetAttr()
 *
 * Get an attribute of the object.
 *
 * Returns NULL on unset or zero length attributes and len set to
 * zero. Returns Non-NULL otherwise and len is updated with the attributes
 * length.
 */

const void *
ObjGetAttr(struct worker *wrk, struct objcore *oc, enum obj_attr attr,
   ssize_t *len)
{
        const struct obj_methods *om = obj_getmethods(oc);

        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);

        AN(om->objgetattr);
        return (om->objgetattr(wrk, oc, attr, len));
}

/*====================================================================
 * ObjSetAttr()
 *
 * Setting fixed size attributes always succeeds.
 *
 * Setting a variable size attribute asserts if the combined size of the
 * variable attributes exceeds the total variable attribute space set at
 * object creation. If there is space it always succeeds.
 *
 * Setting an auxiliary attribute can fail.
 *
 * Resetting any variable asserts if the new length does not match the
 * previous length exactly.
 *
 * If ptr is Non-NULL, it points to the new content which is copied into
 * the attribute.  Otherwise the caller will have to do the copying.
 *
 * Return value is non-NULL on success and NULL on failure. If ptr was
 * non-NULL, it is an error to use the returned pointer to set the
 * attribute data, it is only a success indicator in that case.
 */

void *
ObjSetAttr(struct worker *wrk, struct objcore *oc, enum obj_attr attr,
    ssize_t len, const void *ptr)
{
        const struct obj_methods *om = obj_getmethods(oc);
        void *r;

        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
        CHECK_OBJ_NOTNULL(oc->boc, BOC_MAGIC);

        AN(om->objsetattr);
        assert((int)attr < 16);
        r = om->objsetattr(wrk, oc, attr, len, ptr);
        if (r)
                oc->oa_present |= (1 << attr);
        return (r);
}

/*====================================================================
 * ObjTouch()
 */

void
ObjTouch(struct worker *wrk, struct objcore *oc, vtim_real now)
{
        const struct obj_methods *om = obj_getmethods(oc);

        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
        if (om->objtouch != NULL)
                om->objtouch(wrk, oc, now);
}

/*====================================================================
 * Utility functions which work on top of the previous ones
 */

int
ObjCopyAttr(struct worker *wrk, struct objcore *oc, struct objcore *ocs,
    enum obj_attr attr)
{
        const void *vps;
        void *vpd;
        ssize_t l;

        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
        CHECK_OBJ_NOTNULL(oc, OBJCORE_MAGIC);
        CHECK_OBJ_NOTNULL(oc->boc, BOC_MAGIC);
        CHECK_OBJ_NOTNULL(ocs, OBJCORE_MAGIC);

        vps = ObjGetAttr(wrk, ocs, attr, &l);
        // XXX: later we want to have zero-length OA's too
        if (vps == NULL || l <= 0)
                return (-1);
        vpd = ObjSetAttr(wrk, oc, attr, l, vps);
        if (vpd == NULL)
                return (-1);
        return (0);
}

int
ObjSetXID(struct worker *wrk, struct objcore *oc, vxid_t xid)
{
        uint64_t u;

        u = VXID(xid);
        AZ(ObjSetU64(wrk, oc, OA_VXID, u));
        return (0);
}


vxid_t
ObjGetXID(struct worker *wrk, struct objcore *oc)
{
        vxid_t u;

        AZ(ObjGetU64(wrk, oc, OA_VXID, &u.vxid));
        return (u);
}

/*--------------------------------------------------------------------
 * There is no well-defined byteorder for IEEE-754 double and the
 * correct solution (frexp(3) and manual encoding) is more work
 * than our (weak) goal of being endian-agnostic requires at this point.
 * We give it a shot by memcpy'ing doubles over a uint64_t and then
 * BE encode that.
 */

int
ObjSetDouble(struct worker *wrk, struct objcore *oc, enum obj_attr a, double t)
{
        void *vp;
        uint64_t u;

        assert(sizeof t == sizeof u);
        memcpy(&u, &t, sizeof u);
        vp = ObjSetAttr(wrk, oc, a, sizeof u, NULL);
        if (vp == NULL)
                return (-1);
        vbe64enc(vp, u);
        return (0);
}

int
ObjGetDouble(struct worker *wrk, struct objcore *oc, enum obj_attr a, double *d)
{
        const void *vp;
        uint64_t u;
        ssize_t l;

        assert(sizeof *d == sizeof u);
        vp = ObjGetAttr(wrk, oc, a, &l);
        if (vp == NULL)
                return (-1);
        if (d != NULL) {
                assert(l == sizeof u);
                u = vbe64dec(vp);
                memcpy(d, &u, sizeof *d);
        }
        return (0);
}

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

int
ObjSetU64(struct worker *wrk, struct objcore *oc, enum obj_attr a, uint64_t t)
{
        void *vp;

        vp = ObjSetAttr(wrk, oc, a, sizeof t, NULL);
        if (vp == NULL)
                return (-1);
        vbe64enc(vp, t);
        return (0);
}

int
ObjGetU64(struct worker *wrk, struct objcore *oc, enum obj_attr a, uint64_t *d)
{
        const void *vp;
        ssize_t l;

        vp = ObjGetAttr(wrk, oc, a, &l);
        if (vp == NULL || l != sizeof *d)
                return (-1);
        if (d != NULL)
                *d = vbe64dec(vp);
        return (0);
}

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

int
ObjCheckFlag(struct worker *wrk, struct objcore *oc, enum obj_flags of)
{
        const uint8_t *fp;

        fp = ObjGetAttr(wrk, oc, OA_FLAGS, NULL);
        AN(fp);
        return ((*fp) & of);
}

void
ObjSetFlag(struct worker *wrk, struct objcore *oc, enum obj_flags of, int val)
{
        uint8_t *fp;

        fp = ObjSetAttr(wrk, oc, OA_FLAGS, 1, NULL);
        AN(fp);
        if (val)
                (*fp) |= of;
        else
                (*fp) &= ~of;
}

/*====================================================================
 * Object event subscription mechanism.
 *
 * XXX: it is extremely unclear what the locking circumstances are here.
 */

struct oev_entry {
        unsigned                        magic;
#define OEV_MAGIC                       0xb0b7c5a1
        unsigned                        mask;
        obj_event_f                     *func;
        void                            *priv;
        VTAILQ_ENTRY(oev_entry)         list;
};

static VTAILQ_HEAD(,oev_entry)          oev_list;
static pthread_rwlock_t                 oev_rwl;
static unsigned                         oev_mask;

/*
 * NB: ObjSubscribeEvents() is not atomic:
 * oev_mask is checked optimistically in ObjSendEvent()
 */
uintptr_t
ObjSubscribeEvents(obj_event_f *func, void *priv, unsigned mask)
{
        struct oev_entry *oev;

        AN(func);
        AZ(mask & ~OEV_MASK);

        ALLOC_OBJ(oev, OEV_MAGIC);
        AN(oev);
        oev->func = func;
        oev->priv = priv;
        oev->mask = mask;
        PTOK(pthread_rwlock_wrlock(&oev_rwl));
        VTAILQ_INSERT_TAIL(&oev_list, oev, list);
        oev_mask |= mask;
        PTOK(pthread_rwlock_unlock(&oev_rwl));
        return ((uintptr_t)oev);
}

void
ObjUnsubscribeEvents(uintptr_t *handle)
{
        struct oev_entry *oev, *oev2 = NULL;
        unsigned newmask = 0;

        AN(handle);
        AN(*handle);
        PTOK(pthread_rwlock_wrlock(&oev_rwl));
        VTAILQ_FOREACH(oev, &oev_list, list) {
                CHECK_OBJ_NOTNULL(oev, OEV_MAGIC);
                if ((uintptr_t)oev == *handle)
                        oev2 = oev;
                else
                        newmask |= oev->mask;
        }
        AN(oev2);
        VTAILQ_REMOVE(&oev_list, oev2, list);
        oev_mask = newmask;
        AZ(newmask & ~OEV_MASK);
        PTOK(pthread_rwlock_unlock(&oev_rwl));
        FREE_OBJ(oev2);
        *handle = 0;
}

void
ObjSendEvent(struct worker *wrk, struct objcore *oc, unsigned event)
{
        struct oev_entry *oev;

        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
        CHECK_OBJ_NOTNULL(oc, OBJCORE_MAGIC);
        AN(event & OEV_MASK);
        AZ(event & ~OEV_MASK);
        if (!(event & oev_mask))
                return;

        PTOK(pthread_rwlock_rdlock(&oev_rwl));
        VTAILQ_FOREACH(oev, &oev_list, list) {
                CHECK_OBJ_NOTNULL(oev, OEV_MAGIC);
                if (event & oev->mask)
                        oev->func(wrk, oev->priv, oc, event);
        }
        PTOK(pthread_rwlock_unlock(&oev_rwl));

}

void
ObjInit(void)
{
        VTAILQ_INIT(&oev_list);
        PTOK(pthread_rwlock_init(&oev_rwl, NULL));
}

		varnish-cache/bin/varnishd/cache/cache_obj.c
0		/*-
1		* Copyright (c) 2013-2016 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		* Lifetime of an objcore:
30		* phase 0 - nonexistent
31		* phase 1 - created, but no stevedore associated
32		* phase 2 - stevedore associated, being filled out
33		* phase 3 - stable, no changes happening
34		* phase 4 - unavailable, being dismantled
35		* phase 5 - stevedore disassociated
36		* phase 6 - nonexistent
37		*
38		* 0->1 ObjNew() creates objcore
39		*
40		* 1->2 STV_NewObject() associates a stevedore
41		*
42		* 2 ObjSetState() sets state
43		* 2 ObjWaitState() waits for particular state
44		* INVALID->REQ_DONE->STREAM->FINISHED->FAILED
45		*
46		* 2 ObjGetSpace() allocates space
47		* 2 ObjExtend() commits content
48		* 2 ObjWaitExtend() waits for content - used to implement ObjIterate())
49		*
50		* 2 ObjSetAttr()
51		* 2 ObjCopyAttr()
52		* 2 ObjSetFlag()
53		* 2 ObjSetDouble()
54		* 2 ObjSetU32()
55		* 2 ObjSetU64()
56		*
57		* 2->3 ObjBocDone() Boc removed from OC, clean it up
58		*
59		* 23 ObjHasAttr()
60		* 23 ObjGetAttr()
61		* 23 ObjCheckFlag()
62		* 23 ObjGetDouble()
63		* 23 ObjGetU32()
64		* 23 ObjGetU64()
65		* 23 ObjGetLen()
66		* 23 ObjGetXID()
67		*
68		* 23 ObjIterate() ... over body
69		*
70		* 23 ObjTouch() Signal to LRU(-like) facilities
71		*
72		* 3->4 HSH_Snipe() kill if not in use
73		* 3->4 HSH_Kill() make unavailable
74		*
75		* 234 ObjSlim() Release body storage (but retain attribute storage)
76		*
77		* 4->5 ObjFreeObj() disassociates stevedore
78		*
79		* 5->6 FREE_OBJ() ...in HSH_DerefObjCore()
80		*/
81
82		#include "config.h"
83
84		#include <stdlib.h>
85
86		#include "cache_varnishd.h"
87		#include "cache_obj.h"
88		#include "vend.h"
89		#include "storage/storage.h"
90
91		static const struct obj_methods *
92	162497	obj_getmethods(const struct objcore *oc)
93		{
94
95	162497	CHECK_OBJ_NOTNULL(oc, OBJCORE_MAGIC);
96	162497	CHECK_OBJ_NOTNULL(oc->stobj->stevedore, STEVEDORE_MAGIC);
97	162497	AN(oc->stobj->stevedore->methods);
98	162497	return (oc->stobj->stevedore->methods);
99		}
100
101		static struct boc *
102	3199	obj_newboc(void)
103		{
104		struct boc *boc;
105
106	3199	ALLOC_OBJ(boc, BOC_MAGIC);
107	3199	AN(boc);
108	3199	Lck_New(&boc->mtx, lck_busyobj);
109	3199	PTOK(pthread_cond_init(&boc->cond, NULL));
110	3199	boc->refcount = 1;
111	3199	boc->transit_buffer = cache_param->transit_buffer;
112	3199	return (boc);
113		}
114
115		static void
116	2921	obj_deleteboc(struct boc **p)
117		{
118		struct boc *boc;
119
120	2921	TAKE_OBJ_NOTNULL(boc, p, BOC_MAGIC);
121	2921	Lck_Delete(&boc->mtx);
122	2921	PTOK(pthread_cond_destroy(&boc->cond));
123	2921	free(boc->vary);
124	2921	FREE_OBJ(boc);
125	2921	}
126
127		/*====================================================================
128		* ObjNew()
129		*
130		*/
131
132		struct objcore *
133	3199	ObjNew(const struct worker *wrk)
134		{
135		struct objcore *oc;
136
137	3199	CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
138
139	3199	ALLOC_OBJ(oc, OBJCORE_MAGIC);
140	3199	AN(oc);
141	3199	wrk->stats->n_objectcore++;
142	3199	oc->last_lru = NAN;
143	3199	oc->flags = OC_F_BUSY;
144
145	3199	oc->boc = obj_newboc();
146
147	3199	return (oc);
148		}
149
150		/*====================================================================
151		* ObjDestroy()
152		*
153		*/
154
155		void
156	1857	ObjDestroy(const struct worker wrk, struct objcore *p)
157		{
158		struct objcore *oc;
159
160	1857	CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
161	1857	TAKE_OBJ_NOTNULL(oc, p, OBJCORE_MAGIC);
162	1857	if (oc->boc != NULL)
163	33	obj_deleteboc(&oc->boc);
164	1857	FREE_OBJ(oc);
165	1857	wrk->stats->n_objectcore--;
166	1857	}
167
168		/*====================================================================
169		* ObjIterate()
170		*
171		*/
172
173		int
174	2403	ObjIterate(struct worker wrk, struct objcore oc,
175		void priv, objiterate_f func, int final)
176		{
177	2403	const struct obj_methods *om = obj_getmethods(oc);
178
179	2403	CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
180	2403	AN(func);
181	2403	AN(om->objiterator);
182	2403	return (om->objiterator(wrk, oc, priv, func, final));
183		}
184
185		/*====================================================================
186		* ObjVAI...(): Asynchronous Iteration
187		*
188		*
189		* ObjVAIinit() returns an opaque handle, or NULL if not supported
190		*
191		* A VAI handle must not be used concurrently
192		*
193		* the vai_notify_cb(priv) will be called asynchronously by the storage
194		* engine when a -EAGAIN / -ENOBUFS condition is over and ObjVAIlease()
195		* can be called again.
196		*
197		* Note:
198		* - the callback gets executed by an arbitrary thread
199		* - WITH the boc mtx held
200		* so it should never block and only do minimal work
201		*
202		* ObjVAIlease() fills the vscarab with leases. returns:
203		*
204		* -EAGAIN: nothing available at the moment, storage will notify, no use to
205		* call again until notification
206		* -ENOBUFS: caller needs to return leases, storage will notify
207		* -EPIPE: BOS_FAILED for busy object
208		* -(errno): other problem, fatal
209		*
210		* >= 0: number of viovs added (== scarab->capacity - scarab->used)
211		*
212		* struct vscarab:
213		*
214		* the leases can be used by the caller until returned with
215		* ObjVAIreturn(). The storage guarantees that the lease member is a
216		* multiple of 8 (that is, the lower three bits are zero). These can be
217		* used by the caller between lease and return, but must be cleared to
218		* zero before returning.
219		*
220		* ObjVAIbuffer() allocates temporary buffers, returns:
221		*
222		* -EAGAIN: allocation can not be fulfilled immediately, storage will notify,
223		* no use to call again until notification
224		* -EINVAL: size larger than UINT_MAX requested
225		* -(errno): other problem, fatal
226		* n: n > 0, number of viovs filled
227		*
228		* The struct vscarab is used on the way in and out: On the way in, the
229		* iov.iov_len members contain the sizes the caller requests, all other
230		* members of the struct viovs are expected to be zero initialized.
231		*
232		* The maximum size to be requested is UINT_MAX.
233		*
234		* ObjVAIbuffer() may return sizes larger than requested. The returned n
235		* might be smaller than requested.
236		*
237		* ObjVAIreturn() returns leases collected in a struct vscaret
238		*
239		* it must be called with a vscaret, which holds an array of lease values
240		* received via ObjVAIlease() or ObjVAIbuffer() when the caller can
241		* guarantee that they are no longer accessed.
242		*
243		* ObjVAIreturn() may retain leases in the vscaret if the implementation
244		* still requires them, iow, the vscaret might not be empty upon return.
245		*
246		* ObjVAIfini() finalized iteration
247		*
248		* it must be called when iteration is done, irrespective of error status
249		*/
250
251		vai_hdl
252	2452	ObjVAIinit(struct worker wrk, struct objcore oc, struct ws *ws,
253		vai_notify_cb cb, void cb_priv)
254		{
255	2452	const struct obj_methods *om = obj_getmethods(oc);
256
257	2452	CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
258
259	2452	if (om->vai_init == NULL)
260	0	return (NULL);
261	2452	return (om->vai_init(wrk, oc, ws, cb, cb_priv));
262	2452	}
263
264		int
265	6733	ObjVAIlease(struct worker wrk, vai_hdl vhdl, struct vscarab scarab)
266		{
267	6733	struct vai_hdl_preamble *vaip = vhdl;
268
269	6733	AN(vaip);
270	6733	assert(vaip->magic2 == VAI_HDL_PREAMBLE_MAGIC2);
271	6733	AN(vaip->vai_lease);
272	6733	return (vaip->vai_lease(wrk, vhdl, scarab));
273		}
274
275		int
276	16	ObjVAIbuffer(struct worker wrk, vai_hdl vhdl, struct vscarab scarab)
277		{
278	16	struct vai_hdl_preamble *vaip = vhdl;
279
280	16	AN(vaip);
281	16	assert(vaip->magic2 == VAI_HDL_PREAMBLE_MAGIC2);
282	16	AN(vaip->vai_buffer);
283	16	return (vaip->vai_buffer(wrk, vhdl, scarab));
284		}
285
286		void
287	3027	ObjVAIreturn(struct worker wrk, vai_hdl vhdl, struct vscaret scaret)
288		{
289	3027	struct vai_hdl_preamble *vaip = vhdl;
290
291	3027	AN(vaip);
292	3027	assert(vaip->magic2 == VAI_HDL_PREAMBLE_MAGIC2);
293	3027	AN(vaip->vai_return);
294	3027	vaip->vai_return(wrk, vhdl, scaret);
295	3027	}
296
297		void
298	2452	ObjVAIfini(struct worker wrk, vai_hdl vhdlp)
299		{
300	2452	AN(vhdlp);
301	2452	struct vai_hdl_preamble vaip = vhdlp;
302
303	2452	AN(vaip);
304	2452	assert(vaip->magic2 == VAI_HDL_PREAMBLE_MAGIC2);
305	2452	AN(vaip->vai_lease);
306	2452	vaip->vai_fini(wrk, vhdlp);
307	2452	}
308
309		/*====================================================================
310		* ObjGetSpace()
311		*
312		* This function returns a pointer and length of free space. If there
313		* is no free space, some will be added first.
314		*
315		* The "sz" argument is an input hint of how much space is desired.
316		* 0 means "unknown", return some default size (maybe fetch_chunksize)
317		*/
318
319		int
320	58096	ObjGetSpace(struct worker wrk, struct objcore oc, ssize_t sz, uint8_t *ptr)
321		{
322	58096	const struct obj_methods *om = obj_getmethods(oc);
323
324	58096	CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
325	58096	CHECK_OBJ_NOTNULL(oc->boc, BOC_MAGIC);
326	58096	AN(sz);
327	58096	AN(ptr);
328	58096	assert(*sz >= 0);
329
330	58096	AN(om->objgetspace);
331	58096	return (om->objgetspace(wrk, oc, sz, ptr));
332		}
333
334		/*====================================================================
335		* ObjExtend()
336		*
337		* This function extends the used part of the object a number of bytes
338		* into the last space returned by ObjGetSpace()
339		*
340		* The final flag must be set on the last call, and it will release any
341		* surplus space allocated.
342		*/
343
344		static void
345	56621	obj_extend_condwait(const struct objcore *oc)
346		{
347
348	56621	if (oc->boc->transit_buffer == 0)
349	56130	return;
350
351	491	assert(oc->flags & OC_F_TRANSIENT);
352	519	while (!(oc->flags & OC_F_CANCEL) && oc->boc->fetched_so_far >
353	517	oc->boc->delivered_so_far + oc->boc->transit_buffer)
354	28	(void)Lck_CondWait(&oc->boc->cond, &oc->boc->mtx);
355	56621	}
356
357		// notify of an extension of the boc or state change
358		//lint -sem(obj_boc_notify_Unlock, thread_unlock)
359
360		static void
361	64117	obj_boc_notify_Unlock(struct boc *boc)
362		{
363		struct vai_qe qe, next;
364
365	64117	PTOK(pthread_cond_broadcast(&boc->cond));
366	64117	qe = VSLIST_FIRST(&boc->vai_q_head);
367	64117	VSLIST_FIRST(&boc->vai_q_head) = NULL;
368	65462	while (qe != NULL) {
369	1345	CHECK_OBJ(qe, VAI_Q_MAGIC);
370	1345	AN(qe->flags & VAI_QF_INQUEUE);
371	1345	qe->flags &= ~VAI_QF_INQUEUE;
372	1345	next = VSLIST_NEXT(qe, list);
373	1345	VSLIST_NEXT(qe, list) = NULL;
374	1345	qe->cb(qe->hdl, qe->priv);
375	1345	qe = next;
376		}
377	64117	Lck_Unlock(&boc->mtx);
378	64117	}
379
380		void
381	57313	ObjExtend(struct worker wrk, struct objcore oc, ssize_t l, int final)
382		{
383	57313	const struct obj_methods *om = obj_getmethods(oc);
384
385	57313	CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
386	57313	CHECK_OBJ_NOTNULL(oc->boc, BOC_MAGIC);
387	57313	AN(om->objextend);
388	57313	assert(l >= 0);
389
390	57313	if (l > 0) {
391	56621	Lck_Lock(&oc->boc->mtx);
392	56621	obj_extend_condwait(oc);
393	56621	om->objextend(wrk, oc, l);
394	56621	oc->boc->fetched_so_far += l;
395	56621	obj_boc_notify_Unlock(oc->boc);
396	56621	}
397
398	57313	assert(oc->boc->state < BOS_FINISHED);
399	57313	if (final && om->objtrimstore != NULL)
400	1879	om->objtrimstore(wrk, oc);
401	57313	}
402
403		/*====================================================================
404		*/
405
406		static inline void
407	4656	objSignalFetchLocked(const struct objcore *oc, uint64_t l)
408		{
409	4656	if (oc->boc->transit_buffer > 0) {
410	1042	assert(oc->flags & OC_F_TRANSIENT);
411		/* Signal the new client position */
412	1042	oc->boc->delivered_so_far = l;
413	1042	PTOK(pthread_cond_signal(&oc->boc->cond));
414	1042	}
415	4656	}
416
417		uint64_t
418	0	ObjWaitExtend(const struct worker wrk, const struct objcore oc, uint64_t l,
419		enum boc_state_e *statep)
420		{
421		enum boc_state_e state;
422		uint64_t rv;
423
424	0	CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
425	0	CHECK_OBJ_NOTNULL(oc, OBJCORE_MAGIC);
426	0	CHECK_OBJ_NOTNULL(oc->boc, BOC_MAGIC);
427	0	Lck_Lock(&oc->boc->mtx);
428	0	while (1) {
429	0	rv = oc->boc->fetched_so_far;
430	0	assert(l <= rv \|\| oc->boc->state == BOS_FAILED);
431	0	state = oc->boc->state;
432	0	objSignalFetchLocked(oc, l);
433	0	if (rv > l \|\| state >= BOS_FINISHED)
434	0	break;
435	0	(void)Lck_CondWait(&oc->boc->cond, &oc->boc->mtx);
436		}
437	0	Lck_Unlock(&oc->boc->mtx);
438	0	if (statep != NULL)
439	0	*statep = state;
440	0	return (rv);
441		}
442
443		// get a new extension _or_ register a notification
444		uint64_t
445	4656	ObjVAIGetExtend(struct worker wrk, const struct objcore oc, uint64_t l,
446		enum boc_state_e statep, struct vai_qe qe)
447		{
448		enum boc_state_e state;
449		uint64_t rv;
450
451	4656	(void) wrk;
452	4656	CHECK_OBJ_NOTNULL(oc, OBJCORE_MAGIC);
453	4656	CHECK_OBJ_NOTNULL(oc->boc, BOC_MAGIC);
454	4656	CHECK_OBJ_NOTNULL(qe, VAI_Q_MAGIC);
455	4656	Lck_Lock(&oc->boc->mtx);
456	4656	rv = oc->boc->fetched_so_far;
457	4656	assert(l <= rv \|\| oc->boc->state == BOS_FAILED);
458	4656	state = oc->boc->state;
459	4656	objSignalFetchLocked(oc, l);
460	4656	if (l == rv && state < BOS_FINISHED &&
461	2609	(qe->flags & VAI_QF_INQUEUE) == 0) {
462	1354	qe->flags \|= VAI_QF_INQUEUE;
463	1354	VSLIST_INSERT_HEAD(&oc->boc->vai_q_head, qe, list);
464	1354	}
465	4656	Lck_Unlock(&oc->boc->mtx);
466	4656	if (statep != NULL)
467	4658	*statep = state;
468	4660	return (rv);
469		}
470
471		void
472	755	ObjVAICancel(struct worker wrk, struct boc boc, struct vai_qe *qe)
473		{
474
475	755	(void) wrk;
476	755	CHECK_OBJ_NOTNULL(boc, BOC_MAGIC);
477	755	CHECK_OBJ_NOTNULL(qe, VAI_Q_MAGIC);
478
479	755	Lck_Lock(&boc->mtx);
480		// inefficient, but should be rare
481	755	if ((qe->flags & VAI_QF_INQUEUE) != 0)
482	10	VSLIST_REMOVE(&boc->vai_q_head, qe, vai_qe, list);
483	755	qe->flags = 0;
484	755	Lck_Unlock(&boc->mtx);
485	755	}
486
487		/*====================================================================
488		*/
489
490		void
491	7498	ObjSetState(struct worker wrk, const struct objcore oc,
492		enum boc_state_e next)
493		{
494		const struct obj_methods *om;
495
496	7498	CHECK_OBJ_NOTNULL(oc, OBJCORE_MAGIC);
497	7498	CHECK_OBJ_NOTNULL(oc->boc, BOC_MAGIC);
498	7498	assert(next > oc->boc->state);
499