Skip to content
charmOS docs

CLIMB framework

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

Structs

Section titled “Structs”

climb_handle

Section titled “climb_handle”
struct climb_handle (5 fields) source
§ struct list_node list
§ climb_pressure_t pressure
§ climb_pressure_t applied_pressure_internal

If 0, this has not applied presssure

§ struct thread *given_to

climb_thread_data

Section titled “climb_thread_data”
struct climb_thread_data (11 fields) source
§ climb_pressure_t direct_pressure

pressure

Contributed direct pressure

§ climb_pressure_t indirect_pressure

Indirect pressure from others

§ climb_pressure_t pressure_ewma

EWMA of pressure over time

§ int32_t wanted_boost

boost

0..20, how much this thread “wants”

§ fx32_32_t boost_ewma

EWMA of the wanted_boost_raw

§ int32_t effective_boost

How much boosted (derived from wanted_boost_raw) this thread “gets”. This exists because CLIMB will take into account the existence of other threads and their boosts and periods spent to compute the boost of one thread

§ int32_t pressure_periods

time

>=1 active, < 0 decaying, 0 inactive

§ struct list_head handles

accounting

active pressure handles

§ bool on_climb_tree : 1

scheduler integration

Used to logically verify things

§ struct rbt_node climb_node
§ struct climb_handle handle

if this thread becomes a CLIMB source, what would it “apply”?

climb_source

Section titled “climb_source”
struct climb_source (2 fields) source
§ char *name

Enums

Section titled “Enums”

climb_pressure_kind

Section titled “climb_pressure_kind”
enum climb_pressure_kind (2 variants) source
§ CLIMB_PRESSURE_DIRECT
§ CLIMB_PRESSURE_INDIRECT

Type Aliases

Section titled “Type Aliases”

climb_pressure_t

Section titled “climb_pressure_t”
typedef fx32_32_t climb_pressure_t
source

Functions

Section titled “Functions”

climb_thread_applied_pressure

Section titled “climb_thread_applied_pressure”
climb_pressure_t climb_thread_applied_pressure(struct thread *t)
source

climb_thread_compute_pressure_to_apply

Section titled “climb_thread_compute_pressure_to_apply”
climb_pressure_t climb_thread_compute_pressure_to_apply(struct thread *t)
source

climb_handle_apply

Section titled “climb_handle_apply”
void climb_handle_apply(struct thread *t, struct climb_handle *h)
source

climb_handle_update

Section titled “climb_handle_update”
void climb_handle_update(
    struct thread *t,
    struct climb_handle *h,
    climb_pressure_t new_pressure
)
source

climb_handle_remove

Section titled “climb_handle_remove”
void climb_handle_remove(struct climb_handle *h)
source

climb_handle_apply_locked

Section titled “climb_handle_apply_locked”
void climb_handle_apply_locked(
    struct thread *t,
    struct climb_handle *h
)
source

climb_handle_remove_locked

Section titled “climb_handle_remove_locked”
void climb_handle_remove_locked(struct climb_handle *h)
source

climb_recompute_pressure

Section titled “climb_recompute_pressure”
void climb_recompute_pressure(struct thread *t)
source

climb_thread_remove

Section titled “climb_thread_remove”
void climb_thread_remove(struct thread *t)
source

climb_thread_init

Section titled “climb_thread_init”
void climb_thread_init(struct thread *t)
source

climb_post_migrate_hook

Section titled “climb_post_migrate_hook”
void climb_post_migrate_hook(
    struct thread *t,
    size_t old_cpu,
    size_t new_cpu
)
source

climb_get_thread_data

Section titled “climb_get_thread_data”
size_t climb_get_thread_data(struct rbt_node *n)
source

climb_cmp_threads

Section titled “climb_cmp_threads”
int32_t climb_cmp_threads(
    const struct rbt_node *a,
    const struct rbt_node *b
)
source

climb_handle_init

Section titled “climb_handle_init”
struct climb_handle * climb_handle_init(
    struct climb_handle *ch,
    struct climb_source *cs,
    enum climb_pressure_kind k
)
source

Macros

Section titled “Macros”

CLIMB_BOOST_LEVELS

Section titled “CLIMB_BOOST_LEVELS”
#define CLIMB_BOOST_LEVELS 20
source

CLIMB_MIN_GLOBAL_BOOST

Section titled “CLIMB_MIN_GLOBAL_BOOST”
#define CLIMB_MIN_GLOBAL_BOOST 1
source

CLIMB_GLOBAL_BOOST_SCALE

