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 * Will contain information on the generic type arguments in the
95 * future. For now, all arguments are always reference types.
99 } MonoGenericSharingContext;
101 /* Simplified DWARF location list entry */
103 /* Whenever the value is in a register */
106 * If is_reg is TRUE, the register which contains the value. Otherwise
111 * If is_reg is FALSE, the offset of the stack location relative to 'reg'.
116 * Offsets of the PC interval where the value is in this location.
119 } MonoDwarfLocListEntry;
123 MonoGenericSharingContext *generic_sharing_context;
125 MonoDwarfLocListEntry *locations;
129 gboolean this_in_reg:1;
130 } MonoGenericJitInfo;
133 A try block hole is used to represent a non-contiguous part of
134 of a segment of native code protected by a given .try block.
135 Usually, a try block is defined as a contiguous segment of code.
136 But in some cases it's needed to have some parts of it to not be protected.
137 For example, given "try {} finally {}", the code in the .try block to call
138 the finally part looks like:
144 jump outside try block
150 The instructions between the call and the jump should not be under the try block since they happen
151 after the finally block executes, which means if an async exceptions happens at that point we would
152 execute the finally clause twice. So, to avoid this, we introduce a hole in the try block to signal
153 that those instructions are not protected.
160 } MonoTryBlockHoleJitInfo;
165 MonoTryBlockHoleJitInfo holes [MONO_ZERO_LEN_ARRAY];
166 } MonoTryBlockHoleTableJitInfo;
174 gboolean cas_inited:1;
175 gboolean cas_class_assert:1;
176 gboolean cas_class_deny:1;
177 gboolean cas_class_permitonly:1;
178 gboolean cas_method_assert:1;
179 gboolean cas_method_deny:1;
180 gboolean cas_method_permitonly:1;
183 struct _MonoJitInfo {
184 /* NOTE: These first two elements (method and
185 next_jit_code_hash) must be in the same order and at the
186 same offset as in RuntimeMethod, because of the jit_code_hash
187 internal hash table in MonoDomain. */
189 struct _MonoJitInfo *next_jit_code_hash;
191 /* This might contain an id for the unwind info instead of a register mask */
194 guint32 num_clauses:15;
195 /* Whenever the code is domain neutral or 'shared' */
196 gboolean domain_neutral:1;
197 gboolean has_cas_info:1;
198 gboolean has_generic_jit_info:1;
199 gboolean has_try_block_holes:1;
200 gboolean has_arch_eh_info:1;
202 gboolean from_llvm:1;
203 gboolean dbg_hidden_inited:1;
204 gboolean dbg_hidden:1;
206 /* FIXME: Embed this after the structure later*/
207 gpointer gc_info; /* Currently only used by SGen */
209 MonoJitExceptionInfo clauses [MONO_ZERO_LEN_ARRAY];
210 /* There is an optional MonoGenericJitInfo after the clauses */
211 /* There is an optional MonoTryBlockHoleTableJitInfo after MonoGenericJitInfo clauses*/
212 /* There is an optional MonoArchEHJitInfo after MonoTryBlockHoleTableJitInfo */
215 #define MONO_SIZEOF_JIT_INFO (offsetof (struct _MonoJitInfo, clauses))
217 struct _MonoAppContext {
221 gpointer *static_data;
225 * We have two unloading states because the domain
226 * must remain fully functional while AppDomain::DomainUnload is
228 * After that unloading began and all domain facilities are teared down
229 * such as execution of new threadpool jobs.
232 MONO_APPDOMAIN_CREATED,
233 MONO_APPDOMAIN_UNLOADING_START,
234 MONO_APPDOMAIN_UNLOADING,
235 MONO_APPDOMAIN_UNLOADED
236 } MonoAppDomainState;
238 typedef struct _MonoThunkFreeList {
240 int length; /* only valid for the wait list */
241 struct _MonoThunkFreeList *next;
244 typedef struct _MonoJitCodeHash MonoJitCodeHash;
246 typedef struct _MonoTlsDataRecord MonoTlsDataRecord;
247 struct _MonoTlsDataRecord {
248 MonoTlsDataRecord *next;
255 * This lock must never be taken before the loader lock,
256 * i.e. if both are taken by the same thread, the loader lock
259 CRITICAL_SECTION lock;
261 MonoCodeManager *code_mp;
263 * keep all the managed objects close to each other for the precise GC
264 * For the Boehm GC we additionally keep close also other GC-tracked pointers.
266 #define MONO_DOMAIN_FIRST_OBJECT setup
267 MonoAppDomainSetup *setup;
268 MonoAppDomain *domain;
269 MonoAppContext *default_context;
270 MonoException *out_of_memory_ex;
271 MonoException *null_reference_ex;
272 MonoException *stack_overflow_ex;
274 MonoObject *typeof_void;
275 /* Ephemeron Tombstone*/
276 MonoObject *ephemeron_tombstone;
277 /* new MonoType [0] */
278 MonoArray *empty_types;
280 * The fields between FIRST_GC_TRACKED and LAST_GC_TRACKED are roots, but
281 * not object references.
283 #define MONO_DOMAIN_FIRST_GC_TRACKED env
285 MonoGHashTable *ldstr_table;
286 /* hashtables for Reflection handles */
287 MonoGHashTable *type_hash;
288 MonoGHashTable *refobject_hash;
289 /* a GC-tracked array to keep references to the static fields of types */
290 gpointer *static_data_array;
291 /* maps class -> type initialization exception object */
292 MonoGHashTable *type_init_exception_hash;
293 /* maps delegate trampoline addr -> delegate object */
294 MonoGHashTable *delegate_hash_table;
295 #define MONO_DOMAIN_LAST_GC_TRACKED delegate_hash_table
297 /* Needed by Thread:GetDomainID() */
299 gint32 shadow_serial;
300 unsigned char inet_family_hint; // used in socket-io.c as a cache
301 GSList *domain_assemblies;
302 MonoAssembly *entry_assembly;
304 GPtrArray *class_vtable_array;
305 /* maps remote class key -> MonoRemoteClass */
306 GHashTable *proxy_vtable_hash;
307 /* Protected by 'jit_code_hash_lock' */
308 MonoInternalHashTable jit_code_hash;
309 CRITICAL_SECTION jit_code_hash_lock;
310 int num_jit_info_tables;
312 volatile jit_info_table;
313 GSList *jit_info_free_queue;
314 /* Used when loading assemblies */
316 gchar *private_bin_path;
318 /* Used by remoting proxies */
319 MonoMethod *create_proxy_for_type_method;
320 MonoMethod *private_invoke_method;
321 /* Used to store offsets of thread and context static fields */
322 GHashTable *special_static_fields;
323 MonoTlsDataRecord *tlsrec_list;
325 * This must be a GHashTable, since these objects can't be finalized
326 * if the hashtable contains a GC visible reference to them.
328 GHashTable *finalizable_objects_hash;
330 /* These two are boehm only */
331 /* Maps MonoObjects to a GSList of WeakTrackResurrection GCHandles pointing to them */
332 GHashTable *track_resurrection_objects_hash;
333 /* Maps WeakTrackResurrection GCHandles to the MonoObjects they point to */
334 GHashTable *track_resurrection_handles_hash;
336 /* Protects the three hashes above */
337 CRITICAL_SECTION finalizable_objects_hash_lock;
338 /* Used when accessing 'domain_assemblies' */
339 CRITICAL_SECTION assemblies_lock;
341 GHashTable *method_rgctx_hash;
343 GHashTable *generic_virtual_cases;
344 MonoThunkFreeList **thunk_free_lists;
346 GHashTable *generic_virtual_thunks;
348 /* Information maintained by the JIT engine */
349 gpointer runtime_info;
351 /*thread pool jobs, used to coordinate shutdown.*/
352 volatile int threadpool_jobs;
353 HANDLE cleanup_semaphore;
355 /* Contains the compiled runtime invoke wrapper used by finalizers */
356 gpointer finalize_runtime_invoke;
358 /* Contains the compiled runtime invoke wrapper used by async resylt creation to capture thread context*/
359 gpointer capture_context_runtime_invoke;
361 /* Contains the compiled method used by async resylt creation to capture thread context*/
362 gpointer capture_context_method;
364 /* Assembly bindings, the per-domain part */
365 GSList *assembly_bindings;
366 gboolean assembly_bindings_parsed;
368 /* Used by socket-io.c */
369 /* These are domain specific, since the assembly can be unloaded */
370 MonoImage *socket_assembly;
371 MonoClass *sockaddr_class;
372 MonoClassField *sockaddr_data_field;
374 /* Used by threadpool.c */
375 MonoImage *system_image;
376 MonoClass *corlib_asyncresult_class;
377 MonoClass *socket_class;
378 MonoClass *ad_unloaded_ex_class;
379 MonoClass *process_class;
381 /* Cache function pointers for architectures */
382 /* that require wrappers */
383 GHashTable *ftnptrs_hash;
385 guint32 execution_context_field_offset;
389 guint16 major, minor, build, revision;
390 } AssemblyVersionSet;
392 /* MonoRuntimeInfo: Contains information about versions supported by this runtime */
394 const char runtime_version [12];
395 const char framework_version [4];
396 const AssemblyVersionSet version_sets [4];
399 #define mono_domain_lock(domain) mono_locks_acquire(&(domain)->lock, DomainLock)
400 #define mono_domain_unlock(domain) mono_locks_release(&(domain)->lock, DomainLock)
401 #define mono_domain_assemblies_lock(domain) mono_locks_acquire(&(domain)->assemblies_lock, DomainAssembliesLock)
402 #define mono_domain_assemblies_unlock(domain) mono_locks_release(&(domain)->assemblies_lock, DomainAssembliesLock)
403 #define mono_domain_jit_code_hash_lock(domain) mono_locks_acquire(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
404 #define mono_domain_jit_code_hash_unlock(domain) mono_locks_release(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
406 typedef MonoDomain* (*MonoLoadFunc) (const char *filename, const char *runtime_version);
409 mono_install_runtime_load (MonoLoadFunc func) MONO_INTERNAL;
412 mono_runtime_load (const char *filename, const char *runtime_version) MONO_INTERNAL;
414 typedef void (*MonoCreateDomainFunc) (MonoDomain *domain);
417 mono_install_create_domain_hook (MonoCreateDomainFunc func) MONO_INTERNAL;
419 typedef void (*MonoFreeDomainFunc) (MonoDomain *domain);
422 mono_install_free_domain_hook (MonoFreeDomainFunc func) MONO_INTERNAL;
425 mono_init_com_types (void) MONO_INTERNAL;
428 mono_cleanup (void) MONO_INTERNAL;
431 mono_close_exe_image (void) MONO_INTERNAL;
434 mono_jit_info_table_add (MonoDomain *domain, MonoJitInfo *ji) MONO_INTERNAL;
437 mono_jit_info_table_remove (MonoDomain *domain, MonoJitInfo *ji) MONO_INTERNAL;
440 mono_jit_info_add_aot_module (MonoImage *image, gpointer start, gpointer end) MONO_INTERNAL;
443 mono_jit_info_get_generic_jit_info (MonoJitInfo *ji) MONO_INTERNAL;
445 MonoGenericSharingContext*
446 mono_jit_info_get_generic_sharing_context (MonoJitInfo *ji) MONO_INTERNAL;
449 mono_jit_info_set_generic_sharing_context (MonoJitInfo *ji, MonoGenericSharingContext *gsctx) MONO_INTERNAL;
452 mono_domain_lookup_shared_generic (MonoDomain *domain, MonoMethod *method) MONO_INTERNAL;
455 mono_make_shadow_copy (const char *filename) MONO_INTERNAL;
458 mono_is_shadow_copy_enabled (MonoDomain *domain, const gchar *dir_name) MONO_INTERNAL;
461 mono_domain_alloc (MonoDomain *domain, guint size) MONO_INTERNAL;
464 mono_domain_alloc0 (MonoDomain *domain, guint size) MONO_INTERNAL;
467 mono_domain_code_reserve (MonoDomain *domain, int size) MONO_LLVM_INTERNAL;
470 mono_domain_code_reserve_align (MonoDomain *domain, int size, int alignment) MONO_INTERNAL;
473 mono_domain_code_commit (MonoDomain *domain, void *data, int size, int newsize) MONO_INTERNAL;
476 nacl_domain_get_code_dest (MonoDomain *domain, void *data) MONO_INTERNAL;
479 nacl_domain_code_validate (MonoDomain *domain, guint8 **buf_base, int buf_size, guint8 **code_end) MONO_INTERNAL;
482 mono_domain_code_foreach (MonoDomain *domain, MonoCodeManagerFunc func, void *user_data) MONO_INTERNAL;
485 mono_domain_unset (void) MONO_INTERNAL;
488 mono_domain_set_internal_with_options (MonoDomain *domain, gboolean migrate_exception) MONO_INTERNAL;
490 MonoTryBlockHoleTableJitInfo*
491 mono_jit_info_get_try_block_hole_table_info (MonoJitInfo *ji) MONO_INTERNAL;
494 mono_jit_info_get_arch_eh_info (MonoJitInfo *ji) MONO_INTERNAL;
497 mono_jit_info_get_cas_info (MonoJitInfo *ji) MONO_INTERNAL;
500 * Installs a new function which is used to return a MonoJitInfo for a method inside
503 typedef MonoJitInfo *(*MonoJitInfoFindInAot) (MonoDomain *domain, MonoImage *image, gpointer addr);
504 void mono_install_jit_info_find_in_aot (MonoJitInfoFindInAot func) MONO_INTERNAL;
507 mono_jit_code_hash_init (MonoInternalHashTable *jit_code_hash) MONO_INTERNAL;
510 ves_icall_System_AppDomain_getCurDomain (void) MONO_INTERNAL;
513 ves_icall_System_AppDomain_getRootDomain (void) MONO_INTERNAL;
516 ves_icall_System_AppDomain_createDomain (MonoString *friendly_name,
517 MonoAppDomainSetup *setup) MONO_INTERNAL;
520 ves_icall_System_AppDomain_GetData (MonoAppDomain *ad,
521 MonoString *name) MONO_INTERNAL;
523 MonoReflectionAssembly *
524 ves_icall_System_AppDomain_LoadAssemblyRaw (MonoAppDomain *ad,
525 MonoArray *raw_assembly,
526 MonoArray *raw_symbol_store,
527 MonoObject *evidence,
528 MonoBoolean refonly) MONO_INTERNAL;
531 ves_icall_System_AppDomain_SetData (MonoAppDomain *ad,
533 MonoObject *data) MONO_INTERNAL;
536 ves_icall_System_AppDomain_getSetup (MonoAppDomain *ad) MONO_INTERNAL;
539 ves_icall_System_AppDomain_getFriendlyName (MonoAppDomain *ad) MONO_INTERNAL;
542 ves_icall_System_AppDomain_GetAssemblies (MonoAppDomain *ad,
543 MonoBoolean refonly) MONO_INTERNAL;
545 MonoReflectionAssembly *
546 ves_icall_System_Reflection_Assembly_LoadFrom (MonoString *fname,
547 MonoBoolean refonly) MONO_INTERNAL;
549 MonoReflectionAssembly *
550 ves_icall_System_AppDomain_LoadAssembly (MonoAppDomain *ad,
552 MonoObject *evidence,
553 MonoBoolean refonly) MONO_INTERNAL;
556 ves_icall_System_AppDomain_InternalIsFinalizingForUnload (gint32 domain_id) MONO_INTERNAL;
559 ves_icall_System_AppDomain_InternalUnload (gint32 domain_id) MONO_INTERNAL;
562 ves_icall_System_AppDomain_ExecuteAssembly (MonoAppDomain *ad,
563 MonoReflectionAssembly *refass,
564 MonoArray *args) MONO_INTERNAL;
567 ves_icall_System_AppDomain_InternalSetDomain (MonoAppDomain *ad) MONO_INTERNAL;
570 ves_icall_System_AppDomain_InternalSetDomainByID (gint32 domainid) MONO_INTERNAL;
573 ves_icall_System_AppDomain_InternalPushDomainRef (MonoAppDomain *ad) MONO_INTERNAL;
576 ves_icall_System_AppDomain_InternalPushDomainRefByID (gint32 domain_id) MONO_INTERNAL;
579 ves_icall_System_AppDomain_InternalPopDomainRef (void) MONO_INTERNAL;
582 ves_icall_System_AppDomain_InternalGetContext (void) MONO_INTERNAL;
585 ves_icall_System_AppDomain_InternalGetDefaultContext (void) MONO_INTERNAL;
588 ves_icall_System_AppDomain_InternalSetContext (MonoAppContext *mc) MONO_INTERNAL;
591 ves_icall_System_AppDomain_GetIDFromDomain (MonoAppDomain * ad) MONO_INTERNAL;
594 ves_icall_System_AppDomain_InternalGetProcessGuid (MonoString* newguid) MONO_INTERNAL;
597 mono_assembly_load_corlib (const MonoRuntimeInfo *runtime, MonoImageOpenStatus *status) MONO_INTERNAL;
599 const MonoRuntimeInfo*
600 mono_get_runtime_info (void) MONO_INTERNAL;
603 mono_runtime_set_no_exec (gboolean val) MONO_INTERNAL;
606 mono_runtime_get_no_exec (void) MONO_INTERNAL;
609 mono_assembly_name_parse (const char *name, MonoAssemblyName *aname) MONO_INTERNAL;
611 MonoImage *mono_assembly_open_from_bundle (const char *filename,
612 MonoImageOpenStatus *status,
613 gboolean refonly) MONO_INTERNAL;
616 mono_domain_add_class_static_data (MonoDomain *domain, MonoClass *klass, gpointer data, guint32 *bitmap);
618 MonoReflectionAssembly *
619 mono_try_assembly_resolve (MonoDomain *domain, MonoString *fname, gboolean refonly) MONO_INTERNAL;
621 MonoAssembly* mono_assembly_load_full_nosearch (MonoAssemblyName *aname,
623 MonoImageOpenStatus *status,
624 gboolean refonly) MONO_INTERNAL;
626 void mono_set_private_bin_path_from_config (MonoDomain *domain) MONO_INTERNAL;
628 int mono_framework_version (void) MONO_INTERNAL;
630 void mono_reflection_cleanup_domain (MonoDomain *domain) MONO_INTERNAL;
632 void mono_assembly_cleanup_domain_bindings (guint32 domain_id) MONO_INTERNAL;;
634 #endif /* __MONO_METADATA_DOMAIN_INTERNALS_H__ */