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;
23 * If this is set, the memory belonging to appdomains is not freed when a domain is
24 * unloaded, and assemblies loaded by the appdomain are not unloaded either. This
25 * allows us to use typed gc in non-default appdomains too, leading to increased
28 extern gboolean mono_dont_free_domains;
30 /* This is a copy of System.AppDomainSetup */
33 MonoString *application_base;
34 MonoString *application_name;
35 MonoString *cache_path;
36 MonoString *configuration_file;
37 MonoString *dynamic_base;
38 MonoString *license_file;
39 MonoString *private_bin_path;
40 MonoString *private_bin_path_probe;
41 MonoString *shadow_copy_directories;
42 MonoString *shadow_copy_files;
43 MonoBoolean publisher_policy;
44 MonoBoolean path_changed;
45 int loader_optimization;
46 MonoBoolean disallow_binding_redirects;
47 MonoBoolean disallow_code_downloads;
48 MonoObject *activation_arguments; /* it is System.Object in 1.x, ActivationArguments in 2.0 */
49 MonoObject *domain_initializer;
50 MonoObject *application_trust; /* it is System.Object in 1.x, ApplicationTrust in 2.0 */
51 MonoArray *domain_initializer_args;
52 MonoBoolean disallow_appbase_probe;
53 MonoArray *configuration_bytes;
54 MonoArray *serialized_non_primitives;
57 typedef struct _MonoJitInfoTable MonoJitInfoTable;
58 typedef struct _MonoJitInfoTableChunk MonoJitInfoTableChunk;
60 #define MONO_JIT_INFO_TABLE_CHUNK_SIZE 64
62 struct _MonoJitInfoTableChunk
65 volatile int num_elements;
66 volatile gint8 *last_code_end;
67 MonoJitInfo * volatile data [MONO_JIT_INFO_TABLE_CHUNK_SIZE];
70 struct _MonoJitInfoTable
74 MonoJitInfoTableChunk *chunks [MONO_ZERO_LEN_ARRAY];
77 #define MONO_SIZEOF_JIT_INFO_TABLE (sizeof (struct _MonoJitInfoTable) - MONO_ZERO_LEN_ARRAY * SIZEOF_VOID_P)
79 typedef GArray MonoAotModuleInfoTable;
86 gpointer handler_start;
88 * For LLVM compiled code, this is the index of the il clause
89 * associated with this handler.
93 MonoClass *catch_class;
97 } MonoJitExceptionInfo;
100 * Contains information about the type arguments for generic shared methods.
103 gboolean is_gsharedvt;
104 } MonoGenericSharingContext;
106 /* Simplified DWARF location list entry */
108 /* Whenever the value is in a register */
111 * If is_reg is TRUE, the register which contains the value. Otherwise
116 * If is_reg is FALSE, the offset of the stack location relative to 'reg'.
121 * Offsets of the PC interval where the value is in this location.
124 } MonoDwarfLocListEntry;
128 MonoGenericSharingContext *generic_sharing_context;
130 MonoDwarfLocListEntry *locations;
134 gboolean this_in_reg:1;
135 } MonoGenericJitInfo;
138 A try block hole is used to represent a non-contiguous part of
139 of a segment of native code protected by a given .try block.
140 Usually, a try block is defined as a contiguous segment of code.
141 But in some cases it's needed to have some parts of it to not be protected.
142 For example, given "try {} finally {}", the code in the .try block to call
143 the finally part looks like:
149 jump outside try block
155 The instructions between the call and the jump should not be under the try block since they happen
156 after the finally block executes, which means if an async exceptions happens at that point we would
157 execute the finally clause twice. So, to avoid this, we introduce a hole in the try block to signal
158 that those instructions are not protected.
165 } MonoTryBlockHoleJitInfo;
170 MonoTryBlockHoleJitInfo holes [MONO_ZERO_LEN_ARRAY];
171 } MonoTryBlockHoleTableJitInfo;
180 /* Relative to code_start */
187 JIT_INFO_HAS_GENERIC_JIT_INFO = (1 << 0),
188 JIT_INFO_HAS_TRY_BLOCK_HOLES = (1 << 1),
189 JIT_INFO_HAS_ARCH_EH_INFO = (1 << 2),
190 JIT_INFO_HAS_THUNK_INFO = (1 << 3)
193 struct _MonoJitInfo {
194 /* NOTE: These first two elements (method and
195 next_jit_code_hash) must be in the same order and at the
196 same offset as in RuntimeMethod, because of the jit_code_hash
197 internal hash table in MonoDomain. */
204 struct _MonoJitInfo *next_jit_code_hash;
208 guint32 num_clauses:15;
209 /* Whenever the code is domain neutral or 'shared' */
210 gboolean domain_neutral:1;
211 gboolean has_generic_jit_info:1;
212 gboolean has_try_block_holes:1;
213 gboolean has_arch_eh_info:1;
214 gboolean has_thunk_info:1;
216 gboolean from_llvm:1;
217 gboolean dbg_attrs_inited:1;
218 gboolean dbg_hidden:1;
219 /* Whenever this jit info was loaded in async context */
221 gboolean dbg_step_through:1;
222 gboolean dbg_non_user_code:1;
224 * Whenever this jit info refers to a trampoline.
225 * d.tramp_info contains additional data in this case.
227 gboolean is_trampoline:1;
229 /* FIXME: Embed this after the structure later*/
230 gpointer gc_info; /* Currently only used by SGen */
232 MonoJitExceptionInfo clauses [MONO_ZERO_LEN_ARRAY];
233 /* There is an optional MonoGenericJitInfo after the clauses */
234 /* There is an optional MonoTryBlockHoleTableJitInfo after MonoGenericJitInfo clauses*/
235 /* There is an optional MonoArchEHJitInfo after MonoTryBlockHoleTableJitInfo */
236 /* There is an optional MonoThunkJitInfo after MonoArchEHJitInfo */
239 #define MONO_SIZEOF_JIT_INFO (offsetof (struct _MonoJitInfo, clauses))
241 struct _MonoAppContext {
245 gpointer *static_data;
248 /* Lock-free allocator */
253 } LockFreeMempoolChunk;
256 LockFreeMempoolChunk *current, *chunks;
260 * We have two unloading states because the domain
261 * must remain fully functional while AppDomain::DomainUnload is
263 * After that unloading began and all domain facilities are teared down
264 * such as execution of new threadpool jobs.
267 MONO_APPDOMAIN_CREATED,
268 MONO_APPDOMAIN_UNLOADING_START,
269 MONO_APPDOMAIN_UNLOADING,
270 MONO_APPDOMAIN_UNLOADED
271 } MonoAppDomainState;
273 typedef struct _MonoThunkFreeList {
275 int length; /* only valid for the wait list */
276 struct _MonoThunkFreeList *next;
279 typedef struct _MonoJitCodeHash MonoJitCodeHash;
283 * This lock must never be taken before the loader lock,
284 * i.e. if both are taken by the same thread, the loader lock
289 MonoCodeManager *code_mp;
291 * keep all the managed objects close to each other for the precise GC
292 * For the Boehm GC we additionally keep close also other GC-tracked pointers.
294 #define MONO_DOMAIN_FIRST_OBJECT setup
295 MonoAppDomainSetup *setup;
296 MonoAppDomain *domain;
297 MonoAppContext *default_context;
298 MonoException *out_of_memory_ex;
299 MonoException *null_reference_ex;
300 MonoException *stack_overflow_ex;
302 MonoObject *typeof_void;
303 /* Ephemeron Tombstone*/
304 MonoObject *ephemeron_tombstone;
305 /* new MonoType [0] */
306 MonoArray *empty_types;
308 * The fields between FIRST_GC_TRACKED and LAST_GC_TRACKED are roots, but
309 * not object references.
311 #define MONO_DOMAIN_FIRST_GC_TRACKED env
313 MonoGHashTable *ldstr_table;
314 /* hashtables for Reflection handles */
315 MonoGHashTable *type_hash;
316 MonoGHashTable *refobject_hash;
317 /* a GC-tracked array to keep references to the static fields of types */
318 gpointer *static_data_array;
319 /* maps class -> type initialization exception object */
320 MonoGHashTable *type_init_exception_hash;
321 /* maps delegate trampoline addr -> delegate object */
322 MonoGHashTable *delegate_hash_table;
323 #define MONO_DOMAIN_LAST_GC_TRACKED delegate_hash_table
325 /* Needed by Thread:GetDomainID() */
327 gint32 shadow_serial;
328 unsigned char inet_family_hint; // used in socket-io.c as a cache
329 GSList *domain_assemblies;
330 MonoAssembly *entry_assembly;
332 GPtrArray *class_vtable_array;
333 /* maps remote class key -> MonoRemoteClass */
334 GHashTable *proxy_vtable_hash;
335 /* Protected by 'jit_code_hash_lock' */
336 MonoInternalHashTable jit_code_hash;
337 mono_mutex_t jit_code_hash_lock;
338 int num_jit_info_tables;
340 volatile jit_info_table;
342 * Contains information about AOT loaded code.
343 * Only used in the root domain.
346 volatile aot_modules;
347 GSList *jit_info_free_queue;
348 /* Used when loading assemblies */
350 gchar *private_bin_path;
351 LockFreeMempool *lock_free_mp;
353 /* Used by remoting proxies */
354 MonoMethod *create_proxy_for_type_method;
355 MonoMethod *private_invoke_method;
356 /* Used to store offsets of thread and context static fields */
357 GHashTable *special_static_fields;
359 * This must be a GHashTable, since these objects can't be finalized
360 * if the hashtable contains a GC visible reference to them.
362 GHashTable *finalizable_objects_hash;
364 /* Protects the three hashes above */
365 mono_mutex_t finalizable_objects_hash_lock;
366 /* Used when accessing 'domain_assemblies' */
367 mono_mutex_t assemblies_lock;
369 GHashTable *method_rgctx_hash;
371 GHashTable *generic_virtual_cases;
372 MonoThunkFreeList **thunk_free_lists;
374 GHashTable *generic_virtual_thunks;
376 /* Information maintained by the JIT engine */
377 gpointer runtime_info;
379 /*thread pool jobs, used to coordinate shutdown.*/
380 volatile int threadpool_jobs;
381 HANDLE cleanup_semaphore;
383 /* Contains the compiled runtime invoke wrapper used by finalizers */
384 gpointer finalize_runtime_invoke;
386 /* Contains the compiled runtime invoke wrapper used by async resylt creation to capture thread context*/
387 gpointer capture_context_runtime_invoke;
389 /* Contains the compiled method used by async resylt creation to capture thread context*/
390 gpointer capture_context_method;
392 /* Assembly bindings, the per-domain part */
393 GSList *assembly_bindings;
394 gboolean assembly_bindings_parsed;
396 /* Used by socket-io.c */
397 /* These are domain specific, since the assembly can be unloaded */
398 MonoImage *socket_assembly;
399 MonoClass *sockaddr_class;
400 MonoClassField *sockaddr_data_field;
402 /* Used by threadpool.c */
403 MonoImage *system_image;
404 MonoClass *corlib_asyncresult_class;
405 MonoClass *socket_class;
406 MonoClass *ad_unloaded_ex_class;
407 MonoClass *process_class;
409 /* Cache function pointers for architectures */
410 /* that require wrappers */
411 GHashTable *ftnptrs_hash;
413 guint32 execution_context_field_offset;
417 guint16 major, minor, build, revision;
418 } AssemblyVersionSet;
420 /* MonoRuntimeInfo: Contains information about versions supported by this runtime */
422 const char runtime_version [12];
423 const char framework_version [4];
424 const AssemblyVersionSet version_sets [4];
427 #define mono_domain_assemblies_lock(domain) mono_locks_acquire(&(domain)->assemblies_lock, DomainAssembliesLock)
428 #define mono_domain_assemblies_unlock(domain) mono_locks_release(&(domain)->assemblies_lock, DomainAssembliesLock)
429 #define mono_domain_jit_code_hash_lock(domain) mono_locks_acquire(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
430 #define mono_domain_jit_code_hash_unlock(domain) mono_locks_release(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
432 typedef MonoDomain* (*MonoLoadFunc) (const char *filename, const char *runtime_version);
434 void mono_domain_lock (MonoDomain *domain);
435 void mono_domain_unlock (MonoDomain *domain);
438 mono_install_runtime_load (MonoLoadFunc func);
441 mono_runtime_load (const char *filename, const char *runtime_version);
443 typedef void (*MonoCreateDomainFunc) (MonoDomain *domain);
446 mono_install_create_domain_hook (MonoCreateDomainFunc func);
448 typedef void (*MonoFreeDomainFunc) (MonoDomain *domain);
451 mono_install_free_domain_hook (MonoFreeDomainFunc func);
457 mono_close_exe_image (void);
460 mono_jit_info_size (MonoJitInfoFlags flags, int num_clauses, int num_holes);
463 mono_jit_info_init (MonoJitInfo *ji, MonoMethod *method, guint8 *code, int code_size,
464 MonoJitInfoFlags flags, int num_clauses, int num_holes);
467 mono_jit_info_table_new (MonoDomain *domain);
470 mono_jit_info_table_free (MonoJitInfoTable *table);
473 mono_jit_info_table_add (MonoDomain *domain, MonoJitInfo *ji);
476 mono_jit_info_table_remove (MonoDomain *domain, MonoJitInfo *ji);
479 mono_jit_info_add_aot_module (MonoImage *image, gpointer start, gpointer end);
482 mono_jit_info_get_generic_jit_info (MonoJitInfo *ji);
484 MonoGenericSharingContext*
485 mono_jit_info_get_generic_sharing_context (MonoJitInfo *ji);
488 mono_jit_info_set_generic_sharing_context (MonoJitInfo *ji, MonoGenericSharingContext *gsctx);
491 mono_make_shadow_copy (const char *filename);
494 mono_is_shadow_copy_enabled (MonoDomain *domain, const gchar *dir_name);
497 mono_domain_alloc (MonoDomain *domain, guint size);
500 mono_domain_alloc0 (MonoDomain *domain, guint size);
503 mono_domain_alloc0_lock_free (MonoDomain *domain, guint size);
506 mono_domain_code_reserve (MonoDomain *domain, int size) MONO_LLVM_INTERNAL;
509 mono_domain_code_reserve_align (MonoDomain *domain, int size, int alignment);
512 mono_domain_code_commit (MonoDomain *domain, void *data, int size, int newsize);
515 nacl_domain_get_code_dest (MonoDomain *domain, void *data);
518 nacl_domain_code_validate (MonoDomain *domain, guint8 **buf_base, int buf_size, guint8 **code_end);
521 mono_domain_code_foreach (MonoDomain *domain, MonoCodeManagerFunc func, void *user_data);
524 mono_domain_unset (void);
527 mono_domain_set_internal_with_options (MonoDomain *domain, gboolean migrate_exception);
529 MonoTryBlockHoleTableJitInfo*
530 mono_jit_info_get_try_block_hole_table_info (MonoJitInfo *ji);
533 mono_jit_info_get_arch_eh_info (MonoJitInfo *ji);
536 mono_jit_info_get_thunk_info (MonoJitInfo *ji);
539 * Installs a new function which is used to return a MonoJitInfo for a method inside
542 typedef MonoJitInfo *(*MonoJitInfoFindInAot) (MonoDomain *domain, MonoImage *image, gpointer addr);
543 void mono_install_jit_info_find_in_aot (MonoJitInfoFindInAot func);
546 mono_jit_code_hash_init (MonoInternalHashTable *jit_code_hash);
549 ves_icall_System_AppDomain_getCurDomain (void);
552 ves_icall_System_AppDomain_getRootDomain (void);
555 ves_icall_System_AppDomain_createDomain (MonoString *friendly_name,
556 MonoAppDomainSetup *setup);
559 ves_icall_System_AppDomain_GetData (MonoAppDomain *ad,
562 MonoReflectionAssembly *
563 ves_icall_System_AppDomain_LoadAssemblyRaw (MonoAppDomain *ad,
564 MonoArray *raw_assembly,
565 MonoArray *raw_symbol_store,
566 MonoObject *evidence,
567 MonoBoolean refonly);
570 ves_icall_System_AppDomain_SetData (MonoAppDomain *ad,
575 ves_icall_System_AppDomain_getSetup (MonoAppDomain *ad);
578 ves_icall_System_AppDomain_getFriendlyName (MonoAppDomain *ad);
581 ves_icall_System_AppDomain_GetAssemblies (MonoAppDomain *ad,
582 MonoBoolean refonly);
584 MonoReflectionAssembly *
585 ves_icall_System_Reflection_Assembly_LoadFrom (MonoString *fname,
586 MonoBoolean refonly);
588 MonoReflectionAssembly *
589 ves_icall_System_AppDomain_LoadAssembly (MonoAppDomain *ad,
591 MonoObject *evidence,
592 MonoBoolean refonly);
595 ves_icall_System_AppDomain_InternalIsFinalizingForUnload (gint32 domain_id);
598 ves_icall_System_AppDomain_InternalUnload (gint32 domain_id);
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__ */