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
  41 /*#*
  42  *#* $Log$
  43  *#* Revision 1.12  2006/07/19 12:56:27  bernie
  44  *#* Convert to new Doxygen style.
  45  *#*
  46  *#* Revision 1.11  2006/02/21 16:06:55  bernie
  47  *#* Cleanup/update process scheduling.
  48  *#*
  49  *#* Revision 1.10  2005/11/04 16:20:02  bernie
  50  *#* Fix reference to README.devlib in header.
  51  *#*
  52  *#* Revision 1.9  2005/04/11 19:10:28  bernie
  53  *#* Include top-level headers from cfg/ subdir.
  54  *#*
  55  *#* Revision 1.8  2004/11/16 22:37:14  bernie
  56  *#* Replace IPTR with iptr_t.
  57  *#*
  58  *#* Revision 1.7  2004/10/19 08:54:55  bernie
  59  *#* Define forbid_cnt.
  60  *#*
  61  *#* Revision 1.6  2004/10/03 20:44:18  bernie
  62  *#* Remove stale declarations (moved to monitor.h).
  63  *#*
  64  *#* Revision 1.2  2004/06/03 11:27:09  bernie
  65  *#* Add dual-license information.
  66  *#*
  67  *#* Revision 1.1  2004/05/23 17:27:00  bernie
  68  *#* Import kern/ subdirectory.
  69  *#*
  70  *#*/
  71
  72 #ifndef KERN_PROC_H
  73 #define KERN_PROC_H
  74
  75 #include <cfg/compiler.h>
  76 #include <cpu/cpu.h>
  77 #include <config_kern.h>
  78
  79 /* Fwd decl */
  80 struct Process;
  81
  82 /* Task scheduling services */
  83 void proc_init(void);
  84 struct Process *proc_new_with_name(const char* name, void (*entry)(void), iptr_t data, size_t stacksize, cpustack_t *stack);
  85
  86 #if !CONFIG_KERN_MONITOR
  87         #define proc_new(entry,data,size,stack) proc_new_with_name(NULL,(entry),(data),(size),(stack))
  88 #else
  89         #define proc_new(entry,data,size,stack) proc_new_with_name(#entry,(entry),(data),(size),(stack))
  90 #endif
  91
  92 void proc_exit(void);
  93 void proc_switch(void);
  94 void proc_test(void);
  95 struct Process* proc_current(void);
  96 iptr_t proc_current_user_data(void);
  97 void proc_rename(struct Process* proc, const char* name);
  98
  99 #if CONFIG_KERN_PREEMPTIVE
 100         void proc_forbid(void);
 101         void proc_permit(void);
 102 #else
 103         INLINE void proc_forbid(void) { /* nop */ }
 104         INLINE void proc_permit(void) { /* nop */ }
 105 #endif
 106
 107 /**
 108  * Execute a block of \a CODE atomically with respect to task scheduling.
 109  */
 110 #define PROC_ATOMIC(CODE) \
 111         do { \
 112                 proc_forbid(); \
 113                 CODE; \
 114                 proc_permit(); \
 115         } while(0)
 116
 117 #endif /* KERN_PROC_H */
 118