varnish-cache/lib/libvarnish/vev.c
0
/*-
1
 * Copyright (c) 2006 Verdens Gang AS
2
 * Copyright (c) 2006-2009 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
31
#include "config.h"
32
33
#include <time.h>
34
#include <poll.h>
35
#include <pthread.h>
36
#include <signal.h>
37
#include <stdio.h>
38
#include <stdlib.h>
39
#include <string.h>
40
41
#include "vdef.h"
42
#include "miniobj.h"
43
#include "vas.h"
44
45
#include "vbh.h"
46
#include "vev.h"
47
#include "vtim.h"
48
49
#undef DEBUG_EVENTS
50
51
/* INFTIM indicates an infinite timeout for poll(2) */
52
#ifndef INFTIM
53
#define INFTIM -1
54
#endif
55
56
struct vevsig {
57
        struct vev_root         *vevb;
58
        struct vev              *vev;
59
        struct sigaction        sigact;
60
        unsigned char           happened;
61
        siginfo_t               siginfo[1];
62
};
63
64
static struct vevsig            *vev_sigs;
65
static int                      vev_nsig;
66
67
struct vev_root {
68
        unsigned                magic;
69
#define VEV_BASE_MAGIC          0x477bcf3d
70
        unsigned                n_fd_events;
71
        struct pollfd           *pfd;
72
        struct vev              **pev;
73
        unsigned                npfd;
74
        unsigned                lpfd;
75
        struct vbh              *binheap;
76
        unsigned                psig;
77
        pthread_t               thread;
78
#ifdef DEBUG_EVENTS
79
        FILE                    *debug;
80
#endif
81
};
82
83
/*--------------------------------------------------------------------*/
84
85
#ifdef DEBUG_EVENTS
86
#define DBG(evb, ...) do {                              \
87
        if ((evb)->debug != NULL)                       \
88
                fprintf((evb)->debug, __VA_ARGS__);     \
89
        } while (0);
