threading.h

Go to the documentation of this file.

/*
 * Copyright 2021-present dogtopus
 * SPDX-License-Identifier: MIT
 */

 
#ifndef __MUTEKI_THREADING_H__
#define __MUTEKI_THREADING_H__
 
#include "common.h"
#include "errno.h"
 
#ifdef __cplusplus
extern "C" {
#endif

enum bxc_wait_reason_e {
    BXC_WAIT_ON_NONE = 0x0,
    BXC_WAIT_ON_SEMAPHORE = 0x1,
    BXC_WAIT_ON_EVENT = 0x2,
    BXC_WAIT_ON_QUEUE = 0x4,
    BXC_WAIT_ON_SUSPEND = 0x8,
    BXC_WAIT_ON_CRITICAL_SECTION = 0x10,
    BXC_WAIT_ON_SLEEP = 0x20,
    BXC_WAIT_ON_YIELD = 0x20,
};

enum bxc_threading_kind_e {
    BXC_THREADING_KIND_THREAD = 0x100,
    BXC_THREADING_KIND_SEMAPHORE = 0x200,
    BXC_THREADING_KIND_EVENT = 0x201,
    BXC_THREADING_KIND_CS_QUEUE = 0x202,
};

typedef enum bxc_wait_result_e {
    BXC_WAIT_RESULT_TIMEOUT = 0x82,
    BXC_WAIT_RESULT_RESOLVED,
    BXC_WAIT_RESULT_ERROR,
} bxc_wait_result_t;

typedef int (*bxc_thread_func_t)(void *user_data);

typedef struct {
    unsigned char active_bytes;
    unsigned char waiting_by[8];
} bxc_waitable_t;

typedef unsigned char bxc_queue_message_t[16] SYS_ALIGN(4);

typedef struct {
    bxc_queue_message_t *messages;
    unsigned short size;
    short pop_idx;
    short push_idx;
    short _padding_0xa;
} bxc_queue_nonatomic_t;


typedef struct bxc_thread_s bxc_thread_t;
typedef struct bxc_semaphore_s bxc_semaphore_t;
typedef struct bxc_event_s bxc_event_t;
typedef struct bxc_cs_s bxc_cs_t;
typedef struct bxc_queue_s bxc_queue_t;
typedef union bxc_waitable_desc_u bxc_waitable_desc_t;

struct bxc_thread_s {
    /**
     * @brief Magic. Always `0x100`.
     * @see bxc_threading_kind_e
     */
    int magic; // always 0x100
    uintptr_t *sp;
    void *stack;
    int exit_code; // init to 0
    bxc_errno_t kerrno; // init to 0
    uintptr_t unk_0x14; // init to 0x80000000
    bxc_thread_func_t thread_func;
    short timeout;
    short sleep_counter;
    short wait_reason; // 0x20
    short slot; // 0x22
    char slot_low3b;
    char slot_high3b;
    unsigned char slot_low3b_bit;
    unsigned char slot_high3b_bit;
    bxc_waitable_desc_t *event;
    bxc_thread_t *prev;
    bxc_thread_t *next;
    union {
        /**
         * @brief Old placeholder name.
         * @deprecated Confirmed to be a name field and might contain data on certain builds.
         */
        char unk_0x34[0x20];
        uintptr_t ktls[8];
        char name[0x20];
    };
};


struct bxc_semaphore_s {
    /**
     * @brief Magic. Always `0x200`.
     * @see bxc_threading_kind_e
     */
    int magic;
    int _padding_0x4;
    short ctr;
    bxc_waitable_t wait_state;
    char _padding_0x13;
};


struct bxc_event_s {
     * @see bxc_threading_kind_e
     */
    int magic;
    int flag;
    short latch_on;
    bxc_waitable_t wait_state;
    char _padding_0x13;
};

struct bxc_cs_s {
     * @see bxc_threading_kind_e
     */
    int magic; // 0x00000202
    bxc_thread_t *thr;
    unsigned short refcount;
    bxc_waitable_t wait_state;
    char _padding_0x13;
}; // 0x14

struct bxc_queue_s {

     */
    int magic;
    bxc_queue_nonatomic_t *storage;
    short _padding_0x8;
    bxc_waitable_t wait_state;
    char _padding_0x13;
};

union bxc_waitable_desc_u {
    struct {

        int magic;
        /**
         * @brief Defined by synchronization primitive.
         */
        intptr_t user_data0;
        short user_data1;
        bxc_waitable_t wait_state;
        char user_data2;
    };

    bxc_semaphore_t semaphore;

    bxc_event_t event;
    bxc_cs_t cs;
    bxc_queue_t queue;
};


extern bxc_thread_t *OSCreateThread(bxc_thread_func_t func, void *user_data, size_t stack_size, bool defer_start);

extern int OSTerminateThread(bxc_thread_t *thr, int exit_code);

 extern bool OSSetThreadPriority(bxc_thread_t *thr, short new_slot);

extern short OSGetThreadPriority(bxc_thread_t *thr);

extern bool OSSuspendThread(bxc_thread_t *thr);

extern bool OSResumeThread(bxc_thread_t *thr);

extern bool OSWakeUpThread(bxc_thread_t *thr);

 extern int OSExitThread(int exit_code);

extern void OSSleep(short time_units);

extern bxc_semaphore_t *OSCreateSemaphore(short init_ctr);

extern bxc_wait_result_t OSWaitForSemaphore(bxc_semaphore_t *semaphore, short timeout);

extern bool OSReleaseSemaphore(bxc_semaphore_t *semaphore);

extern bool OSCloseSemaphore(bxc_semaphore_t *semaphore);

extern bxc_event_t *OSCreateEvent(short latch_on, int flag);

extern bxc_wait_result_t OSWaitForEvent(bxc_event_t *event, short timeout);

extern bool OSSetEvent(bxc_event_t *event);

extern bool OSResetEvent(bxc_event_t *event);

extern bool OSCloseEvent(bxc_event_t *event);

extern void OSInitCriticalSection(bxc_cs_t *cs);

extern void OSEnterCriticalSection(bxc_cs_t *cs);

extern void OSLeaveCriticalSection(bxc_cs_t *cs);

extern void OSDeleteCriticalSection(bxc_cs_t *cs);

extern bxc_queue_t *OSCreateMsgQue(unsigned short size);

extern bool OSPostMsgQue(bxc_queue_t *queue, const bxc_queue_message_t *message);

extern bool OSSendMsgQue(bxc_queue_t *queue, const bxc_queue_message_t *message);

extern bool OSPeekMsgQue(bxc_queue_t *queue, bxc_queue_message_t *message);

extern bool OSGetMsgQue(bxc_queue_t *queue, bxc_queue_message_t *message);

extern bool OSCloseMsgQue(bxc_queue_t *queue);

extern short OSGetCurrentlyRunningTCBPrio(void);
 
#ifdef __cplusplus
} // extern "C"
#endif
 
#endif // __MUTEKI_THREADING_H__