git://scm.lunaixsky.com / lunaix-os.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Framework for exporting system header to user space (#59)
[lunaix-os.git] / lunaix-os / includes / lunaix / process.h
diff --git a/lunaix-os/includes/lunaix/process.h b/lunaix-os/includes/lunaix/process.h
index a8ac5d84c19e85aa48aa15341c07c7957a361526..a9f307c704a8688b521cccd8c1817cc39658cd11 100644 (file)
--- a/lunaix-os/includes/lunaix/process.h
+++ b/lunaix-os/includes/lunaix/process.h
@@ -1,24 +1,29 @@
 #ifndef __LUNAIX_PROCESS_H
 #define __LUNAIX_PROCESS_H
 
 #ifndef __LUNAIX_PROCESS_H
 #define __LUNAIX_PROCESS_H
 
-#include <arch/x86/interrupts.h>
 #include <lunaix/clock.h>
 #include <lunaix/ds/waitq.h>
 #include <lunaix/fs.h>
 #include <lunaix/clock.h>
 #include <lunaix/ds/waitq.h>
 #include <lunaix/fs.h>
+#include <lunaix/iopoll.h>
 #include <lunaix/mm/mm.h>
 #include <lunaix/mm/mm.h>
+#include <lunaix/mm/pagetable.h>
 #include <lunaix/mm/region.h>
 #include <lunaix/signal.h>
 #include <lunaix/timer.h>
 #include <lunaix/types.h>
 #include <lunaix/mm/region.h>
 #include <lunaix/signal.h>
 #include <lunaix/timer.h>
 #include <lunaix/types.h>
+#include <lunaix/spike.h>
+#include <lunaix/hart_state.h>
+#include <lunaix/usrscope.h>
+
+#include <usr/lunaix/wait.h>
+
 #include <stdint.h>
 
 #include <stdint.h>
 
-// 虽然内核不是进程，但为了区分，这里使用Pid=-1来指代内核。这主要是方便物理页所有权检查。
-#define KERNEL_PID -1
 
 /*
 
 /*
-    |C|Bk|De|Tn|Pu|Rn|
-         \----/
-            Dt
+    |C|Sp|Bk|De|Tn|Pu|Rn|
+            \----/
+              Dt
 
     Group Dt: whether this process is terminated.
 
 
     Group Dt: whether this process is terminated.
 
@@ -27,6 +32,7 @@
     De: Destoryed
     Pu: Paused
     Bk: Blocked
     De: Destoryed
     Pu: Paused
     Bk: Blocked
+    Sp: Stopped
     C : Created
 */
 
     C : Created
 */
 
@@ -36,112 +42,253 @@
 #define PS_DESTROY 4
 #define PS_PAUSED 8
 #define PS_BLOCKED 16
 #define PS_DESTROY 4
 #define PS_PAUSED 8
 #define PS_BLOCKED 16
-#define PS_CREATED 32
+#define PS_STOPPED 32
+#define PS_CREATED 64
 
 
-#define PS_GrBP (PS_PAUSED | PS_BLOCKED)
+#define PS_GrBP (PS_PAUSED | PS_BLOCKED | PS_STOPPED)
 #define PS_GrDT (PS_TERMNAT | PS_DESTROY)
 #define PS_GrDT (PS_TERMNAT | PS_DESTROY)
+#define PS_Rn (PS_RUNNING | PS_CREATED)
 
 
-#define PROC_TERMINATED(state) ((state)&PS_GrDT)
-#define PROC_HANGED(state) ((state)&PS_BLOCKED)
-#define PROC_RUNNABLE(state) ((state)&PS_PAUSED)
+#define proc_terminated(proc) \
+            (!(proc) || ((proc)->state) & PS_GrDT)
+#define proc_hanged(proc) \
+            ((proc)  && ((proc)->state) & PS_BLOCKED)
+#define proc_runnable(proc) \
+            ((proc) && (!(proc)->state || !(((proc)->state) & ~PS_Rn)))
 
 
-#define PROC_FINPAUSE 1
 
 
-struct proc_sigstate
-{
-    isr_param proc_regs;
-    char fxstate[512] __attribute__((aligned(16)));
-};
+#define TH_DETACHED         0b00000001
+#define TH_STALLED          0b00000010
 
 
-struct sigact
-{
-    struct sigact* prev;
-    sigset_t sa_mask;
-    void* sa_actor;
-    void* sa_handler;
-    pid_t sender;
-};
+#define thread_detached(th) ((th)->flags & TH_DETACHED)
+#define detach_thread(th) ((th)->flags |= TH_DETACHED)
 
 
-struct sighail
-{
-    sigset_t sig_pending;
-    sigset_t sig_mask;
-    struct sigact* inprogress;
-    struct sigact signals[_SIG_NUM];
-};
+#define thread_flags_set(th, flag)      ((th)->flags |= (flag))
+#define thread_flags_clear(th, flag)    ((th)->flags &= ~(flag))
+#define thread_flags_test(th, flag)     ((th)->flags & (flag))
+#define thread_flags_test_all(th, flag) (((th)->flags & (flag)) == (flag))
 
 struct proc_sig
 {
     int sig_num;
     void* sigact;
     void* sighand;
 
 struct proc_sig
 {
     int sig_num;
     void* sigact;
     void* sighand;
-    struct proc_sigstate prev_context;
+    struct hart_state* saved_hstate;
 } __attribute__((packed));
 
 } __attribute__((packed));
 
