Subversion Repositories HelenOS

Rev

Rev 3880 | Rev 4132 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /*
  2.  * Copyright (c) 2006 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 amd64debug
  30.  * @{
  31.  */
  32. /** @file
  33.  */
  34.  
  35. #include <arch/debugger.h>
  36. #include <console/kconsole.h>
  37. #include <console/cmd.h>
  38. #include <symtab.h>
  39. #include <print.h>
  40. #include <panic.h>
  41. #include <interrupt.h>
  42. #include <arch/asm.h>
  43. #include <arch/cpu.h>
  44. #include <debug.h>
  45. #include <func.h>
  46. #include <smp/ipi.h>
  47.  
  48. typedef struct  {
  49.     uintptr_t address;      /**< Breakpoint address */
  50.     int flags;              /**< Flags regarding breakpoint */
  51.     int counter;            /**< How many times the exception occured */
  52. } bpinfo_t;
  53.  
  54. static bpinfo_t breakpoints[BKPOINTS_MAX];
  55. SPINLOCK_INITIALIZE(bkpoint_lock);
  56.  
  57. #ifdef CONFIG_KCONSOLE
  58.  
  59. static int cmd_print_breakpoints(cmd_arg_t *argv);
  60. static cmd_info_t bkpts_info = {
  61.     .name = "bkpts",
  62.     .description = "Print breakpoint table.",
  63.     .func = cmd_print_breakpoints,
  64.     .argc = 0,
  65. };
  66.  
  67. static int cmd_del_breakpoint(cmd_arg_t *argv);
  68. static cmd_arg_t del_argv = {
  69.     .type = ARG_TYPE_INT
  70. };
  71. static cmd_info_t delbkpt_info = {
  72.     .name = "delbkpt",
  73.     .description = "delbkpt <number> - Delete breakpoint.",
  74.     .func = cmd_del_breakpoint,
  75.     .argc = 1,
  76.     .argv = &del_argv
  77. };
  78.  
  79. static int cmd_add_breakpoint(cmd_arg_t *argv);
  80. static cmd_arg_t add_argv = {
  81.     .type = ARG_TYPE_INT
  82. };
  83. static cmd_info_t addbkpt_info = {
  84.     .name = "addbkpt",
  85.     .description = "addbkpt <&symbol> - new breakpoint.",
  86.     .func = cmd_add_breakpoint,
  87.     .argc = 1,
  88.     .argv = &add_argv
  89. };
  90.  
  91. static cmd_arg_t addw_argv = {
  92.     .type = ARG_TYPE_INT
  93. };
  94. static cmd_info_t addwatchp_info = {
  95.     .name = "addwatchp",
  96.     .description = "addbwatchp <&symbol> - new write watchpoint.",
  97.     .func = cmd_add_breakpoint,
  98.     .argc = 1,
  99.     .argv = &addw_argv
  100. };
  101.  
  102. #endif /* CONFIG_KCONSOLE */
  103.  
  104. /* Setup DR register according to table */
  105. static void setup_dr(int curidx)
  106. {
  107.     unative_t dr7;
  108.     bpinfo_t *cur = &breakpoints[curidx];
  109.     int flags = breakpoints[curidx].flags;
  110.  
  111.     /* Disable breakpoint in DR7 */
  112.     dr7 = read_dr7();
  113.     dr7 &= ~(0x2 << (curidx*2));
  114.  
  115.     if (cur->address) { /* Setup DR register */
  116.         /* Set breakpoint to debug registers */
  117.         switch (curidx) {
  118.         case 0:
  119.             write_dr0(cur->address);
  120.             break;
  121.         case 1:
  122.             write_dr1(cur->address);
  123.             break;
  124.         case 2:
  125.             write_dr2(cur->address);
  126.             break;
  127.         case 3:
  128.             write_dr3(cur->address);
  129.             break;
  130.         }
  131.         /* Set type to requested breakpoint & length*/
  132.         dr7 &= ~ (0x3 << (16 + 4*curidx));
  133.         dr7 &= ~ (0x3 << (18 + 4*curidx));
  134.         if ((flags & BKPOINT_INSTR)) {
  135.             ;
  136.         } else {
  137.        
  138. #ifdef __32_BITS__
  139.             dr7 |= ((unative_t) 0x3) << (18 + 4 * curidx);
  140. #endif
  141.  
  142. #ifdef __64_BITS__
  143.             dr7 |= ((unative_t) 0x2) << (18 + 4 * curidx);
  144. #endif
  145.            
  146.             if ((flags & BKPOINT_WRITE))
  147.                 dr7 |= ((unative_t) 0x1) << (16 + 4 * curidx);
  148.             else if ((flags & BKPOINT_READ_WRITE))
  149.                 dr7 |= ((unative_t) 0x3) << (16 + 4 * curidx);
  150.         }
  151.  
  152.         /* Enable global breakpoint */
  153.         dr7 |= 0x2 << (curidx * 2);
  154.  
  155.         write_dr7(dr7);
  156.        
  157.     }
  158. }
  159.    
  160. /** Enable hardware breakpoint
  161.  *
  162.  * @param where Address of HW breakpoint
  163.  * @param flags Type of breakpoint (EXECUTE, WRITE)
  164.  * @return Debug slot on success, -1 - no available HW breakpoint
  165.  */
  166. int breakpoint_add(const void *where, const int flags, int curidx)
  167. {
  168.     ipl_t ipl;
  169.     int i;
  170.     bpinfo_t *cur;
  171.  
  172.     ASSERT(flags & (BKPOINT_INSTR | BKPOINT_WRITE | BKPOINT_READ_WRITE));
  173.  
  174.     ipl = interrupts_disable();
  175.     spinlock_lock(&bkpoint_lock);
  176.    
  177.     if (curidx == -1) {
  178.         /* Find free space in slots */
  179.         for (i = 0; i < BKPOINTS_MAX; i++)
  180.             if (!breakpoints[i].address) {
  181.                 curidx = i;
  182.                 break;
  183.             }
  184.         if (curidx == -1) {
  185.             /* Too many breakpoints */
  186.             spinlock_unlock(&bkpoint_lock);
  187.             interrupts_restore(ipl);
  188.             return -1;
  189.         }
  190.     }
  191.     cur = &breakpoints[curidx];
  192.  
  193.     cur->address = (uintptr_t) where;
  194.     cur->flags = flags;
  195.     cur->counter = 0;
  196.  
  197.     setup_dr(curidx);
  198.  
  199.     spinlock_unlock(&bkpoint_lock);
  200.     interrupts_restore(ipl);
  201.  
  202.     /* Send IPI */
  203. #ifdef CONFIG_SMP
  204. //  ipi_broadcast(VECTOR_DEBUG_IPI);
  205. #endif 
  206.  
  207.     return curidx;
  208. }
  209.  
  210. #ifdef __64_BITS__
  211.     #define getip(x)  ((x)->rip)
  212. #else
  213.     #define getip(x)  ((x)->eip)
  214. #endif
  215.  
  216. static void handle_exception(int slot, istate_t *istate)
  217. {
  218.     ASSERT(breakpoints[slot].address);
  219.  
  220.     /* Handle zero checker */
  221.     if (! (breakpoints[slot].flags & BKPOINT_INSTR)) {
  222.         if ((breakpoints[slot].flags & BKPOINT_CHECK_ZERO)) {
  223.             if (*((unative_t *) breakpoints[slot].address) != 0)
  224.                 return;
  225.             printf("*** Found ZERO on address %lx (slot %d) ***\n",
  226.                 breakpoints[slot].address, slot);
  227.         } else {
  228.             printf("Data watchpoint - new data: %lx\n",
  229.                 *((unative_t *) breakpoints[slot].address));
  230.         }
  231.     }
  232.     printf("Reached breakpoint %d:%lx(%s)\n", slot, getip(istate),
  233.         get_symtab_entry(getip(istate)));
  234.  
  235. #ifdef CONFIG_KCONSOLE
  236.     atomic_set(&haltstate, 1);
  237.     kconsole("debug", "Debug console ready (type 'exit' to continue)\n", false);
  238.     atomic_set(&haltstate, 0);
  239. #endif
  240. }
  241.  
  242. void breakpoint_del(int slot)
  243. {
  244.     bpinfo_t *cur;
  245.     ipl_t ipl;
  246.  
  247.     ipl = interrupts_disable();
  248.     spinlock_lock(&bkpoint_lock);
  249.  
  250.     cur = &breakpoints[slot];
  251.     if (!cur->address) {
  252.         spinlock_unlock(&bkpoint_lock);
  253.         interrupts_restore(ipl);
  254.         return;
  255.     }
  256.  
  257.     cur->address = NULL;
  258.  
  259.     setup_dr(slot);
  260.  
  261.     spinlock_unlock(&bkpoint_lock);
  262.     interrupts_restore(ipl);
  263. #ifdef CONFIG_SMP
  264. //  ipi_broadcast(VECTOR_DEBUG_IPI);   
  265. #endif
  266. }
  267.  
  268.  
  269.  
  270. static void debug_exception(int n __attribute__((unused)), istate_t *istate)
  271. {
  272.     unative_t dr6;
  273.     int i;
  274.    
  275.     /* Set RF to restart the instruction  */
  276. #ifdef __64_BITS__
  277.     istate->rflags |= RFLAGS_RF;
  278. #else
  279.     istate->eflags |= EFLAGS_RF;
  280. #endif
  281.  
  282.     dr6 = read_dr6();
  283.     for (i=0; i < BKPOINTS_MAX; i++) {
  284.         if (dr6 & (1 << i)) {
  285.             dr6 &= ~ (1 << i);
  286.             write_dr6(dr6);
  287.            
  288.             handle_exception(i, istate);
  289.         }
  290.     }
  291. }
  292.  
  293. #ifdef CONFIG_SMP
  294. static void
  295. debug_ipi(int n __attribute__((unused)),
  296.     istate_t *istate __attribute__((unused)))
  297. {
  298.     int i;
  299.  
  300.     spinlock_lock(&bkpoint_lock);
  301.     for (i = 0; i < BKPOINTS_MAX; i++)
  302.         setup_dr(i);
  303.     spinlock_unlock(&bkpoint_lock);
  304. }
  305. #endif
  306.  
  307. /** Initialize debugger */
  308. void debugger_init()
  309. {
  310.     int i;
  311.  
  312.     for (i = 0; i < BKPOINTS_MAX; i++)
  313.         breakpoints[i].address = NULL;
  314.  
  315. #ifdef CONFIG_KCONSOLE
  316.     cmd_initialize(&bkpts_info);
  317.     if (!cmd_register(&bkpts_info))
  318.         printf("Cannot register command %s\n", bkpts_info.name);
  319.  
  320.     cmd_initialize(&delbkpt_info);
  321.     if (!cmd_register(&delbkpt_info))
  322.         printf("Cannot register command %s\n", delbkpt_info.name);
  323.  
  324.     cmd_initialize(&addbkpt_info);
  325.     if (!cmd_register(&addbkpt_info))
  326.         printf("Cannot register command %s\n", addbkpt_info.name);
  327.  
  328.     cmd_initialize(&addwatchp_info);
  329.     if (!cmd_register(&addwatchp_info))
  330.         printf("Cannot register command %s\n", addwatchp_info.name);
  331. #endif /* CONFIG_KCONSOLE */
  332.    
  333.     exc_register(VECTOR_DEBUG, "debugger", debug_exception);
  334. #ifdef CONFIG_SMP
  335.     exc_register(VECTOR_DEBUG_IPI, "debugger_smp", debug_ipi);
  336. #endif
  337. }
  338.  
  339. #ifdef CONFIG_KCONSOLE
  340. /** Print table of active breakpoints */
  341. int cmd_print_breakpoints(cmd_arg_t *argv __attribute__((unused)))
  342. {
  343.     unsigned int i;
  344.     char *symbol;
  345.  
  346. #ifdef __32_BITS__
  347.     printf("#  Count Address    In symbol\n");
  348.     printf("-- ----- ---------- ---------\n");
  349. #endif
  350.  
  351. #ifdef __64_BITS__
  352.     printf("#  Count Address            In symbol\n");
  353.     printf("-- ----- ------------------ ---------\n");
  354. #endif
  355.    
  356.     for (i = 0; i < BKPOINTS_MAX; i++)
  357.         if (breakpoints[i].address) {
  358.             symbol = get_symtab_entry(breakpoints[i].address);
  359.  
  360. #ifdef __32_BITS__
  361.             printf("%-2u %-5d %#10zx %s\n", i,
  362.                 breakpoints[i].counter, breakpoints[i].address,
  363.                 symbol);
  364. #endif
  365.  
  366. #ifdef __64_BITS__
  367.             printf("%-2u %-5d %#18zx %s\n", i,
  368.                 breakpoints[i].counter, breakpoints[i].address,
  369.                 symbol);
  370. #endif
  371.  
  372.         }
  373.     return 1;
  374. }
  375.  
  376. /** Remove breakpoint from table */
  377. int cmd_del_breakpoint(cmd_arg_t *argv)
  378. {
  379.     unative_t bpno = argv->intval;
  380.     if (bpno > BKPOINTS_MAX) {
  381.         printf("Invalid breakpoint number.\n");
  382.         return 0;
  383.     }
  384.     breakpoint_del(argv->intval);
  385.     return 1;
  386. }
  387.  
  388. /** Add new breakpoint to table */
  389. static int cmd_add_breakpoint(cmd_arg_t *argv)
  390. {
  391.     int flags;
  392.     int id;
  393.  
  394.     if (argv == &add_argv) {
  395.         flags = BKPOINT_INSTR;
  396.     } else { /* addwatchp */
  397.         flags = BKPOINT_WRITE;
  398.     }
  399.     printf("Adding breakpoint on address: %p\n", argv->intval);
  400.     id = breakpoint_add((void *)argv->intval, flags, -1);
  401.     if (id < 0)
  402.         printf("Add breakpoint failed.\n");
  403.     else
  404.         printf("Added breakpoint %d.\n", id);
  405.    
  406.     return 1;
  407. }
  408. #endif /* CONFIG_KCONSOLE */
  409.  
  410. /** @}
  411.  */
  412.