mono/mini/xdebug.c

   1 /*
   2  * xdebug.c: Support for emitting gdb debug info for JITted code.
   3  *
   4  * Author:
   5  *   Zoltan Varga (vargaz@gmail.com)
   6  *
   7  * (C) 2010 Novell, Inc.
   8  */
   9
  10 /*
  11  * This works as follows:
  12  * - the runtime writes out an xdb.s file containing DWARF debug info.
  13  * - the user calls a gdb macro
  14  * - the macro compiles and loads this shared library using add-symbol-file.
  15  *
  16  * This is based on the xdebug functionality in the Kaffe Java VM.
  17  *
  18  * We emit assembly code instead of using the ELF writer, so we can emit debug info
  19  * incrementally as each method is JITted, and the debugger doesn't have to call
  20  * into the runtime to emit the shared library, which would cause all kinds of
  21  * complications, like threading issues, and the fact that the ELF writer's
  22  * emit_writeout () function cannot be called more than once.
  23  * GDB 7.0 and later has a JIT interface.
  24  */
  25
  26 #include "config.h"
  27 #include <glib.h>
  28 #include "mini.h"
  29
  30 #if !defined(DISABLE_AOT) && !defined(DISABLE_JIT)
  31 #include <sys/types.h>
  32 #ifdef HAVE_UNISTD_H
  33 #include <unistd.h>
  34 #endif
  35 #ifdef HAVE_STDINT_H
  36 #include <stdint.h>
  37 #endif
  38 #include <fcntl.h>
  39 #include <ctype.h>
  40 #include <string.h>
  41 #ifndef HOST_WIN32
  42 #include <sys/time.h>
  43 #else
  44 #include <winsock2.h>
  45 #include <windows.h>
  46 #endif
  47
  48 #include <errno.h>
  49 #include <sys/stat.h>
  50
  51 #include "image-writer.h"
  52 #include "dwarfwriter.h"
  53
  54 #define USE_GDB_JIT_INTERFACE
  55
  56 /* The recommended gdb macro is: */
  57 /*
  58   define xdb
  59   shell rm -f xdb.so && as --64 -o xdb.o xdb.s && ld -shared -o xdb.so xdb.o
  60   add-symbol-file xdb.so 0
  61   end
  62 */
  63
  64 /*
  65  * GDB JIT interface definitions.
  66  *
  67  *      http://sources.redhat.com/gdb/onlinedocs/gdb_30.html
  68  */
  69 typedef enum
  70 {
  71   JIT_NOACTION = 0,
  72   JIT_REGISTER_FN,
  73   JIT_UNREGISTER_FN
  74 } jit_actions_t;
  75
  76 struct jit_code_entry
  77 {
  78         struct jit_code_entry *next_entry;
  79         struct jit_code_entry *prev_entry;
  80         const char *symfile_addr;
  81         /*
  82          * The gdb code in gdb/jit.c which reads this structure ignores alignment
  83          * requirements, so use two 32 bit fields.
  84          */
  85         guint32 symfile_size1, symfile_size2;
  86 };
  87
  88 struct jit_descriptor
  89 {
  90   guint32 version;
  91   /* This type should be jit_actions_t, but we use guint32
  92      to be explicit about the bitwidth.  */
  93   guint32 action_flag;
  94   struct jit_code_entry *relevant_entry;
  95   struct jit_code_entry *first_entry;
  96 };
  97
  98
  99 #ifdef _MSC_VER
 100 #define MONO_NOINLINE __declspec (noinline)
 101 #else
 102 #define MONO_NOINLINE __attribute__((noinline))
 103 #endif
 104
 105 /* GDB puts a breakpoint in this function.  */
 106 void MONO_NOINLINE __jit_debug_register_code(void);
 107
 108 #if !defined(MONO_LLVM_LOADED) && defined(ENABLE_LLVM) && ((LLVM_MAJOR_VERSION == 2 && LLVM_MINOR_VERSION >= 7) || LLVM_MAJOR_VERSION > 2)
 109 /* LLVM already defines these */
 110 extern struct jit_descriptor __jit_debug_descriptor;
 111 #else
 112
 113 /* Make sure to specify the version statically, because the
 114    debugger may check the version before we can set it.  */
 115 struct jit_descriptor __jit_debug_descriptor = { 1, 0, 0, 0 };
 116
 117 void MONO_NOINLINE __jit_debug_register_code(void) { };
 118 #endif
 119
 120 static MonoImageWriter *xdebug_w;
 121 static MonoDwarfWriter *xdebug_writer;
 122 static FILE *xdebug_fp, *il_file;
 123 static gboolean use_gdb_interface, save_symfiles;
 124 static int il_file_line_index;
 125 static GHashTable *xdebug_syms;
 126
 127 void
 128 mono_xdebug_init (char *options)
 129 {
 130         MonoImageWriter *w;
 131         char **args, **ptr;
 132
 133         args = g_strsplit (options, ",", -1);
 134         for (ptr = args; ptr && *ptr; ptr ++) {
 135                 char *arg = *ptr;
 136
 137                 if (!strcmp (arg, "gdb"))
 138                         use_gdb_interface = TRUE;
 139                 if (!strcmp (arg, "save-symfiles"))
 140                         save_symfiles = TRUE;
 141         }
 142
 143         /* This file will contain the IL code for methods which don't have debug info */
 144         il_file = fopen ("xdb.il", "w");
 145
 146         if (use_gdb_interface)
 147                 return;
 148
 149         unlink ("xdb.s");
 150         xdebug_fp = fopen ("xdb.s", "w");
 151
 152         w = img_writer_create (xdebug_fp, FALSE);
 153
 154         img_writer_emit_start (w);
 155
 156         xdebug_writer = mono_dwarf_writer_create (w, il_file, 0, TRUE);
 157
 158         /* Emit something so the file has a text segment */
 159         img_writer_emit_section_change (w, ".text", 0);
 160         img_writer_emit_string (w, "");
 161
 162         mono_dwarf_writer_emit_base_info (xdebug_writer, mono_unwind_get_cie_program ());
 163 }
 164
 165 static void
 166 xdebug_begin_emit (MonoImageWriter **out_w, MonoDwarfWriter **out_dw)
 167 {
 168         MonoImageWriter *w;
 169         MonoDwarfWriter *dw;
 170
 171         w = img_writer_create (NULL, TRUE);
 172
 173         img_writer_emit_start (w);
 174
 175         /* This file will contain the IL code for methods which don't have debug info */
 176         if (!il_file)
 177                 il_file = fopen ("xdb.il", "w");
 178
 179         dw = mono_dwarf_writer_create (w, il_file, il_file_line_index, FALSE);
 180
 181         mono_dwarf_writer_emit_base_info (dw, mono_unwind_get_cie_program ());
 182
 183         *out_w = w;
 184         *out_dw = dw;
 185 }
 186
 187 static void
 188 xdebug_end_emit (MonoImageWriter *w, MonoDwarfWriter *dw, MonoMethod *method)
 189 {
 190         guint8 *img;
 191         guint32 img_size;
 192         struct jit_code_entry *entry;
 193         guint64 *psize;
 194
 195         il_file_line_index = mono_dwarf_writer_get_il_file_line_index (dw);
 196         mono_dwarf_writer_close (dw);
 197
 198         img_writer_emit_writeout (w);
 199
 200         img = img_writer_get_output (w, &img_size);
 201
 202         img_writer_destroy (w);
 203
 204         if (FALSE) {
 205                 /* Save the symbol files to help debugging */
 206                 FILE *fp;
 207                 char *file_name;
 208                 static int file_counter;
 209
 210                 file_counter ++;
 211                 file_name = g_strdup_printf ("xdb-%d.o", file_counter);
 212                 printf ("%s %p %d\n", file_name, img, img_size);
 213
 214                 fp = fopen (file_name, "w");
 215                 fwrite (img, img_size, 1, fp);
 216                 fclose (fp);
 217                 g_free (file_name);
 218         }
 219
 220         /* Register the image with GDB */
 221
 222         entry = g_malloc0 (sizeof (struct jit_code_entry));
 223
 224         entry->symfile_addr = (const char*)img;
 225         psize = (guint64*)&entry->symfile_size1;
 226         *psize = img_size;
 227
 228         entry->next_entry = __jit_debug_descriptor.first_entry;
 229         if (__jit_debug_descriptor.first_entry)
 230                 __jit_debug_descriptor.first_entry->prev_entry = entry;
 231         __jit_debug_descriptor.first_entry = entry;
 232
 233         __jit_debug_descriptor.relevant_entry = entry;
 234         __jit_debug_descriptor.action_flag = JIT_REGISTER_FN;
 235
 236         __jit_debug_register_code ();
 237 }
 238
 239 /*
 240  * mono_xdebug_flush:
 241  *
 242  *   This could be called from inside gdb to flush the debugging information not yet
 243  * registered with gdb.
 244  */
 245 void
 246 mono_xdebug_flush (void)
 247 {
 248         if (xdebug_w)
 249                 xdebug_end_emit (xdebug_w, xdebug_writer, NULL);
 250
 251         xdebug_begin_emit (&xdebug_w, &xdebug_writer);
 252 }
 253
 254 static int xdebug_method_count;
 255
 256 /*
 257  * mono_save_xdebug_info:
 258  *
 259  *   Emit debugging info for METHOD into an assembly file which can be assembled
 260  * and loaded into gdb to provide debugging info for JITted code.
 261  * LOCKING: Acquires the loader lock.
 262  */
 263 void
 264 mono_save_xdebug_info (MonoCompile *cfg)
 265 {
 266         MonoDebugMethodJitInfo *dmji;
 267
 268         if (use_gdb_interface) {
 269                 mono_loader_lock ();
 270
 271                 if (!xdebug_syms)
 272                         xdebug_syms = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, NULL);
 273
 274                 /*
 275                  * gdb is not designed to handle 1000s of symbol files (one per method). So we
 276                  * group them into groups of 100.
 277                  */
 278                 if ((xdebug_method_count % 100) == 0)
 279                         mono_xdebug_flush ();
 280
 281                 xdebug_method_count ++;
 282
 283                 dmji = mono_debug_find_method (cfg->jit_info->method, mono_domain_get ());;
 284                 mono_dwarf_writer_emit_method (xdebug_writer, cfg, cfg->jit_info->method, NULL, NULL, cfg->jit_info->code_start, cfg->jit_info->code_size, cfg->args, cfg->locals, cfg->unwind_ops, dmji);
 285                 mono_debug_free_method_jit_info (dmji);
 286
 287 #if 0
 288                 /*
 289                  * Emit a symbol for the code by emitting it at the beginning of the text
 290                  * segment, and setting the text segment to have an absolute address.
 291                  * This symbol can be used to set breakpoints in gdb.
 292                  * FIXME: This doesn't work when multiple methods are emitted into the same file.
 293                  */
 294                 sym = get_debug_sym (cfg->jit_info->method, "", xdebug_syms);
 295                 img_writer_emit_section_change (w, ".text", 0);
 296                 if (!xdebug_text_addr) {
 297                         xdebug_text_addr = cfg->jit_info->code_start;
 298                         img_writer_set_section_addr (w, (gssize)xdebug_text_addr);
 299                 }
 300                 img_writer_emit_global_with_size (w, sym, cfg->jit_info->code_size, TRUE);
 301                 img_writer_emit_label (w, sym);
 302                 img_writer_emit_bytes (w, cfg->jit_info->code_start, cfg->jit_info->code_size);
 303                 g_free (sym);
 304 #endif
 305
 306                 mono_loader_unlock ();
 307         } else {
 308                 if (!xdebug_writer)
 309                         return;
 310
 311                 mono_loader_lock ();
 312                 dmji = mono_debug_find_method (cfg->jit_info->method, mono_domain_get ());;
 313                 mono_dwarf_writer_emit_method (xdebug_writer, cfg, cfg->jit_info->method, NULL, NULL, cfg->jit_info->code_start, cfg->jit_info->code_size, cfg->args, cfg->locals, cfg->unwind_ops, dmji);
 314                 mono_debug_free_method_jit_info (dmji);
 315                 fflush (xdebug_fp);
 316                 mono_loader_unlock ();
 317         }
 318
 319 }
 320
 321 /*
 322  * mono_save_trampoline_xdebug_info:
 323  *
 324  *   Same as mono_save_xdebug_info, but for trampolines.
 325  * LOCKING: Acquires the loader lock.
 326  */
 327 void
 328 mono_save_trampoline_xdebug_info (MonoTrampInfo *info)
 329 {
 330         if (use_gdb_interface) {
 331                 MonoImageWriter *w;
 332                 MonoDwarfWriter *dw;
 333
 334                 /* This can be called before the loader lock is initialized */
 335                 mono_loader_lock_if_inited ();
 336
 337                 xdebug_begin_emit (&w, &dw);
 338
 339                 mono_dwarf_writer_emit_trampoline (dw, info->name, NULL, NULL, info->code, info->code_size, info->unwind_ops);
 340
 341                 xdebug_end_emit (w, dw, NULL);
 342
 343                 mono_loader_unlock_if_inited ();
 344         } else {
 345                 if (!xdebug_writer)
 346                         return;
 347
 348                 mono_loader_lock_if_inited ();
 349                 mono_dwarf_writer_emit_trampoline (xdebug_writer, info->name, NULL, NULL, info->code, info->code_size, info->unwind_ops);
 350                 fflush (xdebug_fp);
 351                 mono_loader_unlock_if_inited ();
 352         }
 353 }
 354
 355 #else /* !defined(DISABLE_AOT) && !defined(DISABLE_JIT) */
 356
 357 void
 358 mono_xdebug_init (char *options)
 359 {
 360 }
 361
 362 void
 363 mono_save_xdebug_info (MonoCompile *cfg)
 364 {
 365 }
 366
 367 void
 368 mono_save_trampoline_xdebug_info (MonoTrampInfo *info)
 369 {
 370 }
 371
 372 #endif