kernel: preemptive and cooperative scheduler refactoring.
[bertos.git] / bertos / kern / proc_p.h
index a98f9428aa65f684ad414c4f2a0267c67f0547a1..64fabb1290fef6052231bf3e682fb9c8a4830f49 100644 (file)
 #ifndef KERN_PROC_P_H
 #define KERN_PROC_P_H
 
-#include "cfg/cfg_kern.h"
+#include "cfg/cfg_proc.h"
+#include "cfg/cfg_monitor.h"
+
 #include <cfg/compiler.h>
 
 #include <cpu/types.h>        /* for cpu_stack_t */
+#include <cpu/irq.h>          // IRQ_ASSERT_DISABLED()
 
-#include <struct/list.h>
-
-#if CONFIG_KERN_PREEMPTIVE
-       #include <ucontext.h> // XXX
-#endif
-
-typedef struct Process
-{
-       Node         link;        /**< Link Process into scheduler lists */
-       cpustack_t  *stack;       /**< Per-process SP */
-       iptr_t       user_data;   /**< Custom data passed to the process */
-
-#if CONFIG_KERN_SIGNALS
-       sigmask_t    sig_wait;    /**< Signals the process is waiting for */
-       sigmask_t    sig_recv;    /**< Received signals */
-#endif
-
-#if CONFIG_KERN_PREEMPTIVE
-       int          forbid_cnt;  /**< Nesting count for proc_forbid()/proc_permit(). */
-       bool         leaving;     /**< XXX: maybe global? */
-       ucontext_t   context;
-#endif
-
-#if CONFIG_KERN_HEAP
-       uint16_t     flags;       /**< Flags */
-#endif
-
-#if CONFIG_KERN_HEAP | CONFIG_KERN_MONITOR | (ARCH & ARCH_EMUL)
-       cpustack_t  *stack_base;  /**< Base of process stack */
-       size_t       stack_size;  /**< Size of process stack */
-#endif
+#include <kern/proc.h>   // struct Process
 
-#if CONFIG_KERN_MONITOR
-       struct ProcMonitor
-       {
-               Node        link;
-               const char *name;
-       } monitor;
+#ifndef asm_switch_context
+/**
+ * CPU dependent context switching routines.
+ *
+ * Saving and restoring the context on the stack is done by a CPU-dependent
+ * support routine which usually needs to be written in assembly.
+ */
+EXTERN_C void asm_switch_context(cpu_stack_t **new_sp, cpu_stack_t **save_sp);
 #endif
 
-} Process;
-
-
 /**
  * \name Flags for Process.flags.
  * \{
@@ -97,30 +69,103 @@ typedef struct Process
 
 
 /** Track running processes. */
-extern REGISTER Process        *CurrentProcess;
+extern REGISTER Process        *current_process;
 
 /**
  * Track ready processes.
  *
- * Access to this list must be protected with a proc_forbid() / proc_premit()
- * pair, or with SCHED_ATOMIC()
+ * Access to this list must be performed with interrupts disabled
  */
-extern REGISTER List     ProcReadyList;
-
+extern REGISTER List     proc_ready_list;
+
+#if CONFIG_KERN_PRI
+       #define prio_next()     (LIST_EMPTY(&proc_ready_list) ? INT_MIN : \
+                                       ((PriNode *)LIST_HEAD(&proc_ready_list))->pri)
+       #define prio_proc(proc) (proc->link.pri)
+       #define prio_curr()     prio_proc(current_process)
+
+       #define SCHED_ENQUEUE_INTERNAL(proc) \
+                       LIST_ENQUEUE(&proc_ready_list, &(proc)->link)
+       #define SCHED_ENQUEUE_HEAD_INTERNAL(proc) \
+                       LIST_ENQUEUE_HEAD(&proc_ready_list, &(proc)->link)
+#else
+       #define prio_next()     0
+       #define prio_proc(proc) 0
+       #define prio_curr()     0
+
+       #define SCHED_ENQUEUE_INTERNAL(proc) ADDTAIL(&proc_ready_list, &(proc)->link)
+       #define SCHED_ENQUEUE_HEAD_INTERNAL(proc) ADDHEAD(&proc_ready_list, &(proc)->link)
+#endif
 
 /**
- * Enqueue a task in the ready list.
+ * Enqueue a process in the ready list.
  *
  * Always use this macro to instert a process in the ready list, as its
  * might vary to implement a different scheduling algorithms.
  *
- * \note This macro is *NOT* protected against the scheduler.  Access to
- *       this list must be performed with interrupts disabled.
+ * \note Access to the scheduler ready list must be performed with
+ *       interrupts disabled.
  */
