2 * image.c: Routines for manipulating an image stored in an
3 * extended PE/COFF file.
6 * Miguel de Icaza (miguel@ximian.com)
8 * (C) 2001 Ximian, Inc. http://www.ximian.com
11 * Implement big-endian versions of the reading routines.
20 #include "rawbuffer.h"
24 #define INVALID_ADDRESS 0xffffffff
27 * Keeps track of the various assemblies loaded
29 static GHashTable *loaded_images_hash;
32 mono_cli_rva_image_map (MonoCLIImageInfo *iinfo, guint32 addr)
34 const int top = iinfo->cli_section_count;
35 MonoSectionTable *tables = iinfo->cli_section_tables;
38 for (i = 0; i < top; i++){
39 if ((addr >= tables->st_virtual_address) &&
40 (addr < tables->st_virtual_address + tables->st_raw_data_size)){
41 return addr - tables->st_virtual_address + tables->st_raw_data_ptr;
45 return INVALID_ADDRESS;
49 mono_cli_rva_map (MonoCLIImageInfo *iinfo, guint32 addr)
51 const int top = iinfo->cli_section_count;
52 MonoSectionTable *tables = iinfo->cli_section_tables;
55 for (i = 0; i < top; i++){
56 if ((addr >= tables->st_virtual_address) &&
57 (addr < tables->st_virtual_address + tables->st_raw_data_size)){
58 return iinfo->cli_sections [i] +
59 (addr - tables->st_virtual_address);
67 * mono_image_ensure_section_idx:
68 * @image: The image we are operating on
69 * @section: section number that we will load/map into memory
71 * This routine makes sure that we have an in-memory copy of
72 * an image section (.text, .rsrc, .data).
74 * Returns: TRUE on success
77 mono_image_ensure_section_idx (MonoImage *image, int section)
79 MonoCLIImageInfo *iinfo = image->image_info;
80 MonoSectionTable *sect;
83 g_return_val_if_fail (section < iinfo->cli_section_count, FALSE);
85 if (iinfo->cli_sections [section] != NULL)
88 sect = &iinfo->cli_section_tables [section];
90 writable = sect->st_flags & SECT_FLAGS_MEM_WRITE;
92 iinfo->cli_sections [section] = mono_raw_buffer_load (
93 fileno (image->f), writable,
94 sect->st_raw_data_ptr, sect->st_raw_data_size);
96 if (iinfo->cli_sections [section] == NULL)
103 * mono_image_ensure_section:
104 * @image: The image we are operating on
105 * @section: section name that we will load/map into memory
107 * This routine makes sure that we have an in-memory copy of
108 * an image section (.text, .rsrc, .data).
110 * Returns: TRUE on success
113 mono_image_ensure_section (MonoImage *image, const char *section)
115 MonoCLIImageInfo *ii = image->image_info;
118 for (i = 0; i < ii->cli_section_count; i++){
119 if (strncmp (ii->cli_section_tables [i].st_name, section, 8) != 0)
122 return mono_image_ensure_section_idx (image, i);
128 load_section_tables (MonoImage *image, MonoCLIImageInfo *iinfo)
130 const int top = iinfo->cli_header.coff.coff_sections;
133 iinfo->cli_section_count = top;
134 iinfo->cli_section_tables = g_new0 (MonoSectionTable, top);
135 iinfo->cli_sections = g_new0 (void *, top);
137 for (i = 0; i < top; i++){
138 MonoSectionTable *t = &iinfo->cli_section_tables [i];
140 if (fread (t, sizeof (MonoSectionTable), 1, image->f) != 1)
143 t->st_virtual_size = le32_to_cpu (t->st_virtual_size);
144 t->st_virtual_address = le32_to_cpu (t->st_virtual_address);
145 t->st_raw_data_size = le32_to_cpu (t->st_raw_data_size);
146 t->st_raw_data_ptr = le32_to_cpu (t->st_raw_data_ptr);
147 t->st_reloc_ptr = le32_to_cpu (t->st_reloc_ptr);
148 t->st_lineno_ptr = le32_to_cpu (t->st_lineno_ptr);
149 t->st_reloc_count = le16_to_cpu (t->st_reloc_count);
150 t->st_line_count = le16_to_cpu (t->st_line_count);
152 /* consistency checks here */
155 for (i = 0; i < top; i++)
156 if (!mono_image_ensure_section_idx (image, i))
163 load_cli_header (MonoImage *image, MonoCLIImageInfo *iinfo)
168 offset = mono_cli_rva_image_map (iinfo, iinfo->cli_header.datadir.pe_cli_header.rva);
169 if (offset == INVALID_ADDRESS)
172 if (fseek (image->f, offset, 0) != 0)
175 if ((n = fread (&iinfo->cli_cli_header, sizeof (MonoCLIHeader), 1, image->f)) != 1)
178 /* Catch new uses of the fields that are supposed to be zero */
180 if ((iinfo->cli_cli_header.ch_eeinfo_table.rva != 0) ||
181 (iinfo->cli_cli_header.ch_helper_table.rva != 0) ||
182 (iinfo->cli_cli_header.ch_dynamic_info.rva != 0) ||
183 (iinfo->cli_cli_header.ch_delay_load_info.rva != 0) ||
184 (iinfo->cli_cli_header.ch_module_image.rva != 0) ||
185 (iinfo->cli_cli_header.ch_external_fixups.rva != 0) ||
186 (iinfo->cli_cli_header.ch_ridmap.rva != 0) ||
187 (iinfo->cli_cli_header.ch_debug_map.rva != 0) ||
188 (iinfo->cli_cli_header.ch_ip_map.rva != 0)){
191 * No need to scare people who are testing this, I am just
192 * labelling this as a LAMESPEC
194 /* g_warning ("Some fields in the CLI header which should have been zero are not zero"); */
202 load_metadata_ptrs (MonoImage *image, MonoCLIImageInfo *iinfo)
204 guint32 offset, size;
209 offset = mono_cli_rva_image_map (iinfo, iinfo->cli_cli_header.ch_metadata.rva);
210 size = iinfo->cli_cli_header.ch_metadata.size;
212 image->raw_metadata = mono_raw_buffer_load (fileno (image->f), FALSE, offset, size);
213 if (image->raw_metadata == NULL)
216 ptr = image->raw_metadata;
218 if (strncmp (ptr, "BSJB", 4) == 0){
219 guint32 version_string_len;
222 version_string_len = read32 (ptr);
224 ptr += version_string_len;
225 if (((guint32) ptr) % 4)
226 ptr += 4 - (((guint32) ptr) %4);
230 /* skip over flags */
233 streams = read16 (ptr);
236 for (i = 0; i < streams; i++){
237 if (strncmp (ptr + 8, "#~", 3) == 0){
238 image->heap_tables.offset = read32 (ptr);
239 image->heap_tables.size = read32 (ptr + 4);
241 } else if (strncmp (ptr + 8, "#Strings", 9) == 0){
242 image->heap_strings.offset = read32 (ptr);
243 image->heap_strings.size = read32 (ptr + 4);
245 } else if (strncmp (ptr + 8, "#US", 4) == 0){
246 image->heap_us.offset = read32 (ptr);
247 image->heap_us.size = read32 (ptr + 4);
249 } else if (strncmp (ptr + 8, "#Blob", 6) == 0){
250 image->heap_blob.offset = read32 (ptr);
251 image->heap_blob.size = read32 (ptr + 4);
253 } else if (strncmp (ptr + 8, "#GUID", 6) == 0){
254 image->heap_guid.offset = read32 (ptr);
255 image->heap_guid.size = read32 (ptr + 4);
258 g_message ("Unknown heap type: %s\n", ptr + 8);
259 if (((guint32)ptr) % 4){
260 ptr += 4 - (((guint32)ptr) % 4);
267 * Load representation of logical metadata tables, from the "#~" stream
270 load_tables (MonoImage *image)
272 char *heap_tables = image->raw_metadata + image->heap_tables.offset;
275 int valid = 0, table;
278 heap_sizes = heap_tables [6];
279 image->idx_string_wide = ((heap_sizes & 0x01) == 1);
280 image->idx_guid_wide = ((heap_sizes & 0x02) == 2);
281 image->idx_blob_wide = ((heap_sizes & 0x04) == 4);
283 valid_mask = read64 (heap_tables + 8);
284 rows = (guint32 *) (heap_tables + 24);
286 for (table = 0; table < 64; table++){
287 if ((valid_mask & ((guint64) 1 << table)) == 0){
288 image->tables [table].rows = 0;
292 g_warning("bits in valid must be zero above 0x2b (II - 23.1.6)");
294 image->tables [table].rows = read32 (rows);
299 image->tables_base = (heap_tables + 24) + (4 * valid);
301 /* They must be the same */
302 g_assert ((void *) image->tables_base == (void *) rows);
304 mono_metadata_compute_table_bases (image);
309 load_metadata (MonoImage *image, MonoCLIImageInfo *iinfo)
311 if (!load_metadata_ptrs (image, iinfo))
314 return load_tables (image);
318 load_class_names (MonoImage *image) {
319 MonoTableInfo *t = &image->tables [MONO_TABLE_TYPEDEF];
320 guint32 cols [MONO_TYPEDEF_SIZE];
323 GHashTable *nspace_table;
324 GHashTable *name_cache = image->name_cache;
327 for (i = 1; i <= t->rows; ++i) {
328 mono_metadata_decode_row (t, i - 1, cols, MONO_TYPEDEF_SIZE);
329 name = mono_metadata_string_heap (image, cols [MONO_TYPEDEF_NAME]);
330 nspace = mono_metadata_string_heap (image, cols [MONO_TYPEDEF_NAMESPACE]);
331 if (!(nspace_table = g_hash_table_lookup (name_cache, nspace))) {
332 nspace_table = g_hash_table_new (g_str_hash, g_str_equal);
333 g_hash_table_insert (name_cache, nspace, nspace_table);
335 g_hash_table_insert (nspace_table, name, GUINT_TO_POINTER (i));
340 do_mono_image_open (const char *fname, enum MonoImageOpenStatus *status)
342 MonoCLIImageInfo *iinfo;
343 MonoDotNetHeader *header;
344 MonoMSDOSHeader msdos;
348 image = g_new0 (MonoImage, 1);
349 image->f = fopen (fname, "r");
350 image->name = g_strdup (fname);
351 iinfo = g_new0 (MonoCLIImageInfo, 1);
352 image->image_info = iinfo;
354 image->method_cache = g_hash_table_new (g_direct_hash, g_direct_equal);
355 image->class_cache = g_hash_table_new (g_direct_hash, g_direct_equal);
356 image->name_cache = g_hash_table_new (g_str_hash, g_str_equal);
357 image->array_cache = g_hash_table_new (g_direct_hash, g_direct_equal);
359 header = &iinfo->cli_header;
361 if (image->f == NULL){
363 *status = MONO_IMAGE_ERROR_ERRNO;
364 mono_image_close (image);
369 *status = MONO_IMAGE_IMAGE_INVALID;
371 if (fread (&msdos, sizeof (msdos), 1, image->f) != 1)
374 if (!(msdos.msdos_header [0] == 'M' && msdos.msdos_header [1] == 'Z'))
377 if (msdos.pe_offset != sizeof (msdos))
378 fseek (image->f, msdos.pe_offset, SEEK_SET);
380 if ((n = fread (header, sizeof (MonoDotNetHeader), 1, image->f)) != 1)
383 if (header->coff.coff_machine != 0x14c) /* FIXME: ENOENDIAN */
386 if (header->coff.coff_opt_header_size != (sizeof (MonoDotNetHeader) - sizeof (MonoCOFFHeader) - 4))
389 if (header->pe.pe_magic != 0x10B) /* FIXME: ENOENDIAN */
392 if (header->pe.pe_major != 6 || header->pe.pe_minor != 0)
396 * FIXME: byte swap all addresses here for header.
399 if (!load_section_tables (image, iinfo))
402 /* Load the CLI header */
403 if (!load_cli_header (image, iinfo))
406 if (!load_metadata (image, iinfo))
409 load_class_names (image);
411 image->assembly_name = mono_metadata_string_heap (image,
412 mono_metadata_decode_row_col (&image->tables [MONO_TABLE_ASSEMBLY],
413 0, MONO_ASSEMBLY_NAME));
416 *status = MONO_IMAGE_OK;
421 mono_image_close (image);
427 * @fname: filename that points to the module we want to open
428 * @status: An error condition is returned in this field
430 * Retuns: An open image of type %MonoImage or NULL on error.
431 * if NULL, then check the value of @status for details on the error
434 mono_image_open (const char *fname, enum MonoImageOpenStatus *status)
438 g_return_val_if_fail (fname != NULL, NULL);
440 if (loaded_images_hash){
441 image = g_hash_table_lookup (loaded_images_hash, fname);
448 image = do_mono_image_open (fname, status);
452 if (!loaded_images_hash)
453 loaded_images_hash = g_hash_table_new (g_str_hash, g_str_equal);
454 g_hash_table_insert (loaded_images_hash, image->name, image);
460 free_hash_table(gpointer key, gpointer val, gpointer user_data)
462 g_hash_table_destroy ((GHashTable*)val);
467 * @image: The image file we wish to close
469 * Closes an image file, deallocates all memory consumed and
470 * unmaps all possible sections of the file
473 mono_image_close (MonoImage *image)
475 g_return_if_fail (image != NULL);
477 if (--image->ref_count)
480 g_hash_table_remove (loaded_images_hash, image->name);
485 g_free (image->name);
487 g_hash_table_destroy (image->method_cache);
488 g_hash_table_destroy (image->class_cache);
489 g_hash_table_destroy (image->array_cache);
490 g_hash_table_foreach (image->name_cache, free_hash_table, NULL);
491 g_hash_table_destroy (image->name_cache);
493 if (image->raw_metadata != NULL)
494 mono_raw_buffer_free (image->raw_metadata);
496 if (image->image_info){
497 MonoCLIImageInfo *ii = image->image_info;
500 for (i = 0; i < ii->cli_section_count; i++){
501 if (!ii->cli_sections [i])
503 mono_raw_buffer_free (ii->cli_sections [i]);
505 if (ii->cli_section_tables)
506 g_free (ii->cli_section_tables);
507 if (ii->cli_sections)
508 g_free (ii->cli_sections);
509 g_free (image->image_info);
516 * mono_image_strerror:
517 * @status: an code indicating the result from a recent operation
519 * Returns: a string describing the error
522 mono_image_strerror (enum MonoImageOpenStatus status)
527 case MONO_IMAGE_ERROR_ERRNO:
528 return strerror (errno);
529 case MONO_IMAGE_IMAGE_INVALID:
530 return "File does not contain a valid CIL image";
531 case MONO_IMAGE_MISSING_ASSEMBLYREF:
532 return "An assembly was referenced, but could not be found";
534 return "Internal error";