xref: /lsquic/src/liblsquic/lsquic_pacer.h

/* Copyright (c) 2017 - 2022 LiteSpeed Technologies Inc.  See LICENSE. */
#ifndef LSQUIC_PACER_H
#define LSQUIC_PACER_H 1

struct lsquic_conn;

struct pacer
{
    const struct lsquic_conn
                   *pa_conn;             /* Used for logging */
    lsquic_time_t   pa_next_sched;
    lsquic_time_t   pa_last_delayed;
    lsquic_time_t   pa_now;

    /* All tick times are in microseconds */

    unsigned        pa_clock_granularity;

    unsigned        pa_burst_tokens;
    unsigned        pa_n_scheduled;     /* Within single tick */
    enum {
        PA_LAST_SCHED_DELAYED   = (1 << 0),
        PA_DELAYED_ON_TICK_IN   = (1 << 1),
    }               pa_flags;
#ifndef NDEBUG
    struct {
        unsigned        n_scheduled;
    }               pa_stats;
#endif
};


typedef lsquic_time_t (*tx_time_f)(void *ctx);

void
lsquic_pacer_init (struct pacer *, const struct lsquic_conn *,
                                            unsigned clock_granularity);

void
lsquic_pacer_cleanup (struct pacer *);

void
lsquic_pacer_tick_in (struct pacer *, lsquic_time_t);

void
lsquic_pacer_tick_out (struct pacer *);

int
lsquic_pacer_can_schedule (struct pacer *, unsigned n_in_flight);

void
lsquic_pacer_packet_scheduled (struct pacer *pacer, unsigned n_in_flight,
                        int in_recovery, tx_time_f tx_time, void *tx_ctx);

void
lsquic_pacer_loss_event (struct pacer *);

#define lsquic_pacer_delayed(pacer) ((pacer)->pa_flags & PA_LAST_SCHED_DELAYED)

#define lsquic_pacer_next_sched(pacer) (+(pacer)->pa_next_sched)

int
lsquic_pacer_can_schedule_probe (const struct pacer *,
                                unsigned n_in_flight, lsquic_time_t tx_time);

#endif