1 /*
2 * Copyright (c) 2006-2021, RT-Thread Development Team
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 *
6 * Change Logs:
7 * Date Author Notes
8 * 2018-06-29 heyuanjie first version
9 * 2019-10-12 Jesven Add MMU and userspace support
10 * 2020-10-08 Bernard Architecture and code cleanup
11 * 2021-08-26 linzhenxing add lwp_setcwd\lwp_getcwd
12 * 2023-11-17 xqyjlj add process group and session support
13 * 2023-12-02 Shell Add macro to create lwp status and
14 * fix dead lock problem on pgrp
15 */
16
17 /*
18 * RT-Thread light-weight process
19 */
20 #ifndef __LWP_H__
21 #define __LWP_H__
22
23 #include <stdint.h>
24
25 #include <rthw.h>
26 #include <rtthread.h>
27 #include <dfs.h>
28
29 #include "lwp_arch.h"
30 #include "lwp_pid.h"
31 #include "lwp_ipc.h"
32 #include "lwp_signal.h"
33 #include "lwp_syscall.h"
34 #include "lwp_avl.h"
35 #include "lwp_args.h"
36 #include "mm_aspace.h"
37
38 #ifdef RT_USING_MUSLLIBC
39 #include "libc_musl.h"
40 #endif /* RT_USING_MUSLLIBC */
41
42 #ifdef ARCH_MM_MMU
43 #include "lwp_shm.h"
44 #include <locale.h>
45 #include "mmu.h"
46 #include "page.h"
47 #else
48 #include "lwp_mpu.h"
49 #endif /* ARCH_MM_MMU */
50
51 #ifdef RT_USING_MUSLLIBC
52 #include <locale.h>
53 #endif /* RT_USING_MUSLLIBC */
54
55 #ifdef __cplusplus
56 extern "C" {
57 #endif
58
59 #define LWP_MAGIC 0x5A
60
61 #define LWP_TYPE_FIX_ADDR 0x01
62 #define LWP_TYPE_DYN_ADDR 0x02
63
64 #define LWP_ARG_MAX 8
65
66 struct rt_lwp_objs
67 {
68 rt_aspace_t source;
69 struct rt_mem_obj mem_obj;
70 };
71
72 struct rt_lwp_notify
73 {
74 void (*notify)(rt_wqueue_t *signalfd_queue, int signo);
75 rt_wqueue_t *signalfd_queue;
76 rt_slist_t list_node;
77 };
78
79 struct lwp_tty;
80
81 #ifdef RT_USING_MUSLLIBC
82 #define LWP_COREDUMP_FLAG 0x80
83 #define LWP_CREATE_STAT_EXIT(exit_code) (((exit_code)&0xff) << 8)
84 #define LWP_CREATE_STAT_SIGNALED(signo, coredump) (((signo) & 0x7f) | (coredump ? LWP_COREDUMP_FLAG : 0))
85 #define LWP_CREATE_STAT_STOPPED(signo) (LWP_CREATE_STAT_EXIT(signo) | 0x7f)
86 #define LWP_CREATE_STAT_CONTINUED (0xffff)
87 #else
88 #error "No compatible lwp set status provided for this libc"
89 #endif
90
91 typedef struct rt_lwp *rt_lwp_t;
92 typedef struct rt_session *rt_session_t;
93 typedef struct rt_processgroup *rt_processgroup_t;
94
95 struct rt_session {
96 struct rt_object object;
97 rt_lwp_t leader;
98 rt_list_t processgroup;
99 pid_t sid;
100 pid_t foreground_pgid;
101 struct rt_mutex mutex;
102 struct lwp_tty *ctty;
103 };
104
105 struct rt_processgroup {
106 struct rt_object object;
107 rt_lwp_t leader;
108 rt_list_t process;
109 rt_list_t pgrp_list_node;
110 pid_t pgid;
111 pid_t sid;
112 struct rt_session *session;
113 struct rt_mutex mutex;
114
115 rt_atomic_t ref;
116
117 /* flags on process group */
118 unsigned int is_orphaned:1;
119 };
120
121 struct rt_lwp
122 {
123 #ifdef ARCH_MM_MMU
124 size_t end_heap;
125 rt_aspace_t aspace;
126 #else
127 #ifdef ARCH_MM_MPU
128 struct rt_mpu_info mpu_info;
129 #endif /* ARCH_MM_MPU */
130 #endif /* ARCH_MM_MMU */
131
132 #ifdef RT_USING_SMP
133 int bind_cpu;
134 #endif
135
136 uint8_t lwp_type;
137 uint8_t reserv[3];
138
139 /* flags */
140 unsigned int terminated:1;
141 unsigned int background:1;
142 unsigned int term_ctrlterm:1; /* have control terminal? */
143 unsigned int did_exec:1; /* Whether exec has been performed */
144 unsigned int jobctl_stopped:1; /* job control: current proc is stopped */
145 unsigned int wait_reap_stp:1; /* job control: has wait event for parent */
146 unsigned int sig_protected:1; /* signal: protected proc cannot be killed or stopped */
147
148 struct rt_lwp *parent; /* parent process */
149 struct rt_lwp *first_child; /* first child process */
150 struct rt_lwp *sibling; /* sibling(child) process */
151
152 struct rt_wqueue waitpid_waiters;
153 lwp_status_t lwp_status;
154
155 void *text_entry;
156 uint32_t text_size;
157 void *data_entry;
158 uint32_t data_size;
159
160 rt_atomic_t ref;
161 void *args;
162 uint32_t args_length;
163 pid_t pid;
164 pid_t sid; /* session ID */
165 pid_t pgid; /* process group ID */
166 struct rt_processgroup *pgrp;
167 rt_list_t pgrp_node; /* process group node */
168 rt_list_t t_grp; /* thread group */
169 rt_list_t timer; /* POSIX timer object binding to a process */
170
171 struct dfs_fdtable fdt;
172 char cmd[RT_NAME_MAX];
173 char *exe_file; /* process file path */
174
175 /* POSIX signal */
176 struct lwp_signal signal;
177
178 struct lwp_avl_struct *object_root;
179 struct rt_mutex object_mutex;
180 struct rt_user_context user_ctx;
181
182 struct rt_wqueue wait_queue; /* for console */
183 struct tty_struct *tty; /* NULL if no tty */
184
185 struct lwp_avl_struct *address_search_head; /* for addressed object fast search */
186 char working_directory[DFS_PATH_MAX];
187
188 int debug;
189 rt_uint32_t bak_first_inst; /* backup of first instruction */
190
191 struct rt_mutex lwp_lock;
192
193 rt_slist_t signalfd_notify_head;
194
195 #ifdef LWP_ENABLE_ASID
196 uint64_t generation;
197 unsigned int asid;
198 #endif
199 struct rusage rt_rusage;
200
201 #ifdef RT_USING_VDSO
202 void *vdso_vbase;
203 #endif
204 };
205
206
207 struct rt_lwp *lwp_self(void);
208 rt_err_t lwp_children_register(struct rt_lwp *parent, struct rt_lwp *child);
209 rt_err_t lwp_children_unregister(struct rt_lwp *parent, struct rt_lwp *child);
210
211 enum lwp_exit_request_type
212 {
213 LWP_EXIT_REQUEST_NONE = 0,
214 LWP_EXIT_REQUEST_TRIGGERED,
215 LWP_EXIT_REQUEST_IN_PROCESS,
216 };
217 struct termios *get_old_termios(void);
218 void lwp_setcwd(char *buf);
219 char *lwp_getcwd(void);
220 int lwp_check_exit_request(void);
221 void lwp_terminate(struct rt_lwp *lwp);
222
223 int lwp_tid_init(void);
224 int lwp_tid_get(void);
225 void lwp_tid_put(int tid);
226
227 /**
228 * @brief Automatically get a thread and increase a reference count
229 *
230 * @param tid queried thread ID
231 * @return rt_thread_t
232 */
233 rt_thread_t lwp_tid_get_thread_and_inc_ref(int tid);
234 rt_thread_t lwp_tid_get_thread_raw(int tid);
235 /**
236 * @brief Decrease a reference count
237 *
238 * @param thread target thread
239 */
240 void lwp_tid_dec_ref(rt_thread_t thread);
241
242 void lwp_tid_set_thread(int tid, rt_thread_t thread);
243
244 int lwp_execve(char *filename, int debug, int argc, char **argv, char **envp);
245 int lwp_load(const char *filename, struct rt_lwp *lwp, uint8_t *load_addr, size_t addr_size, struct process_aux *aux);
246 void lwp_user_obj_free(struct rt_lwp *lwp);
247
248 /*create by lwp_setsid.c*/
249 int setsid(void);
250 #ifdef ARCH_MM_MMU
251 void lwp_aspace_switch(struct rt_thread *thread);
252 #endif
253 void lwp_user_setting_save(rt_thread_t thread);
254 void lwp_user_setting_restore(rt_thread_t thread);
255
256 void lwp_uthread_ctx_save(void *ctx);
257 void lwp_uthread_ctx_restore(void);
258
259 int lwp_setaffinity(int tid, int cpu);
260
261 pid_t exec(char *filename, int debug, int argc, char **argv);
262
263 /* ctime lwp API */
264 int timer_list_free(rt_list_t *timer_list);
265
266 rt_err_t lwp_futex_init(void);
267 rt_err_t lwp_futex(struct rt_lwp *lwp, int *uaddr, int op, int val,
268 const struct timespec *timeout, int *uaddr2, int val3);
269
270 /* processgroup api */
lwp_pgid_get_bypgrp(rt_processgroup_t group)271 rt_inline pid_t lwp_pgid_get_bypgrp(rt_processgroup_t group)
272 {
273 return group ? group->pgid : 0;
274 }
275
lwp_pgid_get_byprocess(rt_lwp_t process)276 rt_inline pid_t lwp_pgid_get_byprocess(rt_lwp_t process)
277 {
278 return process ? process->pgid : 0;
279 }
280 rt_processgroup_t lwp_pgrp_find(pid_t pgid);
281 void lwp_pgrp_dec_ref(rt_processgroup_t pgrp);
282 rt_processgroup_t lwp_pgrp_find_and_inc_ref(pid_t pgid);
283 rt_processgroup_t lwp_pgrp_create(rt_lwp_t leader);
284 int lwp_pgrp_delete(rt_processgroup_t group);
285
286 /**
287 * Note: all the pgrp with process operation must be called in the context where
288 * process lock is taken. This is protect us from a possible dead lock condition
289 *
290 * The order is mandatory in the case:
291 * PGRP_LOCK(pgrp);
292 * LWP_LOCK(p);
293 * ... bussiness logic
294 * LWP_UNLOCK(p);
295 * PGRP_UNLOCK(pgrp);
296 */
297 int lwp_pgrp_insert(rt_processgroup_t group, rt_lwp_t process);
298 int lwp_pgrp_remove(rt_processgroup_t group, rt_lwp_t process);
299 int lwp_pgrp_move(rt_processgroup_t group, rt_lwp_t process);
300
301 int lwp_pgrp_update_children_info(rt_processgroup_t group, pid_t sid, pid_t pgid);
302
303 /* session api */
lwp_sid_get_bysession(rt_session_t session)304 rt_inline pid_t lwp_sid_get_bysession(rt_session_t session)
305 {
306 return session ? session->sid : 0;
307 }
308
lwp_sid_get_bypgrp(rt_processgroup_t group)309 rt_inline pid_t lwp_sid_get_bypgrp(rt_processgroup_t group)
310 {
311 return group ? group->sid : 0;
312 }
313
lwp_sid_get_byprocess(rt_lwp_t process)314 rt_inline pid_t lwp_sid_get_byprocess(rt_lwp_t process)
315 {
316 return process ? process->sid : 0;
317 }
318
319 rt_session_t lwp_session_find(pid_t sid);
320 rt_session_t lwp_session_create(struct rt_lwp *leader);
321 int lwp_session_delete(rt_session_t session);
322
323 /**
324 * Note: all the session operation must be called in the context where
325 * process lock is taken. This is protect us from a possible dead lock condition
326 *
327 * The order is mandatory in the case:
328 * PGRP_LOCK(pgrp);
329 * LWP_LOCK(p);
330 * ... bussiness logic
331 * LWP_UNLOCK(p);
332 * PGRP_UNLOCK(pgrp);
333 */
334 int lwp_session_insert(rt_session_t session, rt_processgroup_t group);
335 int lwp_session_remove(rt_session_t session, rt_processgroup_t group);
336 int lwp_session_move(rt_session_t session, rt_processgroup_t group);
337 int lwp_session_update_children_info(rt_session_t session, pid_t sid);
338 int lwp_session_set_foreground(rt_session_t session, pid_t pgid);
339
340 /* complete the job control related bussiness on process exit */
341 void lwp_jobctrl_on_exit(struct rt_lwp *lwp);
342
343 sysret_t lwp_teardown(struct rt_lwp *lwp, void (*cb)(void));
344
345 #ifdef __cplusplus
346 }
347 #endif
348
349 #ifndef AUX_ARRAY_ITEMS_NR
350 #define AUX_ARRAY_ITEMS_NR 32
351 #endif
352
353 /* aux key */
354 #define AT_NULL 0
355 #define AT_IGNORE 1
356 #define AT_EXECFD 2
357 #define AT_PHDR 3
358 #define AT_PHENT 4
359 #define AT_PHNUM 5
360 #define AT_PAGESZ 6
361 #define AT_BASE 7
362 #define AT_FLAGS 8
363 #define AT_ENTRY 9
364 #define AT_NOTELF 10
365 #define AT_UID 11
366 #define AT_EUID 12
367 #define AT_GID 13
368 #define AT_EGID 14
369 #define AT_CLKTCK 17
370 #define AT_PLATFORM 15
371 #define AT_HWCAP 16
372 #define AT_FPUCW 18
373 #define AT_DCACHEBSIZE 19
374 #define AT_ICACHEBSIZE 20
375 #define AT_UCACHEBSIZE 21
376 #define AT_IGNOREPPC 22
377 #define AT_SECURE 23
378 #define AT_BASE_PLATFORM 24
379 #define AT_RANDOM 25
380 #define AT_HWCAP2 26
381 #define AT_EXECFN 31
382 #define AT_SYSINFO_EHDR 33
383
384 struct process_aux_item
385 {
386 size_t key;
387 size_t value;
388 };
389
390 struct process_aux
391 {
392 struct process_aux_item item[AUX_ARRAY_ITEMS_NR];
393 };
394
395 struct dbg_ops_t
396 {
397 int (*dbg)(int argc, char **argv);
398 uint32_t (*arch_get_ins)(void);
399 void (*arch_activate_step)(void);
400 void (*arch_deactivate_step)(void);
401 int (*check_debug_event)(struct rt_hw_exp_stack *regs, unsigned long esr);
402 rt_channel_t (*gdb_get_server_channel)(void);
403 int (*gdb_get_step_type)(void);
404 void (*lwp_check_debug_attach_req)(void *pc);
405 int (*lwp_check_debug_suspend)(void);
406 };
407 extern struct dbg_ops_t *rt_dbg_ops;
408
409 int dbg_thread_in_debug(void);
410 void dbg_register(struct dbg_ops_t *dbg_ops);
411
412 uint32_t dbg_get_ins(void);
413 void dbg_activate_step(void);
414 void dbg_deactivate_step(void);
415 int dbg_check_event(struct rt_hw_exp_stack *regs, unsigned long arg);
416 rt_channel_t gdb_server_channel(void);
417 int dbg_step_type(void);
418 void dbg_attach_req(void *pc);
419 int dbg_check_suspend(void);
420 void rt_hw_set_process_id(int pid);
421 void lwp_futex_exit_robust_list(rt_thread_t thread);
422
423 /* backtrace service */
424 rt_err_t lwp_backtrace_frame(rt_thread_t uthread, struct rt_hw_backtrace_frame *frame);
425
426 #endif
427