lsquic_alarmset.h revision 8c1565cb 
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    /* TODO: remove AL_ACK_INIT and AL_ACK_HSK when LSQVER_ID24 is removed */
31    AL_ACK_INIT,
32    AL_ACK_HSK = AL_ACK_INIT + PNS_HSK,
33    AL_ACK_APP = AL_ACK_INIT + PNS_APP,
34    AL_RET_CIDS,
35    AL_CID_THROT,
36    AL_PATH_CHAL,
37    AL_PATH_CHAL_0 = AL_PATH_CHAL,
38    AL_PATH_CHAL_1,
39    AL_SESS_TICKET,
40    AL_BLOCKED_KA,      /* Blocked Keep-Alive */
41    MAX_LSQUIC_ALARMS
42};
43
44
45enum alarm_id_bit {
46    ALBIT_HANDSHAKE = 1 << AL_HANDSHAKE,
47    ALBIT_RETX_INIT = 1 << AL_RETX_INIT,
48    ALBIT_RETX_HSK  = 1 << AL_RETX_HSK,
49    ALBIT_RETX_APP  = 1 << AL_RETX_APP,
50    ALBIT_ACK_APP   = 1 << AL_ACK_APP,
51    ALBIT_ACK_INIT  = 1 << AL_ACK_INIT,
52    ALBIT_ACK_HSK   = 1 << AL_ACK_HSK,
53    ALBIT_PING      = 1 << AL_PING,
54    ALBIT_IDLE      = 1 << AL_IDLE,
55    ALBIT_RET_CIDS  = 1 << AL_RET_CIDS,
56    ALBIT_CID_THROT = 1 << AL_CID_THROT,
57    ALBIT_PATH_CHAL_0 = 1 << AL_PATH_CHAL_0,
58    ALBIT_PATH_CHAL_1 = 1 << AL_PATH_CHAL_1,
59    ALBIT_SESS_TICKET = 1 << AL_SESS_TICKET,
60    ALBIT_BLOCKED_KA  = 1 << AL_BLOCKED_KA,
61};
62
63
64typedef struct lsquic_alarmset {
65    enum alarm_id_bit           as_armed_set;
66    lsquic_time_t               as_expiry[MAX_LSQUIC_ALARMS];
67    const struct lsquic_conn   *as_conn;    /* Used for logging */
68    struct lsquic_alarm         as_alarms[MAX_LSQUIC_ALARMS];
69} lsquic_alarmset_t;
70
71
72void
73lsquic_alarmset_init (lsquic_alarmset_t *, const struct lsquic_conn *);
74
75void
76lsquic_alarmset_init_alarm (lsquic_alarmset_t *, enum alarm_id,
77                            lsquic_alarm_cb_f, void *cb_ctx);
78
79#define lsquic_alarmset_set(alarmset, al_id, exp) do {                  \
80    (alarmset)->as_armed_set |= 1 << (al_id);                           \
81    (alarmset)->as_expiry[al_id] = exp;                                 \
82} while (0)
83
84#define lsquic_alarmset_unset(alarmset, al_id) do {                     \
85    (alarmset)->as_armed_set &= ~(1 << (al_id));                        \
86} while (0)
87
88#define lsquic_alarmset_is_set(alarmset, al_id) \
89                            ((alarmset)->as_armed_set & (1 << (al_id)))
90
91#define lsquic_alarmset_are_set(alarmset, flags) \
92                            ((alarmset)->as_armed_set & (flags))
93
94/* Timers "fire," alarms "ring." */
95void
96lsquic_alarmset_ring_expired (lsquic_alarmset_t *, lsquic_time_t now);
97
98lsquic_time_t
99lsquic_alarmset_mintime (const lsquic_alarmset_t *, enum alarm_id *);
100
101extern const char *const lsquic_alid2str[];
102
103#endif
104