-struct proc_info
+
+struct proc_info;
+
+struct haybed {
+    struct llist_header sleepers;
+    time_t wakeup_time;
+    time_t alarm_time;
+};
+
+struct thread_stats
+{
+    // number of times the thread entering kernel space involuntarily
+    unsigned long entry_count_invol;
+    // number of times the thread entering kernel space voluntarily
+    unsigned long entry_count_vol;
+    
+    // number of times the thread is preempted in kerenl space
+    unsigned long kpreempt_count;
+
+    // timestamp of last time kernel entry
+    time_t last_entry;
+    // timestamp of last time kernel reentry
+    time_t last_reentry;
+
+    // timestamp of last time kernel leave
+    time_t last_leave;
+    // timestamp of last time the thread is resumed
+    time_t last_resume;
+    
+    union {
+        struct {
+            bool at_user;
+        };
+        int flags;
+    };
+};
+
+struct thread
 {
     /*
         Any change to *critical section*, including layout, size
 {
     /*
         Any change to *critical section*, including layout, size
-        must be reflected in kernel/asm/x86/interrupt.S to avoid
+        must be reflected in arch/<arch>/interrupt.S.inc to avoid
         disaster!
      */
         disaster!
      */
+    struct
+    {
+        struct hart_state* hstate;
+        ptr_t ustack_top;
+    };                              // *critical section
+
+    struct {
+        tid_t tid;
+        time_t created;
+        int state;
+        int syscall_ret;
+        ptr_t exit_val;
+        int flags;
+    };
+
+    struct {
+        ptr_t kstack;               // process local kernel stack
+        struct mm_region* ustack;   // process local user stack (NULL for kernel thread)
+    };
+
+    struct thread_stats stats;
+
+    struct haybed sleep;
+
+    struct proc_info* process;
+    struct llist_header proc_sibs;  // sibling to process-local threads
+    struct llist_header sched_sibs; // sibling to scheduler (global) threads
+    struct sigctx sigctx;
+    waitq_t waitqueue;
+};
 
 
-    /* ---- critical section start ---- */
-
-    pid_t pid;                // offset = 0
-    struct proc_info* parent; // offset = 4
-    isr_param intr_ctx;       // offset = 8
-    ptr_t ustack_top;         // offset = 84 -> 56 -> 60
-    ptr_t page_table;         // offset = 88 -> 60 -> 64
-    void* fxstate;            // offset = 92 -> 64 -> 68
+struct proc_info
+{
+    // active thread, must be at the very beginning
+    struct thread* th_active;
 
 
-    /* ---- critical section end ---- */
+    struct llist_header threads;
+    int thread_count;
 
     struct llist_header tasks;
 
     struct llist_header tasks;
+
     struct llist_header siblings;
     struct llist_header children;
     struct llist_header grp_member;
     struct llist_header siblings;
     struct llist_header children;
     struct llist_header grp_member;
-    waitq_t waitqueue;
 
 
-    struct
-    {
-        struct llist_header sleepers;
-        time_t wakeup_time;
-        time_t alarm_time;
-    } sleep;
-
-    struct proc_mm mm;
-    time_t created;
-    u8_t state;
-    int32_t exit_code;
-    int32_t k_status;
-    int flags;
-    struct sighail sigctx;
+    struct {
+        struct proc_info* parent;
+        pid_t pid;
+        pid_t pgid;
+        time_t created;
+
+        uid_t euid;
+        uid_t suid;
+        gid_t egid;
+        gid_t sgid;
+
+        struct user_scope uscope;
+        struct v_dnode* root;
+
+        int state;
+        int exit_code;
+    };
+
+    struct proc_mm* mm;
+    struct sigregistry* sigreg;
     struct v_fdtable* fdtable;
     struct v_dnode* cwd;
     struct v_fdtable* fdtable;
     struct v_dnode* cwd;
-    pid_t pgid;
+    struct {
+        char* cmd;
+        size_t cmd_len;
+    };
+
+    struct iopoll pollctx;
 };
 
 extern volatile struct proc_info* __current;
 };
 
 extern volatile struct proc_info* __current;