90
#else
91
#define DBG(evb, ...)   /* ... */
92
//#define DBG(evb, ...) fprintf(stderr, __VA_ARGS__);
93
#endif
94
95
/*--------------------------------------------------------------------*/
96
97
static void v_matchproto_(vbh_update_t)
98 124703
vev_bh_update(void *priv, void *a, unsigned u)
99
{
100
        struct vev_root *evb;
101
        struct vev *e;
102
103 124703
        CAST_OBJ_NOTNULL(evb, priv, VEV_BASE_MAGIC);
104 124703
        CAST_OBJ_NOTNULL(e, a, VEV_MAGIC);
105 124703
        assert(u < evb->lpfd);
106 124703
        e->__binheap_idx = u;
107 124703
        if (u != VBH_NOIDX) {
108 105202
                evb->pev[u] = e;
109 105202
                evb->pfd[u].fd = e->fd;
110 105202
                evb->pfd[u].events =
111 105202
                    e->fd_flags & (VEV__RD|VEV__WR|VEV__ERR|VEV__HUP);
112 105202
        }
113 124703
}
114
115
static int v_matchproto_(vbh_cmp_t)
116 71657
vev_bh_cmp(void *priv, const void *a, const void *b)
117
{
118
        struct vev_root *evb;
119
        const struct vev *ea, *eb;
120
121 71657
        CAST_OBJ_NOTNULL(evb, priv, VEV_BASE_MAGIC);
122 71657
        CAST_OBJ_NOTNULL(ea, a, VEV_MAGIC);
123 71657
        CAST_OBJ_NOTNULL(eb, b, VEV_MAGIC);
124 71657
        return (ea->__when < eb->__when);
125
}
126
127
/*--------------------------------------------------------------------*/
128
129
static int
130 17264
vev_get_pfd(struct vev_root *evb)
131
{
132
        unsigned u;
133
134 17264
        if (evb->lpfd + 1 < evb->npfd)
135 13242
                return (0);
136
137 4022
        if (evb->npfd < 8)
138 3072
                u = 8;
139 950
        else if (evb->npfd > 256)
140 0
                u = evb->npfd + 256;
141
        else
142 950
                u = evb->npfd * 2;
143 4022
        evb->npfd = u;
144 4022
        evb->pfd = realloc(evb->pfd, sizeof(*evb->pfd) * u);
145 4022
        AN(evb->pfd);
146 4022
        evb->pev = realloc(evb->pev, sizeof(*evb->pev) * u);
147 4022
        AN(evb->pev);
148 4022
        return (0);
149 17264
}
150
151
/*--------------------------------------------------------------------*/
152
153
static int
154 1886
vev_get_sig(int sig)
155
{
156
        struct vevsig *os;
157
158 1886
        if (sig < vev_nsig)
159 943
                return (0);
160
161 943
        os = calloc((sig + 1L), sizeof *os);
162 943
        if (os == NULL)
163 0
                return (ENOMEM);
164
165 943
        if (vev_sigs != NULL) {
166 0
                memcpy(os, vev_sigs, vev_nsig * sizeof *os);
167 0
                free(vev_sigs);
168 0
        }
169 943
        vev_sigs = os;
170 943
        vev_nsig = sig + 1;
171
172 943
        return (0);
173 1886
}
174
175
/*--------------------------------------------------------------------*/
176
177
static void
178 5
vev_sigaction(int sig, siginfo_t *siginfo, void *ctx)
179
{
180
        struct vevsig *es;
181
182 5
        (void)ctx;
183 5
        assert(sig < vev_nsig);
184 5
        assert(vev_sigs != NULL);
185 5
        es = &vev_sigs[sig];
186 5
        if (!es->happened) {
187 5
                es->vevb->psig++;
188 5
                memcpy(es->siginfo, siginfo, sizeof *es->siginfo);
189 5
                es->vev->siginfo = es->siginfo;
190 5
        }
191 5
        es->happened = 1;
192 5
}
193
194
/*--------------------------------------------------------------------*/
195
196
struct vev_root *
197 3072
VEV_New(void)
198
{
199
        struct vev_root *evb;
200
201 3072
        evb = calloc(1, sizeof *evb);
202 3072
        if (evb == NULL)
203 0
                return (evb);
204 3072
        evb->lpfd = VBH_NOIDX + 1;
205 3072
        if (vev_get_pfd(evb)) {
206 0
                free(evb);
207 0
                return (NULL);
208
        }
209 3072
        evb->magic = VEV_BASE_MAGIC;
210 3072
        evb->binheap = VBH_new(evb, vev_bh_cmp, vev_bh_update);
211 3072
        evb->thread = pthread_self();
212
#ifdef DEBUG_EVENTS
213
        evb->debug = fopen("/tmp/_.events", "w");
214
        AN(evb->debug);
215
        setbuf(evb->debug, NULL);
216
        DBG(evb, "\n\nStart debugging\n");
217
#endif
218 3072
        return (evb);
219 3072
}
220
221
/*--------------------------------------------------------------------*/
222
223
void
224 1012
VEV_Destroy(struct vev_root **evbp)
225
{
226
        struct vev_root *evb;
227
        struct vev *e;
228
229 1012
        TAKE_OBJ_NOTNULL(evb, evbp, VEV_BASE_MAGIC);
230 1012
        assert(pthread_equal(evb->thread, pthread_self()));
231 7718
        while ((e = VBH_root(evb->binheap)) != NULL) {
232 6706
                VEV_Stop(evb, e);
233 6706
                free(e);
234
        }
235 1012
        VBH_destroy(&evb->binheap);
236 1012
        free(evb->pfd);
237 1012
        free(evb->pev);
238 1012
        FREE_OBJ(evb);
239 1012
}
240
241
/*--------------------------------------------------------------------*/
242
243
struct vev *
244 14192
VEV_Alloc(void)
245
{
246
        struct vev *e;
247
248 14192
        e = calloc(1, sizeof *e);
249 14192
        if (e != NULL) {
250 14192
                e->fd = -1;
251 14192
        }
252 14192
        return (e);
253
}
254
255
/*--------------------------------------------------------------------*/
256
257
int
258 14192
VEV_Start(struct vev_root *evb, struct vev *e)
259
{
260
        struct vevsig *es;
261
262 14192
        CHECK_OBJ_NOTNULL(evb, VEV_BASE_MAGIC);
263 14192
        assert(e->magic != VEV_MAGIC);
264 14192
        assert(e->callback != NULL);
265 14192
        assert(e->sig >= 0);
266 14192
        assert(e->timeout >= 0.0);
267 14192
        assert(e->fd < 0 || e->fd_flags);
268 14192
        assert(pthread_equal(evb->thread, pthread_self()));
269
        DBG(evb, "ev_add(%p) fd = %d\n", e, e->fd);
270
271 14192
        if (vev_get_pfd(evb))
272 0
                return (ENOMEM);
273
274 14192
        if (e->sig > 0) {
275 1886
                if (vev_get_sig(e->sig))
276 0
                        return (ENOMEM);
277
278 1886
                assert(e->fd < 0);
279 1886
                es = &vev_sigs[e->sig];
280 1886
                if (es->vev != NULL)
281 0
                        return (EBUSY);
282 1886
                AZ(es->happened);
283 1886
                es->vev = e;
284 1886
                es->vevb = evb;
285 1886
                es->sigact.sa_flags = e->sig_flags | SA_SIGINFO;
286 1886
                es->sigact.sa_sigaction = vev_sigaction;
287 1886
        } else {
288 12306
                es = NULL;
289
        }
290
291 14192
        e->magic = VEV_MAGIC;   /* before VBH_insert() */
292
293 14192
        if (e->timeout != 0.0)
294 5121
                e->__when += VTIM_mono() + e->timeout;
295
        else
296 9071
                e->__when = 9e99;
297
298 14192
        evb->lpfd++;
299 14192
        VBH_insert(evb->binheap, e);
300 14192
        assert(e->__binheap_idx != VBH_NOIDX);
301
302 14192
        e->__vevb = evb;
303 14192
        e->__privflags = 0;
304
305 14192
        if (e->sig > 0) {
306 1886
                assert(es != NULL);
307 1886
                AZ(sigaction(e->sig, &es->sigact, NULL));
308 1886
        }
309
310 14192
        return (0);
311 14192
}
312
313
/*--------------------------------------------------------------------*/
314
315
void
316 14115
VEV_Stop(struct vev_root *evb, struct vev *e)
317
{
318
        struct vevsig *es;
319
320 14115
        CHECK_OBJ_NOTNULL(evb, VEV_BASE_MAGIC);
321 14115
        CHECK_OBJ_NOTNULL(e, VEV_MAGIC);
322
        DBG(evb, "ev_del(%p) fd = %d i=%u L=%d\n", e, e->fd, e->__binheap_idx, evb->lpfd);
323 14115
        assert(evb == e->__vevb);
324 14115
        assert(pthread_equal(evb->thread, pthread_self()));
325 14115
        assert(evb->pev[e->__binheap_idx] == e);
326
327 14115
        assert(e->__binheap_idx != VBH_NOIDX);
328 14115
        e->fd = -1;
329 14115
        VBH_delete(evb->binheap, e->__binheap_idx);
330 14115
        assert(e->__binheap_idx == VBH_NOIDX);
331 14115
        evb->lpfd--;
332
333 14115
        if (e->fd_events) {
334 0
                assert(evb->n_fd_events > 0);
335 0
                evb->n_fd_events--;
336 0
                e->fd_events = 0;
337 0
        }
338
339 14115
        if (e->sig > 0) {
340 1886
                assert(e->sig < vev_nsig);
341 1886
                es = &vev_sigs[e->sig];
342 1886
                assert(es->vev == e);
343 1886
                es->vev = NULL;
344 1886
                es->vevb = NULL;
345 1886
                es->sigact.sa_flags = 0;
346 1886
                es->sigact.sa_handler = SIG_DFL;
347 1886
                AZ(sigaction(e->sig, &es->sigact, NULL));
348 1886
                es->happened = 0;
349 1886
        }
350
351 14115
        e->__vevb = NULL;
352 14115
        FINI_OBJ(e);
353 14115
}
354
355
/*--------------------------------------------------------------------*/
356
357
int
358 943
VEV_Loop(struct vev_root *evb)
359
{
360
        int i;
361
362 943
        CHECK_OBJ_NOTNULL(evb, VEV_BASE_MAGIC);
363 943
        assert(pthread_equal(evb->thread, pthread_self()));
364 943
        do
365 34456
                i = VEV_Once(evb);
366 34456
        while (i == 1);
367 943
        return (i);
368
}
369
370
/*--------------------------------------------------------------------*/
371
372
static int
373 5386
vev_sched_timeout(struct vev_root *evb, struct vev *e, vtim_mono t)
374
{
375
        int i;
376
377
378 5386
        i = e->callback(e, 0);
379 5386
        if (i) {
380 0
                VEV_Stop(evb, e);
381 0
                free(e);
382 0
        } else {
383 5386
                e->__when = t + e->timeout;
384 5386
                VBH_delete(evb->binheap, e->__binheap_idx);
385 5386
                VBH_insert(evb->binheap, e);
386
        }
387 5386
        return (1);
388
}
389
390
static int
391 4
vev_sched_signal(struct vev_root *evb)
392
{
393 4
        int i, j, retval = 1;
394
        struct vevsig *es;
395
        struct vev *e;
396
397 4
        es = vev_sigs;
398 68
        for (j = 0; j < vev_nsig; j++, es++) {
399 64
                if (!es->happened || es->vevb != evb)
400 60
                        continue;
401 4
                evb->psig--;
402 4
                es->happened = 0;
403 4
                e = es->vev;
404 4
                assert(e != NULL);
405 4
                i = e->callback(e, VEV__SIG);
406 4
                if (e->siginfo != NULL) {
407 4
                        e->siginfo = NULL;
408 4
                        memset(es->siginfo, 0, sizeof *es->siginfo);
409 4
                }
410 4
                if (i) {
411 4
                        VEV_Stop(evb, e);
412 4
                        free(e);
413 4
                }
414 4
                if (i < 0)
415 4
                        retval = i;
416 4
        }
417 4
        return (retval);
418
}
419
420
int
421 41066
VEV_Once(struct vev_root *evb)
422
{
423
        double t;
424
        struct vev *e;
425 41066
        int i, k, tmo, retval = 1;
426
        unsigned u;
427
        int progress;
428
429 41066
        CHECK_OBJ_NOTNULL(evb, VEV_BASE_MAGIC);
430 41066
        assert(pthread_equal(evb->thread, pthread_self()));
431 41066
        assert(evb->lpfd < evb->npfd);
432
433 41066
        if (evb->psig)
434 0
                return (vev_sched_signal(evb));
435
436 41066
        tmo = INFTIM;
437 41066
        e = VBH_root(evb->binheap);
438 41066
        if (e != NULL) {
439 40023
                CHECK_OBJ(e, VEV_MAGIC);
440 40023
                assert(e->__binheap_idx == VBH_NOIDX + 1);
441 40023
                t = VTIM_mono();
442 40023
                if (e->__when <= t)
443 1345
                        return (vev_sched_timeout(evb, e, t));
444 38678
                if (e->__when < 9e99)
445 34419
                        tmo = (int)((e->__when - t) * 1e3);
446 38678
                if (tmo == 0)
447 203
                        tmo = 1;
448 38678
        }
449
450 39721
        if (tmo == INFTIM && evb->lpfd == VBH_NOIDX + 1)
451 1048
                return (0);
452
453 38673
        i = poll(evb->pfd + 1, evb->lpfd - 1, tmo);
454 38673
        if (i == -1 && errno == EINTR)
455 4
                return (vev_sched_signal(evb));
456 38669
        if (i == -1)
457 0
                return (-1);
458
459 38669
        if (i == 0) {
460 4227
                assert(e != NULL);
461 4227
                t = VTIM_mono();
462 4227
                if (e->__when <= t)
463 4041
                        return (vev_sched_timeout(evb, e, t));
464 186
        }
465
466 34628
        AZ(evb->n_fd_events);
467 334490
        for (u = 1; u < evb->lpfd; u++) {
468 299862
                AZ(evb->pev[u]->fd_events);
469 299862
                evb->pev[u]->fd_events = evb->pfd[u].revents;
470 299862
                if (evb->pev[u]->fd_events)
471 35348
                        evb->n_fd_events++;
472 299862
        }
473 34628
        assert(evb->n_fd_events == i);
474
475
        DBG(evb, "EVENTS %d\n", i);
476 69154
        while (evb->n_fd_events > 0) {
477 34526
                progress = 0;
478 331495
                for (u = VBH_NOIDX + 1; u < evb->lpfd; u++) {
479 296969
                        e = evb->pev[u];
480 296969
                        if (e->fd_events == 0)
481 261625
                                continue;
482
                        DBG(evb, "EVENT %p u=%u fd=%d ev=0x%x %d\n",
483
                            e, u, e->fd, e->fd_events, i);
484 35344
                        k = e->callback(e, e->fd_events);
485 35344
                        e->fd_events = 0;
486 35344
                        assert(evb->n_fd_events > 0);
487 35344
                        evb->n_fd_events--;
488 35344
                        progress++;
489 35344
                        if (k) {
490 4210
                                VEV_Stop(evb, e);
491 4210
                                free(e);
492 4210
                        }
493 35344
                        if (k < 0)
494 939
                                retval = k;
495 35344
                }
496 34526
                assert(progress > 0);
497
        }
498
499 34628
        return (retval);
500 41066
}