Fix reference to README.devlib in header.
[bertos.git] / kern / proc_p.h
1 /*!
2  * \file
3  * <!--
4  * Copyright 2001, 2004 Develer S.r.l. (http://www.develer.com/)
5  * Copyright 1999, 2000, 2001 Bernardo Innocenti <bernie@develer.com>
6  * This file is part of DevLib - See README.devlib for information.
7  * -->
8  *
9  * \brief Internal scheduler structures and definitions for processes.
10  *
11  * \version $Id$
12  *
13  * \author Bernardo Innocenti <bernie@develer.com>
14  */
15
16 /*#*
17  *#* $Log$
18  *#* Revision 1.14  2005/11/04 16:20:02  bernie
19  *#* Fix reference to README.devlib in header.
20  *#*
21  *#* Revision 1.13  2005/04/11 19:10:28  bernie
22  *#* Include top-level headers from cfg/ subdir.
23  *#*
24  *#* Revision 1.12  2004/12/08 08:57:35  bernie
25  *#* Rename sigset_t to sigmask_t.
26  *#*
27  *#* Revision 1.11  2004/11/16 22:37:14  bernie
28  *#* Replace IPTR with iptr_t.
29  *#*
30  *#* Revision 1.10  2004/10/19 11:47:07  bernie
31  *#* Add missing #endif.
32  *#*
33  *#* Revision 1.9  2004/10/19 08:55:31  bernie
34  *#* Define forbid_cnt.
35  *#*
36  *#* Revision 1.8  2004/10/03 20:39:28  bernie
37  *#* Import changes from sc/firmware.
38  *#*
39  *#* Revision 1.7  2004/08/25 14:12:09  rasky
40  *#* Aggiornato il comment block dei log RCS
41  *#*
42  *#* Revision 1.6  2004/08/24 16:05:15  bernie
43  *#* Add missing headers; Reformat.
44  *#*
45  *#* Revision 1.5  2004/08/14 19:37:57  rasky
46  *#* Merge da SC: macros.h, pool.h, BIT_CHANGE, nome dei processi, etc.
47  *#*
48  *#* Revision 1.4  2004/07/30 14:24:16  rasky
49  *#* Task switching con salvataggio perfetto stato di interrupt (SR)
50  *#* Kernel monitor per dump informazioni su stack dei processi
51  *#*
52  *#* Revision 1.3  2004/07/14 14:18:09  rasky
53  *#* Merge da SC: Rimosso timer dentro il task, che รจ uno spreco di memoria per troppi task
54  *#*
55  *#* Revision 1.2  2004/06/03 11:27:09  bernie
56  *#* Add dual-license information.
57  *#*
58  *#* Revision 1.1  2004/05/23 17:27:00  bernie
59  *#* Import kern/ subdirectory.
60  *#*
61  *#* Revision 1.3  2004/05/14 12:52:13  rasky
62  *#* Importato supporto kernel per AVR da Stefano
63  *#*
64  *#* Revision 1.2  2004/04/28 16:13:49  rasky
65  *#* proc_schedule() is now semi-private (used only within the kernel)
66  *#*
67  *#* Revision 1.1  2004/04/26 18:02:40  rasky
68  *#* Importato microkernel
69  *#*
70  *#* Revision 1.1  2004/04/04 17:40:26  aleph
71  *#* Add multithreading kernel
72  *#*
73  *#*/
74 #ifndef KERN_PROC_P_H
75 #define KERN_PROC_P_H
76
77 #include <cfg/compiler.h>
78 #include <cfg/cpu.h>        /* for cpu_stack_t */
79 #include <cfg/config.h>
80 #include <cfg/config_kern.h>
81 #include <mware/list.h>
82
83 typedef struct Process
84 {
85         Node         link;        /*!< Link Process into scheduler lists */
86         cpustack_t  *stack;       /*!< Per-process SP */
87         iptr_t       user_data;   /*!< Custom data passed to the process */
88
89 #if CONFIG_KERN_SIGNALS
90         sigmask_t    sig_wait;    /*!< Signals the process is waiting for */
91         sigmask_t    sig_recv;    /*!< Received signals */
92 #endif
93
94 #if CONFIG_KERN_PREEMPTIVE
95         int          forbid_cnt;  /*!< Nesting count for proc_forbid()/proc_permit(). */
96 #endif
97
98 #if CONFIG_KERN_HEAP
99         uint16_t     flags;       /*!< Flags */
100         cpustack_t  *stack_base;  /*!< Base of process stack */
101         size_t       stack_size;  /*!< Size of process stack */
102 #endif
103
104 #if CONFIG_KERN_MONITOR
105         struct ProcMonitor
106         {
107                 Node        link;
108                 const char *name;
109                 cpustack_t *stack_base;
110                 size_t      stack_size;
111         } monitor;
112 #endif
113
114 } Process;
115
116
117 /*!
118  * \name Flags for Process.flags.
119  * \{
120  */
121 #define PF_FREESTACK  BV(0)  /*!< Free the stack when process dies */
122 /*\}*/
123
124
125 /*! Track running processes. */
126 extern REGISTER Process *CurrentProcess;
127
128 /*! Track ready processes. */
129 extern REGISTER List     ProcReadyList;
130
131
132 /*! Enqueue a task in the ready list. */
133 #define SCHED_ENQUEUE(proc)  ADDTAIL(&ProcReadyList, &(proc)->link)
134
135 /*! Schedule to another process *without* adding the current to the ready list. */
136 void proc_schedule(void);
137
138 #if CONFIG_KERN_MONITOR
139         /*! Initialize the monitor */
140         void monitor_init(void);
141
142         /*! Register a process into the monitor */
143         void monitor_add(Process *proc, const char *name, cpustack_t *stack, size_t stacksize);
144
145         /*! Unregister a process from the monitor */
146         void monitor_remove(Process *proc);
147
148         /*! Rename a process */
149         void monitor_rename(Process *proc, const char* name);
150 #endif /* CONFIG_KERN_MONITOR */
151
152 #endif /* KERN_PROC_P_H */
153