+extern volatile struct thread* current_thread;
+
+/**
+ * @brief Check if current process belong to kernel itself
+ * (pid=0)
+ */
+#define kernel_process(proc) (!(proc)->pid)
+
+#define resume_thread(th) (th)->state = PS_READY
+#define pause_thread(th) (th)->state = PS_PAUSED
+#define block_thread(th) (th)->state = PS_BLOCKED
+
+static inline void must_inline
+set_current_executing(struct thread* thread)
+{
+    current_thread = thread;
+    __current = thread->process;
+}
+
+static inline struct proc_mm* 
+vmspace(struct proc_info* proc) 
+{
+    return proc ? proc->mm : NULL;
+}
+
+static inline ptr_t
+vmroot(struct proc_info* proc) 
+{
+    return proc ? proc->mm->vmroot : 0;
+}
+
+static inline vm_regions_t* 
+vmregions(struct proc_info* proc) 
+{
+    return proc ? &proc->mm->regions : NULL;
+}
+
+
+static inline unsigned int
+procvm_asid(struct proc_mm* mm)
+{
+    return mm->proc->pid;
+}
 
 static inline void
 
 static inline void
-block_current()
+block_current_thread()
 {
 {
-    __current->state = PS_BLOCKED;
+    block_thread(current_thread);
 }
 
 static inline void
 }
 
 static inline void
-pause_current()
+pause_current_thread()
 {
 {
-    __current->state = PS_PAUSED;
+    pause_thread(current_thread);
 }
 
 static inline void
 }
 
 static inline void
-resume_current()
+resume_current_thread()
 {
 {
-    __current->state = PS_RUNNING;
+    resume_thread(current_thread);
 }
 
 }
 
+static inline int syscall_result(int retval) {
+    return (current_thread->syscall_ret = retval);
+}
+
+/**
+ * @brief Spawn a process with arbitary entry point. 
+ *        The inherit priviledge level is deduced automatically
+ *        from the given entry point
+ * 
+ * @param created returned created main thread
+ * @param entry entry point
+ * @param with_ustack whether to pre-allocate a user stack with it
+ * @return int 
+ */
+int
+spawn_process(struct thread** created, ptr_t entry, bool with_ustack);
+
+/**
+ * @brief Spawn a process that housing a given executable image as well as 
+ *        program argument and environment setting
+ * 
+ * @param created returned created main thread
+ * @param path file system path to executable
+ * @param argv arguments passed to executable
+ * @param envp environment variables passed to executable
+ * @return int 
+ */
+int
+spawn_process_usr(struct thread** created, char* path, 
+                    const char** argv, const char** envp);
+
 /**
  * @brief 分配并初始化一个进程控制块
  *
 /**
  * @brief 分配并初始化一个进程控制块
  *
@@ -169,8 +316,8 @@ commit_process(struct proc_info* process);
 pid_t
 destroy_process(pid_t pid);
 
 pid_t
 destroy_process(pid_t pid);
 
-void
-setup_proc_mem(struct proc_info* proc, ptr_t kstack_from);
+void 
+delete_process(struct proc_info* proc);
 
 /**
  * @brief 复制当前进程（LunaixOS的类 fork (unix) 实现）
 
 /**
  * @brief 复制当前进程（LunaixOS的类 fork (unix) 实现）
@@ -191,7 +338,10 @@ new_proc();
  *
  */
 void
  *
  */
 void
-terminate_proc(int exit_code);
+terminate_current(int exit_code);
+
+void 
+terminate_proccess(struct proc_info* proc, int exit_code);
 
 int
 orphaned_proc(pid_t pid);
 
 int
 orphaned_proc(pid_t pid);
