1 #pragma once
2 
3 #include <common/numa.h>
4 #include <process/proc-types.h>
5 #include <common/err.h>
6 #include <process/process.h>
7 
8 /**
9  * @brief kthread信息
10  * 该结构体将会绑定到pcb的worker_private中
11  */
12 struct kthread_info_t
13 {
14     uint64_t flags;
15     uint32_t cpu;
16     int result;
17     int (*thread_fn)(void *);
18     void *data;
19     // todo: 将这里改为completion机制
20     bool exited;     // 是否已退出
21     char *full_name; // 内核线程的名称
22 };
23 
24 struct process_control_block *kthread_create_on_node(int (*thread_fn)(void *data),
25                                                      void *data,
26                                                      int node,
27                                                      const char name_fmt[], ...);
28 /**
29  * @brief 在当前结点上创建一个内核线程
30  *
31  * @param thread_fn 该内核线程要执行的函数
32  * @param data 传递给 thread_fn 的参数数据
33  * @param name_fmt printf-style format string for the thread name
34  * @param arg name_fmt的参数
35  *
36  * 请注意，该宏会创建一个内核线程，并将其设置为停止状态
37  */
38 #define kthread_create(thread_fn, data, name_fmt, arg...) \
39     kthread_create_on_node(thread_fn, data, NUMA_NO_NODE, name_fmt, ##arg)
40 
41 /**
42  * @brief 创建内核线程，并将其唤醒
43  *
44  * @param thread_fn 该内核线程要执行的函数
45  * @param data 传递给 thread_fn 的参数数据
46  * @param name_fmt printf-style format string for the thread name
47  * @param arg name_fmt的参数
48  */
49 #define kthread_run(thread_fn, data, name_fmt, ...)                                                          \
50     ({                                                                                                       \
51         struct process_control_block *__kt = kthread_create(thread_fn, data, name_fmt, ##__VA_ARGS__); \
52         if (!IS_ERR(__kt))                                                                                   \
53             process_wakeup(__kt);                                                                            \
54         __kt;                                                                                                \
55     })
56 
57 /**
58  * @brief 向kthread发送停止信号，请求其结束
59  *
60  * @param pcb 内核线程的pcb
61  * @return int 错误码
62  */
63 int kthread_stop(struct process_control_block * pcb);
64 
65 /**
66  * @brief 内核线程调用该函数，检查自身的标志位，判断自己是否应该执行完任务后退出
67  *
68  * @return true 内核线程应该退出
69  * @return false 无需退出
70  */
71 bool kthread_should_stop(void);
72 
73 /**
74  * @brief 让当前内核线程退出，并返回result参数给kthread_stop()函数
75  *
76  * @param result 返回值
77  */
78 void kthread_exit(long result);
79 
80 /**
81  * @brief 初始化kthread机制(只应被process_init调用)
82  *
83  * @return int 错误码
84  */
85 int kthread_mechanism_init();
86 
87 /**
88  * @brief 设置pcb中的worker_private字段（只应被设置一次）
89  *
90  * @param pcb pcb
91  * @return bool 成功或失败
92  */
93 bool kthread_set_worker_private(struct process_control_block *pcb);
94 
95 /**
96  * @brief 获取pcb中的kthread结构体
97  *
98  * @param pcb pcb
99  * @return struct kthread* kthread信息结构体
100  */
101 struct kthread_info_t *to_kthread(struct process_control_block *pcb);
102 
103 /**
104  * @brief 释放pcb指向的worker private
105  *
106  * @param pcb 要释放的pcb
107  */
108 void free_kthread_struct(struct process_control_block *pcb);