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>
19 * If this is set, the memory belonging to appdomains is not freed when a domain is
20 * unloaded, and assemblies loaded by the appdomain are not unloaded either. This
21 * allows us to use typed gc in non-default appdomains too, leading to increased
24 extern gboolean mono_dont_free_domains;
26 /* This is a copy of System.AppDomainSetup */
29 MonoString *application_base;
30 MonoString *application_name;
31 MonoString *cache_path;
32 MonoString *configuration_file;
33 MonoString *dynamic_base;
34 MonoString *license_file;
35 MonoString *private_bin_path;
36 MonoString *private_bin_path_probe;
37 MonoString *shadow_copy_directories;
38 MonoString *shadow_copy_files;
39 MonoBoolean publisher_policy;
40 MonoBoolean path_changed;
41 int loader_optimization;
42 MonoBoolean disallow_binding_redirects;
43 MonoBoolean disallow_code_downloads;
44 MonoObject *activation_arguments; /* it is System.Object in 1.x, ActivationArguments in 2.0 */
45 MonoObject *domain_initializer;
46 MonoObject *application_trust; /* it is System.Object in 1.x, ApplicationTrust in 2.0 */
47 MonoArray *domain_initializer_args;
48 MonoBoolean disallow_appbase_probe;
49 MonoArray *configuration_bytes;
50 MonoArray *serialized_non_primitives;
53 typedef struct _MonoJitInfoTable MonoJitInfoTable;
54 typedef struct _MonoJitInfoTableChunk MonoJitInfoTableChunk;
56 #define MONO_JIT_INFO_TABLE_CHUNK_SIZE 64
58 struct _MonoJitInfoTableChunk
61 volatile int num_elements;
62 volatile gint8 *last_code_end;
63 MonoJitInfo *next_tombstone;
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. */
206 struct _MonoJitInfo *next_jit_code_hash;
207 struct _MonoJitInfo *next_tombstone;
212 guint32 num_clauses:15;
213 /* Whenever the code is domain neutral or 'shared' */
214 gboolean domain_neutral:1;
215 gboolean has_generic_jit_info:1;
216 gboolean has_try_block_holes:1;
217 gboolean has_arch_eh_info:1;
218 gboolean has_thunk_info:1;
220 gboolean from_llvm:1;
221 gboolean dbg_attrs_inited:1;
222 gboolean dbg_hidden:1;
223 /* Whenever this jit info was loaded in async context */
225 gboolean dbg_step_through:1;
226 gboolean dbg_non_user_code:1;
228 * Whenever this jit info refers to a trampoline.
229 * d.tramp_info contains additional data in this case.
231 gboolean is_trampoline:1;
233 /* FIXME: Embed this after the structure later*/
234 gpointer gc_info; /* Currently only used by SGen */
236 MonoJitExceptionInfo clauses [MONO_ZERO_LEN_ARRAY];
237 /* There is an optional MonoGenericJitInfo after the clauses */
238 /* There is an optional MonoTryBlockHoleTableJitInfo after MonoGenericJitInfo clauses*/
239 /* There is an optional MonoArchEHJitInfo after MonoTryBlockHoleTableJitInfo */
240 /* There is an optional MonoThunkJitInfo after MonoArchEHJitInfo */
243 #define MONO_SIZEOF_JIT_INFO (offsetof (struct _MonoJitInfo, clauses))
246 gpointer *static_data; /* Used to free the static data without going through the MonoAppContext object itself. */
250 struct _MonoAppContext {
254 gpointer *static_data;
255 ContextStaticData *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;
293 * This lock must never be taken before the loader lock,
294 * i.e. if both are taken by the same thread, the loader lock
299 MonoCodeManager *code_mp;
301 * keep all the managed objects close to each other for the precise GC
302 * For the Boehm GC we additionally keep close also other GC-tracked pointers.
304 #define MONO_DOMAIN_FIRST_OBJECT setup
305 MonoAppDomainSetup *setup;
306 MonoAppDomain *domain;
307 MonoAppContext *default_context;
308 MonoException *out_of_memory_ex;
309 MonoException *null_reference_ex;
310 MonoException *stack_overflow_ex;
312 MonoObject *typeof_void;
313 /* Ephemeron Tombstone*/
314 MonoObject *ephemeron_tombstone;
315 /* new MonoType [0] */
316 MonoArray *empty_types;
318 * The fields between FIRST_GC_TRACKED and LAST_GC_TRACKED are roots, but
319 * not object references.
321 #define MONO_DOMAIN_FIRST_GC_TRACKED env
323 MonoGHashTable *ldstr_table;
324 /* hashtables for Reflection handles */
325 MonoGHashTable *type_hash;
326 MonoGHashTable *refobject_hash;
327 /* a GC-tracked array to keep references to the static fields of types */
328 gpointer *static_data_array;
329 /* maps class -> type initialization exception object */
330 MonoGHashTable *type_init_exception_hash;
331 /* maps delegate trampoline addr -> delegate object */
332 MonoGHashTable *delegate_hash_table;
333 #define MONO_DOMAIN_LAST_GC_TRACKED delegate_hash_table
335 /* Needed by Thread:GetDomainID() */
337 gint32 shadow_serial;
338 unsigned char inet_family_hint; // used in socket-io.c as a cache
339 GSList *domain_assemblies;
340 MonoAssembly *entry_assembly;
342 GPtrArray *class_vtable_array;
343 /* maps remote class key -> MonoRemoteClass */
344 GHashTable *proxy_vtable_hash;
345 /* Protected by 'jit_code_hash_lock' */
346 MonoInternalHashTable jit_code_hash;
347 mono_mutex_t jit_code_hash_lock;
348 int num_jit_info_tables;
350 volatile jit_info_table;
352 * Contains information about AOT loaded code.
353 * Only used in the root domain.
356 volatile aot_modules;
357 GSList *jit_info_free_queue;
358 /* Used when loading assemblies */
360 gchar *private_bin_path;
361 LockFreeMempool *lock_free_mp;
363 /* Used by remoting proxies */
364 MonoMethod *create_proxy_for_type_method;
365 MonoMethod *private_invoke_method;
366 /* Used to store offsets of thread and context static fields */
367 GHashTable *special_static_fields;
369 * This must be a GHashTable, since these objects can't be finalized
370 * if the hashtable contains a GC visible reference to them.
372 GHashTable *finalizable_objects_hash;
374 /* Protects the three hashes above */
375 mono_mutex_t finalizable_objects_hash_lock;
376 /* Used when accessing 'domain_assemblies' */
377 mono_mutex_t assemblies_lock;
379 GHashTable *method_rgctx_hash;
381 GHashTable *generic_virtual_cases;
382 MonoThunkFreeList **thunk_free_lists;
384 GHashTable *generic_virtual_thunks;
386 /* Information maintained by the JIT engine */
387 gpointer runtime_info;
389 /*thread pool jobs, used to coordinate shutdown.*/
390 volatile int threadpool_jobs;
391 HANDLE cleanup_semaphore;
393 /* Contains the compiled runtime invoke wrapper used by finalizers */
394 gpointer finalize_runtime_invoke;
396 /* Contains the compiled runtime invoke wrapper used by async resylt creation to capture thread context*/
397 gpointer capture_context_runtime_invoke;
399 /* Contains the compiled method used by async resylt creation to capture thread context*/
400 gpointer capture_context_method;
402 /* Assembly bindings, the per-domain part */
403 GSList *assembly_bindings;
404 gboolean assembly_bindings_parsed;
406 /* Used by socket-io.c */
407 /* These are domain specific, since the assembly can be unloaded */
408 MonoImage *socket_assembly;
409 MonoClass *sockaddr_class;
410 MonoClassField *sockaddr_data_field;
412 /* Cache function pointers for architectures */
413 /* that require wrappers */
414 GHashTable *ftnptrs_hash;
416 /* Maps MonoMethod* to weak links to DynamicMethod objects */
417 GHashTable *method_to_dyn_method;
419 /* <ThrowUnobservedTaskExceptions /> support */
420 gboolean throw_unobserved_task_exceptions;
422 guint32 execution_context_field_offset;
426 guint16 major, minor, build, revision;
427 } AssemblyVersionSet;
429 /* MonoRuntimeInfo: Contains information about versions supported by this runtime */
431 const char runtime_version [12];
432 const char framework_version [4];
433 const AssemblyVersionSet version_sets [4];
436 #define mono_domain_assemblies_lock(domain) mono_locks_os_acquire(&(domain)->assemblies_lock, DomainAssembliesLock)
437 #define mono_domain_assemblies_unlock(domain) mono_locks_os_release(&(domain)->assemblies_lock, DomainAssembliesLock)
438 #define mono_domain_jit_code_hash_lock(domain) mono_locks_os_acquire(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
439 #define mono_domain_jit_code_hash_unlock(domain) mono_locks_os_release(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
441 typedef MonoDomain* (*MonoLoadFunc) (const char *filename, const char *runtime_version);
443 void mono_domain_lock (MonoDomain *domain);
444 void mono_domain_unlock (MonoDomain *domain);
447 mono_install_runtime_load (MonoLoadFunc func);
450 mono_runtime_load (const char *filename, const char *runtime_version);
452 typedef void (*MonoCreateDomainFunc) (MonoDomain *domain);
455 mono_install_create_domain_hook (MonoCreateDomainFunc func);
457 typedef void (*MonoFreeDomainFunc) (MonoDomain *domain);
460 mono_install_free_domain_hook (MonoFreeDomainFunc func);
466 mono_close_exe_image (void);
469 mono_jit_info_size (MonoJitInfoFlags flags, int num_clauses, int num_holes);
472 mono_jit_info_init (MonoJitInfo *ji, MonoMethod *method, guint8 *code, int code_size,
473 MonoJitInfoFlags flags, int num_clauses, int num_holes);
476 mono_jit_info_table_new (MonoDomain *domain);
479 mono_jit_info_table_free (MonoJitInfoTable *table);
482 mono_jit_info_table_add (MonoDomain *domain, MonoJitInfo *ji);
485 mono_jit_info_table_remove (MonoDomain *domain, MonoJitInfo *ji);
488 mono_jit_info_add_aot_module (MonoImage *image, gpointer start, gpointer end);
491 mono_jit_info_get_generic_jit_info (MonoJitInfo *ji);
493 MonoGenericSharingContext*
494 mono_jit_info_get_generic_sharing_context (MonoJitInfo *ji);
497 mono_jit_info_set_generic_sharing_context (MonoJitInfo *ji, MonoGenericSharingContext *gsctx);
500 mono_make_shadow_copy (const char *filename, MonoError *error);
503 mono_is_shadow_copy_enabled (MonoDomain *domain, const gchar *dir_name);
506 mono_domain_alloc (MonoDomain *domain, guint size);
509 mono_domain_alloc0 (MonoDomain *domain, guint size);
512 mono_domain_alloc0_lock_free (MonoDomain *domain, guint size);
515 mono_domain_code_reserve (MonoDomain *domain, int size) MONO_LLVM_INTERNAL;
518 mono_domain_code_reserve_align (MonoDomain *domain, int size, int alignment);
521 mono_domain_code_commit (MonoDomain *domain, void *data, int size, int newsize);
524 nacl_domain_get_code_dest (MonoDomain *domain, void *data);
527 nacl_domain_code_validate (MonoDomain *domain, guint8 **buf_base, int buf_size, guint8 **code_end);
530 mono_domain_code_foreach (MonoDomain *domain, MonoCodeManagerFunc func, void *user_data);
533 mono_domain_unset (void);
536 mono_domain_set_internal_with_options (MonoDomain *domain, gboolean migrate_exception);
538 MonoTryBlockHoleTableJitInfo*
539 mono_jit_info_get_try_block_hole_table_info (MonoJitInfo *ji);
542 mono_jit_info_get_arch_eh_info (MonoJitInfo *ji);
545 mono_jit_info_get_thunk_info (MonoJitInfo *ji);
548 * Installs a new function which is used to return a MonoJitInfo for a method inside
551 typedef MonoJitInfo *(*MonoJitInfoFindInAot) (MonoDomain *domain, MonoImage *image, gpointer addr);
552 void mono_install_jit_info_find_in_aot (MonoJitInfoFindInAot func);
555 mono_jit_code_hash_init (MonoInternalHashTable *jit_code_hash);
558 ves_icall_System_AppDomain_getCurDomain (void);
561 ves_icall_System_AppDomain_getRootDomain (void);
564 ves_icall_System_AppDomain_createDomain (MonoString *friendly_name,
565 MonoAppDomainSetup *setup);
568 ves_icall_System_AppDomain_GetData (MonoAppDomain *ad,
571 MonoReflectionAssembly *
572 ves_icall_System_AppDomain_LoadAssemblyRaw (MonoAppDomain *ad,
573 MonoArray *raw_assembly,
574 MonoArray *raw_symbol_store,
575 MonoObject *evidence,
576 MonoBoolean refonly);
579 ves_icall_System_AppDomain_SetData (MonoAppDomain *ad,
584 ves_icall_System_AppDomain_getSetup (MonoAppDomain *ad);
587 ves_icall_System_AppDomain_getFriendlyName (MonoAppDomain *ad);
590 ves_icall_System_AppDomain_GetAssemblies (MonoAppDomain *ad,
591 MonoBoolean refonly);
593 MonoReflectionAssembly *
594 ves_icall_System_Reflection_Assembly_LoadFrom (MonoString *fname,
595 MonoBoolean refonly);
597 MonoReflectionAssembly *
598 ves_icall_System_AppDomain_LoadAssembly (MonoAppDomain *ad,
600 MonoObject *evidence,
601 MonoBoolean refonly);
604 ves_icall_System_AppDomain_InternalIsFinalizingForUnload (gint32 domain_id);
607 ves_icall_System_AppDomain_InternalUnload (gint32 domain_id);
610 ves_icall_System_AppDomain_DoUnhandledException (MonoException *exc);
613 ves_icall_System_AppDomain_ExecuteAssembly (MonoAppDomain *ad,
614 MonoReflectionAssembly *refass,
618 ves_icall_System_AppDomain_InternalSetDomain (MonoAppDomain *ad);
621 ves_icall_System_AppDomain_InternalSetDomainByID (gint32 domainid);
624 ves_icall_System_AppDomain_InternalPushDomainRef (MonoAppDomain *ad);
627 ves_icall_System_AppDomain_InternalPushDomainRefByID (gint32 domain_id);
630 ves_icall_System_AppDomain_InternalPopDomainRef (void);
633 ves_icall_System_AppDomain_InternalGetContext (void);
636 ves_icall_System_AppDomain_InternalGetDefaultContext (void);
639 ves_icall_System_AppDomain_InternalSetContext (MonoAppContext *mc);
642 ves_icall_System_AppDomain_GetIDFromDomain (MonoAppDomain * ad);
645 ves_icall_System_AppDomain_InternalGetProcessGuid (MonoString* newguid);
648 ves_icall_System_CLRConfig_CheckThrowUnobservedTaskExceptions (void);
651 mono_assembly_load_corlib (const MonoRuntimeInfo *runtime, MonoImageOpenStatus *status);
653 const MonoRuntimeInfo*
654 mono_get_runtime_info (void);
657 mono_runtime_set_no_exec (gboolean val);
660 mono_runtime_get_no_exec (void);
663 mono_assembly_name_parse (const char *name, MonoAssemblyName *aname);
665 MonoImage *mono_assembly_open_from_bundle (const char *filename,
666 MonoImageOpenStatus *status,
670 mono_domain_add_class_static_data (MonoDomain *domain, MonoClass *klass, gpointer data, guint32 *bitmap);
672 MonoReflectionAssembly *
673 mono_try_assembly_resolve (MonoDomain *domain, MonoString *fname, MonoAssembly *requesting, gboolean refonly, MonoError *error);
676 mono_domain_assembly_postload_search (MonoAssemblyName *aname, MonoAssembly *requesting, gboolean refonly);
678 MonoAssembly* mono_assembly_load_full_nosearch (MonoAssemblyName *aname,
680 MonoImageOpenStatus *status,
683 void mono_domain_set_options_from_config (MonoDomain *domain);
685 int mono_framework_version (void);
687 void mono_reflection_cleanup_domain (MonoDomain *domain);
689 void mono_assembly_cleanup_domain_bindings (guint32 domain_id);
691 MonoJitInfo* mono_jit_info_table_find_internal (MonoDomain *domain, char *addr, gboolean try_aot, gboolean allow_trampolines);
693 void mono_enable_debug_domain_unload (gboolean enable);
695 MonoReflectionAssembly *
696 mono_domain_try_type_resolve_checked (MonoDomain *domain, char *name, MonoObject *tb, MonoError *error);
699 mono_runtime_init_checked (MonoDomain *domain, MonoThreadStartCB start_cb, MonoThreadAttachCB attach_cb, MonoError *error);
702 mono_context_init_checked (MonoDomain *domain, MonoError *error);
704 #endif /* __MONO_METADATA_DOMAIN_INTERNALS_H__ */