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