varnish-cache/bin/varnishd/waiter/waiter_priv.h
0
/*-
1
 * Copyright (c) 2006 Verdens Gang AS
2
 * Copyright (c) 2006-2011 Varnish Software AS
3
 * All rights reserved.
4
 *
5
 * Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
6
 *
7
 * SPDX-License-Identifier: BSD-2-Clause
8
 *
9
 * Redistribution and use in source and binary forms, with or without
10
 * modification, are permitted provided that the following conditions
11
 * are met:
12
 * 1. Redistributions of source code must retain the above copyright
13
 *    notice, this list of conditions and the following disclaimer.
14
 * 2. Redistributions in binary form must reproduce the above copyright
15
 *    notice, this list of conditions and the following disclaimer in the
16
 *    documentation and/or other materials provided with the distribution.
17
 *
18
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21
 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
22
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28
 * SUCH DAMAGE.
29
 *
30
 * Private interfaces
31
 */
32
33
struct waited;
34
struct vbh;
35
36
struct waiter {
37
        unsigned                        magic;
38
#define WAITER_MAGIC                    0x17c399db
39
        const struct waiter_impl        *impl;
40
        VTAILQ_ENTRY(waiter)            list;
41
        VTAILQ_HEAD(,waited)            waithead;
42
43
        void                            *priv;
44
        struct vbh                      *heap;
45
};
46
47
typedef void waiter_init_f(struct waiter *);
48
typedef void waiter_fini_f(struct waiter *);
49
typedef int waiter_enter_f(void *priv, struct waited *);
50
typedef void waiter_inject_f(const struct waiter *, struct waited *);
51
typedef void waiter_evict_f(const struct waiter *, struct waited *);
52
53
struct waiter_impl {
54
        const char                      *name;
55
        waiter_init_f                   *init;
56
        waiter_fini_f                   *fini;
57
        waiter_enter_f                  *enter;
58
        waiter_inject_f                 *inject;
59
        size_t                          size;
60
};
61
62
static inline double
63 86170
Wait_When(const struct waited *wp)
64
{
65 86170
        CHECK_OBJ_NOTNULL(wp, WAITED_MAGIC);
66 86170
        return (wp->idle + wp->tmo);
67
}
68
69
void Wait_Call(const struct waiter *, struct waited *,
70
    enum wait_event ev, double now);
71
void Wait_HeapInsert(const struct waiter *, struct waited *);
72
int Wait_HeapDelete(const struct waiter *, const struct waited *);
73
double Wait_HeapDue(const struct waiter *, struct waited **);