Merge pull request #1695 from gregoryyoung/master
[mono.git] / mono / metadata / debug-mono-symfile.h
index 88fbdc41885cb8aa8e0fc489a351e2ac5d941285..6d9a3c20d34b988dc34f4dd17dde9cd6d78e038c 100644 (file)
@@ -1,6 +1,7 @@
 /*
  * This header is only installed for use by the debugger:
  * the structures and the API declared here are not supported.
+ * Copyright 2012 Xamarin Inc (http://www.xamarin.com)
  */
 
 #ifndef __MONO_DEBUG_MONO_SYMFILE_H__
@@ -20,105 +21,150 @@ typedef struct MonoSymbolFileMethodEntry  MonoSymbolFileMethodEntry;
 
 /* Keep in sync with OffsetTable in mcs/class/Mono.CSharp.Debugger/MonoSymbolTable.cs */
 struct MonoSymbolFileOffsetTable {
-       guint32 _total_file_size;
-       guint32 _data_section_offset;
-       guint32 _data_section_size;
-       guint32 _compile_unit_count;
-       guint32 _compile_unit_table_offset;
-       guint32 _compile_unit_table_size;
-       guint32 _source_count;
-       guint32 _source_table_offset;
-       guint32 _source_table_size;
-       guint32 _method_count;
-       guint32 _method_table_offset;
-       guint32 _method_table_size;
-       guint32 _type_count;
-       guint32 _anonymous_scope_count;
-       guint32 _anonymous_scope_table_offset;
-       guint32 _anonymous_scope_table_size;
-       guint32 _line_number_table_line_base;
-       guint32 _line_number_table_line_range;
-       guint32 _line_number_table_opcode_base;
-       guint32 _is_aspx_source;
+       uint32_t _total_file_size;
+       uint32_t _data_section_offset;
+       uint32_t _data_section_size;
+       uint32_t _compile_unit_count;
+       uint32_t _compile_unit_table_offset;
+       uint32_t _compile_unit_table_size;
+       uint32_t _source_count;
+       uint32_t _source_table_offset;
+       uint32_t _source_table_size;
+       uint32_t _method_count;
+       uint32_t _method_table_offset;
+       uint32_t _method_table_size;
+       uint32_t _type_count;
+       uint32_t _anonymous_scope_count;
+       uint32_t _anonymous_scope_table_offset;
+       uint32_t _anonymous_scope_table_size;
+       uint32_t _line_number_table_line_base;
+       uint32_t _line_number_table_line_range;
+       uint32_t _line_number_table_opcode_base;
+       uint32_t _is_aspx_source;
 };
 
 struct MonoSymbolFileSourceEntry {
-       guint32 _index;
-       guint32 _data_offset;
+       uint32_t _index;
+       uint32_t _data_offset;
 };
 
 struct MonoSymbolFileMethodEntry {
-       guint32 _token;
-       guint32 _data_offset;
-       guint32 _line_number_table;
+       uint32_t _token;
+       uint32_t _data_offset;
+       uint32_t _line_number_table;
 };
 
 struct MonoSymbolFileMethodAddress {
-       guint32 size;
-       const guint8 *start_address;
-       const guint8 *end_address;
-       const guint8 *method_start_address;
-       const guint8 *method_end_address;
-       const guint8 *wrapper_address;
-       guint32 has_this;
-       guint32 num_params;
-       guint32 variable_table_offset;
-       guint32 type_table_offset;
-       guint32 num_line_numbers;
-       guint32 line_number_offset;
-       guint8 data [MONO_ZERO_LEN_ARRAY];
+       uint32_t size;
+       const uint8_t *start_address;
+       const uint8_t *end_address;
+       const uint8_t *method_start_address;
+       const uint8_t *method_end_address;
+       const uint8_t *wrapper_address;
+       uint32_t has_this;
+       uint32_t num_params;
+       uint32_t variable_table_offset;
+       uint32_t type_table_offset;
+       uint32_t num_line_numbers;
+       uint32_t line_number_offset;
+       uint8_t data [MONO_ZERO_LEN_ARRAY];
 };
 
 struct _MonoDebugMethodInfo {
        MonoMethod *method;
        MonoDebugHandle *handle;
-       guint32 index;
-       guint32 data_offset;
-       guint32 lnt_offset;
+       uint32_t index;
+       uint32_t data_offset;
+       uint32_t lnt_offset;
 };
 
