kern/proc.h

   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 Bernardo Innocenti <bernie@develer.com>
  31  *
  32  * -->
  33  *
  34  * \brief Process scheduler (public interface).
  35  *
  36  * \version $Id$
  37  *
  38  * \author Bernardo Innocenti <bernie@develer.com>
  39  */
  40 #ifndef KERN_PROC_H
  41 #define KERN_PROC_H
  42
  43 #include <cfg/compiler.h>
  44 #include <cpu/irq.h>
  45 #include <config_kern.h>
  46
  47 /* Fwd decl */
  48 struct Process;
  49
  50 /* Task scheduling services */
  51 void proc_init(void);
  52 struct Process *proc_new_with_name(const char* name, void (*entry)(void), iptr_t data, size_t stacksize, cpustack_t *stack);
  53
  54 #if !CONFIG_KERN_MONITOR
  55         #define proc_new(entry,data,size,stack) proc_new_with_name(NULL,(entry),(data),(size),(stack))
  56 #else
  57         #define proc_new(entry,data,size,stack) proc_new_with_name(#entry,(entry),(data),(size),(stack))
  58 #endif
  59
  60 void proc_exit(void);
  61 void proc_switch(void);
  62 void proc_test(void);
  63 struct Process *proc_current(void);
  64 iptr_t proc_current_user_data(void);
  65 void proc_rename(struct Process *proc, const char* name);
  66
  67 #if CONFIG_KERN_PREEMPTIVE
  68         void proc_forbid(void);
  69         void proc_permit(void);
  70 #else
  71         INLINE void proc_forbid(void) { /* nop */ }
  72         INLINE void proc_permit(void) { /* nop */ }
  73 #endif
  74
  75 /**
  76  * Execute a block of \a CODE atomically with respect to task scheduling.
  77  */
  78 #define PROC_ATOMIC(CODE) \
  79         do { \
  80                 proc_forbid(); \
  81                 CODE; \
  82                 proc_permit(); \
  83         } while(0)
  84
  85 #endif /* KERN_PROC_H */