2 * Appdomain-related internal data structures and functions.
4 #ifndef __MONO_METADATA_DOMAIN_INTERNALS_H__
5 #define __MONO_METADATA_DOMAIN_INTERNALS_H__
7 #include <mono/metadata/appdomain.h>
8 #include <mono/metadata/mempool.h>
9 #include <mono/metadata/lock-tracer.h>
10 #include <mono/utils/mono-codeman.h>
11 #include <mono/metadata/mono-hash.h>
12 #include <mono/utils/mono-compiler.h>
13 #include <mono/utils/mono-internal-hash.h>
14 #include <mono/io-layer/io-layer.h>
15 #include <mono/metadata/mempool-internals.h>
17 extern CRITICAL_SECTION mono_delegate_section;
18 extern CRITICAL_SECTION mono_strtod_mutex;
21 * If this is set, the memory belonging to appdomains is not freed when a domain is
22 * unloaded, and assemblies loaded by the appdomain are not unloaded either. This
23 * allows us to use typed gc in non-default appdomains too, leading to increased
26 extern gboolean mono_dont_free_domains;
28 /* This is a copy of System.AppDomainSetup */
31 MonoString *application_base;
32 MonoString *application_name;
33 MonoString *cache_path;
34 MonoString *configuration_file;
35 MonoString *dynamic_base;
36 MonoString *license_file;
37 MonoString *private_bin_path;
38 MonoString *private_bin_path_probe;
39 MonoString *shadow_copy_directories;
40 MonoString *shadow_copy_files;
41 MonoBoolean publisher_policy;
42 MonoBoolean path_changed;
43 int loader_optimization;
44 MonoBoolean disallow_binding_redirects;
45 MonoBoolean disallow_code_downloads;
46 MonoObject *activation_arguments; /* it is System.Object in 1.x, ActivationArguments in 2.0 */
47 MonoObject *domain_initializer;
48 MonoObject *application_trust; /* it is System.Object in 1.x, ApplicationTrust in 2.0 */
49 MonoArray *domain_initializer_args;
50 MonoBoolean disallow_appbase_probe;
51 MonoArray *configuration_bytes;
52 MonoArray *serialized_non_primitives;
55 typedef struct _MonoJitInfoTable MonoJitInfoTable;
56 typedef struct _MonoJitInfoTableChunk MonoJitInfoTableChunk;
58 #define MONO_JIT_INFO_TABLE_CHUNK_SIZE 64
60 struct _MonoJitInfoTableChunk
63 volatile int num_elements;
64 volatile gint8 *last_code_end;
65 MonoJitInfo * volatile data [MONO_JIT_INFO_TABLE_CHUNK_SIZE];
68 struct _MonoJitInfoTable
72 MonoJitInfoTableChunk *chunks [MONO_ZERO_LEN_ARRAY];
75 #define MONO_SIZEOF_JIT_INFO_TABLE (sizeof (struct _MonoJitInfoTable) - MONO_ZERO_LEN_ARRAY * SIZEOF_VOID_P)
77 typedef GArray MonoAotModuleInfoTable;
84 gpointer handler_start;
86 MonoClass *catch_class;
90 } MonoJitExceptionInfo;
93 * Will contain information on the generic type arguments in the
94 * future. For now, all arguments are always reference types.
98 } MonoGenericSharingContext;
100 /* Simplified DWARF location list entry */
102 /* Whenever the value is in a register */
105 * If is_reg is TRUE, the register which contains the value. Otherwise
110 * If is_reg is FALSE, the offset of the stack location relative to 'reg'.
115 * Offsets of the PC interval where the value is in this location.
118 } MonoDwarfLocListEntry;
122 MonoGenericSharingContext *generic_sharing_context;
124 MonoDwarfLocListEntry *locations;
128 gboolean this_in_reg:1;
129 } MonoGenericJitInfo;
132 A try block hole is used to represent a non-contiguous part of
133 of a segment of native code protected by a given .try block.
134 Usually, a try block is defined as a contiguous segment of code.
135 But in some cases it's needed to have some parts of it to not be protected.
136 For example, given "try {} finally {}", the code in the .try block to call
137 the finally part looks like:
143 jump outside try block
149 The instructions between the call and the jump should not be under the try block since they happen
150 after the finally block executes, which means if an async exceptions happens at that point we would
151 execute the finally clause twice. So, to avoid this, we introduce a hole in the try block to signal
152 that those instructions are not protected.
159 } MonoTryBlockHoleJitInfo;
164 MonoTryBlockHoleJitInfo holes [MONO_ZERO_LEN_ARRAY];
165 } MonoTryBlockHoleTableJitInfo;
172 struct _MonoJitInfo {
173 /* NOTE: These first two elements (method and
174 next_jit_code_hash) must be in the same order and at the
175 same offset as in RuntimeMethod, because of the jit_code_hash
176 internal hash table in MonoDomain. */
178 struct _MonoJitInfo *next_jit_code_hash;
180 /* This might contain an id for the unwind info instead of a register mask */
183 guint32 num_clauses:15;
184 /* Whenever the code is domain neutral or 'shared' */
185 gboolean domain_neutral:1;
186 gboolean cas_inited:1;
187 gboolean cas_class_assert:1;
188 gboolean cas_class_deny:1;
189 gboolean cas_class_permitonly:1;
190 gboolean cas_method_assert:1;
191 gboolean cas_method_deny:1;
192 gboolean cas_method_permitonly:1;
193 gboolean has_generic_jit_info:1;
194 gboolean has_try_block_holes:1;
195 gboolean has_arch_eh_info:1;
197 gboolean from_llvm:1;
199 /* FIXME: Embed this after the structure later*/
200 gpointer gc_info; /* Currently only used by SGen */
202 MonoJitExceptionInfo clauses [MONO_ZERO_LEN_ARRAY];
203 /* There is an optional MonoGenericJitInfo after the clauses */
204 /* There is an optional MonoTryBlockHoleTableJitInfo after MonoGenericJitInfo clauses*/
205 /* There is an optional MonoArchEHJitInfo after MonoTryBlockHoleTableJitInfo */
208 #define MONO_SIZEOF_JIT_INFO (offsetof (struct _MonoJitInfo, clauses))
210 struct _MonoAppContext {
214 gpointer *static_data;
218 * We have two unloading states because the domain
219 * must remain fully functional while AppDomain::DomainUnload is
221 * After that unloading began and all domain facilities are teared down
222 * such as execution of new threadpool jobs.
225 MONO_APPDOMAIN_CREATED,
226 MONO_APPDOMAIN_UNLOADING_START,
227 MONO_APPDOMAIN_UNLOADING,
228 MONO_APPDOMAIN_UNLOADED
229 } MonoAppDomainState;
231 typedef struct _MonoThunkFreeList {
233 int length; /* only valid for the wait list */
234 struct _MonoThunkFreeList *next;
237 typedef struct _MonoJitCodeHash MonoJitCodeHash;
239 typedef struct _MonoTlsDataRecord MonoTlsDataRecord;
240 struct _MonoTlsDataRecord {
241 MonoTlsDataRecord *next;
248 * This lock must never be taken before the loader lock,
249 * i.e. if both are taken by the same thread, the loader lock
252 CRITICAL_SECTION lock;
254 MonoCodeManager *code_mp;
256 * keep all the managed objects close to each other for the precise GC
257 * For the Boehm GC we additionally keep close also other GC-tracked pointers.
259 #define MONO_DOMAIN_FIRST_OBJECT setup
260 MonoAppDomainSetup *setup;
261 MonoAppDomain *domain;
262 MonoAppContext *default_context;
263 MonoException *out_of_memory_ex;
264 MonoException *null_reference_ex;
265 MonoException *stack_overflow_ex;
267 MonoObject *typeof_void;
268 /* Ephemeron Tombstone*/
269 MonoObject *ephemeron_tombstone;
270 /* new MonoType [0] */
271 MonoArray *empty_types;
273 * The fields between FIRST_GC_TRACKED and LAST_GC_TRACKED are roots, but
274 * not object references.
276 #define MONO_DOMAIN_FIRST_GC_TRACKED env
278 MonoGHashTable *ldstr_table;
279 /* hashtables for Reflection handles */
280 MonoGHashTable *type_hash;
281 MonoGHashTable *refobject_hash;
282 /* a GC-tracked array to keep references to the static fields of types */
283 gpointer *static_data_array;
284 /* maps class -> type initialization exception object */
285 MonoGHashTable *type_init_exception_hash;
286 /* maps delegate trampoline addr -> delegate object */
287 MonoGHashTable *delegate_hash_table;
288 #define MONO_DOMAIN_LAST_GC_TRACKED delegate_hash_table
290 /* Needed by Thread:GetDomainID() */
292 gint32 shadow_serial;
293 unsigned char inet_family_hint; // used in socket-io.c as a cache
294 GSList *domain_assemblies;
295 MonoAssembly *entry_assembly;
297 GPtrArray *class_vtable_array;
298 /* maps remote class key -> MonoRemoteClass */
299 GHashTable *proxy_vtable_hash;
300 /* Protected by 'jit_code_hash_lock' */
301 MonoInternalHashTable jit_code_hash;
302 CRITICAL_SECTION jit_code_hash_lock;
303 int num_jit_info_tables;
305 volatile jit_info_table;
306 GSList *jit_info_free_queue;
307 /* Used when loading assemblies */
309 gchar *private_bin_path;
311 /* Used by remoting proxies */
312 MonoMethod *create_proxy_for_type_method;
313 MonoMethod *private_invoke_method;
314 /* Used to store offsets of thread and context static fields */
315 GHashTable *special_static_fields;
316 MonoTlsDataRecord *tlsrec_list;
318 * This must be a GHashTable, since these objects can't be finalized
319 * if the hashtable contains a GC visible reference to them.
321 GHashTable *finalizable_objects_hash;
323 /* These two are boehm only */
324 /* Maps MonoObjects to a GSList of WeakTrackResurrection GCHandles pointing to them */
325 GHashTable *track_resurrection_objects_hash;
326 /* Maps WeakTrackResurrection GCHandles to the MonoObjects they point to */
327 GHashTable *track_resurrection_handles_hash;
329 /* Protects the three hashes above */
330 CRITICAL_SECTION finalizable_objects_hash_lock;
331 /* Used when accessing 'domain_assemblies' */
332 CRITICAL_SECTION assemblies_lock;
334 GHashTable *method_rgctx_hash;
336 GHashTable *generic_virtual_cases;
337 MonoThunkFreeList **thunk_free_lists;
339 GHashTable *generic_virtual_thunks;
341 /* Information maintained by the JIT engine */
342 gpointer runtime_info;
344 /*thread pool jobs, used to coordinate shutdown.*/
345 volatile int threadpool_jobs;
346 HANDLE cleanup_semaphore;
348 /* Contains the compiled runtime invoke wrapper used by finalizers */
349 gpointer finalize_runtime_invoke;
351 /* Contains the compiled runtime invoke wrapper used by async resylt creation to capture thread context*/
352 gpointer capture_context_runtime_invoke;
354 /* Contains the compiled method used by async resylt creation to capture thread context*/
355 gpointer capture_context_method;
357 /* Assembly bindings, the per-domain part */
358 GSList *assembly_bindings;
359 gboolean assembly_bindings_parsed;
361 /* Used by socket-io.c */
362 /* These are domain specific, since the assembly can be unloaded */
363 MonoImage *socket_assembly;
364 MonoClass *sockaddr_class;
365 MonoClassField *sockaddr_data_field;
367 /* Used by threadpool.c */
368 MonoImage *system_image;
369 MonoImage *system_net_dll;
370 MonoClass *corlib_asyncresult_class;
371 MonoClass *socket_class;
372 MonoClass *ad_unloaded_ex_class;
373 MonoClass *process_class;
375 /* Cache function pointers for architectures */
376 /* that require wrappers */
377 GHashTable *ftnptrs_hash;
379 guint32 execution_context_field_offset;
383 guint16 major, minor, build, revision;
384 } AssemblyVersionSet;
386 /* MonoRuntimeInfo: Contains information about versions supported by this runtime */
388 const char runtime_version [12];
389 const char framework_version [4];
390 const AssemblyVersionSet version_sets [3];
393 #define mono_domain_lock(domain) mono_locks_acquire(&(domain)->lock, DomainLock)
394 #define mono_domain_unlock(domain) mono_locks_release(&(domain)->lock, DomainLock)
395 #define mono_domain_assemblies_lock(domain) mono_locks_acquire(&(domain)->assemblies_lock, DomainAssembliesLock)
396 #define mono_domain_assemblies_unlock(domain) mono_locks_release(&(domain)->assemblies_lock, DomainAssembliesLock)
397 #define mono_domain_jit_code_hash_lock(domain) mono_locks_acquire(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
398 #define mono_domain_jit_code_hash_unlock(domain) mono_locks_release(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
400 typedef MonoDomain* (*MonoLoadFunc) (const char *filename, const char *runtime_version);
403 mono_install_runtime_load (MonoLoadFunc func) MONO_INTERNAL;
406 mono_runtime_load (const char *filename, const char *runtime_version) MONO_INTERNAL;
408 typedef void (*MonoCreateDomainFunc) (MonoDomain *domain);
411 mono_install_create_domain_hook (MonoCreateDomainFunc func) MONO_INTERNAL;
413 typedef void (*MonoFreeDomainFunc) (MonoDomain *domain);
416 mono_install_free_domain_hook (MonoFreeDomainFunc func) MONO_INTERNAL;
419 mono_init_com_types (void) MONO_INTERNAL;
422 mono_cleanup (void) MONO_INTERNAL;
425 mono_close_exe_image (void) MONO_INTERNAL;
428 mono_jit_info_table_add (MonoDomain *domain, MonoJitInfo *ji) MONO_INTERNAL;
431 mono_jit_info_table_remove (MonoDomain *domain, MonoJitInfo *ji) MONO_INTERNAL;
434 mono_jit_info_add_aot_module (MonoImage *image, gpointer start, gpointer end) MONO_INTERNAL;
437 mono_jit_info_get_generic_jit_info (MonoJitInfo *ji) MONO_INTERNAL;
439 MonoGenericSharingContext*
440 mono_jit_info_get_generic_sharing_context (MonoJitInfo *ji) MONO_INTERNAL;
443 mono_jit_info_set_generic_sharing_context (MonoJitInfo *ji, MonoGenericSharingContext *gsctx) MONO_INTERNAL;
446 mono_domain_lookup_shared_generic (MonoDomain *domain, MonoMethod *method) MONO_INTERNAL;
449 mono_make_shadow_copy (const char *filename) MONO_INTERNAL;
452 mono_is_shadow_copy_enabled (MonoDomain *domain, const gchar *dir_name) MONO_INTERNAL;
455 mono_domain_alloc (MonoDomain *domain, guint size) MONO_INTERNAL;
458 mono_domain_alloc0 (MonoDomain *domain, guint size) MONO_INTERNAL;
461 mono_domain_code_reserve (MonoDomain *domain, int size) MONO_LLVM_INTERNAL;
464 mono_domain_code_reserve_align (MonoDomain *domain, int size, int alignment) MONO_INTERNAL;
467 mono_domain_code_commit (MonoDomain *domain, void *data, int size, int newsize) MONO_INTERNAL;
470 nacl_domain_get_code_dest (MonoDomain *domain, void *data) MONO_INTERNAL;
473 nacl_domain_code_validate (MonoDomain *domain, guint8 **buf_base, int buf_size, guint8 **code_end) MONO_INTERNAL;
476 mono_domain_code_foreach (MonoDomain *domain, MonoCodeManagerFunc func, void *user_data) MONO_INTERNAL;
479 mono_domain_unset (void) MONO_INTERNAL;
482 mono_domain_set_internal_with_options (MonoDomain *domain, gboolean migrate_exception) MONO_INTERNAL;
484 MonoTryBlockHoleTableJitInfo*
485 mono_jit_info_get_try_block_hole_table_info (MonoJitInfo *ji) MONO_INTERNAL;
488 mono_jit_info_get_arch_eh_info (MonoJitInfo *ji) MONO_INTERNAL;
491 * Installs a new function which is used to return a MonoJitInfo for a method inside
494 typedef MonoJitInfo *(*MonoJitInfoFindInAot) (MonoDomain *domain, MonoImage *image, gpointer addr);
495 void mono_install_jit_info_find_in_aot (MonoJitInfoFindInAot func) MONO_INTERNAL;
498 mono_jit_code_hash_init (MonoInternalHashTable *jit_code_hash) MONO_INTERNAL;
501 ves_icall_System_AppDomain_getCurDomain (void) MONO_INTERNAL;
504 ves_icall_System_AppDomain_getRootDomain (void) MONO_INTERNAL;
507 ves_icall_System_AppDomain_createDomain (MonoString *friendly_name,
508 MonoAppDomainSetup *setup) MONO_INTERNAL;
511 ves_icall_System_AppDomain_GetData (MonoAppDomain *ad,
512 MonoString *name) MONO_INTERNAL;
514 MonoReflectionAssembly *
515 ves_icall_System_AppDomain_LoadAssemblyRaw (MonoAppDomain *ad,
516 MonoArray *raw_assembly,
517 MonoArray *raw_symbol_store,
518 MonoObject *evidence,
519 MonoBoolean refonly) MONO_INTERNAL;
522 ves_icall_System_AppDomain_SetData (MonoAppDomain *ad,
524 MonoObject *data) MONO_INTERNAL;
527 ves_icall_System_AppDomain_getSetup (MonoAppDomain *ad) MONO_INTERNAL;
530 ves_icall_System_AppDomain_getFriendlyName (MonoAppDomain *ad) MONO_INTERNAL;
533 ves_icall_System_AppDomain_GetAssemblies (MonoAppDomain *ad,
534 MonoBoolean refonly) MONO_INTERNAL;
536 MonoReflectionAssembly *
537 ves_icall_System_Reflection_Assembly_LoadFrom (MonoString *fname,
538 MonoBoolean refonly) MONO_INTERNAL;
540 MonoReflectionAssembly *
541 ves_icall_System_AppDomain_LoadAssembly (MonoAppDomain *ad,
543 MonoObject *evidence,
544 MonoBoolean refonly) MONO_INTERNAL;
547 ves_icall_System_AppDomain_InternalIsFinalizingForUnload (gint32 domain_id) MONO_INTERNAL;
550 ves_icall_System_AppDomain_InternalUnload (gint32 domain_id) MONO_INTERNAL;
553 ves_icall_System_AppDomain_ExecuteAssembly (MonoAppDomain *ad,
554 MonoReflectionAssembly *refass,
555 MonoArray *args) MONO_INTERNAL;
558 ves_icall_System_AppDomain_InternalSetDomain (MonoAppDomain *ad) MONO_INTERNAL;
561 ves_icall_System_AppDomain_InternalSetDomainByID (gint32 domainid) MONO_INTERNAL;
564 ves_icall_System_AppDomain_InternalPushDomainRef (MonoAppDomain *ad) MONO_INTERNAL;
567 ves_icall_System_AppDomain_InternalPushDomainRefByID (gint32 domain_id) MONO_INTERNAL;
570 ves_icall_System_AppDomain_InternalPopDomainRef (void) MONO_INTERNAL;
573 ves_icall_System_AppDomain_InternalGetContext (void) MONO_INTERNAL;
576 ves_icall_System_AppDomain_InternalGetDefaultContext (void) MONO_INTERNAL;
579 ves_icall_System_AppDomain_InternalSetContext (MonoAppContext *mc) MONO_INTERNAL;
582 ves_icall_System_AppDomain_GetIDFromDomain (MonoAppDomain * ad) MONO_INTERNAL;
585 ves_icall_System_AppDomain_InternalGetProcessGuid (MonoString* newguid) MONO_INTERNAL;
588 mono_assembly_load_corlib (const MonoRuntimeInfo *runtime, MonoImageOpenStatus *status) MONO_INTERNAL;
590 const MonoRuntimeInfo*
591 mono_get_runtime_info (void) MONO_INTERNAL;
594 mono_runtime_set_no_exec (gboolean val) MONO_INTERNAL;
597 mono_runtime_get_no_exec (void) MONO_INTERNAL;
600 mono_assembly_name_parse (const char *name, MonoAssemblyName *aname) MONO_INTERNAL;
602 MonoImage *mono_assembly_open_from_bundle (const char *filename,
603 MonoImageOpenStatus *status,
604 gboolean refonly) MONO_INTERNAL;
607 mono_domain_add_class_static_data (MonoDomain *domain, MonoClass *klass, gpointer data, guint32 *bitmap);
609 MonoReflectionAssembly *
610 mono_try_assembly_resolve (MonoDomain *domain, MonoString *fname, gboolean refonly) MONO_INTERNAL;
612 MonoAssembly* mono_assembly_load_full_nosearch (MonoAssemblyName *aname,
614 MonoImageOpenStatus *status,
615 gboolean refonly) MONO_INTERNAL;
617 void mono_set_private_bin_path_from_config (MonoDomain *domain) MONO_INTERNAL;
619 int mono_framework_version (void) MONO_INTERNAL;
621 void mono_reflection_cleanup_domain (MonoDomain *domain) MONO_INTERNAL;
623 void mono_assembly_cleanup_domain_bindings (guint32 domain_id) MONO_INTERNAL;;
625 #endif /* __MONO_METADATA_DOMAIN_INTERNALS_H__ */