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/metadata/mono-conc-hash.h>
16 #include <mono/utils/mono-compiler.h>
17 #include <mono/utils/mono-internal-hash.h>
18 #include <mono/metadata/mempool-internals.h>
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 *next_tombstone;
66 MonoJitInfo * volatile data [MONO_JIT_INFO_TABLE_CHUNK_SIZE];
69 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.
94 uint32_t handler_offset;
97 MonoClass *catch_class;
101 } MonoJitExceptionInfo;
104 * Contains information about the type arguments for generic shared methods.
107 gboolean is_gsharedvt;
108 } MonoGenericSharingContext;
110 /* Simplified DWARF location list entry */
112 /* Whenever the value is in a register */
115 * If is_reg is TRUE, the register which contains the value. Otherwise
120 * If is_reg is FALSE, the offset of the stack location relative to 'reg'.
125 * Offsets of the PC interval where the value is in this location.
128 } MonoDwarfLocListEntry;
132 MonoGenericSharingContext *generic_sharing_context;
134 MonoDwarfLocListEntry *locations;
138 gboolean this_in_reg:1;
139 } MonoGenericJitInfo;
142 A try block hole is used to represent a non-contiguous part of
143 of a segment of native code protected by a given .try block.
144 Usually, a try block is defined as a contiguous segment of code.
145 But in some cases it's needed to have some parts of it to not be protected.
146 For example, given "try {} finally {}", the code in the .try block to call
147 the finally part looks like:
153 jump outside try block
159 The instructions between the call and the jump should not be under the try block since they happen
160 after the finally block executes, which means if an async exceptions happens at that point we would
161 execute the finally clause twice. So, to avoid this, we introduce a hole in the try block to signal
162 that those instructions are not protected.
169 } MonoTryBlockHoleJitInfo;
174 MonoTryBlockHoleJitInfo holes [MONO_ZERO_LEN_ARRAY];
175 } MonoTryBlockHoleTableJitInfo;
184 /* Relative to code_start */
196 JIT_INFO_HAS_GENERIC_JIT_INFO = (1 << 0),
197 JIT_INFO_HAS_TRY_BLOCK_HOLES = (1 << 1),
198 JIT_INFO_HAS_ARCH_EH_INFO = (1 << 2),
199 JIT_INFO_HAS_THUNK_INFO = (1 << 3),
201 * If this is set, the unwind info is stored in the structure, instead of being pointed to by the
202 * 'unwind_info' field.
204 JIT_INFO_HAS_UNWIND_INFO = (1 << 4)
207 struct _MonoJitInfo {
208 /* NOTE: These first two elements (method and
209 next_jit_code_hash) must be in the same order and at the
210 same offset as in RuntimeMethod, because of the jit_code_hash
211 internal hash table in MonoDomain. */
219 struct _MonoJitInfo *next_jit_code_hash;
220 struct _MonoJitInfo *next_tombstone;
225 guint32 num_clauses:15;
226 /* Whenever the code is domain neutral or 'shared' */
227 gboolean domain_neutral:1;
228 gboolean has_generic_jit_info:1;
229 gboolean has_try_block_holes:1;
230 gboolean has_arch_eh_info:1;
231 gboolean has_thunk_info:1;
232 gboolean has_unwind_info:1;
234 gboolean from_llvm:1;
235 gboolean dbg_attrs_inited:1;
236 gboolean dbg_hidden:1;
237 /* Whenever this jit info was loaded in async context */
239 gboolean dbg_step_through:1;
240 gboolean dbg_non_user_code:1;
242 * Whenever this jit info refers to a trampoline.
243 * d.tramp_info contains additional data in this case.
245 gboolean is_trampoline:1;
246 /* Whenever this jit info refers to an interpreter method */
247 gboolean is_interp:1;
249 /* FIXME: Embed this after the structure later*/
250 gpointer gc_info; /* Currently only used by SGen */
252 MonoJitExceptionInfo clauses [MONO_ZERO_LEN_ARRAY];
253 /* There is an optional MonoGenericJitInfo after the clauses */
254 /* There is an optional MonoTryBlockHoleTableJitInfo after MonoGenericJitInfo clauses*/
255 /* There is an optional MonoArchEHJitInfo after MonoTryBlockHoleTableJitInfo */
256 /* There is an optional MonoThunkJitInfo after MonoArchEHJitInfo */
259 #define MONO_SIZEOF_JIT_INFO (offsetof (struct _MonoJitInfo, clauses))
262 gpointer *static_data; /* Used to free the static data without going through the MonoAppContext object itself. */
266 struct _MonoAppContext {
270 gpointer *static_data;
271 ContextStaticData *data;
274 /* Lock-free allocator */
279 } LockFreeMempoolChunk;
282 LockFreeMempoolChunk *current, *chunks;
286 * We have two unloading states because the domain
287 * must remain fully functional while AppDomain::DomainUnload is
289 * After that unloading began and all domain facilities are teared down
290 * such as execution of new threadpool jobs.
293 MONO_APPDOMAIN_CREATED,
294 MONO_APPDOMAIN_UNLOADING_START,
295 MONO_APPDOMAIN_UNLOADING,
296 MONO_APPDOMAIN_UNLOADED
297 } MonoAppDomainState;
299 typedef struct _MonoThunkFreeList {
301 int length; /* only valid for the wait list */
302 struct _MonoThunkFreeList *next;
305 typedef struct _MonoJitCodeHash MonoJitCodeHash;
309 * This lock must never be taken before the loader lock,
310 * i.e. if both are taken by the same thread, the loader lock
315 MonoCodeManager *code_mp;
317 * keep all the managed objects close to each other for the precise GC
318 * For the Boehm GC we additionally keep close also other GC-tracked pointers.
320 #define MONO_DOMAIN_FIRST_OBJECT setup
321 MonoAppDomainSetup *setup;
322 MonoAppDomain *domain;
323 MonoAppContext *default_context;
324 MonoException *out_of_memory_ex;
325 MonoException *null_reference_ex;
326 MonoException *stack_overflow_ex;
328 MonoObject *typeof_void;
329 /* Ephemeron Tombstone*/
330 MonoObject *ephemeron_tombstone;
331 /* new MonoType [0] */
332 MonoArray *empty_types;
333 MonoString *empty_string;
335 * The fields between FIRST_GC_TRACKED and LAST_GC_TRACKED are roots, but
336 * not object references.
338 #define MONO_DOMAIN_FIRST_GC_TRACKED env
340 MonoGHashTable *ldstr_table;
341 /* hashtables for Reflection handles */
342 MonoGHashTable *type_hash;
343 MonoConcGHashTable *refobject_hash;
344 /* maps class -> type initialization exception object */
345 MonoGHashTable *type_init_exception_hash;
346 /* maps delegate trampoline addr -> delegate object */
347 MonoGHashTable *delegate_hash_table;
348 #define MONO_DOMAIN_LAST_GC_TRACKED delegate_hash_table
350 /* Needed by Thread:GetDomainID() */
352 gint32 shadow_serial;
353 GSList *domain_assemblies;
354 MonoAssembly *entry_assembly;
356 GPtrArray *class_vtable_array;
357 /* maps remote class key -> MonoRemoteClass */
358 GHashTable *proxy_vtable_hash;
359 /* Protected by 'jit_code_hash_lock' */
360 MonoInternalHashTable jit_code_hash;
361 mono_mutex_t jit_code_hash_lock;
362 int num_jit_info_tables;
364 volatile jit_info_table;
366 * Contains information about AOT loaded code.
367 * Only used in the root domain.
370 volatile aot_modules;
371 GSList *jit_info_free_queue;
372 /* Used when loading assemblies */
374 gchar *private_bin_path;
375 LockFreeMempool *lock_free_mp;
377 /* Used by remoting proxies */
378 MonoMethod *create_proxy_for_type_method;
379 MonoMethod *private_invoke_method;
380 /* Used to store offsets of thread and context static fields */
381 GHashTable *special_static_fields;
383 * This must be a GHashTable, since these objects can't be finalized
384 * if the hashtable contains a GC visible reference to them.
386 GHashTable *finalizable_objects_hash;
388 /* Protects the three hashes above */
389 mono_mutex_t finalizable_objects_hash_lock;
390 /* Used when accessing 'domain_assemblies' */
391 mono_mutex_t assemblies_lock;
393 GHashTable *method_rgctx_hash;
395 GHashTable *generic_virtual_cases;
397 /* Information maintained by the JIT engine */
398 gpointer runtime_info;
400 /* Contains the compiled runtime invoke wrapper used by finalizers */
401 gpointer finalize_runtime_invoke;
403 /* Contains the compiled runtime invoke wrapper used by async resylt creation to capture thread context*/
404 gpointer capture_context_runtime_invoke;
406 /* Contains the compiled method used by async resylt creation to capture thread context*/
407 gpointer capture_context_method;
409 /* Assembly bindings, the per-domain part */
410 GSList *assembly_bindings;
411 gboolean assembly_bindings_parsed;
413 /* Used by socket-io.c */
414 /* These are domain specific, since the assembly can be unloaded */
415 MonoImage *socket_assembly;
416 MonoClass *sockaddr_class;
417 MonoClassField *sockaddr_data_field;
418 MonoClassField *sockaddr_data_length_field;
420 /* Cache function pointers for architectures */
421 /* that require wrappers */
422 GHashTable *ftnptrs_hash;
424 /* Maps MonoMethod* to weak links to DynamicMethod objects */
425 GHashTable *method_to_dyn_method;
427 /* <ThrowUnobservedTaskExceptions /> support */
428 gboolean throw_unobserved_task_exceptions;
430 guint32 execution_context_field_offset;
434 guint16 major, minor, build, revision;
435 } AssemblyVersionSet;
437 /* MonoRuntimeInfo: Contains information about versions supported by this runtime */
439 const char runtime_version [12];
440 const char framework_version [4];
441 const AssemblyVersionSet version_sets [5];
444 #define mono_domain_assemblies_lock(domain) mono_locks_os_acquire(&(domain)->assemblies_lock, DomainAssembliesLock)
445 #define mono_domain_assemblies_unlock(domain) mono_locks_os_release(&(domain)->assemblies_lock, DomainAssembliesLock)
446 #define mono_domain_jit_code_hash_lock(domain) mono_locks_os_acquire(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
447 #define mono_domain_jit_code_hash_unlock(domain) mono_locks_os_release(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
449 typedef MonoDomain* (*MonoLoadFunc) (const char *filename, const char *runtime_version);
451 void mono_domain_lock (MonoDomain *domain) MONO_LLVM_INTERNAL;
452 void mono_domain_unlock (MonoDomain *domain) MONO_LLVM_INTERNAL;
455 mono_install_runtime_load (MonoLoadFunc func);
458 mono_runtime_load (const char *filename, const char *runtime_version);
460 typedef void (*MonoCreateDomainFunc) (MonoDomain *domain);
463 mono_install_create_domain_hook (MonoCreateDomainFunc func);
465 typedef void (*MonoFreeDomainFunc) (MonoDomain *domain);
468 mono_install_free_domain_hook (MonoFreeDomainFunc func);
474 mono_close_exe_image (void);
477 mono_jit_info_size (MonoJitInfoFlags flags, int num_clauses, int num_holes);
480 mono_jit_info_init (MonoJitInfo *ji, MonoMethod *method, guint8 *code, int code_size,
481 MonoJitInfoFlags flags, int num_clauses, int num_holes);
484 mono_jit_info_table_new (MonoDomain *domain);
487 mono_jit_info_table_free (MonoJitInfoTable *table);
490 mono_jit_info_table_add (MonoDomain *domain, MonoJitInfo *ji);
493 mono_jit_info_table_remove (MonoDomain *domain, MonoJitInfo *ji);
496 mono_jit_info_add_aot_module (MonoImage *image, gpointer start, gpointer end);
499 mono_jit_info_get_generic_jit_info (MonoJitInfo *ji);
501 MonoGenericSharingContext*
502 mono_jit_info_get_generic_sharing_context (MonoJitInfo *ji);
505 mono_jit_info_set_generic_sharing_context (MonoJitInfo *ji, MonoGenericSharingContext *gsctx);
508 mono_make_shadow_copy (const char *filename, MonoError *error);
511 mono_is_shadow_copy_enabled (MonoDomain *domain, const gchar *dir_name);
514 mono_domain_alloc (MonoDomain *domain, guint size);
517 mono_domain_alloc0 (MonoDomain *domain, guint size);
520 mono_domain_alloc0_lock_free (MonoDomain *domain, guint size);
523 mono_domain_code_reserve (MonoDomain *domain, int size) MONO_LLVM_INTERNAL;
526 mono_domain_code_reserve_align (MonoDomain *domain, int size, int alignment);
529 mono_domain_code_commit (MonoDomain *domain, void *data, int size, int newsize);
532 mono_domain_code_foreach (MonoDomain *domain, MonoCodeManagerFunc func, void *user_data);
535 mono_domain_unset (void);
538 mono_domain_set_internal_with_options (MonoDomain *domain, gboolean migrate_exception);
541 mono_domain_set_config_checked (MonoDomain *domain, const char *base_dir, const char *config_file_name, MonoError *error);
543 MonoTryBlockHoleTableJitInfo*
544 mono_jit_info_get_try_block_hole_table_info (MonoJitInfo *ji);
547 mono_jit_info_get_arch_eh_info (MonoJitInfo *ji);
550 mono_jit_info_get_thunk_info (MonoJitInfo *ji);
553 mono_jit_info_get_unwind_info (MonoJitInfo *ji);
556 * Installs a new function which is used to return a MonoJitInfo for a method inside
559 typedef MonoJitInfo *(*MonoJitInfoFindInAot) (MonoDomain *domain, MonoImage *image, gpointer addr);
560 void mono_install_jit_info_find_in_aot (MonoJitInfoFindInAot func);
563 mono_jit_code_hash_init (MonoInternalHashTable *jit_code_hash);
566 mono_assembly_load_corlib (const MonoRuntimeInfo *runtime, MonoImageOpenStatus *status);
568 const MonoRuntimeInfo*
569 mono_get_runtime_info (void);
572 mono_runtime_set_no_exec (gboolean val);
575 mono_runtime_get_no_exec (void);
578 mono_domain_parse_assembly_bindings (MonoDomain *domain, int amajor, int aminor, gchar *domain_config_file_name);
581 mono_assembly_name_parse (const char *name, MonoAssemblyName *aname);
583 MonoImage *mono_assembly_open_from_bundle (const char *filename,
584 MonoImageOpenStatus *status,
588 mono_try_assembly_resolve (MonoDomain *domain, const char *fname, MonoAssembly *requesting, gboolean refonly, MonoError *error);
591 mono_domain_assembly_postload_search (MonoAssemblyName *aname, MonoAssembly *requesting, gboolean refonly);
593 MonoAssembly* mono_assembly_load_full_nosearch (MonoAssemblyName *aname,
595 MonoImageOpenStatus *status,
598 void mono_domain_set_options_from_config (MonoDomain *domain);
600 int mono_framework_version (void);
602 void mono_reflection_cleanup_domain (MonoDomain *domain);
604 void mono_assembly_cleanup_domain_bindings (guint32 domain_id);
606 MonoJitInfo* mono_jit_info_table_find_internal (MonoDomain *domain, char *addr, gboolean try_aot, gboolean allow_trampolines);
608 void mono_enable_debug_domain_unload (gboolean enable);
610 MonoReflectionAssembly *
611 mono_domain_try_type_resolve_checked (MonoDomain *domain, char *name, MonoObject *tb, MonoError *error);
614 mono_runtime_init_checked (MonoDomain *domain, MonoThreadStartCB start_cb, MonoThreadAttachCB attach_cb, MonoError *error);
617 mono_context_init_checked (MonoDomain *domain, MonoError *error);
620 mono_assembly_has_reference_assembly_attribute (MonoAssembly *assembly, MonoError *error);
623 mono_domain_get_assemblies (MonoDomain *domain, gboolean refonly);
625 #endif /* __MONO_METADATA_DOMAIN_INTERNALS_H__ */