-#define SCHED_ENQUEUE(proc)  ADDTAIL(&ProcReadyList, &(proc)->link)
+#define SCHED_ENQUEUE(proc)  do { \
+               IRQ_ASSERT_DISABLED(); \
+               LIST_ASSERT_VALID(&proc_ready_list); \
+               SCHED_ENQUEUE_INTERNAL(proc); \
+       } while (0)
+
+#define SCHED_ENQUEUE_HEAD(proc)  do { \
+               IRQ_ASSERT_DISABLED(); \
+               LIST_ASSERT_VALID(&proc_ready_list); \
+               SCHED_ENQUEUE_HEAD_INTERNAL(proc); \
+       } while (0)
 
-/** Schedule to another process *without* adding the current to the ready list. */
-void proc_schedule(void);
+
+#if CONFIG_KERN_PRI
+/**
+ * Changes the priority of an already enqueued process.
+ *
+ * Searches and removes the process from the ready list, then uses LIST_ENQUEUE(()
+ * to insert again to fix priority.
+ *
+ * No action is performed for processes that aren't in the ready list, eg. in semaphore queues.
+ *
+ * \note Performance could be improved with a different implementation of priority list.
+ */
+INLINE void sched_reenqueue(struct Process *proc)
+{
+       IRQ_ASSERT_DISABLED();
+       LIST_ASSERT_VALID(&proc_ready_list);
+       Node *n;
+       PriNode *pos = NULL;
+       FOREACH_NODE(n, &proc_ready_list)
+       {
+               if (n == &proc->link.link)
+               {
+                       pos = (PriNode *)n;
+                       break;
+               }
+       }
+
+       // only remove and enqueue again if process is already in the ready list
+       // otherwise leave it alone
+       if (pos)
+       {
+               REMOVE(&proc->link.link);
+               LIST_ENQUEUE(&proc_ready_list, &proc->link);
+       }
+}
+#endif //CONFIG_KERN_PRI
+
+/* Process trampoline */
+void proc_entry(void);
+
+/* Schedule another process *without* adding the current one to the ready list. */
+void proc_switch(void);
+
+/* Immediately schedule a particular process bypassing the scheduler. */
+void proc_wakeup(Process *proc);
+
+/* Initialize a scheduler class. */
+void proc_schedInit(void);
 
 #if CONFIG_KERN_MONITOR
        /** Initialize the monitor */
@@ -136,4 +181,38 @@ void proc_schedule(void);
        void monitor_rename(Process *proc, const char *name);
 #endif /* CONFIG_KERN_MONITOR */
 
+#if CONFIG_KERN_PREEMPT
+INLINE int preempt_quantum(void)
+{
+       extern int _proc_quantum;
+       return _proc_quantum;
+}
+
+INLINE void proc_decQuantum(void)
+{
+       extern int _proc_quantum;
+       if (_proc_quantum > 0)
+               _proc_quantum--;
+}
+
+INLINE void preempt_reset_quantum(void)
+{
+       extern int _proc_quantum;
+       _proc_quantum = CONFIG_KERN_QUANTUM;
+}
+#else /* !CONFIG_KERN_PREEMPT */
+INLINE int preempt_quantum(void)
+{
+       return 0;
+}
+
+INLINE void proc_decQuantum(void)
+{
+}
+
+INLINE void preempt_reset_quantum(void)
+{
+}
+#endif /* CONFIG_KERN_PREEMPT */
+
 #endif /* KERN_PROC_P_H */