2006-09-14 Zoltan Varga <vargaz@gmail.com>
[mono.git] / mono / metadata / mono-debug.h
index 9276fa04e205ac2f685753cee8699f4094e54ff3..f18740617a974bb822c422a48954e63747210d94 100644 (file)
 #include <mono/metadata/image.h>
 #include <mono/metadata/appdomain.h>
 
+typedef struct _MonoSymbolTable                        MonoSymbolTable;
+
 typedef struct _MonoSymbolFile                 MonoSymbolFile;
 typedef struct _MonoSymbolFilePriv             MonoSymbolFilePriv;
 
 typedef struct _MonoDebugHandle                        MonoDebugHandle;
 typedef struct _MonoDebugHandlePriv            MonoDebugHandlePriv;
-typedef struct _MonoDebugDomainData            MonoDebugDomainData;
-typedef struct _MonoDebugDomainDataPriv                MonoDebugDomainDataPriv;
+
+typedef struct _MonoDebugLineNumberEntry       MonoDebugLineNumberEntry;
+typedef struct _MonoDebugLexicalBlockEntry     MonoDebugLexicalBlockEntry;
 
 typedef struct _MonoDebugVarInfo               MonoDebugVarInfo;
 typedef struct _MonoDebugMethodJitInfo         MonoDebugMethodJitInfo;
