Scheduler Periodic Work

include/sch/periodic_work.h View source View on GitHub

Structs

scheduler_periodic_work_linker_object

struct scheduler_periodic_work_linker_object {
    char                               *name;
    void                               (*fn)();
    union {
        time_t  time_interval;
        size_t  period_interval;
        size_t  interval;
    };
    enum scheduler_periodic_work_type  type;
    enum scheduler_periodic_work_prio  prio;
};

scheduler_periodic_work

struct scheduler_periodic_work {
    enum scheduler_periodic_work_type  type;
    enum scheduler_periodic_work_prio  prio;
    char                               *name;
    void                               (*fn)();
    cpu_id_t                           cpu;
    union {
        struct {
            uint64_t  last_period_ran;
            uint64_t  period_interval;
            uint64_t  expected_period;
        };
        struct {
            time_t  last_time_ran;
            time_t  time_interval;
            time_t  expected_next_time;
        };
        struct {
            size_t  last_occurrence;
            size_t  interval;
            size_t  expected_next;
        };
    };
    size_t                             executed_times;
    time_t                             interval_total_loss;
    size_t                             interval_latency;
    struct pairing_node                pnode;
};

scheduler_periodic_work_limits

struct scheduler_periodic_work_limits {
    size_t  max_execs_per_call;
    time_t  max_duration_per_call_ns;
};

scheduler_periodic_work_percpu

struct scheduler_periodic_work_percpu {
    struct pairing_heap                    period_based_works[PERIODIC_WORK_MAX];
    struct pairing_heap                    time_based_works[PERIODIC_WORK_MAX];
    size_t                                 period_based_work_count[PERIODIC_WORK_MAX];
    size_t                                 time_based_work_count[PERIODIC_WORK_MAX];
    struct scheduler_periodic_work_limits  limits;
    cpu_id_t                               cpu;
    bool                                   executing;
};

Enums

scheduler_periodic_work_prio

enum scheduler_periodic_work_prio {
    PERIODIC_WORK_HIGH,
    PERIODIC_WORK_MID,
    PERIODIC_WORK_LOW,
    PERIODIC_WORK_MAX,
};

scheduler_periodic_work_type

enum scheduler_periodic_work_type {
    PERIODIC_WORK_PERIOD_BASED,
    PERIODIC_WORK_TIME_BASED,
};

Functions

scheduler_periodic_work_init

void scheduler_periodic_work_init(void);

scheduler_periodic_work_execute

void scheduler_periodic_work_execute(enum scheduler_periodic_work_type type);

scheduler_in_periodic_work

bool scheduler_in_periodic_work();

Macros

SCHEDULER_PERIODIC_WORK_REGISTER

#define SCHEDULER_PERIODIC_WORK_REGISTER(_fn, _type, _prio, _interval) \
    LINKER_SECTION_OBJECT(struct scheduler_periodic_work_linker_object, \
                          sched_periodic_work) \
    __spw_##_fn = {.name = #_fn, \
                   .fn = _fn, \
                   .type = _type, \
                   .interval = _interval, \
                   .prio = _prio}

SCHEDULER_PERIODIC_WORK_REGISTER_PER_PERIOD

#define SCHEDULER_PERIODIC_WORK_REGISTER_PER_PERIOD(_fn, _prio) \
    SCHEDULER_PERIODIC_WORK_REGISTER(_fn, PERIODIC_WORK_PERIOD_BASED, _prio, 1)

---