Add warning. Fix test function.
[bertos.git] / kern / monitor.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 2004 Develer S.r.l. (http://www.develer.com/)
30  *
31  * -->
32  *
33  * \brief Monitor to check for stack overflows
34  *
35  * \version $Id$
36  *
37  * \author Giovanni Bajo <rasky@develer.com>
38  */
39
40 #ifndef KERN_MONITOR_H
41 #define KERN_MONITOR_H
42
43 #include <cpu/types.h>
44 #include <config_kern.h>
45
46 #if CONFIG_KERN_MONITOR
47
48 /**
49  * Start the kernel monitor. It is a special process which checks every second the stacks of the
50  * running processes trying to detect stack overflows.
51  *
52  * \param stacksize Size of stack in chars
53  * \param stack Pointer to the stack that will be used by the monitor
54  *
55  * \note The stack is provided by the caller so that there is no wasted space if the monitor
56  * is not used.
57  */
58 void monitor_start(size_t stacksize, cpustack_t *stack);
59
60
61 /**
62  * Manually check if a given stack has overflown. This is used to check for stacks
63  * of processes handled externally form the kernel, or for other stacks (for instance
64  * the interrupt supervisor stack).
65  *
66  * \note For this function to work, the stack must have been filled at startup with
67  * CONFIG_KERN_STACKFILLCODE.
68  */
69 size_t monitor_checkStack(cpustack_t *stack_base, size_t stack_size);
70
71
72 /** Print a report of the stack status through kdebug */
73 void monitor_report(void);
74
75
76 #endif /* CONFIG_KERN_MONITOR */
77 #endif /* KERN_MONITOR_H */