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 MonoClass *catch_class;
93 } MonoJitExceptionInfo;
96 * Contains information about the type arguments for generic shared methods.
100 * If not NULL, determines whenever the class type arguments of the gshared method are references or vtypes.
101 * The array length is equal to class_inst->type_argv.
104 /* Same for method type parameters */
105 gboolean *mvar_is_vt;
106 } MonoGenericSharingContext;
108 /* Simplified DWARF location list entry */
110 /* Whenever the value is in a register */
113 * If is_reg is TRUE, the register which contains the value. Otherwise
118 * If is_reg is FALSE, the offset of the stack location relative to 'reg'.
123 * Offsets of the PC interval where the value is in this location.
126 } MonoDwarfLocListEntry;
130 MonoGenericSharingContext *generic_sharing_context;
132 MonoDwarfLocListEntry *locations;
136 gboolean this_in_reg:1;
137 } MonoGenericJitInfo;
140 A try block hole is used to represent a non-contiguous part of
141 of a segment of native code protected by a given .try block.
142 Usually, a try block is defined as a contiguous segment of code.
143 But in some cases it's needed to have some parts of it to not be protected.
144 For example, given "try {} finally {}", the code in the .try block to call
145 the finally part looks like:
151 jump outside try block
157 The instructions between the call and the jump should not be under the try block since they happen
158 after the finally block executes, which means if an async exceptions happens at that point we would
159 execute the finally clause twice. So, to avoid this, we introduce a hole in the try block to signal
160 that those instructions are not protected.
167 } MonoTryBlockHoleJitInfo;
172 MonoTryBlockHoleJitInfo holes [MONO_ZERO_LEN_ARRAY];
173 } MonoTryBlockHoleTableJitInfo;
182 gboolean cas_inited:1;
183 gboolean cas_class_assert:1;
184 gboolean cas_class_deny:1;
185 gboolean cas_class_permitonly:1;
186 gboolean cas_method_assert:1;
187 gboolean cas_method_deny:1;
188 gboolean cas_method_permitonly:1;
193 JIT_INFO_HAS_CAS_INFO = (1 << 0),
194 JIT_INFO_HAS_GENERIC_JIT_INFO = (1 << 1),
195 JIT_INFO_HAS_TRY_BLOCK_HOLES = (1 << 2),
196 JIT_INFO_HAS_ARCH_EH_INFO = (1 << 3)
199 struct _MonoJitInfo {
200 /* NOTE: These first two elements (method and
201 next_jit_code_hash) must be in the same order and at the
202 same offset as in RuntimeMethod, because of the jit_code_hash
203 internal hash table in MonoDomain. */
209 struct _MonoJitInfo *next_jit_code_hash;
213 guint32 num_clauses:15;
214 /* Whenever the code is domain neutral or 'shared' */
215 gboolean domain_neutral:1;
216 gboolean has_cas_info:1;
217 gboolean has_generic_jit_info:1;
218 gboolean has_try_block_holes:1;
219 gboolean has_arch_eh_info:1;
221 gboolean from_llvm:1;
222 gboolean dbg_attrs_inited:1;
223 gboolean dbg_hidden:1;
224 /* Whenever this jit info was loaded in async context */
226 gboolean dbg_step_through:1;
227 gboolean dbg_non_user_code:1;
229 /* FIXME: Embed this after the structure later*/
230 gpointer gc_info; /* Currently only used by SGen */
232 MonoJitExceptionInfo clauses [MONO_ZERO_LEN_ARRAY];
233 /* There is an optional MonoGenericJitInfo after the clauses */
234 /* There is an optional MonoTryBlockHoleTableJitInfo after MonoGenericJitInfo clauses*/
235 /* There is an optional MonoArchEHJitInfo after MonoTryBlockHoleTableJitInfo */
238 #define MONO_SIZEOF_JIT_INFO (offsetof (struct _MonoJitInfo, clauses))
240 struct _MonoAppContext {
244 gpointer *static_data;
247 /* Lock-free allocator */
252 } LockFreeMempoolChunk;
255 LockFreeMempoolChunk *current, *chunks;
259 * We have two unloading states because the domain
260 * must remain fully functional while AppDomain::DomainUnload is
262 * After that unloading began and all domain facilities are teared down
263 * such as execution of new threadpool jobs.
266 MONO_APPDOMAIN_CREATED,
267 MONO_APPDOMAIN_UNLOADING_START,
268 MONO_APPDOMAIN_UNLOADING,
269 MONO_APPDOMAIN_UNLOADED
270 } MonoAppDomainState;
272 typedef struct _MonoThunkFreeList {
274 int length; /* only valid for the wait list */
275 struct _MonoThunkFreeList *next;
278 typedef struct _MonoJitCodeHash MonoJitCodeHash;
280 typedef struct _MonoTlsDataRecord MonoTlsDataRecord;
281 struct _MonoTlsDataRecord {
282 MonoTlsDataRecord *next;
289 * This lock must never be taken before the loader lock,
290 * i.e. if both are taken by the same thread, the loader lock
295 MonoCodeManager *code_mp;
297 * keep all the managed objects close to each other for the precise GC
298 * For the Boehm GC we additionally keep close also other GC-tracked pointers.
300 #define MONO_DOMAIN_FIRST_OBJECT setup
301 MonoAppDomainSetup *setup;
302 MonoAppDomain *domain;
303 MonoAppContext *default_context;
304 MonoException *out_of_memory_ex;
305 MonoException *null_reference_ex;
306 MonoException *stack_overflow_ex;
308 MonoObject *typeof_void;
309 /* Ephemeron Tombstone*/
310 MonoObject *ephemeron_tombstone;
311 /* new MonoType [0] */
312 MonoArray *empty_types;
314 * The fields between FIRST_GC_TRACKED and LAST_GC_TRACKED are roots, but
315 * not object references.
317 #define MONO_DOMAIN_FIRST_GC_TRACKED env
319 MonoGHashTable *ldstr_table;
320 /* hashtables for Reflection handles */
321 MonoGHashTable *type_hash;
322 MonoGHashTable *refobject_hash;
323 /* a GC-tracked array to keep references to the static fields of types */
324 gpointer *static_data_array;
325 /* maps class -> type initialization exception object */
326 MonoGHashTable *type_init_exception_hash;
327 /* maps delegate trampoline addr -> delegate object */
328 MonoGHashTable *delegate_hash_table;
329 #define MONO_DOMAIN_LAST_GC_TRACKED delegate_hash_table
331 /* Needed by Thread:GetDomainID() */
333 gint32 shadow_serial;
334 unsigned char inet_family_hint; // used in socket-io.c as a cache
335 GSList *domain_assemblies;
336 MonoAssembly *entry_assembly;
338 GPtrArray *class_vtable_array;
339 /* maps remote class key -> MonoRemoteClass */
340 GHashTable *proxy_vtable_hash;
341 /* Protected by 'jit_code_hash_lock' */
342 MonoInternalHashTable jit_code_hash;
343 mono_mutex_t jit_code_hash_lock;
344 int num_jit_info_tables;
346 volatile jit_info_table;
348 * Contains information about AOT loaded code.
349 * Only used in the root domain.
352 volatile aot_modules;
353 GSList *jit_info_free_queue;
354 /* Used when loading assemblies */
356 gchar *private_bin_path;
357 LockFreeMempool *lock_free_mp;
359 /* Used by remoting proxies */
360 MonoMethod *create_proxy_for_type_method;
361 MonoMethod *private_invoke_method;
362 /* Used to store offsets of thread and context static fields */
363 GHashTable *special_static_fields;
364 MonoTlsDataRecord *tlsrec_list;
366 * This must be a GHashTable, since these objects can't be finalized
367 * if the hashtable contains a GC visible reference to them.
369 GHashTable *finalizable_objects_hash;
371 /* Protects the three hashes above */
372 mono_mutex_t finalizable_objects_hash_lock;
373 /* Used when accessing 'domain_assemblies' */
374 mono_mutex_t assemblies_lock;
376 GHashTable *method_rgctx_hash;
378 GHashTable *generic_virtual_cases;
379 MonoThunkFreeList **thunk_free_lists;
381 GHashTable *generic_virtual_thunks;
383 /* Information maintained by the JIT engine */
384 gpointer runtime_info;
386 /*thread pool jobs, used to coordinate shutdown.*/
387 volatile int threadpool_jobs;
388 HANDLE cleanup_semaphore;
390 /* Contains the compiled runtime invoke wrapper used by finalizers */
391 gpointer finalize_runtime_invoke;
393 /* Contains the compiled runtime invoke wrapper used by async resylt creation to capture thread context*/
394 gpointer capture_context_runtime_invoke;
396 /* Contains the compiled method used by async resylt creation to capture thread context*/
397 gpointer capture_context_method;
399 /* Assembly bindings, the per-domain part */
400 GSList *assembly_bindings;
401 gboolean assembly_bindings_parsed;
403 /* Used by socket-io.c */
404 /* These are domain specific, since the assembly can be unloaded */
405 MonoImage *socket_assembly;
406 MonoClass *sockaddr_class;
407 MonoClassField *sockaddr_data_field;
409 /* Used by threadpool.c */
410 MonoImage *system_image;
411 MonoClass *corlib_asyncresult_class;
412 MonoClass *socket_class;
413 MonoClass *ad_unloaded_ex_class;
414 MonoClass *process_class;
416 /* Cache function pointers for architectures */
417 /* that require wrappers */
418 GHashTable *ftnptrs_hash;
420 guint32 execution_context_field_offset;
424 guint16 major, minor, build, revision;
425 } AssemblyVersionSet;
427 /* MonoRuntimeInfo: Contains information about versions supported by this runtime */
429 const char runtime_version [12];
430 const char framework_version [4];
431 const AssemblyVersionSet version_sets [4];
434 #define mono_domain_lock(domain) mono_locks_acquire(&(domain)->lock, DomainLock)
435 #define mono_domain_unlock(domain) mono_locks_release(&(domain)->lock, DomainLock)
436 #define mono_domain_assemblies_lock(domain) mono_locks_acquire(&(domain)->assemblies_lock, DomainAssembliesLock)
437 #define mono_domain_assemblies_unlock(domain) mono_locks_release(&(domain)->assemblies_lock, DomainAssembliesLock)
438 #define mono_domain_jit_code_hash_lock(domain) mono_locks_acquire(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
439 #define mono_domain_jit_code_hash_unlock(domain) mono_locks_release(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
441 typedef MonoDomain* (*MonoLoadFunc) (const char *filename, const char *runtime_version);
444 mono_install_runtime_load (MonoLoadFunc func) MONO_INTERNAL;
447 mono_runtime_load (const char *filename, const char *runtime_version) MONO_INTERNAL;
449 typedef void (*MonoCreateDomainFunc) (MonoDomain *domain);
452 mono_install_create_domain_hook (MonoCreateDomainFunc func) MONO_INTERNAL;
454 typedef void (*MonoFreeDomainFunc) (MonoDomain *domain);
457 mono_install_free_domain_hook (MonoFreeDomainFunc func) MONO_INTERNAL;
460 mono_cleanup (void) MONO_INTERNAL;
463 mono_close_exe_image (void) MONO_INTERNAL;
466 mono_jit_info_size (MonoJitInfoFlags flags, int num_clauses, int num_holes) MONO_INTERNAL;
469 mono_jit_info_init (MonoJitInfo *ji, MonoMethod *method, guint8 *code, int code_size,
470 MonoJitInfoFlags flags, int num_clauses, int num_holes) MONO_INTERNAL;
473 mono_jit_info_table_new (MonoDomain *domain) MONO_INTERNAL;
476 mono_jit_info_table_free (MonoJitInfoTable *table) MONO_INTERNAL;
479 mono_jit_info_table_add (MonoDomain *domain, MonoJitInfo *ji) MONO_INTERNAL;
482 mono_jit_info_table_remove (MonoDomain *domain, MonoJitInfo *ji) MONO_INTERNAL;
485 mono_jit_info_add_aot_module (MonoImage *image, gpointer start, gpointer end) MONO_INTERNAL;
488 mono_jit_info_get_generic_jit_info (MonoJitInfo *ji) MONO_INTERNAL;
490 MonoGenericSharingContext*
491 mono_jit_info_get_generic_sharing_context (MonoJitInfo *ji) MONO_INTERNAL;
494 mono_jit_info_set_generic_sharing_context (MonoJitInfo *ji, MonoGenericSharingContext *gsctx) MONO_INTERNAL;
497 mono_make_shadow_copy (const char *filename) MONO_INTERNAL;
500 mono_is_shadow_copy_enabled (MonoDomain *domain, const gchar *dir_name) MONO_INTERNAL;
503 mono_domain_alloc (MonoDomain *domain, guint size) MONO_INTERNAL;
506 mono_domain_alloc0 (MonoDomain *domain, guint size) MONO_INTERNAL;
509 mono_domain_alloc0_lock_free (MonoDomain *domain, guint size) MONO_INTERNAL;
512 mono_domain_code_reserve (MonoDomain *domain, int size) MONO_LLVM_INTERNAL;
515 mono_domain_code_reserve_align (MonoDomain *domain, int size, int alignment) MONO_INTERNAL;
518 mono_domain_code_commit (MonoDomain *domain, void *data, int size, int newsize) MONO_INTERNAL;
521 nacl_domain_get_code_dest (MonoDomain *domain, void *data) MONO_INTERNAL;
524 nacl_domain_code_validate (MonoDomain *domain, guint8 **buf_base, int buf_size, guint8 **code_end) MONO_INTERNAL;
527 mono_domain_code_foreach (MonoDomain *domain, MonoCodeManagerFunc func, void *user_data) MONO_INTERNAL;
530 mono_domain_unset (void) MONO_INTERNAL;
533 mono_domain_set_internal_with_options (MonoDomain *domain, gboolean migrate_exception) MONO_INTERNAL;
535 MonoTryBlockHoleTableJitInfo*
536 mono_jit_info_get_try_block_hole_table_info (MonoJitInfo *ji) MONO_INTERNAL;
539 mono_jit_info_get_arch_eh_info (MonoJitInfo *ji) MONO_INTERNAL;
542 mono_jit_info_get_cas_info (MonoJitInfo *ji) MONO_INTERNAL;
545 * Installs a new function which is used to return a MonoJitInfo for a method inside
548 typedef MonoJitInfo *(*MonoJitInfoFindInAot) (MonoDomain *domain, MonoImage *image, gpointer addr);
549 void mono_install_jit_info_find_in_aot (MonoJitInfoFindInAot func) MONO_INTERNAL;
552 mono_jit_code_hash_init (MonoInternalHashTable *jit_code_hash) MONO_INTERNAL;
555 ves_icall_System_AppDomain_getCurDomain (void) MONO_INTERNAL;
558 ves_icall_System_AppDomain_getRootDomain (void) MONO_INTERNAL;
561 ves_icall_System_AppDomain_createDomain (MonoString *friendly_name,
562 MonoAppDomainSetup *setup) MONO_INTERNAL;
565 ves_icall_System_AppDomain_GetData (MonoAppDomain *ad,
566 MonoString *name) MONO_INTERNAL;
568 MonoReflectionAssembly *
569 ves_icall_System_AppDomain_LoadAssemblyRaw (MonoAppDomain *ad,
570 MonoArray *raw_assembly,
571 MonoArray *raw_symbol_store,
572 MonoObject *evidence,
573 MonoBoolean refonly) MONO_INTERNAL;
576 ves_icall_System_AppDomain_SetData (MonoAppDomain *ad,
578 MonoObject *data) MONO_INTERNAL;
581 ves_icall_System_AppDomain_getSetup (MonoAppDomain *ad) MONO_INTERNAL;
584 ves_icall_System_AppDomain_getFriendlyName (MonoAppDomain *ad) MONO_INTERNAL;
587 ves_icall_System_AppDomain_GetAssemblies (MonoAppDomain *ad,
588 MonoBoolean refonly) MONO_INTERNAL;
590 MonoReflectionAssembly *
591 ves_icall_System_Reflection_Assembly_LoadFrom (MonoString *fname,
592 MonoBoolean refonly) MONO_INTERNAL;
594 MonoReflectionAssembly *
595 ves_icall_System_AppDomain_LoadAssembly (MonoAppDomain *ad,
597 MonoObject *evidence,
598 MonoBoolean refonly) MONO_INTERNAL;
601 ves_icall_System_AppDomain_InternalIsFinalizingForUnload (gint32 domain_id) MONO_INTERNAL;
604 ves_icall_System_AppDomain_InternalUnload (gint32 domain_id) MONO_INTERNAL;
607 ves_icall_System_AppDomain_ExecuteAssembly (MonoAppDomain *ad,
608 MonoReflectionAssembly *refass,
609 MonoArray *args) MONO_INTERNAL;
612 ves_icall_System_AppDomain_InternalSetDomain (MonoAppDomain *ad) MONO_INTERNAL;
615 ves_icall_System_AppDomain_InternalSetDomainByID (gint32 domainid) MONO_INTERNAL;
618 ves_icall_System_AppDomain_InternalPushDomainRef (MonoAppDomain *ad) MONO_INTERNAL;
621 ves_icall_System_AppDomain_InternalPushDomainRefByID (gint32 domain_id) MONO_INTERNAL;
624 ves_icall_System_AppDomain_InternalPopDomainRef (void) MONO_INTERNAL;
627 ves_icall_System_AppDomain_InternalGetContext (void) MONO_INTERNAL;
630 ves_icall_System_AppDomain_InternalGetDefaultContext (void) MONO_INTERNAL;
633 ves_icall_System_AppDomain_InternalSetContext (MonoAppContext *mc) MONO_INTERNAL;
636 ves_icall_System_AppDomain_GetIDFromDomain (MonoAppDomain * ad) MONO_INTERNAL;
639 ves_icall_System_AppDomain_InternalGetProcessGuid (MonoString* newguid) MONO_INTERNAL;
642 mono_assembly_load_corlib (const MonoRuntimeInfo *runtime, MonoImageOpenStatus *status) MONO_INTERNAL;
644 const MonoRuntimeInfo*
645 mono_get_runtime_info (void) MONO_INTERNAL;
648 mono_runtime_set_no_exec (gboolean val) MONO_INTERNAL;
651 mono_runtime_get_no_exec (void) MONO_INTERNAL;
654 mono_assembly_name_parse (const char *name, MonoAssemblyName *aname) MONO_INTERNAL;
656 MonoImage *mono_assembly_open_from_bundle (const char *filename,
657 MonoImageOpenStatus *status,
658 gboolean refonly) MONO_INTERNAL;
661 mono_domain_add_class_static_data (MonoDomain *domain, MonoClass *klass, gpointer data, guint32 *bitmap);
663 MonoReflectionAssembly *
664 mono_try_assembly_resolve (MonoDomain *domain, MonoString *fname, MonoAssembly *requesting, gboolean refonly) MONO_INTERNAL;
667 mono_domain_assembly_postload_search (MonoAssemblyName *aname, MonoAssembly *requesting, gboolean refonly) MONO_INTERNAL;
669 MonoAssembly* mono_assembly_load_full_nosearch (MonoAssemblyName *aname,
671 MonoImageOpenStatus *status,
672 gboolean refonly) MONO_INTERNAL;
674 void mono_set_private_bin_path_from_config (MonoDomain *domain) MONO_INTERNAL;
676 int mono_framework_version (void) MONO_INTERNAL;
678 void mono_reflection_cleanup_domain (MonoDomain *domain) MONO_INTERNAL;
680 void mono_assembly_cleanup_domain_bindings (guint32 domain_id) MONO_INTERNAL;
682 MonoJitInfo* mono_jit_info_table_find_internal (MonoDomain *domain, char *addr, gboolean try_aot) MONO_INTERNAL;
684 void mono_enable_debug_domain_unload (gboolean enable);
686 #endif /* __MONO_METADATA_DOMAIN_INTERNALS_H__ */