Subversion Repositories HelenOS

Rev

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

  1. /*
  2.  * Copyright (c) 2008 Jiri Svoboda
  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 debug
  30.  * @{
  31.  */
  32. /** @file
  33.  */
  34.  
  35. #include <stdio.h>
  36. #include <stdlib.h>
  37. #include <unistd.h>
  38. #include <libarch/syscall.h>
  39. #include <ipc/ipc.h>
  40. #include <fibril.h>
  41. #include <loader/loader.h>
  42. #include <errno.h>
  43. #include <udebug.h>
  44. #include <async.h>
  45. #include <string.h>
  46.  
  47. #include "cmd.h"
  48. #include "cons.h"
  49. #include "dthread.h"
  50. #include "breakpoint.h"
  51. #include "include/arch.h"
  52. #include "main.h"
  53.  
  54. void thread_debug_start(unsigned thread_hash);
  55.  
  56. #define IN_BUF_SIZE 64
  57. static char in_buf[IN_BUF_SIZE];
  58.  
  59. #define MAX_ARGC 10
  60. int cmd_argc;
  61. char *cmd_argv[MAX_ARGC + 1];   /* need one spare field for cmd_split() */
  62.  
  63.  
  64. int next_thread_id;
  65.  
  66. int app_phone;
  67. volatile bool abort_debug;
  68.  
  69. volatile int paused;
  70.  
  71. static task_id_t task_id;
  72. static loader_t *task_ldr;
  73.  
  74. static int program_run_fibril(void *arg);
  75.  
  76. static void program_run(void)
  77. {
  78.     fid_t fid;
  79.  
  80.     fid = fibril_create(program_run_fibril, NULL);
  81.     if (fid == 0) {
  82.         printf("Error creating fibril\n");
  83.         exit(1);
  84.     }
  85.  
  86.     fibril_add_ready(fid);
  87. }
  88.  
  89. static int program_run_fibril(void *arg)
  90. {
  91.     int rc;
  92.  
  93.     /*
  94.      * This must be done in background as it will block until
  95.      * we let the task reply to this call.
  96.      */
  97.     rc = loader_run(task_ldr);
  98.     if (rc != 0) {
  99.         printf("Error running program\n");
  100.         exit(1);
  101.     }
  102.  
  103.     free(task_ldr);
  104.     task_ldr = NULL;
  105.  
  106.     return 0;
  107. }
  108.  
  109. static loader_t *preload_task(const char *path, char *const argv[],
  110.     task_id_t *task_id)
  111. {
  112.     loader_t *ldr;
  113.     int rc;
  114.  
  115.     /* Spawn a program loader */   
  116.     ldr = loader_connect();
  117.     if (ldr == NULL)
  118.         return 0;
  119.  
  120.     /* Get task ID. */
  121.     rc = loader_get_task_id(ldr, task_id);
  122.     if (rc != EOK)
  123.         goto error;
  124.  
  125.     /* Send program pathname */
  126.     rc = loader_set_pathname(ldr, path);
  127.     if (rc != EOK)
  128.         goto error;
  129.  
  130.     /* Send arguments */
  131.     rc = loader_set_args(ldr, argv);
  132.     if (rc != EOK)
  133.         goto error;
  134.  
  135.     /* Load the program. */
  136.     rc = loader_load_program(ldr);
  137.     if (rc != EOK)
  138.         goto error;
  139.  
  140.     /* Success */
  141.     return ldr;
  142.  
  143.     /* Error exit */
  144. error:
  145.     loader_abort(ldr);
  146.     free(ldr);
  147.     return NULL;
  148. }
  149.  
  150.  
  151. static void command_split(char *cmd_str)
  152. {
  153.     char *p = cmd_str;
  154.  
  155.     if (*p == '\0') {
  156.         cmd_argc = 0;
  157.         return;
  158.     }
  159.  
  160.     cmd_argc = 1;
  161.     cmd_argv[0] = p;
  162.  
  163.     while (*p != '\0') {
  164.         if (*p == ' ') {
  165.             cmd_argv[cmd_argc++] = p + 1;
  166.             *p = '\0';
  167.         }
  168.         ++p;
  169.     }
  170. }
  171.  
  172. static void command_run(void)
  173. {
  174.     int i;
  175.     int cmp_len;
  176.     int len;
  177.  
  178.     int idx_found;
  179.     int num_found;
  180.  
  181.     len = str_length(cmd_argv[0]);
  182.     cmp_len = 1;
  183.  
  184.     /* Silence warnings */
  185.     num_found = 0;
  186.     idx_found = 0;
  187.  
  188.     while (cmp_len <= len + 1) {
  189.  
  190.         num_found = 0;
  191.         i = 0;
  192.         while (cmd_table[i].name != NULL) {
  193.             if (str_lcmp(cmd_table[i].name, cmd_argv[0], cmp_len) == 0) {
  194.                 idx_found = i;
  195.                 ++num_found;
  196.             }
  197.             ++i;
  198.         }
  199.  
  200.         if (num_found < 2) break;
  201.  
  202.         ++cmp_len;
  203.     }
  204.  
  205.     if (num_found == 0) {
  206.         cons_printf("Unknown command. Try one of:\n");
  207.         cmd_help(0, NULL);
  208.         return;
  209.     }
  210.  
  211.     if (cmd_argc - 1 != cmd_table[idx_found].argc) {
  212.         cons_printf("Command '%s' expects %d arguments\n",
  213.         cmd_table[idx_found].name, cmd_table[idx_found].argc);
  214.         return;
  215.     }
  216.  
  217.     (*cmd_table[idx_found].proc)(cmd_argc, cmd_argv);
  218. }
  219.  
  220. static void thread_stop(void)
  221. {
  222.     dthread_t *dt;
  223.     uintptr_t pc;
  224.  
  225.     dt = dthread_get();
  226.     pc = dthread_get_pc(dt);
  227.     cons_printf("[thread %d] stopped at 0x%lx\n", dt->id, pc);
  228.     dthread_stop_me();
  229.     cons_printf("[thread %d] go\n", dt->id);
  230. }
  231.  
  232. /*
  233.  * Called by a fibril (from arch code) when a breakpoint is hit.
  234.  */
  235. void breakpoint_hit(breakpoint_t *b)
  236. {
  237.     dthread_t *dt;
  238.  
  239.     dt = dthread_get();
  240.     cons_printf("Thread %d hit breakpoint %d at 0x%lx\n",
  241.         dt->id, b->id, b->addr);
  242.     thread_stop();
  243. }
  244.  
  245. /*
  246.  * Called by a fibril (from arch code) when a single instruction
  247.  * in singlestep is executed
  248.  */
  249. void singlestep_hit(void)
  250. {
  251.     cons_printf("singlestep hit\n");
  252.     thread_stop();
  253. }
  254.  
  255. static int connect_task(task_id_t task_id)
  256. {
  257.     int rc;
  258.     unsigned evmask;
  259.  
  260.     cons_printf("ipc_connect_kbox(%;;d)... ", task_id);
  261.     rc = ipc_connect_kbox(task_id);
  262.     cons_printf("-> %d\n", rc);
  263.     app_phone = rc;
  264.     if (rc < 0) return rc;
  265.  
  266.     cons_printf("udebug_begin()... ");
  267.     rc = udebug_begin(app_phone);
  268.     cons_printf("-> %d\n", rc);
  269.     if (rc < 0) return rc;
  270.  
  271.     evmask = UDEBUG_EM_ALL & ~(UDEBUG_EM_SYSCALL_B | UDEBUG_EM_SYSCALL_E);
  272.     cons_printf("udebug_set_evmask(0x%x)... ", evmask);
  273.     rc = udebug_set_evmask(app_phone, evmask);
  274.     cons_printf("-> %d\n", rc);
  275.     if (rc < 0) return rc;
  276.  
  277.     return 0;
  278. }
  279.  
  280. #define THASH_BUF_INIT_LENGTH 32
  281.  
  282. static int get_thread_list(thash_t **thash_buf_ptr, int *n)
  283. {
  284.     int rc;
  285.     size_t tb_copied;
  286.     size_t tb_needed;
  287.     int i;
  288.     size_t tb_size;
  289.     thash_t *thash_buf;
  290.  
  291.     tb_size = THASH_BUF_INIT_LENGTH * sizeof(thash_t);
  292.     thash_buf = malloc(tb_size);
  293.  
  294.     rc = udebug_thread_read(app_phone, thash_buf,
  295.         tb_size, &tb_copied, &tb_needed);
  296.     if (rc < 0) return rc;
  297.  
  298.     if (tb_needed > tb_size) {
  299.         /* Larger buffer needed  */
  300.  
  301.         free(thash_buf);
  302.  
  303.         tb_size = tb_needed;
  304.         thash_buf = malloc(tb_size);
  305.  
  306.         if (!thash_buf) {
  307.             printf("malloc failed\n");
  308.             exit(1);
  309.         }
  310.  
  311.         /* Try again */
  312.        
  313.         rc = udebug_thread_read(app_phone, thash_buf,
  314.             tb_size, &tb_copied, &tb_needed);
  315.  
  316.         if (rc < 0) return rc;
  317.     }
  318.  
  319.     *n = tb_copied / sizeof(thash_t);
  320.  
  321.     cons_printf("thread hashes:");
  322.  
  323.     for (i = 0; i < *n; ++i) {
  324.         cons_printf("0x%x\n", thash_buf[i]);
  325.     }
  326.  
  327.     cons_printf("Total of %u threads\n", *n);
  328.  
  329.     *thash_buf_ptr = thash_buf;
  330.  
  331.     return 0;
  332. }
  333.  
  334. static void event_thread_b(unsigned hash)
  335. {
  336.     async_serialize_start();
  337.     cons_printf("new thread, hash 0x%x\n", hash);
  338.     async_serialize_end();
  339.  
  340.     thread_debug_start(hash);
  341. }
  342.  
  343. static void debug_event(thash_t thash, udebug_event_t ev_type, sysarg_t val0)
  344. {
  345.     switch (ev_type) {
  346.     case UDEBUG_EVENT_STOP:
  347.         cons_printf("stop event\n");
  348.         thread_stop();
  349.         break;
  350.     case UDEBUG_EVENT_THREAD_B:
  351.         event_thread_b(val0);
  352.         break;
  353.     case UDEBUG_EVENT_THREAD_E:
  354.         cons_printf("thread 0x%x exited\n", val0);
  355.         abort_debug = true;
  356.         break;
  357.     case UDEBUG_EVENT_BREAKPOINT:
  358.         arch_event_breakpoint(thash);
  359.         break;
  360.     case UDEBUG_EVENT_TRAP:
  361.         arch_event_trap(dthread_get());
  362.         break;
  363.     default:
  364.         cons_printf("unknown event type %d\n", ev_type);
  365.         break;
  366.     }
  367. }
  368.  
  369. static int debug_loop(void *dt_arg)
  370. {
  371.     int rc;
  372.     udebug_event_t ev_type;
  373.     unsigned val0, val1;
  374.     dthread_t *dt;
  375.  
  376.     dt = (dthread_t *)dt_arg;
  377.  
  378.     cons_printf("debug_loop(%d)\n", dt->id);
  379.  
  380.     while (!abort_debug) {
  381.  
  382.         /* Run thread until an event occurs */
  383.         rc = udebug_go(app_phone, dt->hash, &ev_type, &val0, &val1);
  384.  
  385.         if (ev_type == UDEBUG_EVENT_FINISHED) {
  386.             cons_printf("thread %u debugging finished\n", dt->id);
  387.             break;
  388.         }
  389.         if (rc >= 0) debug_event(dt->hash, ev_type, val0);
  390.     }
  391.  
  392.     cons_printf("debug_loop(%d) exiting\n", dt->id);
  393.     return 0;
  394. }
  395.  
  396. void thread_debug_start(unsigned thash)
  397. {
  398.     fid_t fid;
  399.     dthread_t *dt;
  400.  
  401.     dt = dthread_new(thash);
  402.  
  403.     fid = fibril_create(debug_loop, (void *)dt);
  404.     if (fid == 0) {
  405.         cons_printf("Warning: Failed creating fibril\n");
  406.     }
  407.     dt->fid = fid;
  408.  
  409.     fibril_add_ready(fid);
  410. }
  411.  
  412. static void debug_task(task_id_t task_id)
  413. {
  414.     int i;
  415.     int rc;
  416.  
  417.     thash_t *thash_buffer;
  418.     int n_threads;
  419.  
  420.     rc = get_thread_list(&thash_buffer, &n_threads);
  421.     if (rc < 0) {
  422.         cons_printf("Failed to get thread list\n", rc);
  423.         return;
  424.     }
  425.  
  426.     abort_debug = false;
  427.  
  428.     for (i = 0; i < n_threads; i++) {
  429.         thread_debug_start(thash_buffer[i]);
  430.     }
  431.  
  432.     while (!quit) {
  433.         cons_read_line(in_buf, IN_BUF_SIZE);
  434.         command_split(in_buf);
  435.         if (cmd_argc == 0) continue;
  436.  
  437.         command_run();
  438.     }
  439.  
  440.     cons_printf("terminate debugging session...\n");
  441.     abort_debug = true;
  442.     udebug_end(app_phone);
  443.     ipc_hangup(app_phone);
  444.  
  445.     cons_printf("done\n");
  446.     return;
  447. }
  448.  
  449. static void main_init(void)
  450. {
  451.     next_thread_id = 1;
  452.     paused = 0;
  453.    
  454.     list_initialize(&dthreads);
  455.     breakpoint_init();
  456.     cwt = NULL;
  457. }
  458.  
  459. static void print_syntax()
  460. {
  461.     printf("Syntax:\n");
  462.     printf("\tdebug <executable> [<arg1> [...]]\n");
  463.     printf("or\tdebug -t <task_id>\n");
  464. }
  465.  
  466. static int parse_args(int argc, char *argv[])
  467. {
  468.     char *arg;
  469.     char *err_p;
  470.  
  471.     task_id = 0;
  472.  
  473.     --argc; ++argv;
  474.  
  475.     while (argc > 0) {
  476.         arg = *argv;
  477.         if (arg[0] == '-') {
  478.             if (arg[1] == 't') {
  479.                 /* Trace an already running task */
  480.                 --argc; ++argv;
  481.                 task_id = strtol(*argv, &err_p, 10);
  482.                 task_ldr = NULL;
  483.                 if (*err_p) {
  484.                     printf("Task ID syntax error\n");
  485.                     print_syntax();
  486.                     return -1;
  487.                 }
  488.             } else {
  489.                 printf("Uknown option '%s'\n", arg[0]);
  490.                 print_syntax();
  491.                 return -1;
  492.             }
  493.         } else {
  494.             break;
  495.         }
  496.  
  497.         --argc; ++argv;
  498.     }
  499.  
  500.     if (task_id != 0) {
  501.         if (argc == 0) return 0;
  502.         printf("Extra arguments\n");
  503.         print_syntax();
  504.         return -1;
  505.     }
  506.  
  507.     if (argc < 1) {
  508.         printf("Missing argument\n");
  509.         print_syntax();
  510.         return -1;
  511.     }
  512.  
  513.     /* Preload the specified program file. */
  514.     printf("Spawning '%s' with arguments:\n", *argv);
  515.     {
  516.         char **cp = argv;
  517.         while (*cp) printf("'%s'\n", *cp++);
  518.     }
  519.     task_ldr = preload_task(*argv, argv, &task_id);
  520.  
  521.     return 0;
  522. }
  523.  
  524. int main(int argc, char *argv[])
  525. {
  526.     int rc;
  527.  
  528.     cons_printf("Breakpoint Debugger\n");
  529.  
  530.     main_init();
  531.  
  532.     if (parse_args(argc, argv) < 0)
  533.         return 1;
  534.  
  535.     rc = connect_task(task_id);
  536.     if (rc < 0) {
  537.         printf("Failed connecting to task %lld\n", task_id);
  538.         return 1;
  539.     }
  540.  
  541.     cons_printf("Connected to task %lld\n", task_id);
  542.  
  543.     if (task_ldr != NULL) {
  544.         program_run();
  545.     }
  546.  
  547.     debug_task(task_id);
  548.  
  549.     return 0;
  550. }
  551.  
  552. /** @}
  553.  */
  554.