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;
219 /* FIXME: Embed this after the structure later*/
220 gpointer gc_info; /* Currently only used by SGen */
222 MonoJitExceptionInfo clauses [MONO_ZERO_LEN_ARRAY];
223 /* There is an optional MonoGenericJitInfo after the clauses */
224 /* There is an optional MonoTryBlockHoleTableJitInfo after MonoGenericJitInfo clauses*/
225 /* There is an optional MonoArchEHJitInfo after MonoTryBlockHoleTableJitInfo */
228 #define MONO_SIZEOF_JIT_INFO (offsetof (struct _MonoJitInfo, clauses))
230 struct _MonoAppContext {
234 gpointer *static_data;
237 /* Lock-free allocator */
242 } LockFreeMempoolChunk;
245 LockFreeMempoolChunk *current, *chunks;
249 * We have two unloading states because the domain
250 * must remain fully functional while AppDomain::DomainUnload is
252 * After that unloading began and all domain facilities are teared down
253 * such as execution of new threadpool jobs.
256 MONO_APPDOMAIN_CREATED,
257 MONO_APPDOMAIN_UNLOADING_START,
258 MONO_APPDOMAIN_UNLOADING,
259 MONO_APPDOMAIN_UNLOADED
260 } MonoAppDomainState;
262 typedef struct _MonoThunkFreeList {
264 int length; /* only valid for the wait list */
265 struct _MonoThunkFreeList *next;
268 typedef struct _MonoJitCodeHash MonoJitCodeHash;
270 typedef struct _MonoTlsDataRecord MonoTlsDataRecord;
271 struct _MonoTlsDataRecord {
272 MonoTlsDataRecord *next;
279 * This lock must never be taken before the loader lock,
280 * i.e. if both are taken by the same thread, the loader lock
283 CRITICAL_SECTION lock;
285 MonoCodeManager *code_mp;
287 * keep all the managed objects close to each other for the precise GC
288 * For the Boehm GC we additionally keep close also other GC-tracked pointers.
290 #define MONO_DOMAIN_FIRST_OBJECT setup
291 MonoAppDomainSetup *setup;
292 MonoAppDomain *domain;
293 MonoAppContext *default_context;
294 MonoException *out_of_memory_ex;
295 MonoException *null_reference_ex;
296 MonoException *stack_overflow_ex;
298 MonoObject *typeof_void;
299 /* Ephemeron Tombstone*/
300 MonoObject *ephemeron_tombstone;
301 /* new MonoType [0] */
302 MonoArray *empty_types;
304 * The fields between FIRST_GC_TRACKED and LAST_GC_TRACKED are roots, but
305 * not object references.
307 #define MONO_DOMAIN_FIRST_GC_TRACKED env
309 MonoGHashTable *ldstr_table;
310 /* hashtables for Reflection handles */
311 MonoGHashTable *type_hash;
312 MonoGHashTable *refobject_hash;
313 /* a GC-tracked array to keep references to the static fields of types */
314 gpointer *static_data_array;
315 /* maps class -> type initialization exception object */
316 MonoGHashTable *type_init_exception_hash;
317 /* maps delegate trampoline addr -> delegate object */
318 MonoGHashTable *delegate_hash_table;
319 #define MONO_DOMAIN_LAST_GC_TRACKED delegate_hash_table
321 /* Needed by Thread:GetDomainID() */
323 gint32 shadow_serial;
324 unsigned char inet_family_hint; // used in socket-io.c as a cache
325 GSList *domain_assemblies;
326 MonoAssembly *entry_assembly;
328 GPtrArray *class_vtable_array;
329 /* maps remote class key -> MonoRemoteClass */
330 GHashTable *proxy_vtable_hash;
331 /* Protected by 'jit_code_hash_lock' */
332 MonoInternalHashTable jit_code_hash;
333 CRITICAL_SECTION jit_code_hash_lock;
334 int num_jit_info_tables;
336 volatile jit_info_table;
338 * Contains information about AOT loaded code.
339 * Only used in the root domain.
342 volatile aot_modules;
343 GSList *jit_info_free_queue;
344 /* Used when loading assemblies */
346 gchar *private_bin_path;
347 LockFreeMempool *lock_free_mp;
349 /* Used by remoting proxies */
350 MonoMethod *create_proxy_for_type_method;
351 MonoMethod *private_invoke_method;
352 /* Used to store offsets of thread and context static fields */
353 GHashTable *special_static_fields;
354 MonoTlsDataRecord *tlsrec_list;
356 * This must be a GHashTable, since these objects can't be finalized
357 * if the hashtable contains a GC visible reference to them.
359 GHashTable *finalizable_objects_hash;
361 /* Protects the three hashes above */
362 CRITICAL_SECTION finalizable_objects_hash_lock;
363 /* Used when accessing 'domain_assemblies' */
364 CRITICAL_SECTION assemblies_lock;
366 GHashTable *method_rgctx_hash;
368 GHashTable *generic_virtual_cases;
369 MonoThunkFreeList **thunk_free_lists;
371 GHashTable *generic_virtual_thunks;
373 /* Information maintained by the JIT engine */
374 gpointer runtime_info;
376 /*thread pool jobs, used to coordinate shutdown.*/
377 volatile int threadpool_jobs;
378 HANDLE cleanup_semaphore;
380 /* Contains the compiled runtime invoke wrapper used by finalizers */
381 gpointer finalize_runtime_invoke;
383 /* Contains the compiled runtime invoke wrapper used by async resylt creation to capture thread context*/
384 gpointer capture_context_runtime_invoke;
386 /* Contains the compiled method used by async resylt creation to capture thread context*/
387 gpointer capture_context_method;
389 /* Assembly bindings, the per-domain part */
390 GSList *assembly_bindings;
391 gboolean assembly_bindings_parsed;
393 /* Used by socket-io.c */
394 /* These are domain specific, since the assembly can be unloaded */
395 MonoImage *socket_assembly;
396 MonoClass *sockaddr_class;
397 MonoClassField *sockaddr_data_field;
399 /* Used by threadpool.c */
400 MonoImage *system_image;
401 MonoClass *corlib_asyncresult_class;
402 MonoClass *socket_class;
403 MonoClass *ad_unloaded_ex_class;
404 MonoClass *process_class;
406 /* Cache function pointers for architectures */
407 /* that require wrappers */
408 GHashTable *ftnptrs_hash;
410 guint32 execution_context_field_offset;
414 guint16 major, minor, build, revision;
415 } AssemblyVersionSet;
417 /* MonoRuntimeInfo: Contains information about versions supported by this runtime */
419 const char runtime_version [12];
420 const char framework_version [4];
421 const AssemblyVersionSet version_sets [4];
424 #define mono_domain_lock(domain) mono_locks_acquire(&(domain)->lock, DomainLock)
425 #define mono_domain_unlock(domain) mono_locks_release(&(domain)->lock, DomainLock)
426 #define mono_domain_assemblies_lock(domain) mono_locks_acquire(&(domain)->assemblies_lock, DomainAssembliesLock)
427 #define mono_domain_assemblies_unlock(domain) mono_locks_release(&(domain)->assemblies_lock, DomainAssembliesLock)
428 #define mono_domain_jit_code_hash_lock(domain) mono_locks_acquire(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
429 #define mono_domain_jit_code_hash_unlock(domain) mono_locks_release(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
431 typedef MonoDomain* (*MonoLoadFunc) (const char *filename, const char *runtime_version);
434 mono_install_runtime_load (MonoLoadFunc func) MONO_INTERNAL;
437 mono_runtime_load (const char *filename, const char *runtime_version) MONO_INTERNAL;
439 typedef void (*MonoCreateDomainFunc) (MonoDomain *domain);
442 mono_install_create_domain_hook (MonoCreateDomainFunc func) MONO_INTERNAL;
444 typedef void (*MonoFreeDomainFunc) (MonoDomain *domain);
447 mono_install_free_domain_hook (MonoFreeDomainFunc func) MONO_INTERNAL;
450 mono_cleanup (void) MONO_INTERNAL;
453 mono_close_exe_image (void) MONO_INTERNAL;
456 mono_jit_info_table_add (MonoDomain *domain, MonoJitInfo *ji) MONO_INTERNAL;
459 mono_jit_info_table_remove (MonoDomain *domain, MonoJitInfo *ji) MONO_INTERNAL;
462 mono_jit_info_add_aot_module (MonoImage *image, gpointer start, gpointer end) MONO_INTERNAL;
465 mono_jit_info_get_generic_jit_info (MonoJitInfo *ji) MONO_INTERNAL;
467 MonoGenericSharingContext*
468 mono_jit_info_get_generic_sharing_context (MonoJitInfo *ji) MONO_INTERNAL;
471 mono_jit_info_set_generic_sharing_context (MonoJitInfo *ji, MonoGenericSharingContext *gsctx) MONO_INTERNAL;
474 mono_make_shadow_copy (const char *filename) MONO_INTERNAL;
477 mono_is_shadow_copy_enabled (MonoDomain *domain, const gchar *dir_name) MONO_INTERNAL;
480 mono_domain_alloc (MonoDomain *domain, guint size) MONO_INTERNAL;
483 mono_domain_alloc0 (MonoDomain *domain, guint size) MONO_INTERNAL;
486 mono_domain_alloc0_lock_free (MonoDomain *domain, guint size) MONO_INTERNAL;
489 mono_domain_code_reserve (MonoDomain *domain, int size) MONO_LLVM_INTERNAL;
492 mono_domain_code_reserve_align (MonoDomain *domain, int size, int alignment) MONO_INTERNAL;
495 mono_domain_code_commit (MonoDomain *domain, void *data, int size, int newsize) MONO_INTERNAL;
498 nacl_domain_get_code_dest (MonoDomain *domain, void *data) MONO_INTERNAL;
501 nacl_domain_code_validate (MonoDomain *domain, guint8 **buf_base, int buf_size, guint8 **code_end) MONO_INTERNAL;
504 mono_domain_code_foreach (MonoDomain *domain, MonoCodeManagerFunc func, void *user_data) MONO_INTERNAL;
507 mono_domain_unset (void) MONO_INTERNAL;
510 mono_domain_set_internal_with_options (MonoDomain *domain, gboolean migrate_exception) MONO_INTERNAL;
512 MonoTryBlockHoleTableJitInfo*
513 mono_jit_info_get_try_block_hole_table_info (MonoJitInfo *ji) MONO_INTERNAL;
516 mono_jit_info_get_arch_eh_info (MonoJitInfo *ji) MONO_INTERNAL;
519 mono_jit_info_get_cas_info (MonoJitInfo *ji) MONO_INTERNAL;
522 * Installs a new function which is used to return a MonoJitInfo for a method inside
525 typedef MonoJitInfo *(*MonoJitInfoFindInAot) (MonoDomain *domain, MonoImage *image, gpointer addr);
526 void mono_install_jit_info_find_in_aot (MonoJitInfoFindInAot func) MONO_INTERNAL;
529 mono_jit_code_hash_init (MonoInternalHashTable *jit_code_hash) MONO_INTERNAL;
532 ves_icall_System_AppDomain_getCurDomain (void) MONO_INTERNAL;
535 ves_icall_System_AppDomain_getRootDomain (void) MONO_INTERNAL;
538 ves_icall_System_AppDomain_createDomain (MonoString *friendly_name,
539 MonoAppDomainSetup *setup) MONO_INTERNAL;
542 ves_icall_System_AppDomain_GetData (MonoAppDomain *ad,
543 MonoString *name) MONO_INTERNAL;
545 MonoReflectionAssembly *
546 ves_icall_System_AppDomain_LoadAssemblyRaw (MonoAppDomain *ad,
547 MonoArray *raw_assembly,
548 MonoArray *raw_symbol_store,
549 MonoObject *evidence,
550 MonoBoolean refonly) MONO_INTERNAL;
553 ves_icall_System_AppDomain_SetData (MonoAppDomain *ad,
555 MonoObject *data) MONO_INTERNAL;
558 ves_icall_System_AppDomain_getSetup (MonoAppDomain *ad) MONO_INTERNAL;
561 ves_icall_System_AppDomain_getFriendlyName (MonoAppDomain *ad) MONO_INTERNAL;
564 ves_icall_System_AppDomain_GetAssemblies (MonoAppDomain *ad,
565 MonoBoolean refonly) MONO_INTERNAL;
567 MonoReflectionAssembly *
568 ves_icall_System_Reflection_Assembly_LoadFrom (MonoString *fname,
569 MonoBoolean refonly) MONO_INTERNAL;
571 MonoReflectionAssembly *
572 ves_icall_System_AppDomain_LoadAssembly (MonoAppDomain *ad,
574 MonoObject *evidence,
575 MonoBoolean refonly) MONO_INTERNAL;
578 ves_icall_System_AppDomain_InternalIsFinalizingForUnload (gint32 domain_id) MONO_INTERNAL;
581 ves_icall_System_AppDomain_InternalUnload (gint32 domain_id) MONO_INTERNAL;
584 ves_icall_System_AppDomain_ExecuteAssembly (MonoAppDomain *ad,
585 MonoReflectionAssembly *refass,
586 MonoArray *args) MONO_INTERNAL;
589 ves_icall_System_AppDomain_InternalSetDomain (MonoAppDomain *ad) MONO_INTERNAL;
592 ves_icall_System_AppDomain_InternalSetDomainByID (gint32 domainid) MONO_INTERNAL;
595 ves_icall_System_AppDomain_InternalPushDomainRef (MonoAppDomain *ad) MONO_INTERNAL;
598 ves_icall_System_AppDomain_InternalPushDomainRefByID (gint32 domain_id) MONO_INTERNAL;
601 ves_icall_System_AppDomain_InternalPopDomainRef (void) MONO_INTERNAL;
604 ves_icall_System_AppDomain_InternalGetContext (void) MONO_INTERNAL;
607 ves_icall_System_AppDomain_InternalGetDefaultContext (void) MONO_INTERNAL;
610 ves_icall_System_AppDomain_InternalSetContext (MonoAppContext *mc) MONO_INTERNAL;
613 ves_icall_System_AppDomain_GetIDFromDomain (MonoAppDomain * ad) MONO_INTERNAL;
616 ves_icall_System_AppDomain_InternalGetProcessGuid (MonoString* newguid) MONO_INTERNAL;
619 mono_assembly_load_corlib (const MonoRuntimeInfo *runtime, MonoImageOpenStatus *status) MONO_INTERNAL;
621 const MonoRuntimeInfo*
622 mono_get_runtime_info (void) MONO_INTERNAL;
625 mono_runtime_set_no_exec (gboolean val) MONO_INTERNAL;
628 mono_runtime_get_no_exec (void) MONO_INTERNAL;
631 mono_assembly_name_parse (const char *name, MonoAssemblyName *aname) MONO_INTERNAL;
633 MonoImage *mono_assembly_open_from_bundle (const char *filename,
634 MonoImageOpenStatus *status,
635 gboolean refonly) MONO_INTERNAL;
638 mono_domain_add_class_static_data (MonoDomain *domain, MonoClass *klass, gpointer data, guint32 *bitmap);
640 MonoReflectionAssembly *
641 mono_try_assembly_resolve (MonoDomain *domain, MonoString *fname, gboolean refonly) MONO_INTERNAL;
643 MonoAssembly* mono_assembly_load_full_nosearch (MonoAssemblyName *aname,
645 MonoImageOpenStatus *status,
646 gboolean refonly) MONO_INTERNAL;
648 void mono_set_private_bin_path_from_config (MonoDomain *domain) MONO_INTERNAL;
650 int mono_framework_version (void) MONO_INTERNAL;
652 void mono_reflection_cleanup_domain (MonoDomain *domain) MONO_INTERNAL;
654 void mono_assembly_cleanup_domain_bindings (guint32 domain_id) MONO_INTERNAL;
656 MonoJitInfo* mono_jit_info_table_find_internal (MonoDomain *domain, char *addr, gboolean try_aot) MONO_INTERNAL;
658 void mono_enable_debug_domain_unload (gboolean enable);
660 #endif /* __MONO_METADATA_DOMAIN_INTERNALS_H__ */