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 * If this is set, the memory belonging to appdomains is not freed when a domain is
21 * unloaded, and assemblies loaded by the appdomain are not unloaded either. This
22 * allows us to use typed gc in non-default appdomains too, leading to increased
25 extern gboolean mono_dont_free_domains;
27 /* This is a copy of System.AppDomainSetup */
30 MonoString *application_base;
31 MonoString *application_name;
32 MonoString *cache_path;
33 MonoString *configuration_file;
34 MonoString *dynamic_base;
35 MonoString *license_file;
36 MonoString *private_bin_path;
37 MonoString *private_bin_path_probe;
38 MonoString *shadow_copy_directories;
39 MonoString *shadow_copy_files;
40 MonoBoolean publisher_policy;
41 MonoBoolean path_changed;
42 int loader_optimization;
43 MonoBoolean disallow_binding_redirects;
44 MonoBoolean disallow_code_downloads;
45 MonoObject *activation_arguments; /* it is System.Object in 1.x, ActivationArguments in 2.0 */
46 MonoObject *domain_initializer;
47 MonoObject *application_trust; /* it is System.Object in 1.x, ApplicationTrust in 2.0 */
48 MonoArray *domain_initializer_args;
49 MonoBoolean disallow_appbase_probe;
50 MonoArray *configuration_bytes;
51 MonoArray *serialized_non_primitives;
54 typedef struct _MonoJitInfoTable MonoJitInfoTable;
55 typedef struct _MonoJitInfoTableChunk MonoJitInfoTableChunk;
57 #define MONO_JIT_INFO_TABLE_CHUNK_SIZE 64
59 struct _MonoJitInfoTableChunk
62 volatile int num_elements;
63 volatile gint8 *last_code_end;
64 MonoJitInfo * volatile data [MONO_JIT_INFO_TABLE_CHUNK_SIZE];
67 struct _MonoJitInfoTable
71 MonoJitInfoTableChunk *chunks [MONO_ZERO_LEN_ARRAY];
74 #define MONO_SIZEOF_JIT_INFO_TABLE (sizeof (struct _MonoJitInfoTable) - MONO_ZERO_LEN_ARRAY * SIZEOF_VOID_P)
76 typedef GArray MonoAotModuleInfoTable;
83 gpointer handler_start;
85 * For LLVM compiled code, this is the index of the il clause
86 * associated with this handler.
91 uint32_t handler_offset;
94 MonoClass *catch_class;
98 } MonoJitExceptionInfo;
101 * Contains information about the type arguments for generic shared methods.
104 gboolean is_gsharedvt;
105 } MonoGenericSharingContext;
107 /* Simplified DWARF location list entry */
109 /* Whenever the value is in a register */
112 * If is_reg is TRUE, the register which contains the value. Otherwise
117 * If is_reg is FALSE, the offset of the stack location relative to 'reg'.
122 * Offsets of the PC interval where the value is in this location.
125 } MonoDwarfLocListEntry;
129 MonoGenericSharingContext *generic_sharing_context;
131 MonoDwarfLocListEntry *locations;
135 gboolean this_in_reg:1;
136 } MonoGenericJitInfo;
139 A try block hole is used to represent a non-contiguous part of
140 of a segment of native code protected by a given .try block.
141 Usually, a try block is defined as a contiguous segment of code.
142 But in some cases it's needed to have some parts of it to not be protected.
143 For example, given "try {} finally {}", the code in the .try block to call
144 the finally part looks like:
150 jump outside try block
156 The instructions between the call and the jump should not be under the try block since they happen
157 after the finally block executes, which means if an async exceptions happens at that point we would
158 execute the finally clause twice. So, to avoid this, we introduce a hole in the try block to signal
159 that those instructions are not protected.
166 } MonoTryBlockHoleJitInfo;
171 MonoTryBlockHoleJitInfo holes [MONO_ZERO_LEN_ARRAY];
172 } MonoTryBlockHoleTableJitInfo;
181 /* Relative to code_start */
188 JIT_INFO_HAS_GENERIC_JIT_INFO = (1 << 0),
189 JIT_INFO_HAS_TRY_BLOCK_HOLES = (1 << 1),
190 JIT_INFO_HAS_ARCH_EH_INFO = (1 << 2),
191 JIT_INFO_HAS_THUNK_INFO = (1 << 3)
194 struct _MonoJitInfo {
195 /* NOTE: These first two elements (method and
196 next_jit_code_hash) must be in the same order and at the
197 same offset as in RuntimeMethod, because of the jit_code_hash
198 internal hash table in MonoDomain. */
205 struct _MonoJitInfo *next_jit_code_hash;
209 guint32 num_clauses:15;
210 /* Whenever the code is domain neutral or 'shared' */
211 gboolean domain_neutral:1;
212 gboolean has_generic_jit_info:1;
213 gboolean has_try_block_holes:1;
214 gboolean has_arch_eh_info:1;
215 gboolean has_thunk_info:1;
217 gboolean from_llvm:1;
218 gboolean dbg_attrs_inited:1;
219 gboolean dbg_hidden:1;
220 /* Whenever this jit info was loaded in async context */
222 gboolean dbg_step_through:1;
223 gboolean dbg_non_user_code:1;
225 * Whenever this jit info refers to a trampoline.
226 * d.tramp_info contains additional data in this case.
228 gboolean is_trampoline:1;
230 /* FIXME: Embed this after the structure later*/
231 gpointer gc_info; /* Currently only used by SGen */
233 MonoJitExceptionInfo clauses [MONO_ZERO_LEN_ARRAY];
234 /* There is an optional MonoGenericJitInfo after the clauses */
235 /* There is an optional MonoTryBlockHoleTableJitInfo after MonoGenericJitInfo clauses*/
236 /* There is an optional MonoArchEHJitInfo after MonoTryBlockHoleTableJitInfo */
237 /* There is an optional MonoThunkJitInfo after MonoArchEHJitInfo */
240 #define MONO_SIZEOF_JIT_INFO (offsetof (struct _MonoJitInfo, clauses))
242 struct _MonoAppContext {
246 gpointer *static_data;
249 /* Lock-free allocator */
254 } LockFreeMempoolChunk;
257 LockFreeMempoolChunk *current, *chunks;
261 * We have two unloading states because the domain
262 * must remain fully functional while AppDomain::DomainUnload is
264 * After that unloading began and all domain facilities are teared down
265 * such as execution of new threadpool jobs.
268 MONO_APPDOMAIN_CREATED,
269 MONO_APPDOMAIN_UNLOADING_START,
270 MONO_APPDOMAIN_UNLOADING,
271 MONO_APPDOMAIN_UNLOADED
272 } MonoAppDomainState;
274 typedef struct _MonoThunkFreeList {
276 int length; /* only valid for the wait list */
277 struct _MonoThunkFreeList *next;
280 typedef struct _MonoJitCodeHash MonoJitCodeHash;
284 * This lock must never be taken before the loader lock,
285 * i.e. if both are taken by the same thread, the loader lock
290 MonoCodeManager *code_mp;
292 * keep all the managed objects close to each other for the precise GC
293 * For the Boehm GC we additionally keep close also other GC-tracked pointers.
295 #define MONO_DOMAIN_FIRST_OBJECT setup
296 MonoAppDomainSetup *setup;
297 MonoAppDomain *domain;
298 MonoAppContext *default_context;
299 MonoException *out_of_memory_ex;
300 MonoException *null_reference_ex;
301 MonoException *stack_overflow_ex;
303 MonoObject *typeof_void;
304 /* Ephemeron Tombstone*/
305 MonoObject *ephemeron_tombstone;
306 /* new MonoType [0] */
307 MonoArray *empty_types;
309 * The fields between FIRST_GC_TRACKED and LAST_GC_TRACKED are roots, but
310 * not object references.
312 #define MONO_DOMAIN_FIRST_GC_TRACKED env
314 MonoGHashTable *ldstr_table;
315 /* hashtables for Reflection handles */
316 MonoGHashTable *type_hash;
317 MonoGHashTable *refobject_hash;
318 /* a GC-tracked array to keep references to the static fields of types */
319 gpointer *static_data_array;
320 /* maps class -> type initialization exception object */
321 MonoGHashTable *type_init_exception_hash;
322 /* maps delegate trampoline addr -> delegate object */
323 MonoGHashTable *delegate_hash_table;
324 #define MONO_DOMAIN_LAST_GC_TRACKED delegate_hash_table
326 /* Needed by Thread:GetDomainID() */
328 gint32 shadow_serial;
329 unsigned char inet_family_hint; // used in socket-io.c as a cache
330 GSList *domain_assemblies;
331 MonoAssembly *entry_assembly;
333 GPtrArray *class_vtable_array;
334 /* maps remote class key -> MonoRemoteClass */
335 GHashTable *proxy_vtable_hash;
336 /* Protected by 'jit_code_hash_lock' */
337 MonoInternalHashTable jit_code_hash;
338 mono_mutex_t jit_code_hash_lock;
339 int num_jit_info_tables;
341 volatile jit_info_table;
343 * Contains information about AOT loaded code.
344 * Only used in the root domain.
347 volatile aot_modules;
348 GSList *jit_info_free_queue;
349 /* Used when loading assemblies */
351 gchar *private_bin_path;
352 LockFreeMempool *lock_free_mp;
354 /* Used by remoting proxies */
355 MonoMethod *create_proxy_for_type_method;
356 MonoMethod *private_invoke_method;
357 /* Used to store offsets of thread and context static fields */
358 GHashTable *special_static_fields;
360 * This must be a GHashTable, since these objects can't be finalized
361 * if the hashtable contains a GC visible reference to them.
363 GHashTable *finalizable_objects_hash;
365 /* Protects the three hashes above */
366 mono_mutex_t finalizable_objects_hash_lock;
367 /* Used when accessing 'domain_assemblies' */
368 mono_mutex_t assemblies_lock;
370 GHashTable *method_rgctx_hash;
372 GHashTable *generic_virtual_cases;
373 MonoThunkFreeList **thunk_free_lists;
375 GHashTable *generic_virtual_thunks;
377 /* Information maintained by the JIT engine */
378 gpointer runtime_info;
380 /*thread pool jobs, used to coordinate shutdown.*/
381 volatile int threadpool_jobs;
382 HANDLE cleanup_semaphore;
384 /* Contains the compiled runtime invoke wrapper used by finalizers */
385 gpointer finalize_runtime_invoke;
387 /* Contains the compiled runtime invoke wrapper used by async resylt creation to capture thread context*/
388 gpointer capture_context_runtime_invoke;
390 /* Contains the compiled method used by async resylt creation to capture thread context*/
391 gpointer capture_context_method;
393 /* Assembly bindings, the per-domain part */
394 GSList *assembly_bindings;
395 gboolean assembly_bindings_parsed;
397 /* Used by socket-io.c */
398 /* These are domain specific, since the assembly can be unloaded */
399 MonoImage *socket_assembly;
400 MonoClass *sockaddr_class;
401 MonoClassField *sockaddr_data_field;
403 /* Cache function pointers for architectures */
404 /* that require wrappers */
405 GHashTable *ftnptrs_hash;
407 /* Maps MonoMethod* to weak links to DynamicMethod objects */
408 GHashTable *method_to_dyn_method;
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_assemblies_lock(domain) mono_locks_acquire(&(domain)->assemblies_lock, DomainAssembliesLock)
425 #define mono_domain_assemblies_unlock(domain) mono_locks_release(&(domain)->assemblies_lock, DomainAssembliesLock)
426 #define mono_domain_jit_code_hash_lock(domain) mono_locks_acquire(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
427 #define mono_domain_jit_code_hash_unlock(domain) mono_locks_release(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
429 typedef MonoDomain* (*MonoLoadFunc) (const char *filename, const char *runtime_version);
431 void mono_domain_lock (MonoDomain *domain);
432 void mono_domain_unlock (MonoDomain *domain);
435 mono_install_runtime_load (MonoLoadFunc func);
438 mono_runtime_load (const char *filename, const char *runtime_version);
440 typedef void (*MonoCreateDomainFunc) (MonoDomain *domain);
443 mono_install_create_domain_hook (MonoCreateDomainFunc func);
445 typedef void (*MonoFreeDomainFunc) (MonoDomain *domain);
448 mono_install_free_domain_hook (MonoFreeDomainFunc func);
454 mono_close_exe_image (void);
457 mono_jit_info_size (MonoJitInfoFlags flags, int num_clauses, int num_holes);
460 mono_jit_info_init (MonoJitInfo *ji, MonoMethod *method, guint8 *code, int code_size,
461 MonoJitInfoFlags flags, int num_clauses, int num_holes);
464 mono_jit_info_table_new (MonoDomain *domain);
467 mono_jit_info_table_free (MonoJitInfoTable *table);
470 mono_jit_info_table_add (MonoDomain *domain, MonoJitInfo *ji);
473 mono_jit_info_table_remove (MonoDomain *domain, MonoJitInfo *ji);
476 mono_jit_info_add_aot_module (MonoImage *image, gpointer start, gpointer end);
479 mono_jit_info_get_generic_jit_info (MonoJitInfo *ji);
481 MonoGenericSharingContext*
482 mono_jit_info_get_generic_sharing_context (MonoJitInfo *ji);
485 mono_jit_info_set_generic_sharing_context (MonoJitInfo *ji, MonoGenericSharingContext *gsctx);
488 mono_make_shadow_copy (const char *filename);
491 mono_is_shadow_copy_enabled (MonoDomain *domain, const gchar *dir_name);
494 mono_domain_alloc (MonoDomain *domain, guint size);
497 mono_domain_alloc0 (MonoDomain *domain, guint size);
500 mono_domain_alloc0_lock_free (MonoDomain *domain, guint size);
503 mono_domain_code_reserve (MonoDomain *domain, int size) MONO_LLVM_INTERNAL;
506 mono_domain_code_reserve_align (MonoDomain *domain, int size, int alignment);
509 mono_domain_code_commit (MonoDomain *domain, void *data, int size, int newsize);
512 nacl_domain_get_code_dest (MonoDomain *domain, void *data);
515 nacl_domain_code_validate (MonoDomain *domain, guint8 **buf_base, int buf_size, guint8 **code_end);
518 mono_domain_code_foreach (MonoDomain *domain, MonoCodeManagerFunc func, void *user_data);
521 mono_domain_unset (void);
524 mono_domain_set_internal_with_options (MonoDomain *domain, gboolean migrate_exception);
526 MonoTryBlockHoleTableJitInfo*
527 mono_jit_info_get_try_block_hole_table_info (MonoJitInfo *ji);
530 mono_jit_info_get_arch_eh_info (MonoJitInfo *ji);
533 mono_jit_info_get_thunk_info (MonoJitInfo *ji);
536 * Installs a new function which is used to return a MonoJitInfo for a method inside
539 typedef MonoJitInfo *(*MonoJitInfoFindInAot) (MonoDomain *domain, MonoImage *image, gpointer addr);
540 void mono_install_jit_info_find_in_aot (MonoJitInfoFindInAot func);
543 mono_jit_code_hash_init (MonoInternalHashTable *jit_code_hash);
546 ves_icall_System_AppDomain_getCurDomain (void);
549 ves_icall_System_AppDomain_getRootDomain (void);
552 ves_icall_System_AppDomain_createDomain (MonoString *friendly_name,
553 MonoAppDomainSetup *setup);
556 ves_icall_System_AppDomain_GetData (MonoAppDomain *ad,
559 MonoReflectionAssembly *
560 ves_icall_System_AppDomain_LoadAssemblyRaw (MonoAppDomain *ad,
561 MonoArray *raw_assembly,
562 MonoArray *raw_symbol_store,
563 MonoObject *evidence,
564 MonoBoolean refonly);
567 ves_icall_System_AppDomain_SetData (MonoAppDomain *ad,
572 ves_icall_System_AppDomain_getSetup (MonoAppDomain *ad);
575 ves_icall_System_AppDomain_getFriendlyName (MonoAppDomain *ad);
578 ves_icall_System_AppDomain_GetAssemblies (MonoAppDomain *ad,
579 MonoBoolean refonly);
581 MonoReflectionAssembly *
582 ves_icall_System_Reflection_Assembly_LoadFrom (MonoString *fname,
583 MonoBoolean refonly);
585 MonoReflectionAssembly *
586 ves_icall_System_AppDomain_LoadAssembly (MonoAppDomain *ad,
588 MonoObject *evidence,
589 MonoBoolean refonly);
592 ves_icall_System_AppDomain_InternalIsFinalizingForUnload (gint32 domain_id);
595 ves_icall_System_AppDomain_InternalUnload (gint32 domain_id);
598 ves_icall_System_AppDomain_DoUnhandledException (MonoException *exc);
601 ves_icall_System_AppDomain_ExecuteAssembly (MonoAppDomain *ad,
602 MonoReflectionAssembly *refass,
606 ves_icall_System_AppDomain_InternalSetDomain (MonoAppDomain *ad);
609 ves_icall_System_AppDomain_InternalSetDomainByID (gint32 domainid);
612 ves_icall_System_AppDomain_InternalPushDomainRef (MonoAppDomain *ad);
615 ves_icall_System_AppDomain_InternalPushDomainRefByID (gint32 domain_id);
618 ves_icall_System_AppDomain_InternalPopDomainRef (void);
621 ves_icall_System_AppDomain_InternalGetContext (void);
624 ves_icall_System_AppDomain_InternalGetDefaultContext (void);
627 ves_icall_System_AppDomain_InternalSetContext (MonoAppContext *mc);
630 ves_icall_System_AppDomain_GetIDFromDomain (MonoAppDomain * ad);
633 ves_icall_System_AppDomain_InternalGetProcessGuid (MonoString* newguid);
636 mono_assembly_load_corlib (const MonoRuntimeInfo *runtime, MonoImageOpenStatus *status);
638 const MonoRuntimeInfo*
639 mono_get_runtime_info (void);
642 mono_runtime_set_no_exec (gboolean val);
645 mono_runtime_get_no_exec (void);
648 mono_assembly_name_parse (const char *name, MonoAssemblyName *aname);
650 MonoImage *mono_assembly_open_from_bundle (const char *filename,
651 MonoImageOpenStatus *status,
655 mono_domain_add_class_static_data (MonoDomain *domain, MonoClass *klass, gpointer data, guint32 *bitmap);
657 MonoReflectionAssembly *
658 mono_try_assembly_resolve (MonoDomain *domain, MonoString *fname, MonoAssembly *requesting, gboolean refonly);
661 mono_domain_assembly_postload_search (MonoAssemblyName *aname, MonoAssembly *requesting, gboolean refonly);
663 MonoAssembly* mono_assembly_load_full_nosearch (MonoAssemblyName *aname,
665 MonoImageOpenStatus *status,
668 void mono_set_private_bin_path_from_config (MonoDomain *domain);
670 int mono_framework_version (void);
672 void mono_reflection_cleanup_domain (MonoDomain *domain);
674 void mono_assembly_cleanup_domain_bindings (guint32 domain_id);
676 MonoJitInfo* mono_jit_info_table_find_internal (MonoDomain *domain, char *addr, gboolean try_aot, gboolean allow_trampolines);
678 void mono_enable_debug_domain_unload (gboolean enable);
680 #endif /* __MONO_METADATA_DOMAIN_INTERNALS_H__ */