+typedef struct _MonoDebugMethodAddress         MonoDebugMethodAddress;
+typedef struct _MonoDebugWrapperData           MonoDebugWrapperData;
+typedef struct _MonoDebugClassEntry            MonoDebugClassEntry;
+
+typedef struct _MonoDebugMethodInfo            MonoDebugMethodInfo;
+typedef struct _MonoDebugSourceLocation                MonoDebugSourceLocation;
 
 typedef enum {
        MONO_DEBUG_FORMAT_NONE,
@@ -27,7 +36,72 @@ typedef enum {
        MONO_DEBUG_FORMAT_DEBUGGER
 } MonoDebugFormat;
 
+typedef enum {
+       MONO_DEBUGGER_TYPE_KIND_UNKNOWN = 1,
+       MONO_DEBUGGER_TYPE_KIND_FUNDAMENTAL,
+       MONO_DEBUGGER_TYPE_KIND_STRING,
+       MONO_DEBUGGER_TYPE_KIND_SZARRAY,
+       MONO_DEBUGGER_TYPE_KIND_ARRAY,
+       MONO_DEBUGGER_TYPE_KIND_POINTER,
+       MONO_DEBUGGER_TYPE_KIND_ENUM,
+       MONO_DEBUGGER_TYPE_KIND_OBJECT,
+       MONO_DEBUGGER_TYPE_KIND_STRUCT,
+       MONO_DEBUGGER_TYPE_KIND_CLASS,
+       MONO_DEBUGGER_TYPE_KIND_CLASS_INFO,
+       MONO_DEBUGGER_TYPE_KIND_REFERENCE
+} MonoDebuggerTypeKind;
+
+struct _MonoSymbolTable {
+       guint64 magic;
+       guint32 version;
+       guint32 total_size;
+
+       /*
+        * Corlib and metadata info.
+        */
+       MonoDebugHandle *corlib;
+
+       /*
+        * The symbol files.
+        */
+       MonoDebugHandle **symbol_files;
+       guint32 num_symbol_files;
+
+       /*
+        * Data table.
+        * This is intentionally not a GPtrArray to make it more easy to
+        * read for the debugger.  The `data_tables' field contains
+        * `num_data_tables' pointers to continuous memory areas.
+        *
+        * The data table is basically a big continuous blob, but we need
+        * to split it up into pieces because we don't know the total size
+        * in advance and using g_realloc() doesn't work because that may
+        * reallocate the block to a different address.
+        */
+       guint32 num_data_tables;
+       gpointer *data_tables;
+       /*
+        * Current data table.
+        * The `current_data_table' points to a blob of `current_data_table_size'
+        * bytes.
+        */
+       gpointer current_data_table;
+       guint32 current_data_table_size;
+       /*
+        * The offset in the `current_data_table'.
+        */
+       guint32 current_data_table_offset;
+};
+
+typedef enum {
+       MONO_DEBUG_DATA_ITEM_UNKNOWN            = 0,
+       MONO_DEBUG_DATA_ITEM_METHOD,
+       MONO_DEBUG_DATA_ITEM_CLASS,
+       MONO_DEBUG_DATA_ITEM_WRAPPER
+} MonoDebugDataItemType;
+
 struct _MonoDebugHandle {
+       guint32 index;
        const char *image_file;
        MonoImage *image;
        MonoSymbolFile *symfile;
@@ -35,13 +109,16 @@ struct _MonoDebugHandle {
 };
 
 struct _MonoDebugMethodJitInfo {
+       MonoDebugMethodAddress *address;
        const guint8 *code_start;
        guint32 code_size;
        guint32 prologue_end;
        guint32 epilogue_begin;
        const guint8 *wrapper_addr;
-       /* Array of MonoDebugLineNumberEntry */
-       GArray *line_numbers;
+       guint32 num_line_numbers;
+       MonoDebugLineNumberEntry *line_numbers;
+       guint32 num_lexical_blocks;
+       MonoDebugLexicalBlockEntry *lexical_blocks;
        guint32 num_params;
        MonoDebugVarInfo *this_var;
        MonoDebugVarInfo *params;
@@ -49,10 +126,39 @@ struct _MonoDebugMethodJitInfo {
        MonoDebugVarInfo *locals;
 };
 
-struct _MonoDebugDomainData {
+struct _MonoDebugMethodAddress {
+       guint32 size;
+       guint32 symfile_id;
        guint32 domain_id;
-       MonoDebugMethodJitInfo **jit;
-       MonoDebugDomainDataPriv *_priv;
+       guint32 method_id;
+       guint32 code_size;
+       guint32 dummy;
+       const guint8 *code_start;
+       const guint8 *wrapper_addr;
+       MonoDebugMethodJitInfo *jit;
+       guint8 data [MONO_ZERO_LEN_ARRAY];
+};
+
+struct _MonoDebugWrapperData {
+       guint32 size;
+       guint32 code_size;
+       MonoMethod *method;
+       const guint8 *code_start;
+       const gchar *name;
+       const gchar *cil_code;
+       guint8 data [MONO_ZERO_LEN_ARRAY];
+};
+
+struct _MonoDebugClassEntry {
+       guint32 size;
+       guint32 symfile_id;
+       guint8 data [MONO_ZERO_LEN_ARRAY];
+};
+
+struct _MonoDebugSourceLocation {
+       gchar *source_file;
+       guint32 row, column;
+       guint32 il_offset;
 };
 
 /*
@@ -80,23 +186,51 @@ struct _MonoDebugVarInfo {
        guint32 end_scope;
 };
 
-#define MONO_DEBUGGER_VERSION                          43
+#define MONO_DEBUGGER_VERSION                          57
 #define MONO_DEBUGGER_MAGIC                            0x7aff65af4253d427ULL
 
+extern MonoSymbolTable *mono_symbol_table;
 extern MonoDebugFormat mono_debug_format;
 extern GHashTable *mono_debug_handles;
 
-void mono_debug_init (MonoDomain *domain, MonoDebugFormat format);
+void mono_debug_init (MonoDebugFormat format);
+void mono_debug_init_1 (MonoDomain *domain);
 void mono_debug_init_2 (MonoAssembly *assembly);
+void mono_debug_init_2_memory (MonoImage *image, const guint8 *raw_contents, int size);
 void mono_debug_cleanup (void);
-MonoDebugDomainData *mono_debug_get_domain_data (MonoDebugHandle *handle, MonoDomain *domain);
-void mono_debug_add_wrapper (MonoMethod *method, MonoMethod *wrapper_method, MonoDomain *domain);
-void mono_debug_add_method (MonoMethod *method, MonoDebugMethodJitInfo *jit, MonoDomain *domain);
-gchar *mono_debug_source_location_from_address (MonoMethod *method, guint32 address,
-                                               guint32 *line_number, MonoDomain *domain);
-gchar *mono_debug_source_location_from_il_offset (MonoMethod *method, guint32 offset,
-                                                 guint32 *line_number);
-gint32 mono_debug_il_offset_from_address (MonoMethod *method, gint32 address, MonoDomain *domain);
-gint32 mono_debug_address_from_il_offset (MonoMethod *method, gint32 il_offset, MonoDomain *domain);
+
+gboolean mono_debug_using_mono_debugger (void);
+
+MonoDebugMethodAddress *mono_debug_add_method (MonoMethod *method, MonoDebugMethodJitInfo *jit,
+                                              MonoDomain *domain);
+MonoDebugMethodJitInfo *mono_debug_read_method (MonoDebugMethodAddress *address);
+void mono_debug_free_method_jit_info (MonoDebugMethodJitInfo *jit);
+
+MonoDebugMethodInfo *mono_debug_lookup_method (MonoMethod *method);
+
+/*
+ * Line number support.
+ */
+
+MonoDebugSourceLocation *
+mono_debug_lookup_source_location (MonoMethod *method, guint32 address, MonoDomain *domain);
+
+void
+mono_debug_free_source_location (MonoDebugSourceLocation *location);
+
+gchar *
+mono_debug_print_stack_frame (MonoMethod *method, guint32 native_offset, MonoDomain *domain);
+
+/*
+ * Mono Debugger support functions
+ *
+ * These methods are used by the JIT while running inside the Mono Debugger.
+ */
+
+int             mono_debugger_method_has_breakpoint       (MonoMethod *method);
+int             mono_debugger_insert_breakpoint           (const gchar *method_name, gboolean include_namespace);
+gboolean        mono_debugger_unhandled_exception         (gpointer addr, gpointer stack, MonoObject *exc);
+void            mono_debugger_handle_exception            (gpointer addr, gpointer stack, MonoObject *exc);
+gboolean        mono_debugger_throw_exception             (gpointer addr, gpointer stack, MonoObject *exc);
 
 #endif /* __MONO_DEBUG_H__ */