eloop.h revision 1.1.1.6 
1/* SPDX-License-Identifier: BSD-2-Clause */
2/*
3 * dhcpcd - DHCP client daemon
4 * Copyright (c) 2006-2019 Roy Marples <roy@marples.name>
5 * All rights reserved
6
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29#ifndef ELOOP_H
30#define ELOOP_H
31
32#include <time.h>
33
34/* Some systems don't define timespec macros */
35#ifndef timespecclear
36#define timespecclear(tsp)      (tsp)->tv_sec = (time_t)((tsp)->tv_nsec = 0L)
37#define timespecisset(tsp)      ((tsp)->tv_sec || (tsp)->tv_nsec)
38#define timespeccmp(tsp, usp, cmp)                                      \
39        (((tsp)->tv_sec == (usp)->tv_sec) ?                             \
40            ((tsp)->tv_nsec cmp (usp)->tv_nsec) :                       \
41            ((tsp)->tv_sec cmp (usp)->tv_sec))
42#define timespecadd(tsp, usp, vsp)                                      \
43        do {                                                            \
44                (vsp)->tv_sec = (tsp)->tv_sec + (usp)->tv_sec;          \
45                (vsp)->tv_nsec = (tsp)->tv_nsec + (usp)->tv_nsec;       \
46                if ((vsp)->tv_nsec >= 1000000000L) {                    \
47                        (vsp)->tv_sec++;                                \
48                        (vsp)->tv_nsec -= 1000000000L;                  \
49                }                                                       \
50        } while (/* CONSTCOND */ 0)
51#define timespecsub(tsp, usp, vsp)                                      \
52        do {                                                            \
53                (vsp)->tv_sec = (tsp)->tv_sec - (usp)->tv_sec;          \
54                (vsp)->tv_nsec = (tsp)->tv_nsec - (usp)->tv_nsec;       \
55                if ((vsp)->tv_nsec < 0) {                               \
56                        (vsp)->tv_sec--;                                \
57                        (vsp)->tv_nsec += 1000000000L;                  \
58                }                                                       \
59        } while (/* CONSTCOND */ 0)
60#endif
61
62/* eloop queues are really only for deleting timeouts registered
63 * for a function or object.
64 * The idea being that one interface has different timeouts for
65 * say DHCP and DHCPv6. */
66#ifndef ELOOP_QUEUE
67  #define ELOOP_QUEUE 1
68#endif
69
70/* Forward declare eloop - the content should be invisible to the outside */
71struct eloop;
72
73int eloop_event_add_rw(struct eloop *, int,
74    void (*)(void *), void *,
75    void (*)(void *), void *);
76int eloop_event_add(struct eloop *, int,
77    void (*)(void *), void *);
78int eloop_event_add_w(struct eloop *, int,
79    void (*)(void *), void *);
80#define eloop_event_delete(eloop, fd) \
81    eloop_event_delete_write((eloop), (fd), 0)
82#define eloop_event_remove_writecb(eloop, fd) \
83    eloop_event_delete_write((eloop), (fd), 1)
84int eloop_event_delete_write(struct eloop *, int, int);
85
86#define eloop_timeout_add_tv(eloop, tv, cb, ctx) \
87    eloop_q_timeout_add_tv((eloop), ELOOP_QUEUE, (tv), (cb), (ctx))
88#define eloop_timeout_add_sec(eloop, tv, cb, ctx) \
89    eloop_q_timeout_add_sec((eloop), ELOOP_QUEUE, (tv), (cb), (ctx))
90#define eloop_timeout_add_msec(eloop, ms, cb, ctx) \
91    eloop_q_timeout_add_msec((eloop), ELOOP_QUEUE, (ms), (cb), (ctx))
92#define eloop_timeout_delete(eloop, cb, ctx) \
93    eloop_q_timeout_delete((eloop), ELOOP_QUEUE, (cb), (ctx))
94int eloop_q_timeout_add_tv(struct eloop *, int,
95    const struct timespec *, void (*)(void *), void *);
96int eloop_q_timeout_add_sec(struct eloop *, int,
97    time_t, void (*)(void *), void *);
98int eloop_q_timeout_add_msec(struct eloop *, int,
99    long, void (*)(void *), void *);
100int eloop_q_timeout_delete(struct eloop *, int, void (*)(void *), void *);
101
102int eloop_signal_set_cb(struct eloop *, const int *, size_t,
103    void (*)(int, void *), void *);
104int eloop_signal_mask(struct eloop *, sigset_t *oldset);
105
106struct eloop * eloop_new(void);
107int eloop_requeue(struct eloop *);
108void eloop_clear(struct eloop *);
109void eloop_free(struct eloop *);
110void eloop_exit(struct eloop *, int);
111int eloop_start(struct eloop *, sigset_t *);
112
113#endif
114