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/utils/mono-mutex.h>
13 #include <mono/metadata/mono-hash.h>
14 #include <mono/utils/mono-compiler.h>
15 #include <mono/utils/mono-internal-hash.h>
16 #include <mono/io-layer/io-layer.h>
17 #include <mono/metadata/mempool-internals.h>
20 extern mono_mutex_t mono_delegate_section;
21 extern mono_mutex_t mono_strtod_mutex;
24 * If this is set, the memory belonging to appdomains is not freed when a domain is
25 * unloaded, and assemblies loaded by the appdomain are not unloaded either. This
26 * allows us to use typed gc in non-default appdomains too, leading to increased
29 extern gboolean mono_dont_free_domains;
31 /* This is a copy of System.AppDomainSetup */
34 MonoString *application_base;
35 MonoString *application_name;
36 MonoString *cache_path;
37 MonoString *configuration_file;
38 MonoString *dynamic_base;
39 MonoString *license_file;
40 MonoString *private_bin_path;
41 MonoString *private_bin_path_probe;
42 MonoString *shadow_copy_directories;
43 MonoString *shadow_copy_files;
44 MonoBoolean publisher_policy;
45 MonoBoolean path_changed;
46 int loader_optimization;
47 MonoBoolean disallow_binding_redirects;
48 MonoBoolean disallow_code_downloads;
49 MonoObject *activation_arguments; /* it is System.Object in 1.x, ActivationArguments in 2.0 */
50 MonoObject *domain_initializer;
51 MonoObject *application_trust; /* it is System.Object in 1.x, ApplicationTrust in 2.0 */
52 MonoArray *domain_initializer_args;
53 MonoBoolean disallow_appbase_probe;
54 MonoArray *configuration_bytes;
55 MonoArray *serialized_non_primitives;
58 typedef struct _MonoJitInfoTable MonoJitInfoTable;
59 typedef struct _MonoJitInfoTableChunk MonoJitInfoTableChunk;
61 #define MONO_JIT_INFO_TABLE_CHUNK_SIZE 64
63 struct _MonoJitInfoTableChunk
66 volatile int num_elements;
67 volatile gint8 *last_code_end;
68 MonoJitInfo * volatile data [MONO_JIT_INFO_TABLE_CHUNK_SIZE];
71 struct _MonoJitInfoTable
75 MonoJitInfoTableChunk *chunks [MONO_ZERO_LEN_ARRAY];
78 #define MONO_SIZEOF_JIT_INFO_TABLE (sizeof (struct _MonoJitInfoTable) - MONO_ZERO_LEN_ARRAY * SIZEOF_VOID_P)
80 typedef GArray MonoAotModuleInfoTable;
87 gpointer handler_start;
89 * For LLVM compiled code, this is the index of the il clause
90 * associated with this handler.
94 MonoClass *catch_class;
98 } MonoJitExceptionInfo;
101 * Contains information about the type arguments for generic shared methods.
105 * If not NULL, determines whenever the class type arguments of the gshared method are references or vtypes.
106 * The array length is equal to class_inst->type_argv.
109 /* Same for method type parameters */
110 gboolean *mvar_is_vt;
111 } MonoGenericSharingContext;
113 /* Simplified DWARF location list entry */
115 /* Whenever the value is in a register */
118 * If is_reg is TRUE, the register which contains the value. Otherwise
123 * If is_reg is FALSE, the offset of the stack location relative to 'reg'.
128 * Offsets of the PC interval where the value is in this location.
131 } MonoDwarfLocListEntry;
135 MonoGenericSharingContext *generic_sharing_context;
137 MonoDwarfLocListEntry *locations;
141 gboolean this_in_reg:1;
142 } MonoGenericJitInfo;
145 A try block hole is used to represent a non-contiguous part of
146 of a segment of native code protected by a given .try block.
147 Usually, a try block is defined as a contiguous segment of code.
148 But in some cases it's needed to have some parts of it to not be protected.
149 For example, given "try {} finally {}", the code in the .try block to call
150 the finally part looks like:
156 jump outside try block
162 The instructions between the call and the jump should not be under the try block since they happen
163 after the finally block executes, which means if an async exceptions happens at that point we would
164 execute the finally clause twice. So, to avoid this, we introduce a hole in the try block to signal
165 that those instructions are not protected.
172 } MonoTryBlockHoleJitInfo;
177 MonoTryBlockHoleJitInfo holes [MONO_ZERO_LEN_ARRAY];
178 } MonoTryBlockHoleTableJitInfo;
187 gboolean cas_inited:1;
188 gboolean cas_class_assert:1;
189 gboolean cas_class_deny:1;
190 gboolean cas_class_permitonly:1;
191 gboolean cas_method_assert:1;
192 gboolean cas_method_deny:1;
193 gboolean cas_method_permitonly:1;
198 JIT_INFO_HAS_CAS_INFO = (1 << 0),
199 JIT_INFO_HAS_GENERIC_JIT_INFO = (1 << 1),
200 JIT_INFO_HAS_TRY_BLOCK_HOLES = (1 << 2),
201 JIT_INFO_HAS_ARCH_EH_INFO = (1 << 3)
204 struct _MonoJitInfo {
205 /* NOTE: These first two elements (method and
206 next_jit_code_hash) must be in the same order and at the
207 same offset as in RuntimeMethod, because of the jit_code_hash
208 internal hash table in MonoDomain. */
215 struct _MonoJitInfo *next_jit_code_hash;
219 guint32 num_clauses:15;
220 /* Whenever the code is domain neutral or 'shared' */
221 gboolean domain_neutral:1;
222 gboolean has_cas_info:1;
223 gboolean has_generic_jit_info:1;
224 gboolean has_try_block_holes:1;
225 gboolean has_arch_eh_info:1;
227 gboolean from_llvm:1;
228 gboolean dbg_attrs_inited:1;
229 gboolean dbg_hidden:1;
230 /* Whenever this jit info was loaded in async context */
232 gboolean dbg_step_through:1;
233 gboolean dbg_non_user_code:1;
235 * Whenever this jit info refers to a trampoline.
236 * d.tramp_info contains additional data in this case.
238 gboolean is_trampoline:1;
240 /* FIXME: Embed this after the structure later*/
241 gpointer gc_info; /* Currently only used by SGen */
243 MonoJitExceptionInfo clauses [MONO_ZERO_LEN_ARRAY];
244 /* There is an optional MonoGenericJitInfo after the clauses */
245 /* There is an optional MonoTryBlockHoleTableJitInfo after MonoGenericJitInfo clauses*/
246 /* There is an optional MonoArchEHJitInfo after MonoTryBlockHoleTableJitInfo */
249 #define MONO_SIZEOF_JIT_INFO (offsetof (struct _MonoJitInfo, clauses))
251 struct _MonoAppContext {
255 gpointer *static_data;
258 /* Lock-free allocator */
263 } LockFreeMempoolChunk;
266 LockFreeMempoolChunk *current, *chunks;
270 * We have two unloading states because the domain
271 * must remain fully functional while AppDomain::DomainUnload is
273 * After that unloading began and all domain facilities are teared down
274 * such as execution of new threadpool jobs.
277 MONO_APPDOMAIN_CREATED,
278 MONO_APPDOMAIN_UNLOADING_START,
279 MONO_APPDOMAIN_UNLOADING,
280 MONO_APPDOMAIN_UNLOADED
281 } MonoAppDomainState;
283 typedef struct _MonoThunkFreeList {
285 int length; /* only valid for the wait list */
286 struct _MonoThunkFreeList *next;
289 typedef struct _MonoJitCodeHash MonoJitCodeHash;
291 typedef struct _MonoTlsDataRecord MonoTlsDataRecord;
292 struct _MonoTlsDataRecord {
293 MonoTlsDataRecord *next;
300 * This lock must never be taken before the loader lock,
301 * i.e. if both are taken by the same thread, the loader lock
306 MonoCodeManager *code_mp;
308 * keep all the managed objects close to each other for the precise GC
309 * For the Boehm GC we additionally keep close also other GC-tracked pointers.
311 #define MONO_DOMAIN_FIRST_OBJECT setup
312 MonoAppDomainSetup *setup;
313 MonoAppDomain *domain;
314 MonoAppContext *default_context;
315 MonoException *out_of_memory_ex;
316 MonoException *null_reference_ex;
317 MonoException *stack_overflow_ex;
319 MonoObject *typeof_void;
320 /* Ephemeron Tombstone*/
321 MonoObject *ephemeron_tombstone;
322 /* new MonoType [0] */
323 MonoArray *empty_types;
325 * The fields between FIRST_GC_TRACKED and LAST_GC_TRACKED are roots, but
326 * not object references.
328 #define MONO_DOMAIN_FIRST_GC_TRACKED env
330 MonoGHashTable *ldstr_table;
331 /* hashtables for Reflection handles */
332 MonoGHashTable *type_hash;
333 MonoGHashTable *refobject_hash;
334 /* a GC-tracked array to keep references to the static fields of types */
335 gpointer *static_data_array;
336 /* maps class -> type initialization exception object */
337 MonoGHashTable *type_init_exception_hash;
338 /* maps delegate trampoline addr -> delegate object */
339 MonoGHashTable *delegate_hash_table;
340 #define MONO_DOMAIN_LAST_GC_TRACKED delegate_hash_table
342 /* Needed by Thread:GetDomainID() */
344 gint32 shadow_serial;
345 unsigned char inet_family_hint; // used in socket-io.c as a cache
346 GSList *domain_assemblies;
347 MonoAssembly *entry_assembly;
349 GPtrArray *class_vtable_array;
350 /* maps remote class key -> MonoRemoteClass */
351 GHashTable *proxy_vtable_hash;
352 /* Protected by 'jit_code_hash_lock' */
353 MonoInternalHashTable jit_code_hash;
354 mono_mutex_t jit_code_hash_lock;
355 int num_jit_info_tables;
357 volatile jit_info_table;
359 * Contains information about AOT loaded code.
360 * Only used in the root domain.
363 volatile aot_modules;
364 GSList *jit_info_free_queue;
365 /* Used when loading assemblies */
367 gchar *private_bin_path;
368 LockFreeMempool *lock_free_mp;
370 /* Used by remoting proxies */
371 MonoMethod *create_proxy_for_type_method;
372 MonoMethod *private_invoke_method;
373 /* Used to store offsets of thread and context static fields */
374 GHashTable *special_static_fields;
375 MonoTlsDataRecord *tlsrec_list;
377 * This must be a GHashTable, since these objects can't be finalized
378 * if the hashtable contains a GC visible reference to them.
380 GHashTable *finalizable_objects_hash;
382 /* Protects the three hashes above */
383 mono_mutex_t finalizable_objects_hash_lock;
384 /* Used when accessing 'domain_assemblies' */
385 mono_mutex_t assemblies_lock;
387 GHashTable *method_rgctx_hash;
389 GHashTable *generic_virtual_cases;
390 MonoThunkFreeList **thunk_free_lists;
392 GHashTable *generic_virtual_thunks;
394 /* Information maintained by the JIT engine */
395 gpointer runtime_info;
397 /*thread pool jobs, used to coordinate shutdown.*/
398 volatile int threadpool_jobs;
399 HANDLE cleanup_semaphore;
401 /* Contains the compiled runtime invoke wrapper used by finalizers */
402 gpointer finalize_runtime_invoke;
404 /* Contains the compiled runtime invoke wrapper used by async resylt creation to capture thread context*/
405 gpointer capture_context_runtime_invoke;
407 /* Contains the compiled method used by async resylt creation to capture thread context*/
408 gpointer capture_context_method;
410 /* Assembly bindings, the per-domain part */
411 GSList *assembly_bindings;
412 gboolean assembly_bindings_parsed;
414 /* Used by socket-io.c */
415 /* These are domain specific, since the assembly can be unloaded */
416 MonoImage *socket_assembly;
417 MonoClass *sockaddr_class;
418 MonoClassField *sockaddr_data_field;
420 /* Used by threadpool.c */
421 MonoImage *system_image;
422 MonoClass *corlib_asyncresult_class;
423 MonoClass *socket_class;
424 MonoClass *ad_unloaded_ex_class;
425 MonoClass *process_class;
427 /* Cache function pointers for architectures */
428 /* that require wrappers */
429 GHashTable *ftnptrs_hash;
431 guint32 execution_context_field_offset;
435 guint16 major, minor, build, revision;
436 } AssemblyVersionSet;
438 /* MonoRuntimeInfo: Contains information about versions supported by this runtime */
440 const char runtime_version [12];
441 const char framework_version [4];
442 const AssemblyVersionSet version_sets [4];
445 #define mono_domain_assemblies_lock(domain) mono_locks_acquire(&(domain)->assemblies_lock, DomainAssembliesLock)
446 #define mono_domain_assemblies_unlock(domain) mono_locks_release(&(domain)->assemblies_lock, DomainAssembliesLock)
447 #define mono_domain_jit_code_hash_lock(domain) mono_locks_acquire(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
448 #define mono_domain_jit_code_hash_unlock(domain) mono_locks_release(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
450 typedef MonoDomain* (*MonoLoadFunc) (const char *filename, const char *runtime_version);
452 void mono_domain_lock (MonoDomain *domain);
453 void mono_domain_unlock (MonoDomain *domain);
456 mono_install_runtime_load (MonoLoadFunc func);
459 mono_runtime_load (const char *filename, const char *runtime_version);
461 typedef void (*MonoCreateDomainFunc) (MonoDomain *domain);
464 mono_install_create_domain_hook (MonoCreateDomainFunc func);
466 typedef void (*MonoFreeDomainFunc) (MonoDomain *domain);
469 mono_install_free_domain_hook (MonoFreeDomainFunc func);
475 mono_close_exe_image (void);
478 mono_jit_info_size (MonoJitInfoFlags flags, int num_clauses, int num_holes);
481 mono_jit_info_init (MonoJitInfo *ji, MonoMethod *method, guint8 *code, int code_size,
482 MonoJitInfoFlags flags, int num_clauses, int num_holes);
485 mono_jit_info_table_new (MonoDomain *domain);
488 mono_jit_info_table_free (MonoJitInfoTable *table);
491 mono_jit_info_table_add (MonoDomain *domain, MonoJitInfo *ji);
494 mono_jit_info_table_remove (MonoDomain *domain, MonoJitInfo *ji);
497 mono_jit_info_add_aot_module (MonoImage *image, gpointer start, gpointer end);
500 mono_jit_info_get_generic_jit_info (MonoJitInfo *ji);
502 MonoGenericSharingContext*
503 mono_jit_info_get_generic_sharing_context (MonoJitInfo *ji);
506 mono_jit_info_set_generic_sharing_context (MonoJitInfo *ji, MonoGenericSharingContext *gsctx);
509 mono_make_shadow_copy (const char *filename);
512 mono_is_shadow_copy_enabled (MonoDomain *domain, const gchar *dir_name);
515 mono_domain_alloc (MonoDomain *domain, guint size);
518 mono_domain_alloc0 (MonoDomain *domain, guint size);
521 mono_domain_alloc0_lock_free (MonoDomain *domain, guint size);
524 mono_domain_code_reserve (MonoDomain *domain, int size) MONO_LLVM_INTERNAL;
527 mono_domain_code_reserve_align (MonoDomain *domain, int size, int alignment);
530 mono_domain_code_commit (MonoDomain *domain, void *data, int size, int newsize);
533 nacl_domain_get_code_dest (MonoDomain *domain, void *data);
536 nacl_domain_code_validate (MonoDomain *domain, guint8 **buf_base, int buf_size, guint8 **code_end);
539 mono_domain_code_foreach (MonoDomain *domain, MonoCodeManagerFunc func, void *user_data);
542 mono_domain_unset (void);
545 mono_domain_set_internal_with_options (MonoDomain *domain, gboolean migrate_exception);
547 MonoTryBlockHoleTableJitInfo*
548 mono_jit_info_get_try_block_hole_table_info (MonoJitInfo *ji);
551 mono_jit_info_get_arch_eh_info (MonoJitInfo *ji);
554 mono_jit_info_get_cas_info (MonoJitInfo *ji);
557 * Installs a new function which is used to return a MonoJitInfo for a method inside
560 typedef MonoJitInfo *(*MonoJitInfoFindInAot) (MonoDomain *domain, MonoImage *image, gpointer addr);
561 void mono_install_jit_info_find_in_aot (MonoJitInfoFindInAot func);
564 mono_jit_code_hash_init (MonoInternalHashTable *jit_code_hash);
567 ves_icall_System_AppDomain_getCurDomain (void);
570 ves_icall_System_AppDomain_getRootDomain (void);
573 ves_icall_System_AppDomain_createDomain (MonoString *friendly_name,
574 MonoAppDomainSetup *setup);
577 ves_icall_System_AppDomain_GetData (MonoAppDomain *ad,
580 MonoReflectionAssembly *
581 ves_icall_System_AppDomain_LoadAssemblyRaw (MonoAppDomain *ad,
582 MonoArray *raw_assembly,
583 MonoArray *raw_symbol_store,
584 MonoObject *evidence,
585 MonoBoolean refonly);
588 ves_icall_System_AppDomain_SetData (MonoAppDomain *ad,
593 ves_icall_System_AppDomain_getSetup (MonoAppDomain *ad);
596 ves_icall_System_AppDomain_getFriendlyName (MonoAppDomain *ad);
599 ves_icall_System_AppDomain_GetAssemblies (MonoAppDomain *ad,
600 MonoBoolean refonly);
602 MonoReflectionAssembly *
603 ves_icall_System_Reflection_Assembly_LoadFrom (MonoString *fname,
604 MonoBoolean refonly);
606 MonoReflectionAssembly *
607 ves_icall_System_AppDomain_LoadAssembly (MonoAppDomain *ad,
609 MonoObject *evidence,
610 MonoBoolean refonly);
613 ves_icall_System_AppDomain_InternalIsFinalizingForUnload (gint32 domain_id);
616 ves_icall_System_AppDomain_InternalUnload (gint32 domain_id);
619 ves_icall_System_AppDomain_ExecuteAssembly (MonoAppDomain *ad,
620 MonoReflectionAssembly *refass,
624 ves_icall_System_AppDomain_InternalSetDomain (MonoAppDomain *ad);
627 ves_icall_System_AppDomain_InternalSetDomainByID (gint32 domainid);
630 ves_icall_System_AppDomain_InternalPushDomainRef (MonoAppDomain *ad);
633 ves_icall_System_AppDomain_InternalPushDomainRefByID (gint32 domain_id);
636 ves_icall_System_AppDomain_InternalPopDomainRef (void);
639 ves_icall_System_AppDomain_InternalGetContext (void);
642 ves_icall_System_AppDomain_InternalGetDefaultContext (void);
645 ves_icall_System_AppDomain_InternalSetContext (MonoAppContext *mc);
648 ves_icall_System_AppDomain_GetIDFromDomain (MonoAppDomain * ad);
651 ves_icall_System_AppDomain_InternalGetProcessGuid (MonoString* newguid);
654 mono_assembly_load_corlib (const MonoRuntimeInfo *runtime, MonoImageOpenStatus *status);
656 const MonoRuntimeInfo*
657 mono_get_runtime_info (void);
660 mono_runtime_set_no_exec (gboolean val);
663 mono_runtime_get_no_exec (void);
666 mono_assembly_name_parse (const char *name, MonoAssemblyName *aname);
668 MonoImage *mono_assembly_open_from_bundle (const char *filename,
669 MonoImageOpenStatus *status,
673 mono_domain_add_class_static_data (MonoDomain *domain, MonoClass *klass, gpointer data, guint32 *bitmap);
675 MonoReflectionAssembly *
676 mono_try_assembly_resolve (MonoDomain *domain, MonoString *fname, MonoAssembly *requesting, gboolean refonly);
679 mono_domain_assembly_postload_search (MonoAssemblyName *aname, MonoAssembly *requesting, gboolean refonly);
681 MonoAssembly* mono_assembly_load_full_nosearch (MonoAssemblyName *aname,
683 MonoImageOpenStatus *status,
686 void mono_set_private_bin_path_from_config (MonoDomain *domain);
688 int mono_framework_version (void);
690 void mono_reflection_cleanup_domain (MonoDomain *domain);
692 void mono_assembly_cleanup_domain_bindings (guint32 domain_id);
694 MonoJitInfo* mono_jit_info_table_find_internal (MonoDomain *domain, char *addr, gboolean try_aot, gboolean allow_trampolines);
696 void mono_enable_debug_domain_unload (gboolean enable);
698 #endif /* __MONO_METADATA_DOMAIN_INTERNALS_H__ */