bertos/kern/monitor.c

   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, 2008 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief Monitor to check for stack overflows
  34  *
  35  * \version $Id$
  36  * \author Giovanni Bajo <rasky@develer.com>
  37  */
  38
  39
  40 #include "monitor.h"
  41
  42 #if CONFIG_KERN_MONITOR
  43
  44 #include "proc_p.h"
  45 #include <mware/list.h>
  46 #include <drv/timer.h>
  47 #include <kern/proc.h>
  48 #include <cfg/macros.h>
  49 #include <cfg/debug.h>
  50
  51
  52 /* Access to this list must be protected against the scheduler */
  53 static List MonitorProcs;
  54
  55
  56 void monitor_init(void)
  57 {
  58         LIST_INIT(&MonitorProcs);
  59 }
  60
  61
  62 void monitor_add(Process *proc, const char *name)
  63 {
  64         proc->monitor.name = name;
  65
  66         PROC_ATOMIC(ADDTAIL(&MonitorProcs, &proc->monitor.link));
  67 }
  68
  69
  70 void monitor_remove(Process *proc)
  71 {
  72         PROC_ATOMIC(REMOVE(&proc->monitor.link));
  73 }
  74
  75 void monitor_rename(Process *proc, const char *name)
  76 {
  77         proc->monitor.name = name;
  78 }
  79
  80 size_t monitor_checkStack(cpustack_t *stack_base, size_t stack_size)
  81 {
  82         cpustack_t *beg;
  83         cpustack_t *cur;
  84         cpustack_t *end;
  85         size_t sp_free;
  86
  87         beg = stack_base;
  88         end = stack_base + stack_size / sizeof(cpustack_t) - 1;
  89
  90         if (CPU_STACK_GROWS_UPWARD)
  91         {
  92                 cur = beg;
  93                 beg = end;
  94                 end = cur;
  95         }
  96
  97         cur = beg;
  98         while (cur != end)
  99         {
 100                 if (*cur != CONFIG_KERN_STACKFILLCODE)
 101                         break;
 102
 103                 if (CPU_STACK_GROWS_UPWARD)
 104                         cur--;
 105                 else
 106                         cur++;
 107         }
 108
 109         sp_free = ABS(cur - beg) * sizeof(cpustack_t);
 110         return sp_free;
 111 }
 112
 113
 114 void monitor_report(void)
 115 {
 116         Node *node;
 117         int i;
 118
 119         kprintf("%-24s%-8s%-8s%-8s%-8s\n", "Process name", "TCB", "SPbase", "SPsize", "SPfree");
 120         for (i = 0; i<56; i++)
 121                 kputchar('-');
 122         kputchar('\n');
 123
 124         proc_forbid();
 125         FOREACH_NODE(node, &MonitorProcs)
 126         {
 127                 Process *p = containerof(node, Process, monitor.link);
 128                 size_t free = monitor_checkStack(p->stack_base, p->stack_size);
 129                 kprintf("%-24s%-8p%-8p%-8lu%-8lu\n",
 130                         p->monitor.name, p, p->stack_base, p->stack_size, free);
 131         }
 132         proc_permit();
 133 }
 134
 135
 136 static void NORETURN monitor(void)
 137 {
 138         Process *p;
 139         Node *node;
 140
 141         for (;;)
 142         {
 143                 proc_forbid();
 144                 FOREACH_NODE(node, &MonitorProcs)
 145                 {
 146                         p = containerof(node, Process, monitor.link);
 147                         size_t free = monitor_checkStack(p->stack_base, p->stack_size);
 148
 149                         if (free < 0x20)
 150                                 kprintf("MONITOR: Free stack of process '%s' is only %u chars\n",
 151                                                 p->monitor.name, (unsigned int)free);
 152                 }
 153                 proc_permit();
 154
 155                 /* Give some rest to the system */
 156                 timer_delay(500);
 157         }
 158 }
 159
 160
 161 void monitor_start(size_t stacksize, cpustack_t *stack)
 162 {
 163         proc_new(monitor, NULL, stacksize, stack);
 164 }
 165
 166 #endif /* CONFIG_KERN_MONITOR */