lsquic_alarmset.h revision 0adf085a
1229fce07SDmitri Tikhonov/* Copyright (c) 2017 - 2019 LiteSpeed Technologies Inc.  See LICENSE. */
250aadb33SDmitri Tikhonov/*
350aadb33SDmitri Tikhonov * lsquic_alarmset.h -- A set of alarms
450aadb33SDmitri Tikhonov */
550aadb33SDmitri Tikhonov
650aadb33SDmitri Tikhonov#ifndef LSQUIC_ALARM_H
750aadb33SDmitri Tikhonov#define LSQUIC_ALARM_H 1
850aadb33SDmitri Tikhonov
950aadb33SDmitri Tikhonov#include "lsquic_int_types.h"
1050aadb33SDmitri Tikhonov
115392f7a3SLiteSpeed Techenum alarm_id;
125392f7a3SLiteSpeed Techstruct lsquic_conn;
135392f7a3SLiteSpeed Tech
145392f7a3SLiteSpeed Techtypedef void (*lsquic_alarm_cb_f)(enum alarm_id, void *cb_ctx,
1550aadb33SDmitri Tikhonov                                  lsquic_time_t expiry, lsquic_time_t now);
1650aadb33SDmitri Tikhonov
1750aadb33SDmitri Tikhonovtypedef struct lsquic_alarm {
1850aadb33SDmitri Tikhonov    lsquic_alarm_cb_f           callback;
1950aadb33SDmitri Tikhonov    void                       *cb_ctx;
2050aadb33SDmitri Tikhonov} lsquic_alarm_t;
2150aadb33SDmitri Tikhonov
2250aadb33SDmitri Tikhonov
2350aadb33SDmitri Tikhonovenum alarm_id {
2450aadb33SDmitri Tikhonov    AL_HANDSHAKE,
255392f7a3SLiteSpeed Tech    AL_RETX_INIT,
265392f7a3SLiteSpeed Tech    AL_RETX_HSK = AL_RETX_INIT + PNS_HSK,
275392f7a3SLiteSpeed Tech    AL_RETX_APP = AL_RETX_INIT + PNS_APP,
2850aadb33SDmitri Tikhonov    AL_PING,
2950aadb33SDmitri Tikhonov    AL_IDLE,
305392f7a3SLiteSpeed Tech    AL_ACK_INIT,
315392f7a3SLiteSpeed Tech    AL_ACK_HSK = AL_ACK_INIT + PNS_HSK,
325392f7a3SLiteSpeed Tech    AL_ACK_APP = AL_ACK_INIT + PNS_APP,
335392f7a3SLiteSpeed Tech    AL_RET_CIDS,
345392f7a3SLiteSpeed Tech    AL_CID_THROT,
355392f7a3SLiteSpeed Tech    AL_PATH_CHAL,
365392f7a3SLiteSpeed Tech    AL_PATH_CHAL_0 = AL_PATH_CHAL,
375392f7a3SLiteSpeed Tech    AL_PATH_CHAL_1,
3865728dc5SDmitri Tikhonov    AL_SESS_TICKET,
3950aadb33SDmitri Tikhonov    MAX_LSQUIC_ALARMS
4050aadb33SDmitri Tikhonov};
4150aadb33SDmitri Tikhonov
4250aadb33SDmitri Tikhonov
4350aadb33SDmitri Tikhonovenum alarm_id_bit {
4450aadb33SDmitri Tikhonov    ALBIT_HANDSHAKE = 1 << AL_HANDSHAKE,
455392f7a3SLiteSpeed Tech    ALBIT_RETX_INIT = 1 << AL_RETX_INIT,
465392f7a3SLiteSpeed Tech    ALBIT_RETX_HSK  = 1 << AL_RETX_HSK,
475392f7a3SLiteSpeed Tech    ALBIT_RETX_APP  = 1 << AL_RETX_APP,
485392f7a3SLiteSpeed Tech    ALBIT_ACK_APP   = 1 << AL_ACK_APP,
495392f7a3SLiteSpeed Tech    ALBIT_ACK_INIT  = 1 << AL_ACK_INIT,
505392f7a3SLiteSpeed Tech    ALBIT_ACK_HSK   = 1 << AL_ACK_HSK,
5150aadb33SDmitri Tikhonov    ALBIT_PING      = 1 << AL_PING,
5250aadb33SDmitri Tikhonov    ALBIT_IDLE      = 1 << AL_IDLE,
535392f7a3SLiteSpeed Tech    ALBIT_RET_CIDS  = 1 << AL_RET_CIDS,
545392f7a3SLiteSpeed Tech    ALBIT_CID_THROT = 1 << AL_CID_THROT,
555392f7a3SLiteSpeed Tech    ALBIT_PATH_CHAL = 1 << AL_PATH_CHAL,
565392f7a3SLiteSpeed Tech    ALBIT_PATH_CHAL_0 = 1 << AL_PATH_CHAL_0,
575392f7a3SLiteSpeed Tech    ALBIT_PATH_CHAL_1 = 1 << AL_PATH_CHAL_1,
5865728dc5SDmitri Tikhonov    ALBIT_SESS_TICKET = 1 << AL_SESS_TICKET,
5950aadb33SDmitri Tikhonov};
6050aadb33SDmitri Tikhonov
6150aadb33SDmitri Tikhonov
6250aadb33SDmitri Tikhonovtypedef struct lsquic_alarmset {
6350aadb33SDmitri Tikhonov    enum alarm_id_bit           as_armed_set;
6450aadb33SDmitri Tikhonov    lsquic_time_t               as_expiry[MAX_LSQUIC_ALARMS];
655392f7a3SLiteSpeed Tech    const struct lsquic_conn   *as_conn;    /* Used for logging */
6650aadb33SDmitri Tikhonov    struct lsquic_alarm         as_alarms[MAX_LSQUIC_ALARMS];
6750aadb33SDmitri Tikhonov} lsquic_alarmset_t;
6850aadb33SDmitri Tikhonov
6950aadb33SDmitri Tikhonov
7050aadb33SDmitri Tikhonovvoid
715392f7a3SLiteSpeed Techlsquic_alarmset_init (lsquic_alarmset_t *, const struct lsquic_conn *);
7250aadb33SDmitri Tikhonov
7350aadb33SDmitri Tikhonovvoid
7450aadb33SDmitri Tikhonovlsquic_alarmset_init_alarm (lsquic_alarmset_t *, enum alarm_id,
7550aadb33SDmitri Tikhonov                            lsquic_alarm_cb_f, void *cb_ctx);
7650aadb33SDmitri Tikhonov
7750aadb33SDmitri Tikhonov#define lsquic_alarmset_set(alarmset, al_id, exp) do {                  \
7850aadb33SDmitri Tikhonov    (alarmset)->as_armed_set |= 1 << (al_id);                           \
7950aadb33SDmitri Tikhonov    (alarmset)->as_expiry[al_id] = exp;                                 \
8050aadb33SDmitri Tikhonov} while (0)
8150aadb33SDmitri Tikhonov
8250aadb33SDmitri Tikhonov#define lsquic_alarmset_unset(alarmset, al_id) do {                     \
8350aadb33SDmitri Tikhonov    (alarmset)->as_armed_set &= ~(1 << (al_id));                        \
8450aadb33SDmitri Tikhonov} while (0)
8550aadb33SDmitri Tikhonov
8650aadb33SDmitri Tikhonov#define lsquic_alarmset_is_set(alarmset, al_id) \
8750aadb33SDmitri Tikhonov                            ((alarmset)->as_armed_set & (1 << (al_id)))
8850aadb33SDmitri Tikhonov
895392f7a3SLiteSpeed Tech#define lsquic_alarmset_are_set(alarmset, flags) \
905392f7a3SLiteSpeed Tech                            ((alarmset)->as_armed_set & (flags))
915392f7a3SLiteSpeed Tech
9250aadb33SDmitri Tikhonov/* Timers "fire," alarms "ring." */
9350aadb33SDmitri Tikhonovvoid
9450aadb33SDmitri Tikhonovlsquic_alarmset_ring_expired (lsquic_alarmset_t *, lsquic_time_t now);
9550aadb33SDmitri Tikhonov
96e8bd737dSDmitri Tikhonovlsquic_time_t
970adf085aSDmitri Tikhonovlsquic_alarmset_mintime (const lsquic_alarmset_t *, enum alarm_id *);
980adf085aSDmitri Tikhonov
990adf085aSDmitri Tikhonovextern const char *const lsquic_alid2str[];
100e8bd737dSDmitri Tikhonov
10150aadb33SDmitri Tikhonov#endif
102