bertos/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  * $WIZ$ module_name = "monitor"
  40  * $WIZ$ module_depends = "kernel"
  41  * $WIZ$ module_configuration = "bertos/cfg/cfg_monitor.h"
  42  */
  43
  44 #ifndef KERN_MONITOR_H
  45 #define KERN_MONITOR_H
  46
  47 #include "cfg/cfg_monitor.h"
  48
  49 #include <cpu/types.h>
  50
  51 #if CONFIG_KERN_MONITOR
  52
  53 /**
  54  * Start the kernel monitor. It is a special process which checks every second the stacks of the
  55  * running processes trying to detect stack overflows.
  56  *
  57  * \param stacksize Size of stack in chars
  58  * \param stack Pointer to the stack that will be used by the monitor
  59  *
  60  * \note The stack is provided by the caller so that there is no wasted space if the monitor
  61  * is not used.
  62  */
  63 void monitor_start(size_t stacksize, cpu_stack_t *stack);
  64
  65
  66 /**
  67  * Manually check if a given stack has overflown. This is used to check for stacks
  68  * of processes handled externally form the kernel, or for other stacks (for instance
  69  * the interrupt supervisor stack).
  70  *
  71  * \note For this function to work, the stack must have been filled at startup with
  72  * CONFIG_KERN_STACKFILLCODE.
  73  */
  74 size_t monitor_checkStack(cpu_stack_t *stack_base, size_t stack_size);
  75
  76
  77 /** Print a report of the stack status through kdebug */
  78 void monitor_report(void);
  79
  80
  81 #endif /* CONFIG_KERN_MONITOR */
  82 #endif /* KERN_MONITOR_H */