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;
102 MonoGenericSharingContext *generic_sharing_context;
106 gboolean this_in_reg:1;
107 } MonoGenericJitInfo;
110 A try block hole is used to represent a non-contiguous part of
111 of a segment of native code protected by a given .try block.
112 Usually, a try block is defined as a contiguous segment of code.
113 But in some cases it's needed to have some parts of it to not be protected.
114 For example, given "try {} finally {}", the code in the .try block to call
115 the finally part looks like:
121 jump outside try block
127 The instructions between the call and the jump should not be under the try block since they happen
128 after the finally block executes, which means if an async exceptions happens at that point we would
129 execute the finally clause twice. So, to avoid this, we introduce a hole in the try block to signal
130 that those instructions are not protected.
137 } MonoTryBlockHoleJitInfo;
142 MonoTryBlockHoleJitInfo holes [MONO_ZERO_LEN_ARRAY];
143 } MonoTryBlockHoleTableJitInfo;
145 struct _MonoJitInfo {
146 /* NOTE: These first two elements (method and
147 next_jit_code_hash) must be in the same order and at the
148 same offset as in RuntimeMethod, because of the jit_code_hash
149 internal hash table in MonoDomain. */
151 struct _MonoJitInfo *next_jit_code_hash;
153 /* This might contain an id for the unwind info instead of a register mask */
156 guint32 num_clauses:15;
157 /* Whenever the code is domain neutral or 'shared' */
158 gboolean domain_neutral:1;
159 gboolean cas_inited:1;
160 gboolean cas_class_assert:1;
161 gboolean cas_class_deny:1;
162 gboolean cas_class_permitonly:1;
163 gboolean cas_method_assert:1;
164 gboolean cas_method_deny:1;
165 gboolean cas_method_permitonly:1;
166 gboolean has_generic_jit_info:1;
167 gboolean has_try_block_holes:1;
169 gboolean from_llvm:1;
171 /* FIXME: Embed this after the structure later*/
172 gpointer gc_info; /* Currently only used by SGen */
174 MonoJitExceptionInfo clauses [MONO_ZERO_LEN_ARRAY];
175 /* There is an optional MonoGenericJitInfo after the clauses */
176 /* There is an optional MonoTryBlockHoleTableJitInfo after MonoGenericJitInfo clauses*/
179 #define MONO_SIZEOF_JIT_INFO (offsetof (struct _MonoJitInfo, clauses))
181 struct _MonoAppContext {
185 gpointer *static_data;
189 * We have two unloading states because the domain
190 * must remain fully functional while AppDomain::DomainUnload is
192 * After that unloading began and all domain facilities are teared down
193 * such as execution of new threadpool jobs.
196 MONO_APPDOMAIN_CREATED,
197 MONO_APPDOMAIN_UNLOADING_START,
198 MONO_APPDOMAIN_UNLOADING,
199 MONO_APPDOMAIN_UNLOADED
200 } MonoAppDomainState;
202 typedef struct _MonoThunkFreeList {
204 int length; /* only valid for the wait list */
205 struct _MonoThunkFreeList *next;
208 typedef struct _MonoJitCodeHash MonoJitCodeHash;
212 * This lock must never be taken before the loader lock,
213 * i.e. if both are taken by the same thread, the loader lock
216 CRITICAL_SECTION lock;
218 MonoCodeManager *code_mp;
220 * keep all the managed objects close to each other for the precise GC
221 * For the Boehm GC we additionally keep close also other GC-tracked pointers.
223 #define MONO_DOMAIN_FIRST_OBJECT setup
224 MonoAppDomainSetup *setup;
225 MonoAppDomain *domain;
226 MonoAppContext *default_context;
227 MonoException *out_of_memory_ex;
228 MonoException *null_reference_ex;
229 MonoException *stack_overflow_ex;
231 MonoObject *typeof_void;
232 /* Ephemeron Tombstone*/
233 MonoObject *ephemeron_tombstone;
235 * The fields between FIRST_GC_TRACKED and LAST_GC_TRACKED are roots, but
236 * not object references.
238 #define MONO_DOMAIN_FIRST_GC_TRACKED env
240 MonoGHashTable *ldstr_table;
241 /* hashtables for Reflection handles */
242 MonoGHashTable *type_hash;
243 MonoGHashTable *refobject_hash;
244 /* a GC-tracked array to keep references to the static fields of types */
245 gpointer *static_data_array;
246 /* maps class -> type initialization exception object */
247 MonoGHashTable *type_init_exception_hash;
248 /* maps delegate trampoline addr -> delegate object */
249 MonoGHashTable *delegate_hash_table;
250 #define MONO_DOMAIN_LAST_GC_TRACKED delegate_hash_table
252 /* Needed by Thread:GetDomainID() */
254 gint32 shadow_serial;
255 unsigned char inet_family_hint; // used in socket-io.c as a cache
256 GSList *domain_assemblies;
257 MonoAssembly *entry_assembly;
259 GPtrArray *class_vtable_array;
260 /* maps remote class key -> MonoRemoteClass */
261 GHashTable *proxy_vtable_hash;
262 /* Protected by 'jit_code_hash_lock' */
263 MonoInternalHashTable jit_code_hash;
264 CRITICAL_SECTION jit_code_hash_lock;
265 int num_jit_info_tables;
267 volatile jit_info_table;
268 GSList *jit_info_free_queue;
269 /* Used when loading assemblies */
271 gchar *private_bin_path;
273 /* Used by remoting proxies */
274 MonoMethod *create_proxy_for_type_method;
275 MonoMethod *private_invoke_method;
276 /* Used to store offsets of thread and context static fields */
277 GHashTable *special_static_fields;
279 * This must be a GHashTable, since these objects can't be finalized
280 * if the hashtable contains a GC visible reference to them.
282 GHashTable *finalizable_objects_hash;
284 /* Maps MonoObjects to a GSList of WeakTrackResurrection GCHandles pointing to them */
285 GHashTable *track_resurrection_objects_hash;
286 /* Maps WeakTrackResurrection GCHandles to the MonoObjects they point to */
287 GHashTable *track_resurrection_handles_hash;
289 /* Protects the three hashes above */
290 CRITICAL_SECTION finalizable_objects_hash_lock;
291 /* Used when accessing 'domain_assemblies' */
292 CRITICAL_SECTION assemblies_lock;
294 GHashTable *method_rgctx_hash;
296 GHashTable *generic_virtual_cases;
297 MonoThunkFreeList **thunk_free_lists;
299 /* Information maintained by the JIT engine */
300 gpointer runtime_info;
302 /*thread pool jobs, used to coordinate shutdown.*/
303 volatile int threadpool_jobs;
304 HANDLE cleanup_semaphore;
306 /* Contains the compiled runtime invoke wrapper used by finalizers */
307 gpointer finalize_runtime_invoke;
309 /* Contains the compiled runtime invoke wrapper used by async resylt creation to capture thread context*/
310 gpointer capture_context_runtime_invoke;
312 /* Contains the compiled method used by async resylt creation to capture thread context*/
313 gpointer capture_context_method;
315 /* Assembly bindings, the per-domain part */
316 GSList *assembly_bindings;
317 gboolean assembly_bindings_parsed;
321 guint16 major, minor, build, revision;
322 } AssemblyVersionSet;
324 /* MonoRuntimeInfo: Contains information about versions supported by this runtime */
326 const char runtime_version [12];
327 const char framework_version [4];
328 const AssemblyVersionSet version_sets [3];
331 #define mono_domain_lock(domain) mono_locks_acquire(&(domain)->lock, DomainLock)
332 #define mono_domain_unlock(domain) mono_locks_release(&(domain)->lock, DomainLock)
333 #define mono_domain_assemblies_lock(domain) mono_locks_acquire(&(domain)->assemblies_lock, DomainAssembliesLock)
334 #define mono_domain_assemblies_unlock(domain) mono_locks_release(&(domain)->assemblies_lock, DomainAssembliesLock)
335 #define mono_domain_jit_code_hash_lock(domain) mono_locks_acquire(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
336 #define mono_domain_jit_code_hash_unlock(domain) mono_locks_release(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
338 typedef MonoDomain* (*MonoLoadFunc) (const char *filename, const char *runtime_version);
341 mono_install_runtime_load (MonoLoadFunc func) MONO_INTERNAL;
344 mono_runtime_load (const char *filename, const char *runtime_version) MONO_INTERNAL;
346 typedef void (*MonoCreateDomainFunc) (MonoDomain *domain);
349 mono_install_create_domain_hook (MonoCreateDomainFunc func) MONO_INTERNAL;
351 typedef void (*MonoFreeDomainFunc) (MonoDomain *domain);
354 mono_install_free_domain_hook (MonoFreeDomainFunc func) MONO_INTERNAL;
357 mono_init_com_types (void) MONO_INTERNAL;
360 mono_cleanup (void) MONO_INTERNAL;
363 mono_close_exe_image (void) MONO_INTERNAL;
366 mono_jit_info_table_add (MonoDomain *domain, MonoJitInfo *ji) MONO_INTERNAL;
369 mono_jit_info_table_remove (MonoDomain *domain, MonoJitInfo *ji) MONO_INTERNAL;
372 mono_jit_info_add_aot_module (MonoImage *image, gpointer start, gpointer end) MONO_INTERNAL;
375 mono_jit_info_get_generic_jit_info (MonoJitInfo *ji) MONO_INTERNAL;
377 MonoGenericSharingContext*
378 mono_jit_info_get_generic_sharing_context (MonoJitInfo *ji) MONO_INTERNAL;
381 mono_jit_info_set_generic_sharing_context (MonoJitInfo *ji, MonoGenericSharingContext *gsctx) MONO_INTERNAL;
384 mono_domain_lookup_shared_generic (MonoDomain *domain, MonoMethod *method) MONO_INTERNAL;
387 mono_make_shadow_copy (const char *filename) MONO_INTERNAL;
390 mono_is_shadow_copy_enabled (MonoDomain *domain, const gchar *dir_name) MONO_INTERNAL;
393 mono_domain_alloc (MonoDomain *domain, guint size) MONO_INTERNAL;
396 mono_domain_alloc0 (MonoDomain *domain, guint size) MONO_INTERNAL;
399 mono_domain_code_reserve (MonoDomain *domain, int size) MONO_LLVM_INTERNAL;
402 mono_domain_code_reserve_align (MonoDomain *domain, int size, int alignment) MONO_INTERNAL;
405 mono_domain_code_commit (MonoDomain *domain, void *data, int size, int newsize) MONO_INTERNAL;
408 mono_domain_code_foreach (MonoDomain *domain, MonoCodeManagerFunc func, void *user_data) MONO_INTERNAL;
411 mono_domain_unset (void) MONO_INTERNAL;
414 mono_domain_set_internal_with_options (MonoDomain *domain, gboolean migrate_exception) MONO_INTERNAL;
416 MonoTryBlockHoleTableJitInfo*
417 mono_jit_info_get_try_block_hole_table_info (MonoJitInfo *ji) MONO_INTERNAL;
420 * Installs a new function which is used to return a MonoJitInfo for a method inside
423 typedef MonoJitInfo *(*MonoJitInfoFindInAot) (MonoDomain *domain, MonoImage *image, gpointer addr);
424 void mono_install_jit_info_find_in_aot (MonoJitInfoFindInAot func) MONO_INTERNAL;
427 mono_jit_code_hash_init (MonoInternalHashTable *jit_code_hash) MONO_INTERNAL;
430 ves_icall_System_AppDomain_getCurDomain (void) MONO_INTERNAL;
433 ves_icall_System_AppDomain_getRootDomain (void) MONO_INTERNAL;
436 ves_icall_System_AppDomain_createDomain (MonoString *friendly_name,
437 MonoAppDomainSetup *setup) MONO_INTERNAL;
440 ves_icall_System_AppDomain_GetData (MonoAppDomain *ad,
441 MonoString *name) MONO_INTERNAL;
443 MonoReflectionAssembly *
444 ves_icall_System_AppDomain_LoadAssemblyRaw (MonoAppDomain *ad,
445 MonoArray *raw_assembly,
446 MonoArray *raw_symbol_store,
447 MonoObject *evidence,
448 MonoBoolean refonly) MONO_INTERNAL;
451 ves_icall_System_AppDomain_SetData (MonoAppDomain *ad,
453 MonoObject *data) MONO_INTERNAL;
456 ves_icall_System_AppDomain_getSetup (MonoAppDomain *ad) MONO_INTERNAL;
459 ves_icall_System_AppDomain_getFriendlyName (MonoAppDomain *ad) MONO_INTERNAL;
462 ves_icall_System_AppDomain_GetAssemblies (MonoAppDomain *ad,
463 MonoBoolean refonly) MONO_INTERNAL;
465 MonoReflectionAssembly *
466 ves_icall_System_Reflection_Assembly_LoadFrom (MonoString *fname,
467 MonoBoolean refonly) MONO_INTERNAL;
469 MonoReflectionAssembly *
470 ves_icall_System_AppDomain_LoadAssembly (MonoAppDomain *ad,
472 MonoObject *evidence,
473 MonoBoolean refonly) MONO_INTERNAL;
476 ves_icall_System_AppDomain_InternalIsFinalizingForUnload (gint32 domain_id) MONO_INTERNAL;
479 ves_icall_System_AppDomain_InternalUnload (gint32 domain_id) MONO_INTERNAL;
482 ves_icall_System_AppDomain_ExecuteAssembly (MonoAppDomain *ad,
483 MonoReflectionAssembly *refass,
484 MonoArray *args) MONO_INTERNAL;
487 ves_icall_System_AppDomain_InternalSetDomain (MonoAppDomain *ad) MONO_INTERNAL;
490 ves_icall_System_AppDomain_InternalSetDomainByID (gint32 domainid) MONO_INTERNAL;
493 ves_icall_System_AppDomain_InternalPushDomainRef (MonoAppDomain *ad) MONO_INTERNAL;
496 ves_icall_System_AppDomain_InternalPushDomainRefByID (gint32 domain_id) MONO_INTERNAL;
499 ves_icall_System_AppDomain_InternalPopDomainRef (void) MONO_INTERNAL;
502 ves_icall_System_AppDomain_InternalGetContext (void) MONO_INTERNAL;
505 ves_icall_System_AppDomain_InternalGetDefaultContext (void) MONO_INTERNAL;
508 ves_icall_System_AppDomain_InternalSetContext (MonoAppContext *mc) MONO_INTERNAL;
511 ves_icall_System_AppDomain_GetIDFromDomain (MonoAppDomain * ad) MONO_INTERNAL;
514 ves_icall_System_AppDomain_InternalGetProcessGuid (MonoString* newguid) MONO_INTERNAL;
517 mono_assembly_load_corlib (const MonoRuntimeInfo *runtime, MonoImageOpenStatus *status) MONO_INTERNAL;
519 const MonoRuntimeInfo*
520 mono_get_runtime_info (void) MONO_INTERNAL;
523 mono_runtime_set_no_exec (gboolean val) MONO_INTERNAL;
526 mono_runtime_get_no_exec (void) MONO_INTERNAL;
529 mono_assembly_name_parse (const char *name, MonoAssemblyName *aname) MONO_INTERNAL;
531 MonoImage *mono_assembly_open_from_bundle (const char *filename,
532 MonoImageOpenStatus *status,
533 gboolean refonly) MONO_INTERNAL;
536 mono_domain_add_class_static_data (MonoDomain *domain, MonoClass *klass, gpointer data, guint32 *bitmap);
538 MonoReflectionAssembly *
539 mono_try_assembly_resolve (MonoDomain *domain, MonoString *fname, gboolean refonly) MONO_INTERNAL;
541 MonoAssembly* mono_assembly_load_full_nosearch (MonoAssemblyName *aname,
543 MonoImageOpenStatus *status,
544 gboolean refonly) MONO_INTERNAL;
546 void mono_set_private_bin_path_from_config (MonoDomain *domain) MONO_INTERNAL;
548 int mono_framework_version (void) MONO_INTERNAL;
550 void mono_reflection_cleanup_domain (MonoDomain *domain) MONO_INTERNAL;
552 #endif /* __MONO_METADATA_DOMAIN_INTERNALS_H__ */