thread.h

Go to the documentation of this file.

/*
 * Copyright (C) 2026 Kamil Lulko <kamil.lulko@gmail.com>
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 * This file is part of oveRTOS.
 */
 
#ifndef OVE_THREAD_H
#define OVE_THREAD_H
 
#include "ove/types.h"
 
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef void (*ove_thread_fn)(void *arg);
 
typedef enum {
    OVE_THREAD_STATE_RUNNING = 0, 
    OVE_THREAD_STATE_READY,       
    OVE_THREAD_STATE_BLOCKED,     
    OVE_THREAD_STATE_SUSPENDED,   
    OVE_THREAD_STATE_TERMINATED,  
    OVE_THREAD_STATE_UNKNOWN,     
} ove_thread_state_t;
 
struct ove_thread_stats {
    uint64_t runtime_us; 
    uint32_t cpu_percent_x100; 
};
 
typedef enum {
    OVE_PRIO_IDLE = 0, 
    OVE_PRIO_LOW = 1,  
    OVE_PRIO_BELOW_NORMAL = 2, 
    OVE_PRIO_NORMAL = 3,       
    OVE_PRIO_ABOVE_NORMAL = 4, 
    OVE_PRIO_HIGH = 5,     
    OVE_PRIO_REALTIME = 6,     
    OVE_PRIO_CRITICAL = 7, 
} ove_prio_t;
 
#include "ove/storage.h"
 
int ove_thread_init(ove_thread_t *handle, ove_thread_storage_t *storage, const char *name,
            ove_thread_fn entry, void *arg, ove_prio_t priority, size_t stack_size,
            void *stack);
 
int ove_thread_deinit(ove_thread_t handle);
 
/* _create / _destroy — heap-gated */
#ifdef OVE_HEAP_THREAD
 
int ove_thread_create(ove_thread_t *handle, const char *name, ove_thread_fn entry, void *arg,
              ove_prio_t priority, size_t stack_size);
 
int ove_thread_destroy(ove_thread_t handle);
 
#endif /* OVE_HEAP_THREAD */
 
ove_thread_t ove_thread_get_self(void);
 
void ove_thread_set_priority(ove_thread_t handle, ove_prio_t prio);
 
void ove_thread_sleep_ms(uint32_t ms);
 
void ove_thread_yield(void);
 
void ove_thread_start_scheduler(void);
 
void ove_thread_suspend(ove_thread_t handle);
 
void ove_thread_resume(ove_thread_t handle);
 
void ove_thread_request_stop(ove_thread_t handle);
 
bool ove_thread_should_stop(ove_thread_t handle);
 
size_t ove_thread_get_stack_usage(ove_thread_t handle);
 
ove_thread_state_t ove_thread_get_state(ove_thread_t handle);
 
int ove_thread_get_runtime_stats(ove_thread_t handle, struct ove_thread_stats *stats);
 
/* ── System memory statistics ──────────────────────────────── */
 
struct ove_mem_stats {
    size_t total;     
    size_t free;      
    size_t used;      
    size_t peak_used; 
};
 
int ove_sys_get_mem_stats(struct ove_mem_stats *stats);
 
/* ── Thread enumeration ────────────────────────────────────── */
 
struct ove_thread_state_times {
    uint64_t running_us;   
    uint64_t ready_us;     
    uint64_t blocked_us;   
    uint64_t suspended_us; 
};
 
struct ove_thread_info {
    const char *name;      
    ove_thread_state_t state;  
    int priority;          
    size_t stack_used;     
    size_t stack_size;     
    uint32_t cpu_percent_x100; 
    struct ove_thread_state_times state_times; 
};
 
int ove_thread_list(struct ove_thread_info *out, size_t max_count, size_t *actual_count);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OVE_THREAD_H */