src/pdb.c

   1 /*
   2 Copyright (C) 2001-2008, The Perl Foundation.
   3 $Id$
   4
   5 =head1 NAME
   6
   7 pdb - The Parrot debugger
   8
   9 =head1 SYNOPSIS
  10
  11  pdb programfile
  12
  13 =head1 DESCRIPTION
  14
  15 =head2 Commands
  16
  17 =over 4
  18
  19 =item C<disassemble>
  20
  21 Disassemble the bytecode.
  22
  23 Use this if you have a PBC file but not the PASM.
  24
  25 =item C<load>
  26
  27 Load a source code file.
  28
  29 =item C<list> or C<l>
  30
  31 List the source code file.
  32
  33 =item C<run> or C<r>
  34
  35 Run the program.
  36
  37 =item C<break> or C<b>
  38
  39 Add a breakpoint.
  40
  41 =item C<watch> or C<w>
  42
  43 Add a watchpoint.
  44
  45 =item C<delete> or C<d>
  46
  47 Delete a breakpoint.
  48
  49 =item C<disable>
  50
  51 Disable a breakpoint.
  52
  53 =item C<enable>
  54
  55 Reenable a disabled breakpoint.
  56
  57 =item C<continue> or C<c>
  58
  59 Continue the program execution.
  60
  61 =item C<next> or C<n>
  62
  63 Run the next instruction
  64
  65 =item C<eval> or C<e>
  66
  67 Run an instruction.
  68
  69 =item C<trace> or C<t>
  70
  71 Trace the next instruction.
  72
  73 =item C<print> or C<p>
  74
  75 Print the interpreter registers.
  76
  77 =item C<stack> or C<s>
  78
  79 Examine the stack.
  80
  81 =item C<info>
  82
  83 Print interpreter information.
  84
  85 =item C<quit> or C<q>
  86
  87 Exit the debugger.
  88
  89 =item C<help> or C<h>
  90
  91 Print the help.
  92
  93 =back
  94
  95 =head2 Debug Ops
  96
  97 You can also debug Parrot code by using the C<debug_init>, C<debug_load>
  98 and C<debug_break> ops in F<ops/debug.ops>.
  99
 100 =over 4
 101
 102 =cut
 103
 104 */
 105
 106 #include <stdio.h>
 107 #include <stdlib.h>
 108 #include <ctype.h>
 109 #include "../compilers/imcc/imc.h"
 110 #include "../compilers/imcc/parser.h"
 111 #include "parrot/embed.h"
 112
 113 static void PDB_printwelcome(void);
 114 static void PDB_run_code(Parrot_Interp interp, int argc, char *argv[]);
 115
 116 /*
 117
 118 =item C<int main(int argc, char *argv[])>
 119
 120 Reads the PASM or PBC file from argv[1], loads it, and then calls
 121 Parrot_debug().
 122
 123 =cut
 124
 125 */
 126
 127 extern void imcc_init(Parrot_Interp interp);
 128
 129 int
 130 main(int argc, char *argv[])
 131 {
 132     Parrot_Interp     debugger = Parrot_new(NULL);
 133     Parrot_Interp     interp   = Parrot_new(debugger);
 134     PDB_t            *pdb      = mem_allocate_zeroed_typed(PDB_t);
 135     char             *filename;
 136     char             *ext;
 137     void             *yyscanner;
 138
 139     /*Parrot_set_config_hash();  TODO link with cfg */
 140
 141     /* attach pdb structure */
 142     debugger->pdb    = pdb;
 143     interp->debugger = debugger;
 144     pdb->debugee     = interp;
 145
 146     Parrot_block_DOD(interp);
 147     Parrot_block_GC(interp);
 148     imcc_init(interp);
 149
 150     do_yylex_init(interp, &yyscanner);
 151
 152     if (argc < 2) {
 153         fprintf(stderr, "Usage: pdb programfile [program-options]\n");
 154         Parrot_exit(interp, 1);
 155     }
 156
 157     filename = argv[1];
 158     ext      = strrchr(filename, '.');
 159
 160     if (ext && STREQ(ext, ".pbc")) {
 161         Parrot_PackFile pf = Parrot_readbc(interp, filename);
 162
 163         if (!pf)
 164             return 1;
 165
 166         Parrot_loadbc(interp, pf);
 167     }
 168     else {
 169         Parrot_PackFile pf        = PackFile_new(interp, 0);
 170         int             pasm_file = 0;
 171
 172         Parrot_loadbc(interp, pf);
 173
 174         IMCC_push_parser_state(interp);
 175         IMCC_INFO(interp)->state->file = filename;
 176
 177         if (!(imc_yyin_set(fopen(filename, "r"), yyscanner)))    {
 178             IMCC_fatal_standalone(interp, E_IOError,
 179                     "Error reading source file %s.\n",
 180                     filename);
 181         }
 182
 183         if (ext && STREQ(ext, ".pasm"))
 184             pasm_file = 1;
 185
 186         emit_open(interp, 1, NULL);
 187         IMCC_INFO(interp)->state->pasm_file = pasm_file;
 188         yyparse(yyscanner, interp);
 189         imc_compile_all_units(interp);
 190
 191         imc_cleanup(interp, yyscanner);
 192
 193         fclose(imc_yyin_get(yyscanner));
 194         PackFile_fixup_subs(interp, PBC_POSTCOMP, NULL);
 195     }
 196
 197     Parrot_unblock_DOD(interp);
 198     Parrot_unblock_GC(interp);
 199
 200     PDB_printwelcome();
 201
 202     PDB_run_code(interp, argc - 1, argv + 1);
 203
 204
 205     Parrot_exit(interp, 0);
 206 }
 207
 208 /*
 209
 210 =item C<static void PDB_add_exception_handler(Parrot_Interp)>
 211
 212 Adds a default exception handler to PDB.
 213
 214 */
 215
 216 static void
 217 PDB_run_code(Parrot_Interp interp, int argc, char *argv[])
 218 {
 219     Parrot_exception exp;
 220
 221     if (setjmp(exp.destination)) {
 222         fprintf(stderr, "Caught exception: %s\n",
 223             string_to_cstring(interp, interp->exceptions->msg));
 224         return;
 225     }
 226
 227     push_new_c_exception_handler(interp, &exp);
 228
 229     Parrot_runcode(interp, argc - 1, argv + 1);
 230 }
 231
 232 /*
 233
 234 =item C<static void PDB_printwelcome(void)>
 235
 236 Prints out the welcome string.
 237
 238 =cut
 239
 240 */
 241
 242 static void
 243 PDB_printwelcome(void)
 244 {
 245     fprintf(stderr, "Parrot Debugger 0.4.x\n");
 246     fprintf(stderr, "\nPlease note: ");
 247     fprintf(stderr, "the debugger is currently under reconstruction\n");
 248 }
 249
 250 /*
 251
 252 =back
 253
 254 =head1 SEE ALSO
 255
 256 F<src/debug.c>, F<include/parrot/debug.h>.
 257
 258 =head1 HISTORY
 259
 260 =over 4
 261
 262 =item * Initial version by Daniel Grunblatt on 2002.5.19.
 263
 264 =item * Start of rewrite - leo 2005.02.16
 265
 266 The debugger now uses it's own interpreter. User code is run in
 267 Interp* debugee. We have:
 268
 269   debug_interp->pdb->debugee->debugger
 270     ^                            |
 271     |                            v
 272     +------------- := -----------+
 273
 274 Debug commands are mostly run inside the C<debugger>. User code
 275 runs of course in the C<debugee>.
 276
 277 =back
 278
 279 =head1 TODO
 280
 281 =over 4
 282
 283 =item * Check the user input for bad commands, it's quite easy to make
 284 it bang now, try listing the source before loading or disassembling it.
 285
 286 =item * Print the interpreter info.
 287
 288 =item * Make the user interface better (add comands
 289 history/completion).
 290
 291 =item * Some other things I don't remember now because it's late.
 292
 293
 294 =back
 295
 296 =cut
 297
 298 */
 299
 300
 301 /*
 302  * Local variables:
 303  *   c-file-style: "parrot"
 304  * End:
 305  * vim: expandtab shiftwidth=4:
 306  */