2 * dynamic-image.c: Images created at runtime.
6 * Paolo Molaro (lupus@ximian.com)
8 * Copyright 2001-2003 Ximian, Inc (http://www.ximian.com)
9 * Copyright 2004-2009 Novell, Inc (http://www.novell.com)
10 * Copyright 2011 Rodrigo Kumpera
11 * Copyright 2016 Microsoft
13 * Licensed under the MIT license. See LICENSE file in the project root for full license information.
18 #include "mono/metadata/object.h"
19 #include "mono/metadata/dynamic-image-internals.h"
20 #include "mono/metadata/dynamic-stream-internals.h"
21 #include "mono/metadata/gc-internals.h"
22 #include "mono/metadata/metadata-internals.h"
23 #include "mono/metadata/profiler-private.h"
24 #include "mono/metadata/reflection-internals.h"
25 #include "mono/metadata/sre-internals.h"
26 #include "mono/utils/checked-build.h"
27 #include "mono/utils/mono-error-internals.h"
28 #include "mono/utils/mono-os-mutex.h"
30 const unsigned char table_sizes [MONO_TABLE_NUM] = {
40 MONO_INTERFACEIMPL_SIZE,
41 MONO_MEMBERREF_SIZE, /* 0x0A */
43 MONO_CUSTOM_ATTR_SIZE,
44 MONO_FIELD_MARSHAL_SIZE,
45 MONO_DECL_SECURITY_SIZE,
46 MONO_CLASS_LAYOUT_SIZE,
47 MONO_FIELD_LAYOUT_SIZE, /* 0x10 */
48 MONO_STAND_ALONE_SIGNATURE_SIZE,
52 MONO_PROPERTY_MAP_SIZE,
55 MONO_METHOD_SEMA_SIZE,
57 MONO_MODULEREF_SIZE, /* 0x1A */
63 MONO_ASSEMBLY_SIZE, /* 0x20 */
64 MONO_ASSEMBLY_PROCESSOR_SIZE,
66 MONO_ASSEMBLYREF_SIZE,
67 MONO_ASSEMBLYREFPROC_SIZE,
68 MONO_ASSEMBLYREFOS_SIZE,
72 MONO_NESTED_CLASS_SIZE,
74 MONO_GENERICPARAM_SIZE, /* 0x2A */
76 MONO_GENPARCONSTRAINT_SIZE
80 // The dynamic images list is only needed to support the mempool reference tracking feature in checked-build.
81 static GPtrArray *dynamic_images;
82 static mono_mutex_t dynamic_images_mutex;
85 dynamic_images_lock (void)
87 mono_os_mutex_lock (&dynamic_images_mutex);
91 dynamic_images_unlock (void)
93 mono_os_mutex_unlock (&dynamic_images_mutex);
97 mono_dynamic_images_init (void)
99 mono_os_mutex_init (&dynamic_images_mutex);
102 #ifndef DISABLE_REFLECTION_EMIT
104 string_heap_init (MonoDynamicStream *sh)
106 mono_dynstream_init (sh);
110 #ifndef DISABLE_REFLECTION_EMIT
112 mono_blob_entry_hash (const char* str)
114 MONO_REQ_GC_NEUTRAL_MODE;
118 len = mono_metadata_decode_blob_size (str, &str);
122 for (str += 1; str < end; str++)
123 h = (h << 5) - h + *str;
131 mono_blob_entry_equal (const char *str1, const char *str2) {
132 MONO_REQ_GC_NEUTRAL_MODE;
137 len = mono_metadata_decode_blob_size (str1, &end1);
138 len2 = mono_metadata_decode_blob_size (str2, &end2);
141 return memcmp (end1, end2, len) == 0;
147 * mono_find_dynamic_image_owner:
149 * Find the dynamic image, if any, which a given pointer is located in the memory of.
152 mono_find_dynamic_image_owner (void *ptr)
154 MonoImage *owner = NULL;
157 dynamic_images_lock ();
161 for (i = 0; !owner && i < dynamic_images->len; ++i) {
162 MonoImage *image = (MonoImage *)g_ptr_array_index (dynamic_images, i);
163 if (mono_mempool_contains_addr (image->mempool, ptr))
168 dynamic_images_unlock ();
174 dynamic_image_lock (MonoDynamicImage *image)
177 mono_image_lock ((MonoImage*)image);
182 dynamic_image_unlock (MonoDynamicImage *image)
184 mono_image_unlock ((MonoImage*)image);
187 #ifndef DISABLE_REFLECTION_INIT
189 * mono_dynamic_image_register_token:
191 * Register the TOKEN->OBJ mapping in the mapping table in ASSEMBLY. This is required for
192 * the Module.ResolveXXXToken () methods to work.
195 mono_dynamic_image_register_token (MonoDynamicImage *assembly, guint32 token, MonoObjectHandle obj)
197 MONO_REQ_GC_UNSAFE_MODE;
199 dynamic_image_lock (assembly);
200 mono_g_hash_table_insert (assembly->tokens, GUINT_TO_POINTER (token), MONO_HANDLE_RAW (obj));
201 dynamic_image_unlock (assembly);
205 mono_dynamic_image_register_token (MonoDynamicImage *assembly, guint32 token, MonoObjectHandle obj)
211 lookup_dyn_token (MonoDynamicImage *assembly, guint32 token)
213 MONO_REQ_GC_UNSAFE_MODE;
217 dynamic_image_lock (assembly);
218 obj = (MonoObject *)mono_g_hash_table_lookup (assembly->tokens, GUINT_TO_POINTER (token));
219 dynamic_image_unlock (assembly);
226 * mono_dynamic_image_is_valid_token:
228 * Returns TRUE if token is valid in the given image.
232 mono_dynamic_image_is_valid_token (MonoDynamicImage *image, guint32 token)
234 return lookup_dyn_token (image, token) != NULL;
237 #ifndef DISABLE_REFLECTION_EMIT
239 #endif /* DISABLE_REFLECTION_EMIT */
241 #ifndef DISABLE_REFLECTION_EMIT
243 * mono_reflection_lookup_dynamic_token:
245 * Finish the Builder object pointed to by TOKEN and return the corresponding
246 * runtime structure. If HANDLE_CLASS is not NULL, it is set to the class required by
247 * mono_ldtoken. If valid_token is TRUE, assert if it is not found in the token->object
250 * LOCKING: Take the loader lock
253 mono_reflection_lookup_dynamic_token (MonoImage *image, guint32 token, gboolean valid_token, MonoClass **handle_class, MonoGenericContext *context, MonoError *error)
255 MonoDynamicImage *assembly = (MonoDynamicImage*)image;
259 mono_error_init (error);
261 obj = lookup_dyn_token (assembly, token);
264 g_error ("Could not find required dynamic token 0x%08x", token);
266 mono_error_set_execution_engine (error, "Could not find dynamic token 0x%08x", token);
272 handle_class = &klass;
273 gpointer result = mono_reflection_resolve_object (image, obj, handle_class, context, error);
276 #else /* DISABLE_REFLECTION_EMIT */
278 mono_reflection_lookup_dynamic_token (MonoImage *image, guint32 token, gboolean valid_token, MonoClass **handle_class, MonoGenericContext *context, MonoError *error)
280 mono_error_init (error);
283 #endif /* DISABLE_REFLECTION_EMIT */
285 #ifndef DISABLE_REFLECTION_EMIT
287 mono_dynamic_image_create (MonoDynamicAssembly *assembly, char *assembly_name, char *module_name)
289 static const guchar entrycode [16] = {0xff, 0x25, 0};
290 MonoDynamicImage *image;
295 if (!strcmp (mono_get_runtime_info ()->framework_version, "2.1"))
296 version = "v2.0.50727"; /* HACK: SL 2 enforces the .net 2 metadata version */
298 version = mono_get_runtime_info ()->runtime_version;
301 /* The MonoGHashTable's need GC tracking */
302 image = (MonoDynamicImage *)GC_MALLOC (sizeof (MonoDynamicImage));
304 image = g_new0 (MonoDynamicImage, 1);
307 mono_profiler_module_event (&image->image, MONO_PROFILE_START_LOAD);
309 /*g_print ("created image %p\n", image);*/
310 /* keep in sync with image.c */
311 image->image.name = assembly_name;
312 image->image.assembly_name = image->image.name; /* they may be different */
313 image->image.module_name = module_name;
314 image->image.version = g_strdup (version);
315 image->image.md_version_major = 1;
316 image->image.md_version_minor = 1;
317 image->image.dynamic = TRUE;
319 image->image.references = g_new0 (MonoAssembly*, 1);
320 image->image.references [0] = NULL;
322 mono_image_init (&image->image);
324 image->token_fixups = mono_g_hash_table_new_type ((GHashFunc)mono_object_hash, NULL, MONO_HASH_KEY_GC, MONO_ROOT_SOURCE_REFLECTION, "dynamic module token fixups table");
325 image->method_to_table_idx = g_hash_table_new (NULL, NULL);
326 image->field_to_table_idx = g_hash_table_new (NULL, NULL);
327 image->method_aux_hash = g_hash_table_new (NULL, NULL);
328 image->vararg_aux_hash = g_hash_table_new (NULL, NULL);
329 image->handleref = g_hash_table_new (NULL, NULL);
330 image->handleref_managed = mono_g_hash_table_new_type ((GHashFunc)mono_object_hash, NULL, MONO_HASH_KEY_GC, MONO_ROOT_SOURCE_REFLECTION, "dynamic module reference-to-token table");
331 image->tokens = mono_g_hash_table_new_type (NULL, NULL, MONO_HASH_VALUE_GC, MONO_ROOT_SOURCE_REFLECTION, "dynamic module tokens table");
332 image->generic_def_objects = mono_g_hash_table_new_type (NULL, NULL, MONO_HASH_VALUE_GC, MONO_ROOT_SOURCE_REFLECTION, "dynamic module generic definitions table");
333 image->typespec = g_hash_table_new ((GHashFunc)mono_metadata_type_hash, (GCompareFunc)mono_metadata_type_equal);
334 image->typeref = g_hash_table_new ((GHashFunc)mono_metadata_type_hash, (GCompareFunc)mono_metadata_type_equal);
335 image->blob_cache = g_hash_table_new ((GHashFunc)mono_blob_entry_hash, (GCompareFunc)mono_blob_entry_equal);
336 image->gen_params = g_ptr_array_new ();
337 image->remapped_tokens = mono_g_hash_table_new_type (NULL, NULL, MONO_HASH_VALUE_GC, MONO_ROOT_SOURCE_REFLECTION, "dynamic module remapped tokens table");
339 /*g_print ("string heap create for image %p (%s)\n", image, module_name);*/
340 string_heap_init (&image->sheap);
341 mono_dynstream_add_data (&image->us, "", 1);
342 mono_dynamic_image_add_to_blob_cached (image, (char*) "", 1, NULL, 0);
343 /* import tables... */
344 mono_dynstream_add_data (&image->code, (char*)entrycode, sizeof (entrycode));
345 image->iat_offset = mono_dynstream_add_zero (&image->code, 8); /* two IAT entries */
346 image->idt_offset = mono_dynstream_add_zero (&image->code, 2 * sizeof (MonoIDT)); /* two IDT entries */
347 image->imp_names_offset = mono_dynstream_add_zero (&image->code, 2); /* flags for name entry */
348 mono_dynstream_add_data (&image->code, "_CorExeMain", 12);
349 mono_dynstream_add_data (&image->code, "mscoree.dll", 12);
350 image->ilt_offset = mono_dynstream_add_zero (&image->code, 8); /* two ILT entries */
351 mono_dynstream_data_align (&image->code);
353 image->cli_header_offset = mono_dynstream_add_zero (&image->code, sizeof (MonoCLIHeader));
355 for (i=0; i < MONO_TABLE_NUM; ++i) {
356 image->tables [i].next_idx = 1;
357 image->tables [i].columns = table_sizes [i];
360 image->image.assembly = (MonoAssembly*)assembly;
361 image->run = assembly->run;
362 image->save = assembly->save;
363 image->pe_kind = 0x1; /* ILOnly */
364 image->machine = 0x14c; /* I386 */
366 mono_profiler_module_loaded (&image->image, MONO_PROFILE_OK);
368 dynamic_images_lock ();
371 dynamic_images = g_ptr_array_new ();
373 g_ptr_array_add (dynamic_images, image);
375 dynamic_images_unlock ();
379 #else /* DISABLE_REFLECTION_EMIT */
381 mono_dynamic_image_create (MonoDynamicAssembly *assembly, char *assembly_name, char *module_name)
383 g_assert_not_reached ();
386 #endif /* DISABLE_REFLECTION_EMIT */
389 mono_dynamic_image_add_to_blob_cached (MonoDynamicImage *assembly, char *b1, int s1, char *b2, int s2)
391 MONO_REQ_GC_NEUTRAL_MODE;
395 gpointer oldkey, oldval;
397 copy = (char *)g_malloc (s1+s2);
398 memcpy (copy, b1, s1);
399 memcpy (copy + s1, b2, s2);
400 if (g_hash_table_lookup_extended (assembly->blob_cache, copy, &oldkey, &oldval)) {
402 idx = GPOINTER_TO_UINT (oldval);
404 idx = mono_dynstream_add_data (&assembly->blob, b1, s1);
405 mono_dynstream_add_data (&assembly->blob, b2, s2);
406 g_hash_table_insert (assembly->blob_cache, copy, GUINT_TO_POINTER (idx));
412 mono_dynimage_alloc_table (MonoDynamicTable *table, guint nrows)
414 MONO_REQ_GC_NEUTRAL_MODE;
417 g_assert (table->columns);
418 if (nrows + 1 >= table->alloc_rows) {
419 while (nrows + 1 >= table->alloc_rows) {
420 if (table->alloc_rows == 0)
421 table->alloc_rows = 16;
423 table->alloc_rows *= 2;
426 table->values = (guint32 *)g_renew (guint32, table->values, (table->alloc_rows) * table->columns);
432 free_blob_cache_entry (gpointer key, gpointer val, gpointer user_data)
438 release_hashtable (MonoGHashTable **hash)
441 mono_g_hash_table_destroy (*hash);
447 mono_dynamic_image_release_gc_roots (MonoDynamicImage *image)
449 release_hashtable (&image->token_fixups);
450 release_hashtable (&image->handleref_managed);
451 release_hashtable (&image->tokens);
452 release_hashtable (&image->remapped_tokens);
453 release_hashtable (&image->generic_def_objects);
456 // Free dynamic image pass one: Free resources but not image itself
458 mono_dynamic_image_free (MonoDynamicImage *image)
460 MonoDynamicImage *di = image;
465 g_hash_table_destroy (di->typespec);
467 g_hash_table_destroy (di->typeref);
469 g_hash_table_destroy (di->handleref);
470 if (di->handleref_managed)
471 mono_g_hash_table_destroy (di->handleref_managed);
473 mono_g_hash_table_destroy (di->tokens);
474 if (di->remapped_tokens)
475 mono_g_hash_table_destroy (di->remapped_tokens);
476 if (di->generic_def_objects)
477 mono_g_hash_table_destroy (di->generic_def_objects);
478 if (di->blob_cache) {
479 g_hash_table_foreach (di->blob_cache, free_blob_cache_entry, NULL);
480 g_hash_table_destroy (di->blob_cache);
482 if (di->standalonesig_cache)
483 g_hash_table_destroy (di->standalonesig_cache);
484 for (list = di->array_methods; list; list = list->next) {
485 ArrayMethod *am = (ArrayMethod *)list->data;
486 mono_sre_array_method_free (am);
488 g_list_free (di->array_methods);
489 if (di->gen_params) {
490 for (i = 0; i < di->gen_params->len; i++) {
491 GenericParamTableEntry *entry = (GenericParamTableEntry *)g_ptr_array_index (di->gen_params, i);
492 mono_sre_generic_param_table_entry_free (entry);
494 g_ptr_array_free (di->gen_params, TRUE);
496 if (di->token_fixups)
497 mono_g_hash_table_destroy (di->token_fixups);
498 if (di->method_to_table_idx)
499 g_hash_table_destroy (di->method_to_table_idx);
500 if (di->field_to_table_idx)
501 g_hash_table_destroy (di->field_to_table_idx);
502 if (di->method_aux_hash)
503 g_hash_table_destroy (di->method_aux_hash);
504 if (di->vararg_aux_hash)
505 g_hash_table_destroy (di->vararg_aux_hash);
506 g_free (di->strong_name);
507 g_free (di->win32_res);
509 g_free (di->public_key);
511 /*g_print ("string heap destroy for image %p\n", di);*/
512 mono_dynamic_stream_reset (&di->sheap);
513 mono_dynamic_stream_reset (&di->code);
514 mono_dynamic_stream_reset (&di->resources);
515 mono_dynamic_stream_reset (&di->us);
516 mono_dynamic_stream_reset (&di->blob);
517 mono_dynamic_stream_reset (&di->tstream);
518 mono_dynamic_stream_reset (&di->guid);
519 for (i = 0; i < MONO_TABLE_NUM; ++i) {
520 g_free (di->tables [i].values);
523 dynamic_images_lock ();
526 g_ptr_array_remove (dynamic_images, di);
528 dynamic_images_unlock ();
531 // Free dynamic image pass two: Free image itself (might never get called in some debug modes)
533 mono_dynamic_image_free_image (MonoDynamicImage *image)
535 /* See create_dynamic_mono_image () */
537 /* Allocated using GC_MALLOC */