kernel/generic/src/interrupt/interrupt.c

   1 /*
   2  * Copyright (c) 2005 Ondrej Palkovsky
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * - Redistributions of source code must retain the above copyright
  10  *   notice, this list of conditions and the following disclaimer.
  11  * - Redistributions in binary form must reproduce the above copyright
  12  *   notice, this list of conditions and the following disclaimer in the
  13  *   documentation and/or other materials provided with the distribution.
  14  * - The name of the author may not be used to endorse or promote products
  15  *   derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /** @addtogroup kernel_generic_interrupt
  30  * @{
  31  */
  32 /**
  33  * @file
  34  * @brief Interrupt redirector.
  35  *
  36  * This file provides means of registering interrupt handlers
  37  * by kernel functions and calling the handlers when interrupts
  38  * occur.
  39  *
  40  */
  41
  42 #include <assert.h>
  43 #include <interrupt.h>
  44 #include <console/kconsole.h>
  45 #include <console/console.h>
  46 #include <console/cmd.h>
  47 #include <synch/mutex.h>
  48 #include <time/delay.h>
  49 #include <macros.h>
  50 #include <panic.h>
  51 #include <stdio.h>
  52 #include <stdarg.h>
  53 #include <symtab.h>
  54 #include <proc/thread.h>
  55 #include <arch/cycle.h>
  56 #include <arch/stack.h>
  57 #include <str.h>
  58 #include <trace.h>
  59
  60 /*
  61  * If IVT_ITEMS is zero (e.g. for special/abs32le) we hide completely any
  62  * access to the exception table array and panic if the function is called
  63  * at all. It also silences (correct) compiler warnings about possible
  64  * out-of-bound array access.
  65  */
  66
  67 exc_table_t exc_table[IVT_ITEMS];
  68 IRQ_SPINLOCK_INITIALIZE(exctbl_lock);
  69
  70 /** Register exception handler
  71  *
  72  * @param n       Exception number.
  73  * @param name    Description.
  74  * @param hot     Whether the exception is actually handled
  75  *                in any meaningful way.
  76  * @param handler New exception handler.
  77  *
  78  * @return Previously registered exception handler.
  79  *
  80  */
  81 iroutine_t exc_register(unsigned int n, const char *name, bool hot,
  82     iroutine_t handler)
  83 {
  84 #if (IVT_ITEMS > 0)
  85         assert(n < IVT_ITEMS);
  86
  87         irq_spinlock_lock(&exctbl_lock, true);
  88
  89         iroutine_t old = exc_table[n].handler;
  90         exc_table[n].handler = handler;
  91         exc_table[n].name = name;
  92         exc_table[n].hot = hot;
  93         exc_table[n].cycles = 0;
  94         exc_table[n].count = 0;
  95
  96         irq_spinlock_unlock(&exctbl_lock, true);
  97
  98         return old;
  99 #else
 100         panic("No space for any exception handler, cannot register.");
 101 #endif
 102 }
 103
 104 /** Dispatch exception according to exception table
 105  *
 106  * Called directly from the assembler code.
 107  * CPU is interrupts_disable()'d.
 108  *
 109  */
 110 _NO_TRACE void exc_dispatch(unsigned int n, istate_t *istate)
 111 {
 112 #if (IVT_ITEMS > 0)
 113         assert(n < IVT_ITEMS);
 114
 115         /* Account user cycles */
 116         if (THREAD)
 117                 thread_update_accounting(true);
 118
 119         /* Account CPU usage if it woke up from sleep */
 120         if (CPU && CPU_LOCAL->idle) {
 121                 uint64_t now = get_cycle();
 122                 atomic_time_increment(&CPU->idle_cycles, now - CPU_LOCAL->last_cycle);
 123                 CPU_LOCAL->last_cycle = now;
 124                 CPU_LOCAL->idle = false;
 125         }
 126
 127         uint64_t begin_cycle = get_cycle();
 128
 129 #ifdef CONFIG_UDEBUG
 130         if (THREAD)
 131                 THREAD->udebug.uspace_state = istate;
 132 #endif
 133
 134         exc_table[n].handler(n + IVT_FIRST, istate);
 135
 136 #ifdef CONFIG_UDEBUG
 137         if (THREAD)
 138                 THREAD->udebug.uspace_state = NULL;
 139 #endif
 140
 141         /* This is a safe place to exit exiting thread */
 142         if ((THREAD) && (THREAD->interrupted) && (istate_from_uspace(istate)))
 143                 thread_exit();
 144
 145         /* Account exception handling */
 146         uint64_t end_cycle = get_cycle();
 147
 148         irq_spinlock_lock(&exctbl_lock, false);
 149         exc_table[n].cycles += end_cycle - begin_cycle;
 150         exc_table[n].count++;
 151         irq_spinlock_unlock(&exctbl_lock, false);
 152
 153         /* Do not charge THREAD for exception cycles */
 154         if (THREAD)
 155                 THREAD->last_cycle = end_cycle;
 156 #else
 157         panic("No space for any exception handler, yet we want to handle some exception.");
 158 #endif
 159 }
 160
 161 /** Default 'null' exception handler
 162  *
 163  */
 164 _NO_TRACE static void exc_undef(unsigned int n, istate_t *istate)
 165 {
 166         fault_if_from_uspace(istate, "Unhandled exception %u.", n);
 167         panic_badtrap(istate, n, "Unhandled exception %u.", n);
 168 }
 169
 170 static _NO_TRACE void
 171 fault_from_uspace_core(istate_t *istate, const char *fmt, va_list args)
 172 {
 173         printf("Task %s (%" PRIu64 ") killed due to an exception at "
 174             "program counter %p.\n", TASK->name, TASK->taskid,
 175             (void *) istate_get_pc(istate));
 176
 177         istate_decode(istate);
 178         stack_trace_istate(istate);
 179
 180         printf("Kill message: ");
 181         vprintf(fmt, args);
 182         printf("\n");
 183
 184         task_kill_self(true);
 185 }
 186
 187 /** Terminate thread and task after the exception came from userspace.
 188  *
 189  */
 190 _NO_TRACE void fault_from_uspace(istate_t *istate, const char *fmt, ...)
 191 {
 192         va_list args;
 193
 194         va_start(args, fmt);
 195         fault_from_uspace_core(istate, fmt, args);
 196         va_end(args);
 197 }
 198
 199 /** Terminate thread and task if exception came from userspace.
 200  *
 201  */
 202 _NO_TRACE void fault_if_from_uspace(istate_t *istate, const char *fmt, ...)
 203 {
 204         if (!istate_from_uspace(istate))
 205                 return;
 206
 207         va_list args;
 208         va_start(args, fmt);
 209         fault_from_uspace_core(istate, fmt, args);
 210         va_end(args);
 211 }
 212
 213 /** Get istate structure of a thread.
 214  *
 215  * Get pointer to the istate structure at the bottom of the kernel stack.
 216  *
 217  * This function can be called in interrupt or user context. In interrupt
 218  * context the istate structure is created by the low-level exception
 219  * handler. In user context the istate structure is created by the
 220  * low-level syscall handler.
 221  */
 222 istate_t *istate_get(thread_t *thread)
 223 {
 224         /*
 225          * The istate structure should be right at the bottom of the kernel
 226          * memory stack.
 227          */
 228         return (istate_t *) &thread->kstack[MEM_STACK_SIZE - sizeof(istate_t)];
 229 }
 230
 231 #ifdef CONFIG_KCONSOLE
 232
 233 static char flag_buf[MAX_CMDLINE + 1];
 234
 235 /** Print all exceptions
 236  *
 237  */
 238 _NO_TRACE static int cmd_exc_print(cmd_arg_t *argv)
 239 {
 240         bool excs_all;
 241
 242         if (str_cmp(flag_buf, "-a") == 0)
 243                 excs_all = true;
 244         else if (str_cmp(flag_buf, "") == 0)
 245                 excs_all = false;
 246         else {
 247                 printf("Unknown argument \"%s\".\n", flag_buf);
 248                 return 1;
 249         }
 250
 251 #if (IVT_ITEMS > 0)
 252         unsigned int i;
 253         unsigned int rows;
 254
 255         irq_spinlock_lock(&exctbl_lock, true);
 256
 257 #ifdef __32_BITS__
 258         printf("[exc   ] [description       ] [count   ] [cycles  ]"
 259             " [handler ] [symbol\n");
 260         rows = 1;
 261 #endif
 262
 263 #ifdef __64_BITS__
 264         printf("[exc   ] [description       ] [count   ] [cycles  ]"
 265             " [handler         ]\n");
 266         printf("         [symbol\n");
 267         rows = 2;
 268 #endif
 269
 270         for (i = 0; i < IVT_ITEMS; i++) {
 271                 if ((!excs_all) && (!exc_table[i].hot))
 272                         continue;
 273
 274                 uint64_t count;
 275                 char count_suffix;
 276
 277                 order_suffix(exc_table[i].count, &count, &count_suffix);
 278
 279                 uint64_t cycles;
 280                 char cycles_suffix;
 281
 282                 order_suffix(exc_table[i].cycles, &cycles, &cycles_suffix);
 283
 284                 const char *symbol =
 285                     symtab_fmt_name_lookup((sysarg_t) exc_table[i].handler);
 286
 287 #ifdef __32_BITS__
 288                 printf("%-8u %-20s %9" PRIu64 "%c %9" PRIu64 "%c %10p %s\n",
 289                     i + IVT_FIRST, exc_table[i].name, count, count_suffix,
 290                     cycles, cycles_suffix, exc_table[i].handler, symbol);
 291
 292                 PAGING(rows, 1, irq_spinlock_unlock(&exctbl_lock, true),
 293                     irq_spinlock_lock(&exctbl_lock, true));
 294 #endif
 295
 296 #ifdef __64_BITS__
 297                 printf("%-8u %-20s %9" PRIu64 "%c %9" PRIu64 "%c %18p\n",
 298                     i + IVT_FIRST, exc_table[i].name, count, count_suffix,
 299                     cycles, cycles_suffix, exc_table[i].handler);
 300                 printf("         %s\n", symbol);
 301
 302                 PAGING(rows, 2, irq_spinlock_unlock(&exctbl_lock, true),
 303                     irq_spinlock_lock(&exctbl_lock, true));
 304 #endif
 305         }
 306
 307         irq_spinlock_unlock(&exctbl_lock, true);
 308 #else /* (IVT_ITEMS > 0) */
 309
 310         printf("No exception table%s.\n", excs_all ? " (showing all exceptions)" : "");
 311
 312 #endif /* (IVT_ITEMS > 0) */
 313
 314         return 1;
 315 }
 316
 317 static cmd_arg_t exc_argv = {
 318         .type = ARG_TYPE_STRING_OPTIONAL,
 319         .buffer = flag_buf,
 320         .len = sizeof(flag_buf)
 321 };
 322
 323 static cmd_info_t exc_info = {
 324         .name = "exc",
 325         .description = "Print exception table (use -a for all exceptions).",
 326         .func = cmd_exc_print,
 327         .help = NULL,
 328         .argc = 1,
 329         .argv = &exc_argv
 330 };
 331
 332 #endif /* CONFIG_KCONSOLE */
 333
 334 /** Initialize generic exception handling support
 335  *
 336  */
 337 void exc_init(void)
 338 {
 339         (void) exc_undef;
 340
 341 #if (IVT_ITEMS > 0)
 342         unsigned int i;
 343
 344         for (i = 0; i < IVT_ITEMS; i++)
 345                 exc_register(i, "undef", false, (iroutine_t) exc_undef);
 346 #endif
 347
 348 #ifdef CONFIG_KCONSOLE
 349         cmd_initialize(&exc_info);
 350         if (!cmd_register(&exc_info))
 351                 printf("Cannot register command %s\n", exc_info.name);
 352 #endif
 353 }
 354
 355 /** @}
 356  */