3 * Appdomain-related internal data structures and functions.
4 * Copyright 2012 Xamarin Inc (http://www.xamarin.com)
5 * Licensed under the MIT license. See LICENSE file in the project root for full license information.
7 #ifndef __MONO_METADATA_DOMAIN_INTERNALS_H__
8 #define __MONO_METADATA_DOMAIN_INTERNALS_H__
10 #include <mono/metadata/appdomain.h>
11 #include <mono/metadata/mempool.h>
12 #include <mono/metadata/lock-tracer.h>
13 #include <mono/utils/mono-codeman.h>
14 #include <mono/metadata/mono-hash.h>
15 #include <mono/utils/mono-compiler.h>
16 #include <mono/utils/mono-internal-hash.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 *next_tombstone;
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 * For LLVM compiled code, this is the index of the il clause
87 * associated with this handler.
92 uint32_t handler_offset;
95 MonoClass *catch_class;
99 } MonoJitExceptionInfo;
102 * Contains information about the type arguments for generic shared methods.
105 gboolean is_gsharedvt;
106 } MonoGenericSharingContext;
108 /* Simplified DWARF location list entry */
110 /* Whenever the value is in a register */
113 * If is_reg is TRUE, the register which contains the value. Otherwise
118 * If is_reg is FALSE, the offset of the stack location relative to 'reg'.
123 * Offsets of the PC interval where the value is in this location.
126 } MonoDwarfLocListEntry;
130 MonoGenericSharingContext *generic_sharing_context;
132 MonoDwarfLocListEntry *locations;
136 gboolean this_in_reg:1;
137 } MonoGenericJitInfo;
140 A try block hole is used to represent a non-contiguous part of
141 of a segment of native code protected by a given .try block.
142 Usually, a try block is defined as a contiguous segment of code.
143 But in some cases it's needed to have some parts of it to not be protected.
144 For example, given "try {} finally {}", the code in the .try block to call
145 the finally part looks like:
151 jump outside try block
157 The instructions between the call and the jump should not be under the try block since they happen
158 after the finally block executes, which means if an async exceptions happens at that point we would
159 execute the finally clause twice. So, to avoid this, we introduce a hole in the try block to signal
160 that those instructions are not protected.
167 } MonoTryBlockHoleJitInfo;
172 MonoTryBlockHoleJitInfo holes [MONO_ZERO_LEN_ARRAY];
173 } MonoTryBlockHoleTableJitInfo;
182 /* Relative to code_start */
189 JIT_INFO_HAS_GENERIC_JIT_INFO = (1 << 0),
190 JIT_INFO_HAS_TRY_BLOCK_HOLES = (1 << 1),
191 JIT_INFO_HAS_ARCH_EH_INFO = (1 << 2),
192 JIT_INFO_HAS_THUNK_INFO = (1 << 3)
195 struct _MonoJitInfo {
196 /* NOTE: These first two elements (method and
197 next_jit_code_hash) must be in the same order and at the
198 same offset as in RuntimeMethod, because of the jit_code_hash
199 internal hash table in MonoDomain. */
207 struct _MonoJitInfo *next_jit_code_hash;
208 struct _MonoJitInfo *next_tombstone;
213 guint32 num_clauses:15;
214 /* Whenever the code is domain neutral or 'shared' */
215 gboolean domain_neutral:1;
216 gboolean has_generic_jit_info:1;
217 gboolean has_try_block_holes:1;
218 gboolean has_arch_eh_info:1;
219 gboolean has_thunk_info:1;
221 gboolean from_llvm:1;
222 gboolean dbg_attrs_inited:1;
223 gboolean dbg_hidden:1;
224 /* Whenever this jit info was loaded in async context */
226 gboolean dbg_step_through:1;
227 gboolean dbg_non_user_code:1;
229 * Whenever this jit info refers to a trampoline.
230 * d.tramp_info contains additional data in this case.
232 gboolean is_trampoline:1;
234 /* FIXME: Embed this after the structure later*/
235 gpointer gc_info; /* Currently only used by SGen */
237 MonoJitExceptionInfo clauses [MONO_ZERO_LEN_ARRAY];
238 /* There is an optional MonoGenericJitInfo after the clauses */
239 /* There is an optional MonoTryBlockHoleTableJitInfo after MonoGenericJitInfo clauses*/
240 /* There is an optional MonoArchEHJitInfo after MonoTryBlockHoleTableJitInfo */
241 /* There is an optional MonoThunkJitInfo after MonoArchEHJitInfo */
244 #define MONO_SIZEOF_JIT_INFO (offsetof (struct _MonoJitInfo, clauses))
247 gpointer *static_data; /* Used to free the static data without going through the MonoAppContext object itself. */
251 struct _MonoAppContext {
255 gpointer *static_data;
256 ContextStaticData *data;
259 /* Lock-free allocator */
264 } LockFreeMempoolChunk;
267 LockFreeMempoolChunk *current, *chunks;
271 * We have two unloading states because the domain
272 * must remain fully functional while AppDomain::DomainUnload is
274 * After that unloading began and all domain facilities are teared down
275 * such as execution of new threadpool jobs.
278 MONO_APPDOMAIN_CREATED,
279 MONO_APPDOMAIN_UNLOADING_START,
280 MONO_APPDOMAIN_UNLOADING,
281 MONO_APPDOMAIN_UNLOADED
282 } MonoAppDomainState;
284 typedef struct _MonoThunkFreeList {
286 int length; /* only valid for the wait list */
287 struct _MonoThunkFreeList *next;
290 typedef struct _MonoJitCodeHash MonoJitCodeHash;
294 * This lock must never be taken before the loader lock,
295 * i.e. if both are taken by the same thread, the loader lock
300 MonoCodeManager *code_mp;
302 * keep all the managed objects close to each other for the precise GC
303 * For the Boehm GC we additionally keep close also other GC-tracked pointers.
305 #define MONO_DOMAIN_FIRST_OBJECT setup
306 MonoAppDomainSetup *setup;
307 MonoAppDomain *domain;
308 MonoAppContext *default_context;
309 MonoException *out_of_memory_ex;
310 MonoException *null_reference_ex;
311 MonoException *stack_overflow_ex;
313 MonoObject *typeof_void;
314 /* Ephemeron Tombstone*/
315 MonoObject *ephemeron_tombstone;
316 /* new MonoType [0] */
317 MonoArray *empty_types;
318 MonoString *empty_string;
320 * The fields between FIRST_GC_TRACKED and LAST_GC_TRACKED are roots, but
321 * not object references.
323 #define MONO_DOMAIN_FIRST_GC_TRACKED env
325 MonoGHashTable *ldstr_table;
326 /* hashtables for Reflection handles */
327 MonoGHashTable *type_hash;
328 MonoGHashTable *refobject_hash;
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 GSList *domain_assemblies;
339 MonoAssembly *entry_assembly;
341 GPtrArray *class_vtable_array;
342 /* maps remote class key -> MonoRemoteClass */
343 GHashTable *proxy_vtable_hash;
344 /* Protected by 'jit_code_hash_lock' */
345 MonoInternalHashTable jit_code_hash;
346 mono_mutex_t jit_code_hash_lock;
347 int num_jit_info_tables;
349 volatile jit_info_table;
351 * Contains information about AOT loaded code.
352 * Only used in the root domain.
355 volatile aot_modules;
356 GSList *jit_info_free_queue;
357 /* Used when loading assemblies */
359 gchar *private_bin_path;
360 LockFreeMempool *lock_free_mp;
362 /* Used by remoting proxies */
363 MonoMethod *create_proxy_for_type_method;
364 MonoMethod *private_invoke_method;
365 /* Used to store offsets of thread and context static fields */
366 GHashTable *special_static_fields;
368 * This must be a GHashTable, since these objects can't be finalized
369 * if the hashtable contains a GC visible reference to them.
371 GHashTable *finalizable_objects_hash;
373 /* Protects the three hashes above */
374 mono_mutex_t finalizable_objects_hash_lock;
375 /* Used when accessing 'domain_assemblies' */
376 mono_mutex_t assemblies_lock;
378 GHashTable *method_rgctx_hash;
380 GHashTable *generic_virtual_cases;
382 /* Information maintained by the JIT engine */
383 gpointer runtime_info;
385 /* Contains the compiled runtime invoke wrapper used by finalizers */
386 gpointer finalize_runtime_invoke;
388 /* Contains the compiled runtime invoke wrapper used by async resylt creation to capture thread context*/
389 gpointer capture_context_runtime_invoke;
391 /* Contains the compiled method used by async resylt creation to capture thread context*/
392 gpointer capture_context_method;
394 /* Assembly bindings, the per-domain part */
395 GSList *assembly_bindings;
396 gboolean assembly_bindings_parsed;
398 /* Used by socket-io.c */
399 /* These are domain specific, since the assembly can be unloaded */
400 MonoImage *socket_assembly;
401 MonoClass *sockaddr_class;
402 MonoClassField *sockaddr_data_field;
403 MonoClassField *sockaddr_data_length_field;
405 /* Cache function pointers for architectures */
406 /* that require wrappers */
407 GHashTable *ftnptrs_hash;
409 /* Maps MonoMethod* to weak links to DynamicMethod objects */
410 GHashTable *method_to_dyn_method;
412 /* <ThrowUnobservedTaskExceptions /> support */
413 gboolean throw_unobserved_task_exceptions;
415 guint32 execution_context_field_offset;
419 guint16 major, minor, build, revision;
420 } AssemblyVersionSet;
422 /* MonoRuntimeInfo: Contains information about versions supported by this runtime */
424 const char runtime_version [12];
425 const char framework_version [4];
426 const AssemblyVersionSet version_sets [5];
429 #define mono_domain_assemblies_lock(domain) mono_locks_os_acquire(&(domain)->assemblies_lock, DomainAssembliesLock)
430 #define mono_domain_assemblies_unlock(domain) mono_locks_os_release(&(domain)->assemblies_lock, DomainAssembliesLock)
431 #define mono_domain_jit_code_hash_lock(domain) mono_locks_os_acquire(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
432 #define mono_domain_jit_code_hash_unlock(domain) mono_locks_os_release(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
434 typedef MonoDomain* (*MonoLoadFunc) (const char *filename, const char *runtime_version);
436 void mono_domain_lock (MonoDomain *domain) MONO_LLVM_INTERNAL;
437 void mono_domain_unlock (MonoDomain *domain) MONO_LLVM_INTERNAL;
440 mono_install_runtime_load (MonoLoadFunc func);
443 mono_runtime_load (const char *filename, const char *runtime_version);
445 typedef void (*MonoCreateDomainFunc) (MonoDomain *domain);
448 mono_install_create_domain_hook (MonoCreateDomainFunc func);
450 typedef void (*MonoFreeDomainFunc) (MonoDomain *domain);
453 mono_install_free_domain_hook (MonoFreeDomainFunc func);
459 mono_close_exe_image (void);
462 mono_jit_info_size (MonoJitInfoFlags flags, int num_clauses, int num_holes);
465 mono_jit_info_init (MonoJitInfo *ji, MonoMethod *method, guint8 *code, int code_size,
466 MonoJitInfoFlags flags, int num_clauses, int num_holes);
469 mono_jit_info_table_new (MonoDomain *domain);
472 mono_jit_info_table_free (MonoJitInfoTable *table);
475 mono_jit_info_table_add (MonoDomain *domain, MonoJitInfo *ji);
478 mono_jit_info_table_remove (MonoDomain *domain, MonoJitInfo *ji);
481 mono_jit_info_add_aot_module (MonoImage *image, gpointer start, gpointer end);
484 mono_jit_info_get_generic_jit_info (MonoJitInfo *ji);
486 MonoGenericSharingContext*
487 mono_jit_info_get_generic_sharing_context (MonoJitInfo *ji);
490 mono_jit_info_set_generic_sharing_context (MonoJitInfo *ji, MonoGenericSharingContext *gsctx);
493 mono_make_shadow_copy (const char *filename, MonoError *error);
496 mono_is_shadow_copy_enabled (MonoDomain *domain, const gchar *dir_name);
499 mono_domain_alloc (MonoDomain *domain, guint size);
502 mono_domain_alloc0 (MonoDomain *domain, guint size);
505 mono_domain_alloc0_lock_free (MonoDomain *domain, guint size);
508 mono_domain_code_reserve (MonoDomain *domain, int size) MONO_LLVM_INTERNAL;
511 mono_domain_code_reserve_align (MonoDomain *domain, int size, int alignment);
514 mono_domain_code_commit (MonoDomain *domain, void *data, int size, int newsize);
517 mono_domain_code_foreach (MonoDomain *domain, MonoCodeManagerFunc func, void *user_data);
520 mono_domain_unset (void);
523 mono_domain_set_internal_with_options (MonoDomain *domain, gboolean migrate_exception);
525 MonoTryBlockHoleTableJitInfo*
526 mono_jit_info_get_try_block_hole_table_info (MonoJitInfo *ji);
529 mono_jit_info_get_arch_eh_info (MonoJitInfo *ji);
532 mono_jit_info_get_thunk_info (MonoJitInfo *ji);
535 * Installs a new function which is used to return a MonoJitInfo for a method inside
538 typedef MonoJitInfo *(*MonoJitInfoFindInAot) (MonoDomain *domain, MonoImage *image, gpointer addr);
539 void mono_install_jit_info_find_in_aot (MonoJitInfoFindInAot func);
542 mono_jit_code_hash_init (MonoInternalHashTable *jit_code_hash);
545 mono_assembly_load_corlib (const MonoRuntimeInfo *runtime, MonoImageOpenStatus *status);
547 const MonoRuntimeInfo*
548 mono_get_runtime_info (void);
551 mono_runtime_set_no_exec (gboolean val);
554 mono_runtime_get_no_exec (void);
557 mono_assembly_name_parse (const char *name, MonoAssemblyName *aname);
559 MonoImage *mono_assembly_open_from_bundle (const char *filename,
560 MonoImageOpenStatus *status,
564 mono_try_assembly_resolve (MonoDomain *domain, const char *fname, MonoAssembly *requesting, gboolean refonly, MonoError *error);
567 mono_domain_assembly_postload_search (MonoAssemblyName *aname, MonoAssembly *requesting, gboolean refonly);
569 MonoAssembly* mono_assembly_load_full_nosearch (MonoAssemblyName *aname,
571 MonoImageOpenStatus *status,
574 void mono_domain_set_options_from_config (MonoDomain *domain);
576 int mono_framework_version (void);
578 void mono_reflection_cleanup_domain (MonoDomain *domain);
580 void mono_assembly_cleanup_domain_bindings (guint32 domain_id);
582 MonoJitInfo* mono_jit_info_table_find_internal (MonoDomain *domain, char *addr, gboolean try_aot, gboolean allow_trampolines);
584 void mono_enable_debug_domain_unload (gboolean enable);
586 MonoReflectionAssembly *
587 mono_domain_try_type_resolve_checked (MonoDomain *domain, char *name, MonoObject *tb, MonoError *error);
590 mono_runtime_init_checked (MonoDomain *domain, MonoThreadStartCB start_cb, MonoThreadAttachCB attach_cb, MonoError *error);
593 mono_context_init_checked (MonoDomain *domain, MonoError *error);
596 mono_assembly_has_reference_assembly_attribute (MonoAssembly *assembly, MonoError *error);
599 mono_domain_get_assemblies (MonoDomain *domain, gboolean refonly);
601 #endif /* __MONO_METADATA_DOMAIN_INTERNALS_H__ */