@@ -199,7 +349,166 @@ orphaned_proc(pid_t pid);
 struct proc_info*
 get_process(pid_t pid);
 
 struct proc_info*
 get_process(pid_t pid);
 
+/* 
+    ========= Thread =========
+*/
+
+void
+commit_thread(struct thread* thread);
+
+struct thread*
+alloc_thread(struct proc_info* process);
+
+void
+destory_thread(struct thread* thread);
+
+void
+terminate_thread(struct thread* thread, ptr_t val);
+
+void
+terminate_current_thread(ptr_t val);
+
+struct thread*
+create_thread(struct proc_info* proc, bool with_ustack);
+
+void
+start_thread(struct thread* th, ptr_t entry);
+
+static inline void
+spawn_kthread(ptr_t entry) {
+    assert(kernel_process(__current));
+
+    struct thread* th = create_thread(__current, false);
+    
+    assert(th);
+    start_thread(th, entry);
+    detach_thread(th);
+}
+
+void 
+exit_thread(void* val);
+
 void
 void
-proc_setsignal(struct proc_info* proc, int signum);
+thread_release_mem(struct thread* thread);
+
+/* 
+    ========= Signal =========
+*/
+
+#define pending_sigs(thread) ((thread)->sigctx.sig_pending)
+#define raise_signal(thread, sig) sigset_add(pending_sigs(thread), sig)
+#define sigact_of(proc, sig) ((proc)->sigreg->signals[(sig)])
+#define set_sigact(proc, sig, sigact) ((proc)->sigreg->signals[(sig)] = (sigact))
+
+static inline struct sigact*
+active_signal(struct thread* thread) {
+    struct sigctx* sigctx = &thread->sigctx;
+    struct sigregistry* sigreg = thread->process->sigreg;
+    return sigreg->signals[sigctx->sig_active];
+} 
+
+static inline void 
+sigactive_push(struct thread* thread, int active_sig) {
+    struct sigctx* sigctx = &thread->sigctx;
+    int prev_active = sigctx->sig_active;
+
+    assert(sigact_of(thread->process, active_sig));
+
+    sigctx->sig_order[active_sig] = prev_active;
+    sigctx->sig_active = active_sig;
+}
+
+static inline void 
+sigactive_pop(struct thread* thread) {
+    struct sigctx* sigctx = &thread->sigctx;
+    int active_sig = sigctx->sig_active;
+
+    sigctx->sig_active = sigctx->sig_order[active_sig];
+    sigctx->sig_order[active_sig] = active_sig;
+}
+
+void
+proc_setsignal(struct proc_info* proc, signum_t signum);
+
+void
+thread_setsignal(struct thread* thread, signum_t signum);
+
+void
+thread_stats_update(bool inbound, bool voluntary);
+
+static inline void
+thread_stats_update_entering(bool voluntary)
+{
+    thread_stats_update(true, voluntary);
+}
+
+static inline void
+thread_stats_update_leaving()
+{
+    thread_stats_update(false, true);
+}
+
+static inline void
+thread_stats_update_kpreempt()
+{
+    current_thread->stats.kpreempt_count++;
+}
+
+static inline void
+thread_stats_reset_kpreempt()
+{
+    current_thread->stats.kpreempt_count = 0;
+}
+
+static inline ticks_t
+thread_stats_kernel_elapse(struct thread* thread)
+{
+    return clock_systime() - thread->stats.last_reentry;
+}
+
+static inline ticks_t
+thread_stats_user_elapse(struct thread* thread)
+{
+    struct thread_stats* stats;
+    stats = &thread->stats;
+
+    return stats->last_entry - stats->last_leave;
+}
+
+static inline struct user_scope*
+current_user_scope()
+{
+    return &__current->uscope;
+}
+
+static inline uid_t must_inline
+current_euid()
+{
+    return __current->euid;
+}
+
+static inline bool must_inline
+current_is_root()
+{
+    return current_euid() == 0;
+}
+
+static inline gid_t must_inline
+current_egid()
+{
+    return __current->egid;
+}
+
+static inline void must_inline
+current_set_egid(gid_t gid)
+{
+    __current->egid = gid;
+}
+
+static inline void must_inline
+current_set_euid(uid_t uid)
+{
+    __current->euid = uid;
+}
 
 #endif /* __LUNAIX_PROCESS_H */
 
 #endif /* __LUNAIX_PROCESS_H */
The lunaix project - hobby kernel from scratch