-struct _MonoDebugLineNumberEntry {
-       guint32 il_offset;
-       guint32 native_offset;
+typedef struct {
+       int parent;
+       int type;
+       /* IL offsets */
+       int start_offset, end_offset;
+} MonoDebugCodeBlock;
+
+typedef struct {
+       char *name;
+       int index;
+       /* Might be null for the main scope */
+       MonoDebugCodeBlock *block;
+} MonoDebugLocalVar;
+
+/*
+ * Information about local variables retrieved from a symbol file.
+ */
+struct _MonoDebugLocalsInfo {
+       int num_locals;
+       MonoDebugLocalVar *locals;
+       int num_blocks;
+       MonoDebugCodeBlock *code_blocks;
 };
 
-struct _MonoSymbolFile {
-       const guint8 *raw_contents;
-       int raw_contents_size;
-       int major_version;
-       int minor_version;
-       gchar *filename;
-       GHashTable *method_hash;
-       MonoSymbolFileOffsetTable *offset_table;
+struct _MonoDebugLineNumberEntry {
+       uint32_t il_offset;
+       uint32_t native_offset;
 };
 
-#define MONO_SYMBOL_FILE_MAJOR_VERSION         42
-#define MONO_SYMBOL_FILE_MINOR_VERSION         5
+/*
+ * Information about a source file retrieved from a symbol file.
+ */
+typedef struct {
+       char *source_file;
+       /* 16 byte long */
+       guint8 *guid, *hash;
+} MonoDebugSourceInfo;
+
+#define MONO_SYMBOL_FILE_MAJOR_VERSION         50
+#define MONO_SYMBOL_FILE_MINOR_VERSION         0
 #define MONO_SYMBOL_FILE_MAGIC                 0x45e82623fd7fa614ULL
 
-G_BEGIN_DECLS
+MONO_BEGIN_DECLS
 
-MonoSymbolFile *
+MONO_API MonoSymbolFile *
 mono_debug_open_mono_symbols       (MonoDebugHandle          *handle,
-                                   const guint8             *raw_contents,
+                                   const uint8_t            *raw_contents,
                                    int                       size,
-                                   gboolean                  in_the_debugger);
+                                   mono_bool                 in_the_debugger);
 
-void
+MONO_API void
 mono_debug_close_mono_symbol_file  (MonoSymbolFile           *symfile);
 
-MonoDebugSourceLocation *
+MONO_API mono_bool
+mono_debug_symfile_is_loaded       (MonoSymbolFile           *symfile);
+
+MONO_API MonoDebugSourceLocation *
 mono_debug_symfile_lookup_location (MonoDebugMethodInfo      *minfo,
-                                   guint32                   offset);
+                                   uint32_t                  offset);
+
+MONO_API void
+mono_debug_symfile_free_location   (MonoDebugSourceLocation  *location);
 
-gint32
+int32_t
 _mono_debug_address_from_il_offset (MonoDebugMethodJitInfo   *jit,
-                                   guint32                   il_offset);
+                                   uint32_t                  il_offset);
 
-MonoDebugMethodInfo *
+MONO_API MonoDebugMethodInfo *
 mono_debug_symfile_lookup_method   (MonoDebugHandle          *handle,
                                    MonoMethod               *method);
-G_END_DECLS
+
+MONO_API MonoDebugLocalsInfo*
+mono_debug_symfile_lookup_locals (MonoDebugMethodInfo *minfo);
+
+MONO_API void
+mono_debug_symfile_free_locals (MonoDebugLocalsInfo *info);
+
+MONO_API void
+mono_debug_symfile_get_line_numbers (MonoDebugMethodInfo *minfo, char **source_file, int *n_il_offsets, int **il_offsets, int **line_numbers);
+
+MONO_API void
+mono_debug_symfile_get_line_numbers_full (MonoDebugMethodInfo *minfo, char **source_file, GPtrArray **source_file_list, int *n_il_offsets, int **il_offsets, int **line_numbers, int **column_numbers, int **source_files, int **end_line_numbers, int **end_column_numbers);
+
+gboolean
+mono_debug_image_has_debug_info (MonoImage *image);
+
+MONO_END_DECLS
 
 #endif /* __MONO_SYMFILE_H__ */