1 #include <common/glib.h>
2 #include <common/kthread.h>
3 #include <common/spinlock.h>
4 #include <debug/bug.h>
5 #include <sched/sched.h>
6 #include <time/sleep.h>
7
8 static spinlock_t __kthread_create_lock; // kthread创建过程的锁
9 static struct List kthread_create_list; // kthread创建任务的链表
10 struct process_control_block *kthreadd_pcb = NULL; // kthreadd守护线程的pcb
11
12 // 枚举各个标志位是在第几位
13 enum KTHREAD_BITS
14 {
15 KTHREAD_IS_PER_CPU = 0,
16 KTHREAD_SHOULD_STOP,
17 KTHREAD_SHOULD_PARK,
18 };
19
20 /**
21 * @brief kthread的创建信息（仅在创建过程中存在）
22 *
23 */
24 struct kthread_create_info_t
25 {
26 // 传递给kthread的信息
27 int (*thread_fn)(void *data);
28 void *data;
29 int node;
30
31 // kthreadd守护进程传递给kthread_create的结果,
32 // 成功则返回PCB，不成功则该值为负数错误码。若该值为NULL，意味着创建过程尚未完成
33 struct process_control_block *result;
34
35 struct List list;
36 };
37
38 /**
39 * @brief 获取pcb中的kthread结构体
40 *
41 * @param pcb pcb
42 * @return struct kthread* kthread信息结构体
43 */
to_kthread(struct process_control_block * pcb)44 struct kthread_info_t *to_kthread(struct process_control_block *pcb)
45 {
46 WARN_ON(!(pcb->flags & PF_KTHREAD));
47 return pcb->worker_private;
48 }
49
__kthread_create_on_node(int (* thread_fn)(void * data),void * data,int node,const char name_fmt[],va_list args)50 static struct process_control_block *__kthread_create_on_node(int (*thread_fn)(void *data), void *data, int node,
51 const char name_fmt[], va_list args)
52 {
53 struct process_control_block *pcb = NULL;
54 struct kthread_create_info_t *create = kzalloc(sizeof(struct kthread_create_info_t), 0);
55
56 if (create == NULL)
57 return ERR_PTR(-ENOMEM);
58 BUG_ON(name_fmt == NULL);
59
60 create->thread_fn = thread_fn;
61 create->data = data;
62 create->node = node;
63 create->result = NULL;
64 list_init(&create->list);
65
66 spin_lock(&__kthread_create_lock);
67 list_append(&kthread_create_list, &create->list);
68 spin_unlock(&__kthread_create_lock);
69 // kdebug("to wakeup kthread daemon..., current preempt=%d, rflags=%#018lx", current_pcb->preempt_count,
70
71 // todo: 使用completion优化这里
72 while (kthreadd_pcb == NULL) // 若kthreadd未初始化，则等待kthreadd启动
73 ;
74 // 唤醒kthreadd守护进程
75 process_wakeup_immediately(kthreadd_pcb);
76
77 // 等待创建完成
78 // todo: 使用completion机制以降低忙等时间
79 while (create->result == NULL)
80 pause();
81 // 获取结果
82 pcb = create->result;
83 if (!IS_ERR(create->result))
84 {
85 // 为内核线程设置名字
86 char pcb_name[PCB_NAME_LEN];
87 va_list get_args;
88 va_copy(get_args, args);
89 // 获取到字符串的前16字节
90 int len = vsnprintf(pcb_name, name_fmt, PCB_NAME_LEN, get_args);
91 if (len >= PCB_NAME_LEN)
92 {
93 //名字过大 放到full_name字段中
94 struct kthread_info_t *kthread = to_kthread(pcb);
95 char *full_name = kzalloc(1024, 0);
96 vsprintf(full_name, name_fmt, get_args);
97 kthread->full_name = full_name;
98 }
99 // 将前16Bytes放到pcb的name字段
100 process_set_pcb_name(pcb, pcb_name);
101 va_end(get_args);
102 }
103
104 kfree(create);
105 return pcb;
106 }
107
108 /**
109 * @brief 让当前内核线程退出，并返回result参数给kthread_stop()函数
110 *
111 * @param result 返回值
112 */
kthread_exit(long result)113 void kthread_exit(long result)
114 {
115 struct kthread_info_t *kt = to_kthread(current_pcb);
116 kt->result = result;
117 kt->exited = true;
118 process_do_exit(0);
119 }
120
121 /**
122 * @brief 在当前结点上创建一个内核线程
123 *
124 * @param thread_fn 该内核线程要执行的函数
125 * @param data 传递给 thread_fn 的参数数据
126 * @param node 线程的任务和线程结构都分配在这个节点上
127 * @param name_fmt printf-style format string for the thread name
128 * @param arg name_fmt的参数
129 * @return 返回一个pcb或者是ERR_PTR(-ENOMEM)
130 *
131 * 请注意，该宏会创建一个内核线程，并将其设置为停止状态。您可以使用wake_up_process来启动这个线程。
132 * 新的线程的调度策略为SCHED_NORMAL，并且能在所有的cpu上运行
133 *
134 * 当内核线程被唤醒时，会运行thread_fn函数，并将data作为参数传入。
135 * 内核线程可以直接返回，也可以在kthread_should_stop为真时返回。
136 */
kthread_create_on_node(int (* thread_fn)(void * data),void * data,int node,const char name_fmt[],...)137 struct process_control_block *kthread_create_on_node(int (*thread_fn)(void *data), void *data, int node,
138 const char name_fmt[], ...)
139 {
140 struct process_control_block *pcb;
141 va_list args;
142 va_start(args, name_fmt);
143 pcb = __kthread_create_on_node(thread_fn, data, node, name_fmt, args);
144 va_end(args);
145 return pcb;
146 }
147 /**
148 * @brief 内核线程的包裹程序
149 * 当内核线程被运行后，从kernel_thread_func跳转到这里。
150 * @param _create 内核线程的创建信息
151 * @return int 内核线程的退出返回值
152 */
kthread(void * _create)153 static int kthread(void *_create)
154 {
155 struct kthread_create_info_t *create = _create;
156 // 将这几个信息从kthread_create_info中拷贝过来。以免在kthread_create_info被free后，数据丢失从而导致错误。
157 int (*thread_fn)(void *data) = create->thread_fn;
158 void *data = create->data;
159
160 int retval = 0;
161
162 struct kthread_info_t *self = to_kthread(current_pcb);
163
164 self->thread_fn = thread_fn;
165 self->data = data;
166
167 // todo: 增加调度参数设定
168 // todo: 当前内核线程继承了kthreadd的优先级以及调度策略，需要在这里进行更新
169
170 // 设置当前进程为不可被打断
171 current_pcb->state = PROC_UNINTERRUPTIBLE;
172
173 // 将当前pcb返回给创建者
174 create->result = current_pcb;
175
176 current_pcb->state &= ~PROC_RUNNING; // 设置当前进程不是RUNNING态
177 io_mfence();
178
179 // 发起调度，使得当前内核线程休眠。直到创建者通过process_wakeup将当前内核线程唤醒
180 sched();
181
182 retval = -EINTR;
183 // 如果发起者没有调用kthread_stop()，则该kthread的功能函数开始执行
184 if (!(self->flags & (1 << KTHREAD_SHOULD_STOP)))
185 {
186 retval = thread_fn(data);
187 }
188 kthread_exit(retval);
189 }
190
__create_kthread(struct kthread_create_info_t * create)191 static void __create_kthread(struct kthread_create_info_t *create)
192 {
193 pid_t pid = kernel_thread(kthread, create, CLONE_FS | CLONE_SIGNAL);
194 io_mfence();
195 if (IS_ERR((void *)pid))
196 {
197 // todo: 使用complete机制完善这里
198
199 create->result = (struct process_control_block *)pid;
200 }
201 }
202
203 /**
204 * @brief kthread守护线程
205 *
206 * @param unused
207 * @return int 不应当退出
208 */
kthreadd(void * unused)209 int kthreadd(void *unused)
210 {
211 kinfo("kthread daemon started!");
212 struct process_control_block *pcb = current_pcb;
213 kthreadd_pcb = current_pcb;
214 current_pcb->flags |= PF_NOFREEZE;
215
216 for (;;)
217 {
218 current_pcb->state = PROC_INTERRUPTIBLE;
219 // 所有的创建任务都被处理完了
220 if (list_empty(&kthread_create_list))
221 sched();
222
223 spin_lock(&__kthread_create_lock);
224 // 循环取出链表中的任务
225 while (!list_empty(&kthread_create_list))
226 {
227
228 // 从链表中取出第一个要创建的内核线程任务
229 struct kthread_create_info_t *create =
230 container_of(kthread_create_list.next, struct kthread_create_info_t, list);
231 list_del_init(&create->list);
232 spin_unlock(&__kthread_create_lock);
233
234 __create_kthread(create);
235
236 spin_lock(&__kthread_create_lock);
237 }
238 spin_unlock(&__kthread_create_lock);
239 }
240 }
241
242 /**
243 * @brief 内核线程调用该函数，检查自身的标志位，判断自己是否应该执行完任务后退出
244 *
245 * @return true 内核线程应该退出
246 * @return false 无需退出
247 */
kthread_should_stop(void)248 bool kthread_should_stop(void)
249 {
250 struct kthread_info_t *self = to_kthread(current_pcb);
251 if (self->flags & (1 << KTHREAD_SHOULD_STOP))
252 return true;
253
254 return false;
255 }
256
257 /**
258 * @brief 向kthread发送停止信号，请求其结束
259 *
260 * @param pcb 内核线程的pcb
261 * @return int 错误码
262 */
kthread_stop(struct process_control_block * pcb)263 int kthread_stop(struct process_control_block *pcb)
264 {
265 int retval;
266 struct kthread_info_t *target = to_kthread(pcb);
267 target->flags |= (1 << KTHREAD_SHOULD_STOP);
268 process_wakeup(pcb);
269 // 等待指定的内核线程退出
270 // todo: 使用completion机制改进这里
271 while (target->exited == false)
272 usleep(5000);
273 retval = target->result;
274
275 // 释放内核线程的页表
276 process_exit_mm(pcb);
277 process_release_pcb(pcb);
278 return retval;
279 }
280
281 /**
282 * @brief 设置pcb中的worker_private字段（只应被设置一次）
283 *
284 * @param pcb pcb
285 * @return bool 成功或失败
286 */
kthread_set_worker_private(struct process_control_block * pcb)287 bool kthread_set_worker_private(struct process_control_block *pcb)
288 {
289 if (WARN_ON_ONCE(to_kthread(pcb)))
290 return false;
291
292 struct kthread_info_t *kt = kzalloc(sizeof(struct kthread_info_t), 0);
293 if (kt == NULL)
294 return false;
295 pcb->worker_private = kt;
296 return true;
297 }
298
299 /**
300 * @brief 初始化kthread机制(只应被process_init调用)
301 *
302 * @return int 错误码
303 */
kthread_mechanism_init()304 int kthread_mechanism_init()
305 {
306 kinfo("Initializing kthread mechanism...");
307 spin_init(&__kthread_create_lock);
308 list_init(&kthread_create_list);
309 // 创建kthreadd守护进程
310 kernel_thread(kthreadd, NULL, CLONE_FS | CLONE_SIGNAL);
311
312 return 0;
313 }
314
315 /**
316 * @brief 释放pcb指向的worker private
317 *
318 * @param pcb 要释放的pcb
319 */
free_kthread_struct(struct process_control_block * pcb)320 void free_kthread_struct(struct process_control_block *pcb)
321 {
322 struct kthread_info_t *kthread = to_kthread(pcb);
323 if (!kthread)
324 {
325 return;
326 }
327 pcb->worker_private = NULL;
328 kfree(kthread->full_name);
329 kfree(kthread);
330 }