2 * Appdomain-related internal data structures and functions.
3 * Copyright 2012 Xamarin Inc (http://www.xamarin.com)
5 #ifndef __MONO_METADATA_DOMAIN_INTERNALS_H__
6 #define __MONO_METADATA_DOMAIN_INTERNALS_H__
8 #include <mono/metadata/appdomain.h>
9 #include <mono/metadata/mempool.h>
10 #include <mono/metadata/lock-tracer.h>
11 #include <mono/utils/mono-codeman.h>
12 #include <mono/utils/mono-mutex.h>
13 #include <mono/metadata/mono-hash.h>
14 #include <mono/utils/mono-compiler.h>
15 #include <mono/utils/mono-internal-hash.h>
16 #include <mono/io-layer/io-layer.h>
17 #include <mono/metadata/mempool-internals.h>
20 extern mono_mutex_t mono_delegate_section;
21 extern mono_mutex_t mono_strtod_mutex;
24 * If this is set, the memory belonging to appdomains is not freed when a domain is
25 * unloaded, and assemblies loaded by the appdomain are not unloaded either. This
26 * allows us to use typed gc in non-default appdomains too, leading to increased
29 extern gboolean mono_dont_free_domains;
31 /* This is a copy of System.AppDomainSetup */
34 MonoString *application_base;
35 MonoString *application_name;
36 MonoString *cache_path;
37 MonoString *configuration_file;
38 MonoString *dynamic_base;
39 MonoString *license_file;
40 MonoString *private_bin_path;
41 MonoString *private_bin_path_probe;
42 MonoString *shadow_copy_directories;
43 MonoString *shadow_copy_files;
44 MonoBoolean publisher_policy;
45 MonoBoolean path_changed;
46 int loader_optimization;
47 MonoBoolean disallow_binding_redirects;
48 MonoBoolean disallow_code_downloads;
49 MonoObject *activation_arguments; /* it is System.Object in 1.x, ActivationArguments in 2.0 */
50 MonoObject *domain_initializer;
51 MonoObject *application_trust; /* it is System.Object in 1.x, ApplicationTrust in 2.0 */
52 MonoArray *domain_initializer_args;
53 MonoBoolean disallow_appbase_probe;
54 MonoArray *configuration_bytes;
55 MonoArray *serialized_non_primitives;
58 typedef struct _MonoJitInfoTable MonoJitInfoTable;
59 typedef struct _MonoJitInfoTableChunk MonoJitInfoTableChunk;
61 #define MONO_JIT_INFO_TABLE_CHUNK_SIZE 64
63 struct _MonoJitInfoTableChunk
66 volatile int num_elements;
67 volatile gint8 *last_code_end;
68 MonoJitInfo * volatile data [MONO_JIT_INFO_TABLE_CHUNK_SIZE];
71 struct _MonoJitInfoTable
75 MonoJitInfoTableChunk *chunks [MONO_ZERO_LEN_ARRAY];
78 #define MONO_SIZEOF_JIT_INFO_TABLE (sizeof (struct _MonoJitInfoTable) - MONO_ZERO_LEN_ARRAY * SIZEOF_VOID_P)
80 typedef GArray MonoAotModuleInfoTable;
87 gpointer handler_start;
89 * For LLVM compiled code, this is the index of the il clause
90 * associated with this handler.
94 MonoClass *catch_class;
98 } MonoJitExceptionInfo;
101 * Contains information about the type arguments for generic shared methods.
105 * If not NULL, determines whenever the class type arguments of the gshared method are references or vtypes.
106 * The array length is equal to class_inst->type_argv.
109 /* Same for method type parameters */
110 gboolean *mvar_is_vt;
111 } MonoGenericSharingContext;
113 /* Simplified DWARF location list entry */
115 /* Whenever the value is in a register */
118 * If is_reg is TRUE, the register which contains the value. Otherwise
123 * If is_reg is FALSE, the offset of the stack location relative to 'reg'.
128 * Offsets of the PC interval where the value is in this location.
131 } MonoDwarfLocListEntry;
135 MonoGenericSharingContext *generic_sharing_context;
137 MonoDwarfLocListEntry *locations;
141 gboolean this_in_reg:1;
142 } MonoGenericJitInfo;
145 A try block hole is used to represent a non-contiguous part of
146 of a segment of native code protected by a given .try block.
147 Usually, a try block is defined as a contiguous segment of code.
148 But in some cases it's needed to have some parts of it to not be protected.
149 For example, given "try {} finally {}", the code in the .try block to call
150 the finally part looks like:
156 jump outside try block
162 The instructions between the call and the jump should not be under the try block since they happen
163 after the finally block executes, which means if an async exceptions happens at that point we would
164 execute the finally clause twice. So, to avoid this, we introduce a hole in the try block to signal
165 that those instructions are not protected.
172 } MonoTryBlockHoleJitInfo;
177 MonoTryBlockHoleJitInfo holes [MONO_ZERO_LEN_ARRAY];
178 } MonoTryBlockHoleTableJitInfo;
187 /* Relative to code_start */
194 JIT_INFO_HAS_GENERIC_JIT_INFO = (1 << 0),
195 JIT_INFO_HAS_TRY_BLOCK_HOLES = (1 << 1),
196 JIT_INFO_HAS_ARCH_EH_INFO = (1 << 2),
197 JIT_INFO_HAS_THUNK_INFO = (1 << 3)
200 struct _MonoJitInfo {
201 /* NOTE: These first two elements (method and
202 next_jit_code_hash) must be in the same order and at the
203 same offset as in RuntimeMethod, because of the jit_code_hash
204 internal hash table in MonoDomain. */
211 struct _MonoJitInfo *next_jit_code_hash;
215 guint32 num_clauses:15;
216 /* Whenever the code is domain neutral or 'shared' */
217 gboolean domain_neutral:1;
218 gboolean has_generic_jit_info:1;
219 gboolean has_try_block_holes:1;
220 gboolean has_arch_eh_info:1;
221 gboolean has_thunk_info:1;
223 gboolean from_llvm:1;
224 gboolean dbg_attrs_inited:1;
225 gboolean dbg_hidden:1;
226 /* Whenever this jit info was loaded in async context */
228 gboolean dbg_step_through:1;
229 gboolean dbg_non_user_code:1;
231 * Whenever this jit info refers to a trampoline.
232 * d.tramp_info contains additional data in this case.
234 gboolean is_trampoline:1;
236 /* FIXME: Embed this after the structure later*/
237 gpointer gc_info; /* Currently only used by SGen */
239 MonoJitExceptionInfo clauses [MONO_ZERO_LEN_ARRAY];
240 /* There is an optional MonoGenericJitInfo after the clauses */
241 /* There is an optional MonoTryBlockHoleTableJitInfo after MonoGenericJitInfo clauses*/
242 /* There is an optional MonoArchEHJitInfo after MonoTryBlockHoleTableJitInfo */
243 /* There is an optional MonoThunkJitInfo after MonoArchEHJitInfo */
246 #define MONO_SIZEOF_JIT_INFO (offsetof (struct _MonoJitInfo, clauses))
248 struct _MonoAppContext {
252 gpointer *static_data;
255 /* Lock-free allocator */
260 } LockFreeMempoolChunk;
263 LockFreeMempoolChunk *current, *chunks;
267 * We have two unloading states because the domain
268 * must remain fully functional while AppDomain::DomainUnload is
270 * After that unloading began and all domain facilities are teared down
271 * such as execution of new threadpool jobs.
274 MONO_APPDOMAIN_CREATED,
275 MONO_APPDOMAIN_UNLOADING_START,
276 MONO_APPDOMAIN_UNLOADING,
277 MONO_APPDOMAIN_UNLOADED
278 } MonoAppDomainState;
280 typedef struct _MonoThunkFreeList {
282 int length; /* only valid for the wait list */
283 struct _MonoThunkFreeList *next;
286 typedef struct _MonoJitCodeHash MonoJitCodeHash;
288 typedef struct _MonoTlsDataRecord MonoTlsDataRecord;
289 struct _MonoTlsDataRecord {
290 MonoTlsDataRecord *next;
297 * This lock must never be taken before the loader lock,
298 * i.e. if both are taken by the same thread, the loader lock
303 MonoCodeManager *code_mp;
305 * keep all the managed objects close to each other for the precise GC
306 * For the Boehm GC we additionally keep close also other GC-tracked pointers.
308 #define MONO_DOMAIN_FIRST_OBJECT setup
309 MonoAppDomainSetup *setup;
310 MonoAppDomain *domain;
311 MonoAppContext *default_context;
312 MonoException *out_of_memory_ex;
313 MonoException *null_reference_ex;
314 MonoException *stack_overflow_ex;
316 MonoObject *typeof_void;
317 /* Ephemeron Tombstone*/
318 MonoObject *ephemeron_tombstone;
319 /* new MonoType [0] */
320 MonoArray *empty_types;
322 * The fields between FIRST_GC_TRACKED and LAST_GC_TRACKED are roots, but
323 * not object references.
325 #define MONO_DOMAIN_FIRST_GC_TRACKED env
327 MonoGHashTable *ldstr_table;
328 /* hashtables for Reflection handles */
329 MonoGHashTable *type_hash;
330 MonoGHashTable *refobject_hash;
331 /* a GC-tracked array to keep references to the static fields of types */
332 gpointer *static_data_array;
333 /* maps class -> type initialization exception object */
334 MonoGHashTable *type_init_exception_hash;
335 /* maps delegate trampoline addr -> delegate object */
336 MonoGHashTable *delegate_hash_table;
337 #define MONO_DOMAIN_LAST_GC_TRACKED delegate_hash_table
339 /* Needed by Thread:GetDomainID() */
341 gint32 shadow_serial;
342 unsigned char inet_family_hint; // used in socket-io.c as a cache
343 GSList *domain_assemblies;
344 MonoAssembly *entry_assembly;
346 GPtrArray *class_vtable_array;
347 /* maps remote class key -> MonoRemoteClass */
348 GHashTable *proxy_vtable_hash;
349 /* Protected by 'jit_code_hash_lock' */
350 MonoInternalHashTable jit_code_hash;
351 mono_mutex_t jit_code_hash_lock;
352 int num_jit_info_tables;
354 volatile jit_info_table;
356 * Contains information about AOT loaded code.
357 * Only used in the root domain.
360 volatile aot_modules;
361 GSList *jit_info_free_queue;
362 /* Used when loading assemblies */
364 gchar *private_bin_path;
365 LockFreeMempool *lock_free_mp;
367 /* Used by remoting proxies */
368 MonoMethod *create_proxy_for_type_method;
369 MonoMethod *private_invoke_method;
370 /* Used to store offsets of thread and context static fields */
371 GHashTable *special_static_fields;
372 MonoTlsDataRecord *tlsrec_list;
374 * This must be a GHashTable, since these objects can't be finalized
375 * if the hashtable contains a GC visible reference to them.
377 GHashTable *finalizable_objects_hash;
379 /* Protects the three hashes above */
380 mono_mutex_t finalizable_objects_hash_lock;
381 /* Used when accessing 'domain_assemblies' */
382 mono_mutex_t assemblies_lock;
384 GHashTable *method_rgctx_hash;
386 GHashTable *generic_virtual_cases;
387 MonoThunkFreeList **thunk_free_lists;
389 GHashTable *generic_virtual_thunks;
391 /* Information maintained by the JIT engine */
392 gpointer runtime_info;
394 /*thread pool jobs, used to coordinate shutdown.*/
395 volatile int threadpool_jobs;
396 HANDLE cleanup_semaphore;
398 /* Contains the compiled runtime invoke wrapper used by finalizers */
399 gpointer finalize_runtime_invoke;
401 /* Contains the compiled runtime invoke wrapper used by async resylt creation to capture thread context*/
402 gpointer capture_context_runtime_invoke;
404 /* Contains the compiled method used by async resylt creation to capture thread context*/
405 gpointer capture_context_method;
407 /* Assembly bindings, the per-domain part */
408 GSList *assembly_bindings;
409 gboolean assembly_bindings_parsed;
411 /* Used by socket-io.c */
412 /* These are domain specific, since the assembly can be unloaded */
413 MonoImage *socket_assembly;
414 MonoClass *sockaddr_class;
415 MonoClassField *sockaddr_data_field;
417 /* Used by threadpool.c */
418 MonoImage *system_image;
419 MonoClass *corlib_asyncresult_class;
420 MonoClass *socket_class;
421 MonoClass *ad_unloaded_ex_class;
422 MonoClass *process_class;
424 /* Cache function pointers for architectures */
425 /* that require wrappers */
426 GHashTable *ftnptrs_hash;
428 guint32 execution_context_field_offset;
432 guint16 major, minor, build, revision;
433 } AssemblyVersionSet;
435 /* MonoRuntimeInfo: Contains information about versions supported by this runtime */
437 const char runtime_version [12];
438 const char framework_version [4];
439 const AssemblyVersionSet version_sets [4];
442 #define mono_domain_assemblies_lock(domain) mono_locks_acquire(&(domain)->assemblies_lock, DomainAssembliesLock)
443 #define mono_domain_assemblies_unlock(domain) mono_locks_release(&(domain)->assemblies_lock, DomainAssembliesLock)
444 #define mono_domain_jit_code_hash_lock(domain) mono_locks_acquire(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
445 #define mono_domain_jit_code_hash_unlock(domain) mono_locks_release(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
447 typedef MonoDomain* (*MonoLoadFunc) (const char *filename, const char *runtime_version);
449 void mono_domain_lock (MonoDomain *domain);
450 void mono_domain_unlock (MonoDomain *domain);
453 mono_install_runtime_load (MonoLoadFunc func);
456 mono_runtime_load (const char *filename, const char *runtime_version);
458 typedef void (*MonoCreateDomainFunc) (MonoDomain *domain);
461 mono_install_create_domain_hook (MonoCreateDomainFunc func);
463 typedef void (*MonoFreeDomainFunc) (MonoDomain *domain);
466 mono_install_free_domain_hook (MonoFreeDomainFunc func);
472 mono_close_exe_image (void);
475 mono_jit_info_size (MonoJitInfoFlags flags, int num_clauses, int num_holes);
478 mono_jit_info_init (MonoJitInfo *ji, MonoMethod *method, guint8 *code, int code_size,
479 MonoJitInfoFlags flags, int num_clauses, int num_holes);
482 mono_jit_info_table_new (MonoDomain *domain);
485 mono_jit_info_table_free (MonoJitInfoTable *table);
488 mono_jit_info_table_add (MonoDomain *domain, MonoJitInfo *ji);
491 mono_jit_info_table_remove (MonoDomain *domain, MonoJitInfo *ji);
494 mono_jit_info_add_aot_module (MonoImage *image, gpointer start, gpointer end);
497 mono_jit_info_get_generic_jit_info (MonoJitInfo *ji);
499 MonoGenericSharingContext*
500 mono_jit_info_get_generic_sharing_context (MonoJitInfo *ji);
503 mono_jit_info_set_generic_sharing_context (MonoJitInfo *ji, MonoGenericSharingContext *gsctx);
506 mono_make_shadow_copy (const char *filename);
509 mono_is_shadow_copy_enabled (MonoDomain *domain, const gchar *dir_name);
512 mono_domain_alloc (MonoDomain *domain, guint size);
515 mono_domain_alloc0 (MonoDomain *domain, guint size);
518 mono_domain_alloc0_lock_free (MonoDomain *domain, guint size);
521 mono_domain_code_reserve (MonoDomain *domain, int size) MONO_LLVM_INTERNAL;
524 mono_domain_code_reserve_align (MonoDomain *domain, int size, int alignment);
527 mono_domain_code_commit (MonoDomain *domain, void *data, int size, int newsize);
530 nacl_domain_get_code_dest (MonoDomain *domain, void *data);
533 nacl_domain_code_validate (MonoDomain *domain, guint8 **buf_base, int buf_size, guint8 **code_end);
536 mono_domain_code_foreach (MonoDomain *domain, MonoCodeManagerFunc func, void *user_data);
539 mono_domain_unset (void);
542 mono_domain_set_internal_with_options (MonoDomain *domain, gboolean migrate_exception);
544 MonoTryBlockHoleTableJitInfo*
545 mono_jit_info_get_try_block_hole_table_info (MonoJitInfo *ji);
548 mono_jit_info_get_arch_eh_info (MonoJitInfo *ji);
551 mono_jit_info_get_thunk_info (MonoJitInfo *ji);
554 * Installs a new function which is used to return a MonoJitInfo for a method inside
557 typedef MonoJitInfo *(*MonoJitInfoFindInAot) (MonoDomain *domain, MonoImage *image, gpointer addr);
558 void mono_install_jit_info_find_in_aot (MonoJitInfoFindInAot func);
561 mono_jit_code_hash_init (MonoInternalHashTable *jit_code_hash);
564 ves_icall_System_AppDomain_getCurDomain (void);
567 ves_icall_System_AppDomain_getRootDomain (void);
570 ves_icall_System_AppDomain_createDomain (MonoString *friendly_name,
571 MonoAppDomainSetup *setup);
574 ves_icall_System_AppDomain_GetData (MonoAppDomain *ad,
577 MonoReflectionAssembly *
578 ves_icall_System_AppDomain_LoadAssemblyRaw (MonoAppDomain *ad,
579 MonoArray *raw_assembly,
580 MonoArray *raw_symbol_store,
581 MonoObject *evidence,
582 MonoBoolean refonly);
585 ves_icall_System_AppDomain_SetData (MonoAppDomain *ad,
590 ves_icall_System_AppDomain_getSetup (MonoAppDomain *ad);
593 ves_icall_System_AppDomain_getFriendlyName (MonoAppDomain *ad);
596 ves_icall_System_AppDomain_GetAssemblies (MonoAppDomain *ad,
597 MonoBoolean refonly);
599 MonoReflectionAssembly *
600 ves_icall_System_Reflection_Assembly_LoadFrom (MonoString *fname,
601 MonoBoolean refonly);
603 MonoReflectionAssembly *
604 ves_icall_System_AppDomain_LoadAssembly (MonoAppDomain *ad,
606 MonoObject *evidence,
607 MonoBoolean refonly);
610 ves_icall_System_AppDomain_InternalIsFinalizingForUnload (gint32 domain_id);
613 ves_icall_System_AppDomain_InternalUnload (gint32 domain_id);
616 ves_icall_System_AppDomain_ExecuteAssembly (MonoAppDomain *ad,
617 MonoReflectionAssembly *refass,
621 ves_icall_System_AppDomain_InternalSetDomain (MonoAppDomain *ad);
624 ves_icall_System_AppDomain_InternalSetDomainByID (gint32 domainid);
627 ves_icall_System_AppDomain_InternalPushDomainRef (MonoAppDomain *ad);
630 ves_icall_System_AppDomain_InternalPushDomainRefByID (gint32 domain_id);
633 ves_icall_System_AppDomain_InternalPopDomainRef (void);
636 ves_icall_System_AppDomain_InternalGetContext (void);
639 ves_icall_System_AppDomain_InternalGetDefaultContext (void);
642 ves_icall_System_AppDomain_InternalSetContext (MonoAppContext *mc);
645 ves_icall_System_AppDomain_GetIDFromDomain (MonoAppDomain * ad);
648 ves_icall_System_AppDomain_InternalGetProcessGuid (MonoString* newguid);
651 mono_assembly_load_corlib (const MonoRuntimeInfo *runtime, MonoImageOpenStatus *status);
653 const MonoRuntimeInfo*
654 mono_get_runtime_info (void);
657 mono_runtime_set_no_exec (gboolean val);
660 mono_runtime_get_no_exec (void);
663 mono_assembly_name_parse (const char *name, MonoAssemblyName *aname);
665 MonoImage *mono_assembly_open_from_bundle (const char *filename,
666 MonoImageOpenStatus *status,
670 mono_domain_add_class_static_data (MonoDomain *domain, MonoClass *klass, gpointer data, guint32 *bitmap);
672 MonoReflectionAssembly *
673 mono_try_assembly_resolve (MonoDomain *domain, MonoString *fname, MonoAssembly *requesting, gboolean refonly);
676 mono_domain_assembly_postload_search (MonoAssemblyName *aname, MonoAssembly *requesting, gboolean refonly);
678 MonoAssembly* mono_assembly_load_full_nosearch (MonoAssemblyName *aname,
680 MonoImageOpenStatus *status,
683 void mono_set_private_bin_path_from_config (MonoDomain *domain);
685 int mono_framework_version (void);
687 void mono_reflection_cleanup_domain (MonoDomain *domain);
689 void mono_assembly_cleanup_domain_bindings (guint32 domain_id);
691 MonoJitInfo* mono_jit_info_table_find_internal (MonoDomain *domain, char *addr, gboolean try_aot, gboolean allow_trampolines);
693 void mono_enable_debug_domain_unload (gboolean enable);
695 #endif /* __MONO_METADATA_DOMAIN_INTERNALS_H__ */