4 * This file is part of BeRTOS.
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.
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.
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
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.
29 * Copyright 2004 Develer S.r.l. (http://www.develer.com/)
33 * \brief Monitor to check for stack overflows
37 * \author Giovanni Bajo <rasky@develer.com>
42 *#* Revision 1.5 2006/07/19 12:56:27 bernie
43 *#* Convert to new Doxygen style.
45 *#* Revision 1.4 2006/02/24 01:17:05 bernie
46 *#* Update for new emulator.
48 *#* Revision 1.3 2005/11/04 16:20:02 bernie
49 *#* Fix reference to README.devlib in header.
51 *#* Revision 1.2 2005/04/11 19:10:28 bernie
52 *#* Include top-level headers from cfg/ subdir.
54 *#* Revision 1.1 2004/10/03 20:39:03 bernie
57 *#* Revision 1.1 2004/09/30 23:19:30 rasky
58 *#* Estratto il monitor degli stack da proc.c in due file a parte: monitor.c/h
59 *#* Rinominata monitor_debug_stacks in monitor_report
63 #ifndef KERN_MONITOR_H
64 #define KERN_MONITOR_H
67 #include <config_kern.h>
69 #if CONFIG_KERN_MONITOR
72 * Start the kernel monitor. It is a special process which checks every second the stacks of the
73 * running processes trying to detect stack overflows.
75 * \param stacksize Size of stack in chars
76 * \param stack Pointer to the stack that will be used by the monitor
78 * \note The stack is provided by the caller so that there is no wasted space if the monitor
81 void monitor_start(size_t stacksize, cpustack_t *stack);
85 * Manually check if a given stack has overflown. This is used to check for stacks
86 * of processes handled externally form the kernel, or for other stacks (for instance
87 * the interrupt supervisor stack).
89 * \note For this function to work, the stack must have been filled at startup with
90 * CONFIG_KERN_STACKFILLCODE.
92 size_t monitor_checkStack(cpustack_t *stack_base, size_t stack_size);
95 /** Print a report of the stack status through kdebug */
96 void monitor_report(void);
99 #endif /* CONFIG_KERN_MONITOR */
100 #endif /* KERN_MONITOR_H */