kern/monitor.c

   1 /*!
   2  * \file
   3  * <!--
   4  * Copyright 2004 Develer S.r.l. (http://www.develer.com/)
   5  * This file is part of DevLib - See README.devlib for information.
   6  * -->
   7  *
   8  * \brief Monitor to check for stack overflows
   9  *
  10  * \version $Id$
  11  *
  12  * \author Giovanni Bajo <rasky@develer.com>
  13  */
  14
  15 /*#*
  16  *#* $Log$
  17  *#* Revision 1.6  2006/02/24 01:17:05  bernie
  18  *#* Update for new emulator.
  19  *#*
  20  *#* Revision 1.5  2005/11/04 16:20:02  bernie
  21  *#* Fix reference to README.devlib in header.
  22  *#*
  23  *#* Revision 1.4  2005/04/11 19:10:28  bernie
  24  *#* Include top-level headers from cfg/ subdir.
  25  *#*
  26  *#* Revision 1.3  2004/11/28 23:20:25  bernie
  27  *#* Remove obsolete INITLIST macro.
  28  *#*
  29  *#* Revision 1.2  2004/10/26 09:01:15  bernie
  30  *#* monitor_rename(): New function.
  31  *#*
  32  *#* Revision 1.1  2004/10/03 20:39:03  bernie
  33  *#* Import in DevLib.
  34  *#*
  35  *#* Revision 1.2  2004/10/03 20:36:43  bernie
  36  *#* Use debug.h instead of drv/kdebug.h; Misc spacing/header fixes.
  37  *#*
  38  *#* Revision 1.1  2004/09/30 23:19:30  rasky
  39  *#* Estratto il monitor degli stack da proc.c in due file a parte: monitor.c/h
  40  *#* Rinominata monitor_debug_stacks in monitor_report
  41  *#*/
  42
  43 #include "monitor.h"
  44
  45 #if CONFIG_KERN_MONITOR
  46
  47 #include "proc_p.h"
  48 #include <mware/list.h>
  49 #include <drv/timer.h>
  50 #include <kern/proc.h>
  51 #include <cfg/macros.h>
  52 #include <cfg/debug.h>
  53
  54
  55 static List MonitorProcs;
  56
  57
  58 void monitor_init(void)
  59 {
  60         LIST_INIT(&MonitorProcs);
  61 }
  62
  63
  64 void monitor_add(Process* proc, const char* name, cpustack_t* stack_base, size_t stack_size)
  65 {
  66         proc->monitor.name = name;
  67         proc->monitor.stack_base = stack_base;
  68         proc->monitor.stack_size = stack_size;
  69
  70         ADDTAIL(&MonitorProcs, &proc->monitor.link);
  71 }
  72
  73
  74 void monitor_remove(Process* proc)
  75 {
  76         REMOVE(&proc->monitor.link);
  77 }
  78
  79 void monitor_rename(Process *proc, const char* name)
  80 {
  81         proc->monitor.name = name;
  82 }
  83
  84 #define MONITOR_NODE_TO_PROCESS(node) \
  85         (struct Process *)((char *)(node) - offsetof(struct Process, monitor.link))
  86
  87 size_t monitor_checkStack(cpustack_t* stack_base, size_t stack_size)
  88 {
  89         cpustack_t* beg;
  90         cpustack_t* cur;
  91         cpustack_t* end;
  92         size_t sp_free;
  93
  94         beg = stack_base;
  95         end = stack_base + stack_size / sizeof(cpustack_t) - 1;
  96
  97         if (CPU_STACK_GROWS_UPWARD)
  98         {
  99                 cur = beg;
 100                 beg = end;
 101                 end = cur;
 102         }
 103
 104         cur = beg;
 105         while (cur != end)
 106         {
 107                 if (*cur != CONFIG_KERN_STACKFILLCODE)
 108                         break;
 109
 110                 if (CPU_STACK_GROWS_UPWARD)
 111                         cur--;
 112                 else
 113                         cur++;
 114         }
 115
 116         sp_free = ABS(cur - beg) * sizeof(cpustack_t);
 117         return sp_free;
 118 }
 119
 120
 121 void monitor_report(void)
 122 {
 123         struct Process* p;
 124         int i;
 125
 126         if (LIST_EMPTY(&MonitorProcs))
 127         {
 128                 kputs("No stacks registered in the monitor\n");
 129                 return;
 130         }
 131
 132         kprintf("%-24s%-8s%-8s%-8s%-8s\n", "Process name", "TCB", "SPbase", "SPsize", "SPfree");
 133         for (i=0;i<56;i++)
 134                 kputchar('-');
 135         kputchar('\n');
 136
 137         for (p = MONITOR_NODE_TO_PROCESS(LIST_HEAD(&MonitorProcs));
 138                  p->monitor.link.succ;
 139                  p = MONITOR_NODE_TO_PROCESS(p->monitor.link.succ))
 140         {
 141                 size_t free = monitor_checkStack(p->monitor.stack_base, p->monitor.stack_size);
 142                 kprintf("%-24s%8p%8p%8lx%8lx\n",
 143                         p->monitor.name, p, p->monitor.stack_base, p->monitor.stack_size, free);
 144         }
 145 }
 146
 147
 148 static void NORETURN monitor(void)
 149 {
 150         struct Process* p;
 151
 152         while (1)
 153         {
 154                 for (p = MONITOR_NODE_TO_PROCESS(LIST_HEAD(&MonitorProcs));
 155                         p->monitor.link.succ;
 156                         p = MONITOR_NODE_TO_PROCESS(p->monitor.link.succ))
 157                 {
 158                         size_t free = monitor_checkStack(p->monitor.stack_base, p->monitor.stack_size);
 159
 160                         if (free < 0x20)
 161                         {
 162                                 kprintf("MONITOR: ***************************************\n");
 163                                 kprintf("MONITOR: WARNING: Free stack for process '%s' is only %04x chars\n", p->monitor.name, free);
 164                                 kprintf("MONITOR: ***************************************\n\n");
 165                         }
 166
 167                         timer_delay(500);
 168                 }
 169         }
 170 }
 171
 172
 173 void monitor_start(size_t stacksize, cpustack_t *stack)
 174 {
 175         proc_new(monitor, NULL, stacksize, stack);
 176 }
 177
 178 #endif /* CONFIG_KERN_MONITOR */