os_kernel/thread/thread.h

#ifndef __THREAD_THREAD_H
#define __THREAD_THREAD_H
#include "../lib/stdint.h"
#include "../lib/kernel/list.h"
#include "../kernel/memory.h"

// 通用函数类型，它将在很多线程函数中作为参数类型
typedef void thread_func(void *);
typedef int16_t pid_t;

// 线程的状态
enum task_status
{
    TASK_RUNNING,
    TASK_READY,
    TASK_BLOCKED,
    TASK_WAITING,
    TASK_HANGING,
    TASK_DIED
};

/******************** 中断栈 intr_stack **********************************
 * 些结构用于中断发生时保护程序(线程或进程)的上下文环境:
 * 进程或线程被外部中断或软中断打断时，需要保护程序(线程或进程)的上下文寄存器，
 * kernel.S 中的 intr_exit 出栈操作是些结构的逆操作。
 * 此栈在线程自己的内核栈中位置固定，所在页的最顶端。
 ***********************************************************************/
struct intr_stack
{
    uint32_t vec_no; // kernel.S 宏VECTOR中push %1压入的中断号
    uint32_t edi;
    uint32_t esi;
    uint32_t ebp;
    uint32_t esp_dummy; // 虽然pushad会把esp压入，但esp是不断变化的，所以会被popad忽略
    uint32_t ebx;
    uint32_t edx;
    uint32_t ecx;
    uint32_t eax;
    uint32_t gs;
    uint32_t fs;
    uint32_t es;
    uint32_t ds;

    // 以下由cpu从低特权级进入高特权级时压入
    uint32_t err_code; // err_code会被压入在eip之后
    void (*eip)(void);
    uint32_t cs;
    uint32_t eflags;
    void *esp;
    uint32_t ss;
};

/********************* 线程栈thread_stack ********************************
 * 线程自己的栈，用于存储线程中待执行的函数
 * 此结构在线程自己的内核栈中位置不固定
 * 仅用在 switch_to 时保存线程环境
 * 实际位置取决于实际运行情况
 ***********************************************************************/
struct thread_stack
{
    // All registers on the Intel386 缸e global and thus visible to both a calling and a called function.
    // Registers %ebp, %ebx, %edi, %esi, and %esp “ belong” to the calling function.
    // In other words, a called function must preserve these registers' values for its caller.
    // Remaining registers “ belong” to the called function.
    // If a calling function wants to preserve such a register value across a function call,
    // it must save the value in its local stack frame.
    uint32_t ebp;
    uint32_t ebx;
    uint32_t edi;
    uint32_t esi;

    // 线程第一次执行时，eip指向待调用的函数kernel_thread
    // 其他时候，指向switch_to的返回地址
    void (*eip)(thread_func *func, void *func_arg);

    // 以下仅供第一次被调度上cpu时使用
    // 参数unused_ret只为占位置充数为返回地址
    void(*unused_retaddr);
    thread_func *function; // 由kernel_thread所调用的函数名
    void *func_arg;        // 由kernel_thread所调用的函数所需的参数
};

// 进程或线程的 pcb，程序控制块(process control block)
struct task_struct
{
    uint32_t *self_kstack;   // 各内核线程都用自己的内核栈
    pid_t pid;               // 任务pid
    enum task_status status; // 线程状态
    char name[16];           // 进程或线程的名字
    uint8_t priority;        // 线程优先级
    uint8_t ticks;           // 每次在处理器上执行的时间嘀嗒数
    uint32_t elapsed_ticks;  //  累计计执行的 ticks 数

    struct list_elem general_tag;  // 用于线程在一般队列中的结点
    struct list_elem all_list_tag; // 用于线程队列 thread_all_list 中的结点

    uint32_t *pgdir;                   // 进程自己页表的虚拟地址, 如果是线程则为 NULL
    struct virtual_addr userprog_addr; // 用户进程的虚拟地址
    uint32_t stack_magic;              // 用这串数字做栈的边界标记，用于检测栈的溢出
};

extern struct list thread_ready_list; // 就绪队列
extern struct list thread_all_list;   // 所有任务队列

// 获取当前线程的 PCB 指针
struct task_struct *running_thread(void);
// 初始化线程栈 thread_stack
void thread_create(struct task_struct *pthread, thread_func function, void *func_arg);
// 初始化线程基本信息
void init_thread(struct task_struct *pthread, char *name, int prio);
// 创建优先级为 prio 的线程, 线程名为 name, 线程所执行的函数是 function(func_arg)
struct task_struct *thread_start(char *name, int prio, thread_func function, void *func_arg);
// 任务调度
void schedule(void);
// 当前线程将自己阻塞，标志其状态为 status
void thread_block(enum task_status status);
// 解除线程的阻塞状态，标志其状态为 TASK_RUNNING
void thread_unblock(struct task_struct *pthread);
// 初始化线程环境
void thread_init(void);

#endif // __THREAD_THREAD_H