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  * \author Giovanni Bajo <rasky@develer.com>
  36  */
  37
  38
  39 #include "monitor.h"
  40
  41 #if CONFIG_KERN_MONITOR
  42
  43 #include "proc_p.h"
  44 #include <cfg/macros.h>
  45 #include <cfg/debug.h>
  46
  47 #include <struct/list.h>
  48
  49 #include <drv/timer.h>
  50
  51 #include <kern/proc.h>
  52
  53 #include <cpu/frame.h> /* CPU_STACK_GROWS_UPWARD */
  54
  55 /* Access to this list must be protected against the scheduler */
  56 static List MonitorProcs;
  57
  58 void monitor_init(void)
  59 {
  60         LIST_INIT(&MonitorProcs);
  61 }
  62
  63
  64 void monitor_add(Process *proc, const char *name)
  65 {
  66         proc->monitor.name = name;
  67
  68         PROC_ATOMIC(ADDTAIL(&MonitorProcs, &proc->monitor.link));
  69 }
  70
  71
  72 void monitor_remove(Process *proc)
  73 {
  74         PROC_ATOMIC(REMOVE(&proc->monitor.link));
  75 }
  76
  77 void monitor_rename(Process *proc, const char *name)
  78 {
  79         proc->monitor.name = name;
  80 }
  81
  82 size_t monitor_checkStack(cpu_stack_t *stack_base, size_t stack_size)
  83 {
  84         cpu_stack_t *beg;
  85         cpu_stack_t *cur;
  86         cpu_stack_t *end;
  87         int inc;
  88         size_t sp_free;
  89
  90
  91         beg = stack_base;
  92         end = stack_base + stack_size / sizeof(cpu_stack_t);
  93         inc = +1;
  94
  95         if (CPU_STACK_GROWS_UPWARD)
  96         {
  97                 SWAP(beg, end);
  98                 inc = -1;
  99         }
 100
 101         cur = beg;
 102         while (cur != end)
 103         {
 104                 if (*cur != CONFIG_KERN_STACKFILLCODE)
 105                         break;
 106
 107                 cur += inc;
 108         }
 109
 110         sp_free = ABS(cur - beg) * sizeof(cpu_stack_t);
 111         return sp_free;
 112 }
 113
 114
 115 void monitor_report(void)
 116 {
 117         Node *node;
 118         int i;
 119
 120         proc_forbid();
 121         kprintf("%-9s%-9s%-9s%-9s%s\n", "TCB", "SPbase", "SPsize", "SPfree", "Name");
 122         for (i = 0; i < 56; i++)
 123                 kputchar('-');
 124         kputchar('\n');
 125
 126         FOREACH_NODE(node, &MonitorProcs)
 127         {
 128                 Process *p = containerof(node, Process, monitor.link);
 129                 size_t free = monitor_checkStack(p->stack_base, p->stack_size);
 130                 kprintf("%-9p%-9p%-9zu%-9zu%s\n",
 131                         p, p->stack_base, p->stack_size, free, p->monitor.name);
 132         }
 133         proc_permit();
 134 }
 135
 136
 137 static void NORETURN monitor(void)
 138 {
 139         Node *node;
 140
 141         for (;;)
 142         {
 143                 proc_forbid();
 144                 FOREACH_NODE(node, &MonitorProcs)
 145                 {
 146                         Process *p = containerof(node, Process, monitor.link);
 147                         size_t free = monitor_checkStack(p->stack_base, p->stack_size);
 148
 149                         if (p->stack_base && 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 void monitor_start(size_t stacksize, cpu_stack_t *stack)
 161 {
 162         struct Process *p = proc_new(monitor, NULL, stacksize, stack);
 163         proc_setPri(p, -10);
 164 }
 165
 166 #endif /* CONFIG_KERN_MONITOR */