rt-thread/components/lwp/lwp.h

318 lines
6.9 KiB
C
Raw Normal View History

2018-12-10 16:31:33 +08:00
/*
2021-03-08 18:19:04 +08:00
* Copyright (c) 2006-2021, RT-Thread Development Team
2018-12-10 16:31:33 +08:00
*
* SPDX-License-Identifier: Apache-2.0
2018-12-10 16:31:33 +08:00
*
* Change Logs:
* Date Author Notes
* 2018-06-29 heyuanjie first version
* 2019-10-12 Jesven Add MMU and userspace support
* 2020-10-08 Bernard Architecture and code cleanup
* 2021-08-26 linzhenxing add lwp_setcwd\lwp_getcwd
2018-12-10 16:31:33 +08:00
*/
/*
* RT-Thread light-weight process
*/
2018-12-10 16:31:33 +08:00
#ifndef __LWP_H__
#define __LWP_H__
#include <stdint.h>
#include <rthw.h>
#include <rtthread.h>
#include <dfs.h>
#include "lwp_arch.h"
#include "lwp_pid.h"
#include "lwp_ipc.h"
#include "lwp_signal.h"
#include "lwp_syscall.h"
#include "lwp_avl.h"
#include "mm_aspace.h"
#ifdef RT_USING_MUSLLIBC
#include "libc_musl.h"
#endif /* RT_USING_MUSLLIBC */
#ifdef ARCH_MM_MMU
#include "lwp_shm.h"
#include "mmu.h"
#include "page.h"
#else
#include "lwp_mpu.h"
#endif /* ARCH_MM_MMU */
#ifdef RT_USING_MUSLLIBC
#include <locale.h>
#endif /* RT_USING_MUSLLIBC */
#ifdef RT_USING_TTY
struct tty_struct;
#endif /* RT_USING_TTY */
#ifdef __cplusplus
extern "C" {
#endif
2018-12-10 16:31:33 +08:00
#define LWP_MAGIC 0x5A
#define LWP_TYPE_FIX_ADDR 0x01
#define LWP_TYPE_DYN_ADDR 0x02
#define LWP_ARG_MAX 8
struct rt_lwp_objs
{
rt_aspace_t source;
struct rt_mem_obj mem_obj;
};
2018-12-10 16:31:33 +08:00
struct rt_lwp
{
#ifdef ARCH_MM_MMU
size_t end_heap;
rt_aspace_t aspace;
struct rt_lwp_objs *lwp_obj;
#else
#ifdef ARCH_MM_MPU
struct rt_mpu_info mpu_info;
#endif /* ARCH_MM_MPU */
#endif
#ifdef RT_USING_SMP
int bind_cpu;
#endif
2018-12-10 16:31:33 +08:00
uint8_t lwp_type;
uint8_t reserv[3];
2018-12-10 16:31:33 +08:00
struct rt_lwp *parent;
struct rt_lwp *first_child;
struct rt_lwp *sibling;
2018-12-10 16:31:33 +08:00
rt_list_t wait_list;
rt_bool_t finish;
rt_bool_t terminated;
rt_bool_t background;
int lwp_ret;
2018-12-10 16:31:33 +08:00
void *text_entry;
uint32_t text_size;
void *data_entry;
2018-12-10 16:31:33 +08:00
uint32_t data_size;
int ref;
2018-12-10 16:31:33 +08:00
void *args;
uint32_t args_length;
pid_t pid;
pid_t __pgrp; /*Accessed via process_group()*/
pid_t tty_old_pgrp;
pid_t session;
rt_list_t t_grp;
rt_list_t timer; /* POSIX timer object binding to a process */
int leader; /*boolean value for session group_leader*/
struct dfs_fdtable fdt;
char cmd[RT_NAME_MAX];
/* POSIX signal */
struct lwp_signal signal;
struct lwp_avl_struct *object_root;
struct rt_mutex object_mutex;
struct rt_user_context user_ctx;
struct rt_wqueue wait_queue; /*for console */
struct tty_struct *tty; /* NULL if no tty */
struct lwp_avl_struct *address_search_head; /* for addressed object fast search */
char working_directory[DFS_PATH_MAX];
int debug;
uint32_t bak_first_ins;
#ifdef LWP_ENABLE_ASID
uint64_t generation;
unsigned int asid;
#endif
2018-12-10 16:31:33 +08:00
};
struct rt_lwp *lwp_self(void);
enum lwp_exit_request_type
2018-12-10 16:31:33 +08:00
{
LWP_EXIT_REQUEST_NONE = 0,
LWP_EXIT_REQUEST_TRIGGERED,
LWP_EXIT_REQUEST_IN_PROCESS,
};
struct termios *get_old_termios(void);
void lwp_setcwd(char *buf);
char *lwp_getcwd(void);
void lwp_request_thread_exit(rt_thread_t thread_to_exit);
int lwp_check_exit_request(void);
void lwp_terminate(struct rt_lwp *lwp);
void lwp_wait_subthread_exit(void);
2018-12-10 16:31:33 +08:00
int lwp_tid_get(void);
void lwp_tid_put(int tid);
rt_thread_t lwp_tid_get_thread(int tid);
void lwp_tid_set_thread(int tid, rt_thread_t thread);
size_t lwp_user_strlen(const char *s, int *err);
int lwp_execve(char *filename, int debug, int argc, char **argv, char **envp);
/*create by lwp_setsid.c*/
int setsid(void);
#ifdef ARCH_MM_MMU
void lwp_aspace_switch(struct rt_thread *thread);
#endif
void lwp_user_setting_save(rt_thread_t thread);
void lwp_user_setting_restore(rt_thread_t thread);
2023-08-08 00:22:14 +08:00
void lwp_uthread_ctx_save(void *ctx);
void lwp_uthread_ctx_restore(void);
int lwp_setaffinity(pid_t pid, int cpu);
/* ctime lwp API */
int timer_list_free(rt_list_t *timer_list);
#ifdef ARCH_MM_MMU
struct __pthread {
/* Part 1 -- these fields may be external or
* * internal (accessed via asm) ABI. Do not change. */
struct pthread *self;
uintptr_t *dtv;
struct pthread *prev, *next; /* non-ABI */
uintptr_t sysinfo;
uintptr_t canary, canary2;
/* Part 2 -- implementation details, non-ABI. */
int tid;
int errno_val;
volatile int detach_state;
volatile int cancel;
volatile unsigned char canceldisable, cancelasync;
unsigned char tsd_used:1;
unsigned char dlerror_flag:1;
unsigned char *map_base;
size_t map_size;
void *stack;
size_t stack_size;
size_t guard_size;
void *result;
struct __ptcb *cancelbuf;
void **tsd;
struct {
volatile void *volatile head;
long off;
volatile void *volatile pending;
} robust_list;
volatile int timer_id;
locale_t locale;
volatile int killlock[1];
char *dlerror_buf;
void *stdio_locks;
/* Part 3 -- the positions of these fields relative to
* * the end of the structure is external and internal ABI. */
uintptr_t canary_at_end;
uintptr_t *dtv_copy;
2018-12-10 16:31:33 +08:00
};
#endif
2018-12-10 16:31:33 +08:00
/* for futex op */
#define FUTEX_WAIT 0
#define FUTEX_WAKE 1
/* for pmutex op */
#define PMUTEX_INIT 0
#define PMUTEX_LOCK 1
#define PMUTEX_UNLOCK 2
#define PMUTEX_DESTROY 3
#ifdef __cplusplus
}
#endif
#define AUX_ARRAY_ITEMS_NR 6
/* aux key */
#define AT_NULL 0
#define AT_IGNORE 1
#define AT_EXECFD 2
#define AT_PHDR 3
#define AT_PHENT 4
#define AT_PHNUM 5
#define AT_PAGESZ 6
#define AT_BASE 7
#define AT_FLAGS 8
#define AT_ENTRY 9
#define AT_NOTELF 10
#define AT_UID 11
#define AT_EUID 12
#define AT_GID 13
#define AT_EGID 14
#define AT_CLKTCK 17
#define AT_PLATFORM 15
#define AT_HWCAP 16
#define AT_FPUCW 18
#define AT_DCACHEBSIZE 19
#define AT_ICACHEBSIZE 20
#define AT_UCACHEBSIZE 21
#define AT_IGNOREPPC 22
#define AT_SECURE 23
#define AT_BASE_PLATFORM 24
#define AT_RANDOM 25
#define AT_HWCAP2 26
#define AT_EXECFN 31
struct process_aux_item
{
size_t key;
size_t value;
};
struct process_aux
2018-12-10 16:31:33 +08:00
{
struct process_aux_item item[AUX_ARRAY_ITEMS_NR];
};
2018-12-10 16:31:33 +08:00
struct lwp_args_info
{
char **argv;
char **envp;
int argc;
int envc;
int size;
};
struct dbg_ops_t
{
int (*dbg)(int argc, char **argv);
uint32_t (*arch_get_ins)(void);
void (*arch_activate_step)(void);
void (*arch_deactivate_step)(void);
int (*check_debug_event)(struct rt_hw_exp_stack *regs, unsigned long esr);
rt_channel_t (*gdb_get_server_channel)(void);
int (*gdb_get_step_type)(void);
void (*lwp_check_debug_attach_req)(void *pc);
int (*lwp_check_debug_suspend)(void);
2018-12-10 16:31:33 +08:00
};
extern struct dbg_ops_t *rt_dbg_ops;
2018-12-10 16:31:33 +08:00
int dbg_thread_in_debug(void);
void dbg_register(struct dbg_ops_t *dbg_ops);
2018-12-10 16:31:33 +08:00
uint32_t dbg_get_ins(void);
void dbg_activate_step(void);
void dbg_deactivate_step(void);
int dbg_check_event(struct rt_hw_exp_stack *regs, unsigned long arg);
rt_channel_t gdb_server_channel(void);
int dbg_step_type(void);
void dbg_attach_req(void *pc);
int dbg_check_suspend(void);
void rt_hw_set_process_id(int pid);
2018-12-10 16:31:33 +08:00
#endif