Section titled “CLIMB_GLOBAL_BOOST_SCALE”
#define CLIMB_GLOBAL_BOOST_SCALE(nt)
source
Expansion
#define CLIMB_GLOBAL_BOOST_SCALE(nt) (CLIMB_BOOST_LEVELS / nt)

CLIMB_PRESSURE_KEY_SHIFT

Section titled “CLIMB_PRESSURE_KEY_SHIFT”
#define CLIMB_PRESSURE_KEY_SHIFT 31
source

one period == 0.5 pressure points

CLIMB_MAX_DECAY_PERIODS

Section titled “CLIMB_MAX_DECAY_PERIODS”
#define CLIMB_MAX_DECAY_PERIODS 20
source

Pressures

CLIMB_PRESSURE_THREAD_BASE

Section titled “CLIMB_PRESSURE_THREAD_BASE”
#define CLIMB_PRESSURE_THREAD_BASE FX(0.05)
source

CLIMB_PRESSURE_IO_BASE

Section titled “CLIMB_PRESSURE_IO_BASE”
#define CLIMB_PRESSURE_IO_BASE FX(0.20)
source

CLIMB_PRESSURE_LOCK_BASE

Section titled “CLIMB_PRESSURE_LOCK_BASE”
#define CLIMB_PRESSURE_LOCK_BASE FX(0.10)
source

CLIMB_PRESSURE

Section titled “CLIMB_PRESSURE”
#define CLIMB_PRESSURE(x)
source
Expansion
#define CLIMB_PRESSURE(x) FX(x)

Pressure space

CLIMB_PRESSURE_MAX

Section titled “CLIMB_PRESSURE_MAX”
#define CLIMB_PRESSURE_MAX FX(1.0)
source

CLIMB_DIRECT_PRESSURE_MAX

Section titled “CLIMB_DIRECT_PRESSURE_MAX”
#define CLIMB_DIRECT_PRESSURE_MAX FX(1.0)
source

CLIMB_INDIRECT_PRESSURE_MAX

Section titled “CLIMB_INDIRECT_PRESSURE_MAX”
#define CLIMB_INDIRECT_PRESSURE_MAX FX(1.0)
source

Indirect pressure scaling

CLIMB_INDIRECT_MIN_SCALE

Section titled “CLIMB_INDIRECT_MIN_SCALE”
#define CLIMB_INDIRECT_MIN_SCALE FX(0.10)
source

CLIMB_INDIRECT_WEIGHT

Section titled “CLIMB_INDIRECT_WEIGHT”
#define CLIMB_INDIRECT_WEIGHT FX(0.85)
source

CLIMB_BOOST_LEVEL_MAX

Section titled “CLIMB_BOOST_LEVEL_MAX”
#define CLIMB_BOOST_LEVEL_MAX 20
source

Boost space

CLIMB_BOOST_EWMA_ALPHA

Section titled “CLIMB_BOOST_EWMA_ALPHA”
#define CLIMB_BOOST_EWMA_ALPHA FX(0.75)
source

EWMA smoothing

Pressure to boost shaping

CLIMB_PRESSURE_EXPONENT

Section titled “CLIMB_PRESSURE_EXPONENT”
#define CLIMB_PRESSURE_EXPONENT 3
source

cubic

CLIMB_PRESSURE_TO_BOOST_SCALE

Section titled “CLIMB_PRESSURE_TO_BOOST_SCALE”
#define CLIMB_PRESSURE_TO_BOOST_SCALE FX(8.0)
source

climb_thread_data_from_tree_node

Section titled “climb_thread_data_from_tree_node”
#define climb_thread_data_from_tree_node(tn)
source
Expansion
#define climb_thread_data_from_tree_node(tn) \
    (container_of(tn, struct climb_thread_data, climb_node))

CLIMB_SOURCE_EXTERN

Section titled “CLIMB_SOURCE_EXTERN”
#define CLIMB_SOURCE_EXTERN(name)
source
Expansion
#define CLIMB_SOURCE_EXTERN(name) extern struct climb_source __climb_src_##name

CLIMB_SOURCE_CREATE

Section titled “CLIMB_SOURCE_CREATE”
#define CLIMB_SOURCE_CREATE(n, strname, b)
source
Expansion
#define CLIMB_SOURCE_CREATE(n, strname, b) \
    struct climb_source __climb_src_##n = {.name = strname, .base = b}

CLIMB_SOURCE

Section titled “CLIMB_SOURCE”
#define CLIMB_SOURCE(name)
source
Expansion
#define CLIMB_SOURCE(name) &(__climb_src_##name)