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. */
194 struct _MonoJitInfo *next_jit_code_hash;
196 /* This might contain an id for the unwind info instead of a register mask */
199 guint32 num_clauses:15;
200 /* Whenever the code is domain neutral or 'shared' */
201 gboolean domain_neutral:1;
202 gboolean has_cas_info:1;
203 gboolean has_generic_jit_info:1;
204 gboolean has_try_block_holes:1;
205 gboolean has_arch_eh_info:1;
207 gboolean from_llvm:1;
208 gboolean dbg_hidden_inited:1;
209 gboolean dbg_hidden:1;
211 /* FIXME: Embed this after the structure later*/
212 gpointer gc_info; /* Currently only used by SGen */
214 MonoJitExceptionInfo clauses [MONO_ZERO_LEN_ARRAY];
215 /* There is an optional MonoGenericJitInfo after the clauses */
216 /* There is an optional MonoTryBlockHoleTableJitInfo after MonoGenericJitInfo clauses*/
217 /* There is an optional MonoArchEHJitInfo after MonoTryBlockHoleTableJitInfo */
220 #define MONO_SIZEOF_JIT_INFO (offsetof (struct _MonoJitInfo, clauses))
222 struct _MonoAppContext {
226 gpointer *static_data;
230 * We have two unloading states because the domain
231 * must remain fully functional while AppDomain::DomainUnload is
233 * After that unloading began and all domain facilities are teared down
234 * such as execution of new threadpool jobs.
237 MONO_APPDOMAIN_CREATED,
238 MONO_APPDOMAIN_UNLOADING_START,
239 MONO_APPDOMAIN_UNLOADING,
240 MONO_APPDOMAIN_UNLOADED
241 } MonoAppDomainState;
243 typedef struct _MonoThunkFreeList {
245 int length; /* only valid for the wait list */
246 struct _MonoThunkFreeList *next;
249 typedef struct _MonoJitCodeHash MonoJitCodeHash;
251 typedef struct _MonoTlsDataRecord MonoTlsDataRecord;
252 struct _MonoTlsDataRecord {
253 MonoTlsDataRecord *next;
260 * This lock must never be taken before the loader lock,
261 * i.e. if both are taken by the same thread, the loader lock
264 CRITICAL_SECTION lock;
266 MonoCodeManager *code_mp;
268 * keep all the managed objects close to each other for the precise GC
269 * For the Boehm GC we additionally keep close also other GC-tracked pointers.
271 #define MONO_DOMAIN_FIRST_OBJECT setup
272 MonoAppDomainSetup *setup;
273 MonoAppDomain *domain;
274 MonoAppContext *default_context;
275 MonoException *out_of_memory_ex;
276 MonoException *null_reference_ex;
277 MonoException *stack_overflow_ex;
279 MonoObject *typeof_void;
280 /* Ephemeron Tombstone*/
281 MonoObject *ephemeron_tombstone;
282 /* new MonoType [0] */
283 MonoArray *empty_types;
285 * The fields between FIRST_GC_TRACKED and LAST_GC_TRACKED are roots, but
286 * not object references.
288 #define MONO_DOMAIN_FIRST_GC_TRACKED env
290 MonoGHashTable *ldstr_table;
291 /* hashtables for Reflection handles */
292 MonoGHashTable *type_hash;
293 MonoGHashTable *refobject_hash;
294 /* a GC-tracked array to keep references to the static fields of types */
295 gpointer *static_data_array;
296 /* maps class -> type initialization exception object */
297 MonoGHashTable *type_init_exception_hash;
298 /* maps delegate trampoline addr -> delegate object */
299 MonoGHashTable *delegate_hash_table;
300 #define MONO_DOMAIN_LAST_GC_TRACKED delegate_hash_table
302 /* Needed by Thread:GetDomainID() */
304 gint32 shadow_serial;
305 unsigned char inet_family_hint; // used in socket-io.c as a cache
306 GSList *domain_assemblies;
307 MonoAssembly *entry_assembly;
309 GPtrArray *class_vtable_array;
310 /* maps remote class key -> MonoRemoteClass */
311 GHashTable *proxy_vtable_hash;
312 /* Protected by 'jit_code_hash_lock' */
313 MonoInternalHashTable jit_code_hash;
314 CRITICAL_SECTION jit_code_hash_lock;
315 int num_jit_info_tables;
317 volatile jit_info_table;
318 GSList *jit_info_free_queue;
319 /* Used when loading assemblies */
321 gchar *private_bin_path;
323 /* Used by remoting proxies */
324 MonoMethod *create_proxy_for_type_method;
325 MonoMethod *private_invoke_method;
326 /* Used to store offsets of thread and context static fields */
327 GHashTable *special_static_fields;
328 MonoTlsDataRecord *tlsrec_list;
330 * This must be a GHashTable, since these objects can't be finalized
331 * if the hashtable contains a GC visible reference to them.
333 GHashTable *finalizable_objects_hash;
335 /* Protects the three hashes above */
336 CRITICAL_SECTION finalizable_objects_hash_lock;
337 /* Used when accessing 'domain_assemblies' */
338 CRITICAL_SECTION assemblies_lock;
340 GHashTable *method_rgctx_hash;
342 GHashTable *generic_virtual_cases;
343 MonoThunkFreeList **thunk_free_lists;
345 GHashTable *generic_virtual_thunks;
347 /* Information maintained by the JIT engine */
348 gpointer runtime_info;
350 /*thread pool jobs, used to coordinate shutdown.*/
351 volatile int threadpool_jobs;
352 HANDLE cleanup_semaphore;
354 /* Contains the compiled runtime invoke wrapper used by finalizers */
355 gpointer finalize_runtime_invoke;
357 /* Contains the compiled runtime invoke wrapper used by async resylt creation to capture thread context*/
358 gpointer capture_context_runtime_invoke;
360 /* Contains the compiled method used by async resylt creation to capture thread context*/
361 gpointer capture_context_method;
363 /* Assembly bindings, the per-domain part */
364 GSList *assembly_bindings;
365 gboolean assembly_bindings_parsed;
367 /* Used by socket-io.c */
368 /* These are domain specific, since the assembly can be unloaded */
369 MonoImage *socket_assembly;
370 MonoClass *sockaddr_class;
371 MonoClassField *sockaddr_data_field;
373 /* Used by threadpool.c */
374 MonoImage *system_image;
375 MonoClass *corlib_asyncresult_class;
376 MonoClass *socket_class;
377 MonoClass *ad_unloaded_ex_class;
378 MonoClass *process_class;
380 /* Cache function pointers for architectures */
381 /* that require wrappers */
382 GHashTable *ftnptrs_hash;
384 guint32 execution_context_field_offset;
388 guint16 major, minor, build, revision;
389 } AssemblyVersionSet;
391 /* MonoRuntimeInfo: Contains information about versions supported by this runtime */
393 const char runtime_version [12];
394 const char framework_version [4];
395 const AssemblyVersionSet version_sets [4];
398 #define mono_domain_lock(domain) mono_locks_acquire(&(domain)->lock, DomainLock)
399 #define mono_domain_unlock(domain) mono_locks_release(&(domain)->lock, DomainLock)
400 #define mono_domain_assemblies_lock(domain) mono_locks_acquire(&(domain)->assemblies_lock, DomainAssembliesLock)
401 #define mono_domain_assemblies_unlock(domain) mono_locks_release(&(domain)->assemblies_lock, DomainAssembliesLock)
402 #define mono_domain_jit_code_hash_lock(domain) mono_locks_acquire(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
403 #define mono_domain_jit_code_hash_unlock(domain) mono_locks_release(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
405 typedef MonoDomain* (*MonoLoadFunc) (const char *filename, const char *runtime_version);
408 mono_install_runtime_load (MonoLoadFunc func) MONO_INTERNAL;
411 mono_runtime_load (const char *filename, const char *runtime_version) MONO_INTERNAL;
413 typedef void (*MonoCreateDomainFunc) (MonoDomain *domain);
416 mono_install_create_domain_hook (MonoCreateDomainFunc func) MONO_INTERNAL;
418 typedef void (*MonoFreeDomainFunc) (MonoDomain *domain);
421 mono_install_free_domain_hook (MonoFreeDomainFunc func) MONO_INTERNAL;
424 mono_cleanup (void) MONO_INTERNAL;
427 mono_close_exe_image (void) MONO_INTERNAL;
430 mono_jit_info_table_add (MonoDomain *domain, MonoJitInfo *ji) MONO_INTERNAL;
433 mono_jit_info_table_remove (MonoDomain *domain, MonoJitInfo *ji) MONO_INTERNAL;
436 mono_jit_info_add_aot_module (MonoImage *image, gpointer start, gpointer end) MONO_INTERNAL;
439 mono_jit_info_get_generic_jit_info (MonoJitInfo *ji) MONO_INTERNAL;
441 MonoGenericSharingContext*
442 mono_jit_info_get_generic_sharing_context (MonoJitInfo *ji) MONO_INTERNAL;
445 mono_jit_info_set_generic_sharing_context (MonoJitInfo *ji, MonoGenericSharingContext *gsctx) MONO_INTERNAL;
448 mono_domain_lookup_shared_generic (MonoDomain *domain, MonoMethod *method) MONO_INTERNAL;
451 mono_make_shadow_copy (const char *filename) MONO_INTERNAL;
454 mono_is_shadow_copy_enabled (MonoDomain *domain, const gchar *dir_name) MONO_INTERNAL;
457 mono_domain_alloc (MonoDomain *domain, guint size) MONO_INTERNAL;
460 mono_domain_alloc0 (MonoDomain *domain, guint size) MONO_INTERNAL;
463 mono_domain_code_reserve (MonoDomain *domain, int size) MONO_LLVM_INTERNAL;
466 mono_domain_code_reserve_align (MonoDomain *domain, int size, int alignment) MONO_INTERNAL;
469 mono_domain_code_commit (MonoDomain *domain, void *data, int size, int newsize) MONO_INTERNAL;
472 nacl_domain_get_code_dest (MonoDomain *domain, void *data) MONO_INTERNAL;
475 nacl_domain_code_validate (MonoDomain *domain, guint8 **buf_base, int buf_size, guint8 **code_end) MONO_INTERNAL;
478 mono_domain_code_foreach (MonoDomain *domain, MonoCodeManagerFunc func, void *user_data) MONO_INTERNAL;
481 mono_domain_unset (void) MONO_INTERNAL;
484 mono_domain_set_internal_with_options (MonoDomain *domain, gboolean migrate_exception) MONO_INTERNAL;
486 MonoTryBlockHoleTableJitInfo*
487 mono_jit_info_get_try_block_hole_table_info (MonoJitInfo *ji) MONO_INTERNAL;
490 mono_jit_info_get_arch_eh_info (MonoJitInfo *ji) MONO_INTERNAL;
493 mono_jit_info_get_cas_info (MonoJitInfo *ji) MONO_INTERNAL;
496 * Installs a new function which is used to return a MonoJitInfo for a method inside
499 typedef MonoJitInfo *(*MonoJitInfoFindInAot) (MonoDomain *domain, MonoImage *image, gpointer addr);
500 void mono_install_jit_info_find_in_aot (MonoJitInfoFindInAot func) MONO_INTERNAL;
503 mono_jit_code_hash_init (MonoInternalHashTable *jit_code_hash) MONO_INTERNAL;
506 ves_icall_System_AppDomain_getCurDomain (void) MONO_INTERNAL;
509 ves_icall_System_AppDomain_getRootDomain (void) MONO_INTERNAL;
512 ves_icall_System_AppDomain_createDomain (MonoString *friendly_name,
513 MonoAppDomainSetup *setup) MONO_INTERNAL;
516 ves_icall_System_AppDomain_GetData (MonoAppDomain *ad,
517 MonoString *name) MONO_INTERNAL;
519 MonoReflectionAssembly *
520 ves_icall_System_AppDomain_LoadAssemblyRaw (MonoAppDomain *ad,
521 MonoArray *raw_assembly,
522 MonoArray *raw_symbol_store,
523 MonoObject *evidence,
524 MonoBoolean refonly) MONO_INTERNAL;
527 ves_icall_System_AppDomain_SetData (MonoAppDomain *ad,
529 MonoObject *data) MONO_INTERNAL;
532 ves_icall_System_AppDomain_getSetup (MonoAppDomain *ad) MONO_INTERNAL;
535 ves_icall_System_AppDomain_getFriendlyName (MonoAppDomain *ad) MONO_INTERNAL;
538 ves_icall_System_AppDomain_GetAssemblies (MonoAppDomain *ad,
539 MonoBoolean refonly) MONO_INTERNAL;
541 MonoReflectionAssembly *
542 ves_icall_System_Reflection_Assembly_LoadFrom (MonoString *fname,
543 MonoBoolean refonly) MONO_INTERNAL;
545 MonoReflectionAssembly *
546 ves_icall_System_AppDomain_LoadAssembly (MonoAppDomain *ad,
548 MonoObject *evidence,
549 MonoBoolean refonly) MONO_INTERNAL;
552 ves_icall_System_AppDomain_InternalIsFinalizingForUnload (gint32 domain_id) MONO_INTERNAL;
555 ves_icall_System_AppDomain_InternalUnload (gint32 domain_id) MONO_INTERNAL;
558 ves_icall_System_AppDomain_ExecuteAssembly (MonoAppDomain *ad,
559 MonoReflectionAssembly *refass,
560 MonoArray *args) MONO_INTERNAL;
563 ves_icall_System_AppDomain_InternalSetDomain (MonoAppDomain *ad) MONO_INTERNAL;
566 ves_icall_System_AppDomain_InternalSetDomainByID (gint32 domainid) MONO_INTERNAL;
569 ves_icall_System_AppDomain_InternalPushDomainRef (MonoAppDomain *ad) MONO_INTERNAL;
572 ves_icall_System_AppDomain_InternalPushDomainRefByID (gint32 domain_id) MONO_INTERNAL;
575 ves_icall_System_AppDomain_InternalPopDomainRef (void) MONO_INTERNAL;
578 ves_icall_System_AppDomain_InternalGetContext (void) MONO_INTERNAL;
581 ves_icall_System_AppDomain_InternalGetDefaultContext (void) MONO_INTERNAL;
584 ves_icall_System_AppDomain_InternalSetContext (MonoAppContext *mc) MONO_INTERNAL;
587 ves_icall_System_AppDomain_GetIDFromDomain (MonoAppDomain * ad) MONO_INTERNAL;
590 ves_icall_System_AppDomain_InternalGetProcessGuid (MonoString* newguid) MONO_INTERNAL;
593 mono_assembly_load_corlib (const MonoRuntimeInfo *runtime, MonoImageOpenStatus *status) MONO_INTERNAL;
595 const MonoRuntimeInfo*
596 mono_get_runtime_info (void) MONO_INTERNAL;
599 mono_runtime_set_no_exec (gboolean val) MONO_INTERNAL;
602 mono_runtime_get_no_exec (void) MONO_INTERNAL;
605 mono_assembly_name_parse (const char *name, MonoAssemblyName *aname) MONO_INTERNAL;
607 MonoImage *mono_assembly_open_from_bundle (const char *filename,
608 MonoImageOpenStatus *status,
609 gboolean refonly) MONO_INTERNAL;
612 mono_domain_add_class_static_data (MonoDomain *domain, MonoClass *klass, gpointer data, guint32 *bitmap);
614 MonoReflectionAssembly *
615 mono_try_assembly_resolve (MonoDomain *domain, MonoString *fname, gboolean refonly) MONO_INTERNAL;
617 MonoAssembly* mono_assembly_load_full_nosearch (MonoAssemblyName *aname,
619 MonoImageOpenStatus *status,
620 gboolean refonly) MONO_INTERNAL;
622 void mono_set_private_bin_path_from_config (MonoDomain *domain) MONO_INTERNAL;
624 int mono_framework_version (void) MONO_INTERNAL;
626 void mono_reflection_cleanup_domain (MonoDomain *domain) MONO_INTERNAL;
628 void mono_assembly_cleanup_domain_bindings (guint32 domain_id) MONO_INTERNAL;;
630 #endif /* __MONO_METADATA_DOMAIN_INTERNALS_H__ */