bertos/kern/proc.c

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2001, 2004 Develer S.r.l. (http://www.develer.com/)
  30  * Copyright 1999, 2000, 2001, 2008 Bernie Innocenti <bernie@codewiz.org>
  31  * -->
  32  *
  33  * \brief Simple cooperative multitasking scheduler.
  34  *
  35  * \version $Id$
  36  * \author Bernie Innocenti <bernie@codewiz.org>
  37  * \author Stefano Fedrigo <aleph@develer.com>
  38  */
  39
  40 #include "proc_p.h"
  41 #include "proc.h"
  42
  43 #include "cfg/cfg_proc.h"
  44 #define LOG_LEVEL KERN_LOG_LEVEL
  45 #define LOG_FORMAT KERN_LOG_FORMAT
  46 #include <cfg/log.h>
  47
  48 #include "cfg/cfg_arch.h"  // ARCH_EMUL
  49 #include "cfg/cfg_monitor.h"
  50 #include <cfg/macros.h>    // ROUND_UP2
  51 #include <cfg/module.h>
  52 #include <cfg/depend.h>    // CONFIG_DEPEND()
  53
  54 #include <cpu/irq.h>
  55 #include <cpu/types.h>
  56 #include <cpu/attr.h>
  57 #include <cpu/frame.h>
  58
  59 #if CONFIG_KERN_HEAP
  60         #include <struct/heap.h>
  61 #endif
  62
  63 #include <string.h>           /* memset() */
  64
  65 /*
  66  * The scheduer tracks ready processes by enqueuing them in the
  67  * ready list.
  68  *
  69  * \note Access to the list must occur while interrupts are disabled.
  70  */
  71 REGISTER List ProcReadyList;
  72
  73 /*
  74  * Holds a pointer to the TCB of the currently running process.
  75  *
  76  * \note User applications should use proc_current() to retrieve this value.
  77  */
  78 REGISTER Process *CurrentProcess;
  79
  80 #if (ARCH & ARCH_EMUL)
  81 /*
  82  * In some hosted environments, we must emulate the stack on the real
  83  * process stack to satisfy consistency checks in system libraries and
  84  * because some ABIs place trampolines on the stack.
  85  *
  86  * Access to this list must be protected by PROC_ATOMIC().
  87  */
  88 List StackFreeList;
  89
  90 #define NPROC 10
  91 cpu_stack_t proc_stacks[NPROC][(64 * 1024) / sizeof(cpu_stack_t)];
  92 #endif
  93
  94 /** The main process (the one that executes main()). */
  95 struct Process MainProcess;
  96
  97
  98 static void proc_init_struct(Process *proc)
  99 {
 100         /* Avoid warning for unused argument. */
 101         (void)proc;
 102
 103 #if CONFIG_KERN_SIGNALS
 104         proc->sig_recv = 0;
 105         proc->sig_wait = 0;
 106 #endif
 107
 108 #if CONFIG_KERN_HEAP
 109         proc->flags = 0;
 110 #endif
 111
 112 #if CONFIG_KERN_PRI
 113         proc->link.pri = 0;
 114 #endif
 115
 116 }
 117
 118 MOD_DEFINE(proc);
 119
 120 void proc_init(void)
 121 {
 122         LIST_INIT(&ProcReadyList);
 123
 124 #if ARCH & ARCH_EMUL
 125         LIST_INIT(&StackFreeList);
 126         for (int i = 0; i < NPROC; i++)
 127                 ADDTAIL(&StackFreeList, (Node *)proc_stacks[i]);
 128 #endif
 129
 130         /*
 131          * We "promote" the current context into a real process. The only thing we have
 132          * to do is create a PCB and make it current. We don't need to setup the stack
 133          * pointer because it will be written the first time we switch to another process.
 134          */
 135         proc_init_struct(&MainProcess);
 136         CurrentProcess = &MainProcess;
 137
 138 #if CONFIG_KERN_MONITOR
 139         monitor_init();
 140         monitor_add(CurrentProcess, "main");
 141 #endif
 142
 143 #if CONFIG_KERN_PREEMPT
 144         preempt_init();
 145 #endif
 146
 147         MOD_INIT(proc);
 148 }
 149
 150 /**
 151  * Create a new process, starting at the provided entry point.
 152  *
 153  * \return Process structure of new created process
 154  *         if successful, NULL otherwise.
 155  */
 156 struct Process *proc_new_with_name(UNUSED_ARG(const char *, name), void (*entry)(void), iptr_t data, size_t stack_size, cpu_stack_t *stack_base)
 157 {
 158         Process *proc;
 159         const size_t PROC_SIZE_WORDS = ROUND_UP2(sizeof(Process), sizeof(cpu_stack_t)) / sizeof(cpu_stack_t);
 160 #if CONFIG_KERN_HEAP
 161         bool free_stack = false;
 162 #endif
 163         LOG_INFO("name=%s", name);
 164
 165 #if (ARCH & ARCH_EMUL)
 166         /* Ignore stack provided by caller and use the large enough default instead. */
 167         PROC_ATOMIC(stack_base = (cpu_stack_t *)list_remHead(&StackFreeList));
 168         ASSERT(stack_base);
 169
 170         stack_size = KERN_MINSTACKSIZE;
 171 #elif CONFIG_KERN_HEAP
 172         /* Did the caller provide a stack for us? */
 173         if (!stack_base)
 174         {
 175                 /* Did the caller specify the desired stack size? */
 176                 if (!stack_size)
 177                         stack_size = KERN_MINSTACKSIZE;
 178
 179                 /* Allocate stack dinamically */
 180                 if (!(stack_base = heap_alloc(stack_size)))
 181                         return NULL;
 182
 183                 free_stack = true;
 184         }
 185
 186 #else // !ARCH_EMUL && !CONFIG_KERN_HEAP
 187
 188         /* Stack must have been provided by the user */
 189         ASSERT_VALID_PTR(stack_base);
 190         ASSERT(stack_size);
 191
 192 #endif // !ARCH_EMUL && !CONFIG_KERN_HEAP
 193
 194 #if CONFIG_KERN_MONITOR
 195         /*
 196          * Fill-in the stack with a special marker to help debugging.
 197          * On 64bit platforms, CONFIG_KERN_STACKFILLCODE is larger
 198          * than an int, so the (int) cast is required to silence the
 199          * warning for truncating its size.
 200          */
 201         memset(stack_base, (int)CONFIG_KERN_STACKFILLCODE, stack_size);
 202 #endif
 203
 204         /* Initialize the process control block */
 205         if (CPU_STACK_GROWS_UPWARD)
 206         {
 207                 proc = (Process *)stack_base;
 208                 proc->stack = stack_base + PROC_SIZE_WORDS;
 209                 // On some architecture stack should be aligned, so we do it.
 210                 proc->stack = (cpu_stack_t *)((uintptr_t)proc->stack + (sizeof(cpu_aligned_stack_t) - ((uintptr_t)proc->stack % sizeof(cpu_aligned_stack_t))));
 211                 if (CPU_SP_ON_EMPTY_SLOT)
 212                         proc->stack++;
 213         }
 214         else
 215         {
 216                 proc = (Process *)(stack_base + stack_size / sizeof(cpu_stack_t) - PROC_SIZE_WORDS);
 217                 // On some architecture stack should be aligned, so we do it.
 218                 proc->stack = (cpu_stack_t *)((uintptr_t)proc - ((uintptr_t)proc % sizeof(cpu_aligned_stack_t)));
 219                 if (CPU_SP_ON_EMPTY_SLOT)
 220                         proc->stack--;
 221         }
 222         /* Ensure stack is aligned */
 223         ASSERT((uintptr_t)proc->stack % sizeof(cpu_aligned_stack_t) == 0);
 224
 225         stack_size -= PROC_SIZE_WORDS * sizeof(cpu_stack_t);
 226         proc_init_struct(proc);
 227         proc->user_data = data;
 228
 229 #if CONFIG_KERN_HEAP | CONFIG_KERN_MONITOR | (ARCH & ARCH_EMUL)
 230         proc->stack_base = stack_base;
 231         proc->stack_size = stack_size;
 232         #if CONFIG_KERN_HEAP
 233         if (free_stack)
 234                 proc->flags |= PF_FREESTACK;
 235         #endif
 236 #endif
 237
 238         #if CONFIG_KERN_PREEMPT
 239
 240                 getcontext(&proc->context);
 241                 proc->context.uc_stack.ss_sp = proc->stack;
 242                 proc->context.uc_stack.ss_size = stack_size - 1;
 243                 proc->context.uc_link = NULL;
 244                 makecontext(&proc->context, (void (*)(void))proc_entry, 1, entry);
 245
 246         #else // !CONFIG_KERN_PREEMPT
 247
 248                 CPU_CREATE_NEW_STACK(proc->stack, entry, proc_exit);
 249
 250         #endif // CONFIG_KERN_PREEMPT
 251
 252         #if CONFIG_KERN_MONITOR
 253                 monitor_add(proc, name);
 254         #endif
 255
 256         /* Add to ready list */
 257         ATOMIC(SCHED_ENQUEUE(proc));
 258
 259         return proc;
 260 }
 261
 262 /**
 263  * Return the name of the specified process.
 264  *
 265  * NULL is a legal argument and will return the name "<NULL>".
 266  */
 267 const char *proc_name(struct Process *proc)
 268 {
 269         #if CONFIG_KERN_MONITOR
 270                 return proc ? proc->monitor.name : "<NULL>";
 271         #else
 272                 (void)proc;
 273                 return "---";
 274         #endif
 275 }
 276
 277 /// Return the name of the currently running process
 278 const char *proc_currentName(void)
 279 {
 280         return proc_name(proc_current());
 281 }
 282
 283 /// Rename a process
 284 void proc_rename(struct Process *proc, const char *name)
 285 {
 286 #if CONFIG_KERN_MONITOR
 287         monitor_rename(proc, name);
 288 #else
 289         (void)proc; (void)name;
 290 #endif
 291 }
 292
 293
 294 #if CONFIG_KERN_PRI
 295 /**
 296  * Change the scheduling priority of a process.
 297  *
 298  * Process piorities are signed ints, whereas a larger integer value means
 299  * higher scheduling priority.  The default priority for new processes is 0.
 300  * The idle process runs with the lowest possible priority: INT_MIN.
 301  *
 302  * A process with a higher priority always preempts lower priority processes.
 303  * Processes of equal priority share the CPU time according to a simple
 304  * round-robin policy.
 305  *
 306  * As a general rule to maximize responsiveness, compute-bound processes
 307  * should be assigned negative priorities and tight, interactive processes
 308  * should be assigned positive priorities.
 309  *
 310  * To avoid interfering with system background activities such as input
 311  * processing, application processes should remain within the range -10
 312  * and +10.
 313  */
 314 void proc_setPri(struct Process *proc, int pri)
 315 {
 316                 if (proc->link.pri == pri)
 317                         return;
 318
 319                 proc->link.pri = pri;
 320
 321                 if (proc != CurrentProcess)
 322                 {
 323                                 proc_forbid();
 324                                 ATOMIC(sched_reenqueue(proc));
 325                                 proc_permit();
 326                 }
 327 }
 328 #endif // CONFIG_KERN_PRI
 329
 330 /**
 331  * Terminate the current process
 332  */
 333 void proc_exit(void)
 334 {
 335         LOG_INFO("%p:%s", CurrentProcess, proc_currentName());
 336
 337 #if CONFIG_KERN_MONITOR
 338         monitor_remove(CurrentProcess);
 339 #endif
 340
 341 #if CONFIG_KERN_HEAP
 342         /*
 343          * The following code is BROKEN.
 344          * We are freeing our own stack before entering proc_schedule()
 345          * BAJO: A correct fix would be to rearrange the scheduler with
 346          *  an additional parameter which frees the old stack/process
 347          *  after a context switch.
 348          */
 349         if (CurrentProcess->flags & PF_FREESTACK)
 350                 heap_free(CurrentProcess->stack_base, CurrentProcess->stack_size);
 351         heap_free(CurrentProcess);
 352 #endif
 353
 354 #if (ARCH & ARCH_EMUL)
 355         /* Reinsert process stack in free list */
 356         PROC_ATOMIC(ADDHEAD(&StackFreeList, (Node *)CurrentProcess->stack_base));
 357
 358         /*
 359          * NOTE: At this point the first two words of what used
 360          * to be our stack contain a list node. From now on, we
 361          * rely on the compiler not reading/writing the stack.
 362          */
 363 #endif /* ARCH_EMUL */
 364
 365         CurrentProcess = NULL;
 366         proc_switch();
 367         /* not reached */
 368 }
 369
 370
 371 /**
 372  * Get the pointer to the user data of the current process
 373  */
 374 iptr_t proc_currentUserData(void)
 375 {
 376         return CurrentProcess->user_data;
 377 }