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/metadata/mono-hash.h>
13 #include <mono/utils/mono-compiler.h>
14 #include <mono/utils/mono-internal-hash.h>
15 #include <mono/io-layer/io-layer.h>
16 #include <mono/metadata/mempool-internals.h>
18 extern CRITICAL_SECTION mono_delegate_section;
19 extern CRITICAL_SECTION mono_strtod_mutex;
22 * If this is set, the memory belonging to appdomains is not freed when a domain is
23 * unloaded, and assemblies loaded by the appdomain are not unloaded either. This
24 * allows us to use typed gc in non-default appdomains too, leading to increased
27 extern gboolean mono_dont_free_domains;
29 /* This is a copy of System.AppDomainSetup */
32 MonoString *application_base;
33 MonoString *application_name;
34 MonoString *cache_path;
35 MonoString *configuration_file;
36 MonoString *dynamic_base;
37 MonoString *license_file;
38 MonoString *private_bin_path;
39 MonoString *private_bin_path_probe;
40 MonoString *shadow_copy_directories;
41 MonoString *shadow_copy_files;
42 MonoBoolean publisher_policy;
43 MonoBoolean path_changed;
44 int loader_optimization;
45 MonoBoolean disallow_binding_redirects;
46 MonoBoolean disallow_code_downloads;
47 MonoObject *activation_arguments; /* it is System.Object in 1.x, ActivationArguments in 2.0 */
48 MonoObject *domain_initializer;
49 MonoObject *application_trust; /* it is System.Object in 1.x, ApplicationTrust in 2.0 */
50 MonoArray *domain_initializer_args;
51 MonoBoolean disallow_appbase_probe;
52 MonoArray *configuration_bytes;
53 MonoArray *serialized_non_primitives;
56 typedef struct _MonoJitInfoTable MonoJitInfoTable;
57 typedef struct _MonoJitInfoTableChunk MonoJitInfoTableChunk;
59 #define MONO_JIT_INFO_TABLE_CHUNK_SIZE 64
61 struct _MonoJitInfoTableChunk
64 volatile int num_elements;
65 volatile gint8 *last_code_end;
66 MonoJitInfo * volatile data [MONO_JIT_INFO_TABLE_CHUNK_SIZE];
69 struct _MonoJitInfoTable
73 MonoJitInfoTableChunk *chunks [MONO_ZERO_LEN_ARRAY];
76 #define MONO_SIZEOF_JIT_INFO_TABLE (sizeof (struct _MonoJitInfoTable) - MONO_ZERO_LEN_ARRAY * SIZEOF_VOID_P)
78 typedef GArray MonoAotModuleInfoTable;
85 gpointer handler_start;
87 MonoClass *catch_class;
91 } MonoJitExceptionInfo;
94 * Contains information about the type arguments for generic shared methods.
98 * If not NULL, determines whenever the class type arguments of the gshared method are references or vtypes.
99 * The array length is equal to class_inst->type_argv.
102 /* Same for method type parameters */
103 gboolean *mvar_is_vt;
104 } MonoGenericSharingContext;
106 /* Simplified DWARF location list entry */
108 /* Whenever the value is in a register */
111 * If is_reg is TRUE, the register which contains the value. Otherwise
116 * If is_reg is FALSE, the offset of the stack location relative to 'reg'.
121 * Offsets of the PC interval where the value is in this location.
124 } MonoDwarfLocListEntry;
128 MonoGenericSharingContext *generic_sharing_context;
130 MonoDwarfLocListEntry *locations;
134 gboolean this_in_reg:1;
135 } MonoGenericJitInfo;
138 A try block hole is used to represent a non-contiguous part of
139 of a segment of native code protected by a given .try block.
140 Usually, a try block is defined as a contiguous segment of code.
141 But in some cases it's needed to have some parts of it to not be protected.
142 For example, given "try {} finally {}", the code in the .try block to call
143 the finally part looks like:
149 jump outside try block
155 The instructions between the call and the jump should not be under the try block since they happen
156 after the finally block executes, which means if an async exceptions happens at that point we would
157 execute the finally clause twice. So, to avoid this, we introduce a hole in the try block to signal
158 that those instructions are not protected.
165 } MonoTryBlockHoleJitInfo;
170 MonoTryBlockHoleJitInfo holes [MONO_ZERO_LEN_ARRAY];
171 } MonoTryBlockHoleTableJitInfo;
179 gboolean cas_inited:1;
180 gboolean cas_class_assert:1;
181 gboolean cas_class_deny:1;
182 gboolean cas_class_permitonly:1;
183 gboolean cas_method_assert:1;
184 gboolean cas_method_deny:1;
185 gboolean cas_method_permitonly:1;
188 struct _MonoJitInfo {
189 /* NOTE: These first two elements (method and
190 next_jit_code_hash) must be in the same order and at the
191 same offset as in RuntimeMethod, because of the jit_code_hash
192 internal hash table in MonoDomain. */
198 struct _MonoJitInfo *next_jit_code_hash;
200 /* This might contain an id for the unwind info instead of a register mask */
203 guint32 num_clauses:15;
204 /* Whenever the code is domain neutral or 'shared' */
205 gboolean domain_neutral:1;
206 gboolean has_cas_info:1;
207 gboolean has_generic_jit_info:1;
208 gboolean has_try_block_holes:1;
209 gboolean has_arch_eh_info:1;
211 gboolean from_llvm:1;
212 gboolean dbg_hidden_inited:1;
213 gboolean dbg_hidden:1;
214 /* Whenever this jit info was loaded in async context */
216 gboolean dbg_step_through_inited:1;
217 gboolean dbg_step_through:1;
218 gboolean dbg_non_user_code_inited:1;
219 gboolean dbg_non_user_code:1;
221 /* FIXME: Embed this after the structure later*/
222 gpointer gc_info; /* Currently only used by SGen */
224 MonoJitExceptionInfo clauses [MONO_ZERO_LEN_ARRAY];
225 /* There is an optional MonoGenericJitInfo after the clauses */
226 /* There is an optional MonoTryBlockHoleTableJitInfo after MonoGenericJitInfo clauses*/
227 /* There is an optional MonoArchEHJitInfo after MonoTryBlockHoleTableJitInfo */
230 #define MONO_SIZEOF_JIT_INFO (offsetof (struct _MonoJitInfo, clauses))
232 struct _MonoAppContext {
236 gpointer *static_data;
239 /* Lock-free allocator */
244 } LockFreeMempoolChunk;
247 LockFreeMempoolChunk *current, *chunks;
251 * We have two unloading states because the domain
252 * must remain fully functional while AppDomain::DomainUnload is
254 * After that unloading began and all domain facilities are teared down
255 * such as execution of new threadpool jobs.
258 MONO_APPDOMAIN_CREATED,
259 MONO_APPDOMAIN_UNLOADING_START,
260 MONO_APPDOMAIN_UNLOADING,
261 MONO_APPDOMAIN_UNLOADED
262 } MonoAppDomainState;
264 typedef struct _MonoThunkFreeList {
266 int length; /* only valid for the wait list */
267 struct _MonoThunkFreeList *next;
270 typedef struct _MonoJitCodeHash MonoJitCodeHash;
272 typedef struct _MonoTlsDataRecord MonoTlsDataRecord;
273 struct _MonoTlsDataRecord {
274 MonoTlsDataRecord *next;
281 * This lock must never be taken before the loader lock,
282 * i.e. if both are taken by the same thread, the loader lock
285 CRITICAL_SECTION lock;
287 MonoCodeManager *code_mp;
289 * keep all the managed objects close to each other for the precise GC
290 * For the Boehm GC we additionally keep close also other GC-tracked pointers.
292 #define MONO_DOMAIN_FIRST_OBJECT setup
293 MonoAppDomainSetup *setup;
294 MonoAppDomain *domain;
295 MonoAppContext *default_context;
296 MonoException *out_of_memory_ex;
297 MonoException *null_reference_ex;
298 MonoException *stack_overflow_ex;
300 MonoObject *typeof_void;
301 /* Ephemeron Tombstone*/
302 MonoObject *ephemeron_tombstone;
303 /* new MonoType [0] */
304 MonoArray *empty_types;
306 * The fields between FIRST_GC_TRACKED and LAST_GC_TRACKED are roots, but
307 * not object references.
309 #define MONO_DOMAIN_FIRST_GC_TRACKED env
311 MonoGHashTable *ldstr_table;
312 /* hashtables for Reflection handles */
313 MonoGHashTable *type_hash;
314 MonoGHashTable *refobject_hash;
315 /* a GC-tracked array to keep references to the static fields of types */
316 gpointer *static_data_array;
317 /* maps class -> type initialization exception object */
318 MonoGHashTable *type_init_exception_hash;
319 /* maps delegate trampoline addr -> delegate object */
320 MonoGHashTable *delegate_hash_table;
321 #define MONO_DOMAIN_LAST_GC_TRACKED delegate_hash_table
323 /* Needed by Thread:GetDomainID() */
325 gint32 shadow_serial;
326 unsigned char inet_family_hint; // used in socket-io.c as a cache
327 GSList *domain_assemblies;
328 MonoAssembly *entry_assembly;
330 GPtrArray *class_vtable_array;
331 /* maps remote class key -> MonoRemoteClass */
332 GHashTable *proxy_vtable_hash;
333 /* Protected by 'jit_code_hash_lock' */
334 MonoInternalHashTable jit_code_hash;
335 CRITICAL_SECTION jit_code_hash_lock;
336 int num_jit_info_tables;
338 volatile jit_info_table;
340 * Contains information about AOT loaded code.
341 * Only used in the root domain.
344 volatile aot_modules;
345 GSList *jit_info_free_queue;
346 /* Used when loading assemblies */
348 gchar *private_bin_path;
349 LockFreeMempool *lock_free_mp;
351 /* Used by remoting proxies */
352 MonoMethod *create_proxy_for_type_method;
353 MonoMethod *private_invoke_method;
354 /* Used to store offsets of thread and context static fields */
355 GHashTable *special_static_fields;
356 MonoTlsDataRecord *tlsrec_list;
358 * This must be a GHashTable, since these objects can't be finalized
359 * if the hashtable contains a GC visible reference to them.
361 GHashTable *finalizable_objects_hash;
363 /* Protects the three hashes above */
364 CRITICAL_SECTION finalizable_objects_hash_lock;
365 /* Used when accessing 'domain_assemblies' */
366 CRITICAL_SECTION assemblies_lock;
368 GHashTable *method_rgctx_hash;
370 GHashTable *generic_virtual_cases;
371 MonoThunkFreeList **thunk_free_lists;
373 GHashTable *generic_virtual_thunks;
375 /* Information maintained by the JIT engine */
376 gpointer runtime_info;
378 /*thread pool jobs, used to coordinate shutdown.*/
379 volatile int threadpool_jobs;
380 HANDLE cleanup_semaphore;
382 /* Contains the compiled runtime invoke wrapper used by finalizers */
383 gpointer finalize_runtime_invoke;
385 /* Contains the compiled runtime invoke wrapper used by async resylt creation to capture thread context*/
386 gpointer capture_context_runtime_invoke;
388 /* Contains the compiled method used by async resylt creation to capture thread context*/
389 gpointer capture_context_method;
391 /* Assembly bindings, the per-domain part */
392 GSList *assembly_bindings;
393 gboolean assembly_bindings_parsed;
395 /* Used by socket-io.c */
396 /* These are domain specific, since the assembly can be unloaded */
397 MonoImage *socket_assembly;
398 MonoClass *sockaddr_class;
399 MonoClassField *sockaddr_data_field;
401 /* Used by threadpool.c */
402 MonoImage *system_image;
403 MonoClass *corlib_asyncresult_class;
404 MonoClass *socket_class;
405 MonoClass *ad_unloaded_ex_class;
406 MonoClass *process_class;
408 /* Cache function pointers for architectures */
409 /* that require wrappers */
410 GHashTable *ftnptrs_hash;
412 guint32 execution_context_field_offset;
416 guint16 major, minor, build, revision;
417 } AssemblyVersionSet;
419 /* MonoRuntimeInfo: Contains information about versions supported by this runtime */
421 const char runtime_version [12];
422 const char framework_version [4];
423 const AssemblyVersionSet version_sets [4];
426 #define mono_domain_lock(domain) mono_locks_acquire(&(domain)->lock, DomainLock)
427 #define mono_domain_unlock(domain) mono_locks_release(&(domain)->lock, DomainLock)
428 #define mono_domain_assemblies_lock(domain) mono_locks_acquire(&(domain)->assemblies_lock, DomainAssembliesLock)
429 #define mono_domain_assemblies_unlock(domain) mono_locks_release(&(domain)->assemblies_lock, DomainAssembliesLock)
430 #define mono_domain_jit_code_hash_lock(domain) mono_locks_acquire(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
431 #define mono_domain_jit_code_hash_unlock(domain) mono_locks_release(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
433 typedef MonoDomain* (*MonoLoadFunc) (const char *filename, const char *runtime_version);
436 mono_install_runtime_load (MonoLoadFunc func) MONO_INTERNAL;
439 mono_runtime_load (const char *filename, const char *runtime_version) MONO_INTERNAL;
441 typedef void (*MonoCreateDomainFunc) (MonoDomain *domain);
444 mono_install_create_domain_hook (MonoCreateDomainFunc func) MONO_INTERNAL;
446 typedef void (*MonoFreeDomainFunc) (MonoDomain *domain);
449 mono_install_free_domain_hook (MonoFreeDomainFunc func) MONO_INTERNAL;
452 mono_cleanup (void) MONO_INTERNAL;
455 mono_close_exe_image (void) MONO_INTERNAL;
458 mono_jit_info_table_add (MonoDomain *domain, MonoJitInfo *ji) MONO_INTERNAL;
461 mono_jit_info_table_remove (MonoDomain *domain, MonoJitInfo *ji) MONO_INTERNAL;
464 mono_jit_info_add_aot_module (MonoImage *image, gpointer start, gpointer end) MONO_INTERNAL;
467 mono_jit_info_get_generic_jit_info (MonoJitInfo *ji) MONO_INTERNAL;
469 MonoGenericSharingContext*
470 mono_jit_info_get_generic_sharing_context (MonoJitInfo *ji) MONO_INTERNAL;
473 mono_jit_info_set_generic_sharing_context (MonoJitInfo *ji, MonoGenericSharingContext *gsctx) MONO_INTERNAL;
476 mono_make_shadow_copy (const char *filename) MONO_INTERNAL;
479 mono_is_shadow_copy_enabled (MonoDomain *domain, const gchar *dir_name) MONO_INTERNAL;
482 mono_domain_alloc (MonoDomain *domain, guint size) MONO_INTERNAL;
485 mono_domain_alloc0 (MonoDomain *domain, guint size) MONO_INTERNAL;
488 mono_domain_alloc0_lock_free (MonoDomain *domain, guint size) MONO_INTERNAL;
491 mono_domain_code_reserve (MonoDomain *domain, int size) MONO_LLVM_INTERNAL;
494 mono_domain_code_reserve_align (MonoDomain *domain, int size, int alignment) MONO_INTERNAL;
497 mono_domain_code_commit (MonoDomain *domain, void *data, int size, int newsize) MONO_INTERNAL;
500 nacl_domain_get_code_dest (MonoDomain *domain, void *data) MONO_INTERNAL;
503 nacl_domain_code_validate (MonoDomain *domain, guint8 **buf_base, int buf_size, guint8 **code_end) MONO_INTERNAL;
506 mono_domain_code_foreach (MonoDomain *domain, MonoCodeManagerFunc func, void *user_data) MONO_INTERNAL;
509 mono_domain_unset (void) MONO_INTERNAL;
512 mono_domain_set_internal_with_options (MonoDomain *domain, gboolean migrate_exception) MONO_INTERNAL;
514 MonoTryBlockHoleTableJitInfo*
515 mono_jit_info_get_try_block_hole_table_info (MonoJitInfo *ji) MONO_INTERNAL;
518 mono_jit_info_get_arch_eh_info (MonoJitInfo *ji) MONO_INTERNAL;
521 mono_jit_info_get_cas_info (MonoJitInfo *ji) MONO_INTERNAL;
524 * Installs a new function which is used to return a MonoJitInfo for a method inside
527 typedef MonoJitInfo *(*MonoJitInfoFindInAot) (MonoDomain *domain, MonoImage *image, gpointer addr);
528 void mono_install_jit_info_find_in_aot (MonoJitInfoFindInAot func) MONO_INTERNAL;
531 mono_jit_code_hash_init (MonoInternalHashTable *jit_code_hash) MONO_INTERNAL;
534 ves_icall_System_AppDomain_getCurDomain (void) MONO_INTERNAL;
537 ves_icall_System_AppDomain_getRootDomain (void) MONO_INTERNAL;
540 ves_icall_System_AppDomain_createDomain (MonoString *friendly_name,
541 MonoAppDomainSetup *setup) MONO_INTERNAL;
544 ves_icall_System_AppDomain_GetData (MonoAppDomain *ad,
545 MonoString *name) MONO_INTERNAL;
547 MonoReflectionAssembly *
548 ves_icall_System_AppDomain_LoadAssemblyRaw (MonoAppDomain *ad,
549 MonoArray *raw_assembly,
550 MonoArray *raw_symbol_store,
551 MonoObject *evidence,
552 MonoBoolean refonly) MONO_INTERNAL;
555 ves_icall_System_AppDomain_SetData (MonoAppDomain *ad,
557 MonoObject *data) MONO_INTERNAL;
560 ves_icall_System_AppDomain_getSetup (MonoAppDomain *ad) MONO_INTERNAL;
563 ves_icall_System_AppDomain_getFriendlyName (MonoAppDomain *ad) MONO_INTERNAL;
566 ves_icall_System_AppDomain_GetAssemblies (MonoAppDomain *ad,
567 MonoBoolean refonly) MONO_INTERNAL;
569 MonoReflectionAssembly *
570 ves_icall_System_Reflection_Assembly_LoadFrom (MonoString *fname,
571 MonoBoolean refonly) MONO_INTERNAL;
573 MonoReflectionAssembly *
574 ves_icall_System_AppDomain_LoadAssembly (MonoAppDomain *ad,
576 MonoObject *evidence,
577 MonoBoolean refonly) MONO_INTERNAL;
580 ves_icall_System_AppDomain_InternalIsFinalizingForUnload (gint32 domain_id) MONO_INTERNAL;
583 ves_icall_System_AppDomain_InternalUnload (gint32 domain_id) MONO_INTERNAL;
586 ves_icall_System_AppDomain_ExecuteAssembly (MonoAppDomain *ad,
587 MonoReflectionAssembly *refass,
588 MonoArray *args) MONO_INTERNAL;
591 ves_icall_System_AppDomain_InternalSetDomain (MonoAppDomain *ad) MONO_INTERNAL;
594 ves_icall_System_AppDomain_InternalSetDomainByID (gint32 domainid) MONO_INTERNAL;
597 ves_icall_System_AppDomain_InternalPushDomainRef (MonoAppDomain *ad) MONO_INTERNAL;
600 ves_icall_System_AppDomain_InternalPushDomainRefByID (gint32 domain_id) MONO_INTERNAL;
603 ves_icall_System_AppDomain_InternalPopDomainRef (void) MONO_INTERNAL;
606 ves_icall_System_AppDomain_InternalGetContext (void) MONO_INTERNAL;
609 ves_icall_System_AppDomain_InternalGetDefaultContext (void) MONO_INTERNAL;
612 ves_icall_System_AppDomain_InternalSetContext (MonoAppContext *mc) MONO_INTERNAL;
615 ves_icall_System_AppDomain_GetIDFromDomain (MonoAppDomain * ad) MONO_INTERNAL;
618 ves_icall_System_AppDomain_InternalGetProcessGuid (MonoString* newguid) MONO_INTERNAL;
621 mono_assembly_load_corlib (const MonoRuntimeInfo *runtime, MonoImageOpenStatus *status) MONO_INTERNAL;
623 const MonoRuntimeInfo*
624 mono_get_runtime_info (void) MONO_INTERNAL;
627 mono_runtime_set_no_exec (gboolean val) MONO_INTERNAL;
630 mono_runtime_get_no_exec (void) MONO_INTERNAL;
633 mono_assembly_name_parse (const char *name, MonoAssemblyName *aname) MONO_INTERNAL;
635 MonoImage *mono_assembly_open_from_bundle (const char *filename,
636 MonoImageOpenStatus *status,
637 gboolean refonly) MONO_INTERNAL;
640 mono_domain_add_class_static_data (MonoDomain *domain, MonoClass *klass, gpointer data, guint32 *bitmap);
642 MonoReflectionAssembly *
643 mono_try_assembly_resolve (MonoDomain *domain, MonoString *fname, gboolean refonly) MONO_INTERNAL;
645 MonoAssembly* mono_assembly_load_full_nosearch (MonoAssemblyName *aname,
647 MonoImageOpenStatus *status,
648 gboolean refonly) MONO_INTERNAL;
650 void mono_set_private_bin_path_from_config (MonoDomain *domain) MONO_INTERNAL;
652 int mono_framework_version (void) MONO_INTERNAL;
654 void mono_reflection_cleanup_domain (MonoDomain *domain) MONO_INTERNAL;
656 void mono_assembly_cleanup_domain_bindings (guint32 domain_id) MONO_INTERNAL;
658 MonoJitInfo* mono_jit_info_table_find_internal (MonoDomain *domain, char *addr, gboolean try_aot) MONO_INTERNAL;
660 void mono_enable_debug_domain_unload (gboolean enable);
662 #endif /* __MONO_METADATA_DOMAIN_INTERNALS_H__ */