util/x86emu/x86emu/debug.c

   1 /****************************************************************************
   2 *
   3 *                       Realmode X86 Emulator Library
   4 *
   5 *               Copyright (C) 1991-2004 SciTech Software, Inc.
   6 *                    Copyright (C) David Mosberger-Tang
   7 *                      Copyright (C) 1999 Egbert Eich
   8 *
   9 *  ========================================================================
  10 *
  11 *  Permission to use, copy, modify, distribute, and sell this software and
  12 *  its documentation for any purpose is hereby granted without fee,
  13 *  provided that the above copyright notice appear in all copies and that
  14 *  both that copyright notice and this permission notice appear in
  15 *  supporting documentation, and that the name of the authors not be used
  16 *  in advertising or publicity pertaining to distribution of the software
  17 *  without specific, written prior permission.  The authors makes no
  18 *  representations about the suitability of this software for any purpose.
  19 *  It is provided "as is" without express or implied warranty.
  20 *
  21 *  THE AUTHORS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  22 *  INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  23 *  EVENT SHALL THE AUTHORS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  24 *  CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
  25 *  USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
  26 *  OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  27 *  PERFORMANCE OF THIS SOFTWARE.
  28 *
  29 *  ========================================================================
  30 *
  31 * Language:     ANSI C
  32 * Environment:  Any
  33 * Developer:    Kendall Bennett
  34 *
  35 * Description:  This file contains the code to handle debugging of the
  36 *               emulator.
  37 *
  38 ****************************************************************************/
  39
  40 #include "x86emui.h"
  41 // #include <stdarg.h>
  42
  43 /*----------------------------- Implementation ----------------------------*/
  44
  45 #ifdef DEBUG
  46
  47 static void     print_encoded_bytes (u16 s, u16 o);
  48 static void     print_decoded_instruction (void);
  49 int      parse_line (char *s, int *ps, int *n);
  50
  51 /* should look something like debug's output. */
  52 void X86EMU_trace_regs (void)
  53 {
  54     if (DEBUG_TRACE()) {
  55         if (M.x86.mode & (SYSMODE_PREFIX_DATA | SYSMODE_PREFIX_ADDR)) {
  56                 x86emu_dump_xregs();
  57         } else {
  58                 x86emu_dump_regs();
  59         }
  60     }
  61     if (DEBUG_DECODE() && ! DEBUG_DECODE_NOPRINT()) {
  62         printk("%04x:%04x ",M.x86.saved_cs, M.x86.saved_ip);
  63         print_encoded_bytes( M.x86.saved_cs, M.x86.saved_ip);
  64         print_decoded_instruction();
  65     }
  66 }
  67
  68 void X86EMU_trace_xregs (void)
  69 {
  70     if (DEBUG_TRACE()) {
  71         x86emu_dump_xregs();
  72     }
  73 }
  74
  75 void x86emu_just_disassemble (void)
  76 {
  77     /*
  78      * This routine called if the flag DEBUG_DISASSEMBLE is set kind
  79      * of a hack!
  80      */
  81     printk("%04x:%04x ",M.x86.saved_cs, M.x86.saved_ip);
  82     print_encoded_bytes( M.x86.saved_cs, M.x86.saved_ip);
  83     print_decoded_instruction();
  84 }
  85
  86 void disassemble_forward (u16 seg, u16 off, int n)
  87 {
  88     X86EMU_sysEnv tregs;
  89     int i;
  90     u8 op1;
  91     /*
  92      * hack, hack, hack.  What we do is use the exact machinery set up
  93      * for execution, except that now there is an additional state
  94      * flag associated with the "execution", and we are using a copy
  95      * of the register struct.  All the major opcodes, once fully
  96      * decoded, have the following two steps: TRACE_REGS(r,m);
  97      * SINGLE_STEP(r,m); which disappear if DEBUG is not defined to
  98      * the preprocessor.  The TRACE_REGS macro expands to:
  99      *
 100      * if (debug&DEBUG_DISASSEMBLE)
 101      *     {just_disassemble(); goto EndOfInstruction;}
 102      *     if (debug&DEBUG_TRACE) trace_regs(r,m);
 103      *
 104      * ......  and at the last line of the routine.
 105      *
 106      * EndOfInstruction: end_instr();
 107      *
 108      * Up to the point where TRACE_REG is expanded, NO modifications
 109      * are done to any register EXCEPT the IP register, for fetch and
 110      * decoding purposes.
 111      *
 112      * This was done for an entirely different reason, but makes a
 113      * nice way to get the system to help debug codes.
 114      */
 115     tregs = M;
 116     tregs.x86.R_IP = off;
 117     tregs.x86.R_CS = seg;
 118
 119     /* reset the decoding buffers */
 120     tregs.x86.enc_str_pos = 0;
 121     tregs.x86.enc_pos = 0;
 122
 123     /* turn on the "disassemble only, no execute" flag */
 124     tregs.x86.debug |= DEBUG_DISASSEMBLE_F;
 125
 126     /* DUMP NEXT n instructions to screen in straight_line fashion */
 127     /*
 128      * This looks like the regular instruction fetch stream, except
 129      * that when this occurs, each fetched opcode, upon seeing the
 130      * DEBUG_DISASSEMBLE flag set, exits immediately after decoding
 131      * the instruction.  XXX --- CHECK THAT MEM IS NOT AFFECTED!!!
 132      * Note the use of a copy of the register structure...
 133      */
 134     for (i=0; i<n; i++) {
 135         op1 = (*sys_rdb)(((u32)M.x86.R_CS<<4) + (M.x86.R_IP++));
 136         (x86emu_optab[op1])(op1);
 137     }
 138     /* end major hack mode. */
 139 }
 140
 141 void x86emu_check_ip_access (void)
 142 {
 143     /* NULL as of now */
 144 }
 145
 146 void x86emu_check_sp_access (void)
 147 {
 148 }
 149
 150 void x86emu_check_mem_access (u32 dummy)
 151 {
 152     /*  check bounds, etc */
 153 }
 154
 155 void x86emu_check_data_access (uint dummy1, uint dummy2)
 156 {
 157     /*  check bounds, etc */
 158 }
 159
 160 void x86emu_inc_decoded_inst_len (int x)
 161 {
 162     M.x86.enc_pos += x;
 163 }
 164
 165 void x86emu_decode_printf (char *x)
 166 {
 167     sprintf(M.x86.decoded_buf+M.x86.enc_str_pos,"%s",x);
 168     M.x86.enc_str_pos += strlen(x);
 169 }
 170
 171 void x86emu_decode_printf2 (char *x, int y)
 172 {
 173     char temp[100];
 174     sprintf(temp,x,y);
 175     sprintf(M.x86.decoded_buf+M.x86.enc_str_pos,"%s",temp);
 176     M.x86.enc_str_pos += strlen(temp);
 177 }
 178
 179 void x86emu_end_instr (void)
 180 {
 181     M.x86.enc_str_pos = 0;
 182     M.x86.enc_pos = 0;
 183 }
 184
 185 static void print_encoded_bytes (u16 s, u16 o)
 186 {
 187     int i;
 188     char buf1[64];
 189     for (i=0; i< M.x86.enc_pos; i++) {
 190         sprintf(buf1+2*i,"%02x", fetch_data_byte_abs(s,o+i));
 191     }
 192     printk("%-20s ",buf1);
 193 }
 194
 195 static void print_decoded_instruction (void)
 196 {
 197     printk("%s", M.x86.decoded_buf);
 198 }
 199
 200 void x86emu_print_int_vect (u16 iv)
 201 {
 202     u16 seg,off;
 203
 204     if (iv > 256) return;
 205     seg   = fetch_data_word_abs(0,iv*4);
 206     off   = fetch_data_word_abs(0,iv*4+2);
 207     printk("%04x:%04x ", seg, off);
 208 }
 209
 210 void X86EMU_dump_memory (u16 seg, u16 off, u32 amt)
 211 {
 212     u32 start = off & 0xfffffff0;
 213     u32 end  = (off+16) & 0xfffffff0;
 214     u32 i;
 215     u32 current;
 216
 217     current = start;
 218     while (end <= off + amt) {
 219         printk("%04x:%04x ", seg, start);
 220         for (i=start; i< off; i++)
 221           printk("   ");
 222         for (       ; i< end; i++)
 223           printk("%02x ", fetch_data_byte_abs(seg,i));
 224         printk("\n");
 225         start = end;
 226         end = start + 16;
 227     }
 228 }
 229
 230 void x86emu_single_step (void)
 231 {
 232 #if 0
 233     char s[1024];
 234     int ps[10];
 235     int ntok;
 236     int cmd;
 237     int done;
 238         int segment;
 239     int offset;
 240     static int breakpoint;
 241     static int noDecode = 1;
 242
 243     char *p;
 244
 245         if (DEBUG_BREAK()) {
 246                 if (M.x86.saved_ip != breakpoint) {
 247                         return;
 248                 } else {
 249               M.x86.debug &= ~DEBUG_DECODE_NOPRINT_F;
 250                         M.x86.debug |= DEBUG_TRACE_F;
 251                         M.x86.debug &= ~DEBUG_BREAK_F;
 252                         print_decoded_instruction ();
 253                         X86EMU_trace_regs();
 254                 }
 255         }
 256     done=0;
 257     offset = M.x86.saved_ip;
 258     while (!done) {
 259         printk("-");
 260         p = fgets(s, 1023, stdin);
 261         cmd = parse_line(s, ps, &ntok);
 262         switch(cmd) {
 263           case 'u':
 264             disassemble_forward(M.x86.saved_cs,(u16)offset,10);
 265             break;
 266           case 'd':
 267                             if (ntok == 2) {
 268                                     segment = M.x86.saved_cs;
 269                                     offset = ps[1];
 270                                     X86EMU_dump_memory(segment,(u16)offset,16);
 271                                     offset += 16;
 272                             } else if (ntok == 3) {
 273                                     segment = ps[1];
 274                                     offset = ps[2];
 275                                     X86EMU_dump_memory(segment,(u16)offset,16);
 276                                     offset += 16;
 277                             } else {
 278                                     segment = M.x86.saved_cs;
 279                                     X86EMU_dump_memory(segment,(u16)offset,16);
 280                                     offset += 16;
 281                             }
 282             break;
 283           case 'c':
 284             M.x86.debug ^= DEBUG_TRACECALL_F;
 285             break;
 286           case 's':
 287             M.x86.debug ^= DEBUG_SVC_F | DEBUG_SYS_F | DEBUG_SYSINT_F;
 288             break;
 289           case 'r':
 290             X86EMU_trace_regs();
 291             break;
 292           case 'x':
 293             X86EMU_trace_xregs();
 294             break;
 295           case 'g':
 296             if (ntok == 2) {
 297                 breakpoint = ps[1];
 298         if (noDecode) {
 299                         M.x86.debug |= DEBUG_DECODE_NOPRINT_F;
 300         } else {
 301                         M.x86.debug &= ~DEBUG_DECODE_NOPRINT_F;
 302         }
 303         M.x86.debug &= ~DEBUG_TRACE_F;
 304         M.x86.debug |= DEBUG_BREAK_F;
 305         done = 1;
 306             }
 307             break;
 308           case 'q':
 309           M.x86.debug |= DEBUG_EXIT;
 310           return;
 311       case 'P':
 312           noDecode = (noDecode)?0:1;
 313           printk("Toggled decoding to %s\n",(noDecode)?"FALSE":"TRUE");
 314           break;
 315           case 't':
 316       case 0:
 317             done = 1;
 318             break;
 319         }
 320     }
 321 #endif
 322 }
 323
 324 int X86EMU_trace_on(void)
 325 {
 326     return M.x86.debug |= DEBUG_STEP_F | DEBUG_DECODE_F | DEBUG_TRACE_F;
 327 }
 328
 329 int X86EMU_trace_off(void)
 330 {
 331     return M.x86.debug &= ~(DEBUG_STEP_F | DEBUG_DECODE_F | DEBUG_TRACE_F);
 332 }
 333
 334 int parse_line (char *s, int *ps, int *n)
 335 {
 336 #if 0
 337     int cmd;
 338
 339     *n = 0;
 340     while(*s == ' ' || *s == '\t') s++;
 341     ps[*n] = *s;
 342     switch (*s) {
 343       case '\n':
 344         *n += 1;
 345         return 0;
 346       default:
 347         cmd = *s;
 348         *n += 1;
 349     }
 350
 351     while (1) {
 352         while (*s != ' ' && *s != '\t' && *s != '\n')  s++;
 353
 354         if (*s == '\n')
 355             return cmd;
 356
 357         while(*s == ' ' || *s == '\t') s++;
 358
 359         sscanf(s,"%x",&ps[*n]);
 360         *n += 1;
 361     }
 362 #else
 363     return 0;
 364 #endif
 365 }
 366
 367 #endif /* DEBUG */
 368
 369 void x86emu_dump_regs (void)
 370 {
 371     printk("\tAX=%04x  ", M.x86.R_AX );
 372     printk("BX=%04x  ", M.x86.R_BX );
 373     printk("CX=%04x  ", M.x86.R_CX );
 374     printk("DX=%04x  ", M.x86.R_DX );
 375     printk("SP=%04x  ", M.x86.R_SP );
 376     printk("BP=%04x  ", M.x86.R_BP );
 377     printk("SI=%04x  ", M.x86.R_SI );
 378     printk("DI=%04x\n", M.x86.R_DI );
 379     printk("\tDS=%04x  ", M.x86.R_DS );
 380     printk("ES=%04x  ", M.x86.R_ES );
 381     printk("SS=%04x  ", M.x86.R_SS );
 382     printk("CS=%04x  ", M.x86.R_CS );
 383     printk("IP=%04x   ", M.x86.R_IP );
 384     if (ACCESS_FLAG(F_OF))    printk("OV ");     /* CHECKED... */
 385     else                        printk("NV ");
 386     if (ACCESS_FLAG(F_DF))    printk("DN ");
 387     else                        printk("UP ");
 388     if (ACCESS_FLAG(F_IF))    printk("EI ");
 389     else                        printk("DI ");
 390     if (ACCESS_FLAG(F_SF))    printk("NG ");
 391     else                        printk("PL ");
 392     if (ACCESS_FLAG(F_ZF))    printk("ZR ");
 393     else                        printk("NZ ");
 394     if (ACCESS_FLAG(F_AF))    printk("AC ");
 395     else                        printk("NA ");
 396     if (ACCESS_FLAG(F_PF))    printk("PE ");
 397     else                        printk("PO ");
 398     if (ACCESS_FLAG(F_CF))    printk("CY ");
 399     else                        printk("NC ");
 400     printk("\n");
 401 }
 402
 403 void x86emu_dump_xregs (void)
 404 {
 405     printk("\tEAX=%08x  ", M.x86.R_EAX );
 406     printk("EBX=%08x  ", M.x86.R_EBX );
 407     printk("ECX=%08x  ", M.x86.R_ECX );
 408     printk("EDX=%08x  \n", M.x86.R_EDX );
 409     printk("\tESP=%08x  ", M.x86.R_ESP );
 410     printk("EBP=%08x  ", M.x86.R_EBP );
 411     printk("ESI=%08x  ", M.x86.R_ESI );
 412     printk("EDI=%08x\n", M.x86.R_EDI );
 413     printk("\tDS=%04x  ", M.x86.R_DS );
 414     printk("ES=%04x  ", M.x86.R_ES );
 415     printk("SS=%04x  ", M.x86.R_SS );
 416     printk("CS=%04x  ", M.x86.R_CS );
 417     printk("EIP=%08x\n\t", M.x86.R_EIP );
 418     if (ACCESS_FLAG(F_OF))    printk("OV ");     /* CHECKED... */
 419     else                        printk("NV ");
 420     if (ACCESS_FLAG(F_DF))    printk("DN ");
 421     else                        printk("UP ");
 422     if (ACCESS_FLAG(F_IF))    printk("EI ");
 423     else                        printk("DI ");
 424     if (ACCESS_FLAG(F_SF))    printk("NG ");
 425     else                        printk("PL ");
 426     if (ACCESS_FLAG(F_ZF))    printk("ZR ");
 427     else                        printk("NZ ");
 428     if (ACCESS_FLAG(F_AF))    printk("AC ");
 429     else                        printk("NA ");
 430     if (ACCESS_FLAG(F_PF))    printk("PE ");
 431     else                        printk("PO ");
 432     if (ACCESS_FLAG(F_CF))    printk("CY ");
 433     else                        printk("NC ");
 434     printk("\n");
 435 }