lsquic_alarmset.h revision bc520ef7 
1/* Copyright (c) 2017 - 2020 LiteSpeed Technologies Inc.  See LICENSE. */
2/*
3 * lsquic_alarmset.h -- A set of alarms
4 */
5
6#ifndef LSQUIC_ALARM_H
7#define LSQUIC_ALARM_H 1
8
9#include "lsquic_int_types.h"
10
11enum alarm_id;
12struct lsquic_conn;
13
14typedef void (*lsquic_alarm_cb_f)(enum alarm_id, void *cb_ctx,
15                                  lsquic_time_t expiry, lsquic_time_t now);
16
17typedef struct lsquic_alarm {
18    lsquic_alarm_cb_f           callback;
19    void                       *cb_ctx;
20} lsquic_alarm_t;
21
22
23enum alarm_id {
24    AL_HANDSHAKE,
25    AL_RETX_INIT,
26    AL_RETX_HSK = AL_RETX_INIT + PNS_HSK,
27    AL_RETX_APP = AL_RETX_INIT + PNS_APP,
28    AL_PING,
29    AL_IDLE,
30    AL_ACK_APP,
31    AL_RET_CIDS,
32    AL_CID_THROT,
33    AL_PATH_CHAL,
34    AL_PATH_CHAL_0 = AL_PATH_CHAL,
35    AL_PATH_CHAL_1,
36    AL_SESS_TICKET,
37    AL_BLOCKED_KA,      /* Blocked Keep-Alive */
38    MAX_LSQUIC_ALARMS
39};
40
41
42enum alarm_id_bit {
43    ALBIT_HANDSHAKE = 1 << AL_HANDSHAKE,
44    ALBIT_RETX_INIT = 1 << AL_RETX_INIT,
45    ALBIT_RETX_HSK  = 1 << AL_RETX_HSK,
46    ALBIT_RETX_APP  = 1 << AL_RETX_APP,
47    ALBIT_ACK_APP   = 1 << AL_ACK_APP,
48    ALBIT_PING      = 1 << AL_PING,
49    ALBIT_IDLE      = 1 << AL_IDLE,
50    ALBIT_RET_CIDS  = 1 << AL_RET_CIDS,
51    ALBIT_CID_THROT = 1 << AL_CID_THROT,
52    ALBIT_PATH_CHAL_0 = 1 << AL_PATH_CHAL_0,
53    ALBIT_PATH_CHAL_1 = 1 << AL_PATH_CHAL_1,
54    ALBIT_SESS_TICKET = 1 << AL_SESS_TICKET,
55    ALBIT_BLOCKED_KA  = 1 << AL_BLOCKED_KA,
56};
57
58
59typedef struct lsquic_alarmset {
60    enum alarm_id_bit           as_armed_set;
61    lsquic_time_t               as_expiry[MAX_LSQUIC_ALARMS];
62    const struct lsquic_conn   *as_conn;    /* Used for logging */
63    struct lsquic_alarm         as_alarms[MAX_LSQUIC_ALARMS];
64} lsquic_alarmset_t;
65
66
67void
68lsquic_alarmset_init (lsquic_alarmset_t *, const struct lsquic_conn *);
69
70void
71lsquic_alarmset_init_alarm (lsquic_alarmset_t *, enum alarm_id,
72                            lsquic_alarm_cb_f, void *cb_ctx);
73
74#define lsquic_alarmset_set(alarmset, al_id, exp) do {                  \
75    (alarmset)->as_armed_set |= 1 << (al_id);                           \
76    (alarmset)->as_expiry[al_id] = exp;                                 \
77} while (0)
78
79#define lsquic_alarmset_unset(alarmset, al_id) do {                     \
80    (alarmset)->as_armed_set &= ~(1 << (al_id));                        \
81} while (0)
82
83#define lsquic_alarmset_is_set(alarmset, al_id) \
84                            ((alarmset)->as_armed_set & (1 << (al_id)))
85
86#define lsquic_alarmset_are_set(alarmset, flags) \
87                            ((alarmset)->as_armed_set & (flags))
88
89/* Timers "fire," alarms "ring." */
90void
91lsquic_alarmset_ring_expired (lsquic_alarmset_t *, lsquic_time_t now);
92
93lsquic_time_t
94lsquic_alarmset_mintime (const lsquic_alarmset_t *, enum alarm_id *);
95
96extern const char *const lsquic_alid2str[];
97
98#endif
99