mono/metadata/domain-internals.h

   1 /*
   2  * Appdomain-related internal data structures and functions.
   3  */
   4 #ifndef __MONO_METADATA_DOMAIN_INTERNALS_H__
   5 #define __MONO_METADATA_DOMAIN_INTERNALS_H__
   6
   7 #include <mono/metadata/appdomain.h>
   8 #include <mono/metadata/lock-tracer.h>
   9 #include <mono/utils/mono-codeman.h>
  10 #include <mono/utils/mono-hash.h>
  11 #include <mono/utils/mono-compiler.h>
  12 #include <mono/utils/mono-internal-hash.h>
  13 #include <mono/io-layer/io-layer.h>
  14
  15 extern CRITICAL_SECTION mono_delegate_section;
  16 extern CRITICAL_SECTION mono_strtod_mutex;
  17
  18 /*
  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
  22  * performance.
  23  */
  24 extern gboolean mono_dont_free_domains;
  25
  26 /* This is a copy of System.AppDomainSetup */
  27 typedef struct {
  28         MonoObject object;
  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         MonoArray *domain_initializer_args;
  47         MonoObject *application_trust; /* it is System.Object in 1.x, ApplicationTrust in 2.0 */
  48         MonoBoolean disallow_appbase_probe;
  49         MonoArray *configuration_bytes;
  50 } MonoAppDomainSetup;
  51
  52 typedef struct _MonoJitInfoTable MonoJitInfoTable;
  53 typedef struct _MonoJitInfoTableChunk MonoJitInfoTableChunk;
  54
  55 #define MONO_JIT_INFO_TABLE_CHUNK_SIZE          64
  56
  57 struct _MonoJitInfoTableChunk
  58 {
  59         int                    refcount;
  60         volatile int           num_elements;
  61         volatile gint8        *last_code_end;
  62         MonoJitInfo * volatile data [MONO_JIT_INFO_TABLE_CHUNK_SIZE];
  63 };
  64
  65 struct _MonoJitInfoTable
  66 {
  67         MonoDomain             *domain;
  68         int                     num_chunks;
  69         MonoJitInfoTableChunk  *chunks [MONO_ZERO_LEN_ARRAY];
  70 };
  71
  72 #define MONO_SIZEOF_JIT_INFO_TABLE (sizeof (struct _MonoJitInfoTable) - MONO_ZERO_LEN_ARRAY * SIZEOF_VOID_P)
  73
  74 typedef GArray MonoAotModuleInfoTable;
  75
  76 typedef struct {
  77         guint32  flags;
  78         gint32   exvar_offset;
  79         gpointer try_start;
  80         gpointer try_end;
  81         gpointer handler_start;
  82         union {
  83                 MonoClass *catch_class;
  84                 gpointer filter;
  85         } data;
  86 } MonoJitExceptionInfo;
  87
  88 /*
  89  * Will contain information on the generic type arguments in the
  90  * future.  For now, all arguments are always reference types.
  91  */
  92 typedef struct {
  93         int dummy;
  94 } MonoGenericSharingContext;
  95
  96 typedef struct
  97 {
  98         MonoGenericSharingContext *generic_sharing_context;
  99         gint32 this_offset;
 100         guint8 this_reg;
 101         gboolean has_this:1;
 102         gboolean this_in_reg:1;
 103 } MonoGenericJitInfo;
 104
 105 struct _MonoJitInfo {
 106         /* NOTE: These first two elements (method and
 107            next_jit_code_hash) must be in the same order and at the
 108            same offset as in RuntimeMethod, because of the jit_code_hash
 109            internal hash table in MonoDomain. */
 110         MonoMethod *method;
 111         struct _MonoJitInfo *next_jit_code_hash;
 112         gpointer    code_start;
 113         /* This might contain an id for the unwind info instead of a register mask */
 114         guint32     used_regs;
 115         int         code_size;
 116         guint32     num_clauses:15;
 117         /* Whenever the code is domain neutral or 'shared' */
 118         gboolean    domain_neutral:1;
 119         gboolean    cas_inited:1;
 120         gboolean    cas_class_assert:1;
 121         gboolean    cas_class_deny:1;
 122         gboolean    cas_class_permitonly:1;
 123         gboolean    cas_method_assert:1;
 124         gboolean    cas_method_deny:1;
 125         gboolean    cas_method_permitonly:1;
 126         gboolean    has_generic_jit_info:1;
 127         gboolean    from_aot:1;
 128         gboolean    from_llvm:1;
 129 #ifdef HAVE_SGEN_GC
 130         /* FIXME: Embed this after the structure later */
 131         gpointer    gc_info;
 132 #endif
 133         MonoJitExceptionInfo clauses [MONO_ZERO_LEN_ARRAY];
 134         /* There is an optional MonoGenericJitInfo after the clauses */
 135 };
 136
 137 #define MONO_SIZEOF_JIT_INFO (offsetof (struct _MonoJitInfo, clauses))
 138
 139 struct _MonoAppContext {
 140         MonoObject obj;
 141         gint32 domain_id;
 142         gint32 context_id;
 143         gpointer *static_data;
 144 };
 145
 146 /*
 147  * We have two unloading states because the domain
 148  * must remain fully functional while AppDomain::DomainUnload is
 149  * processed.
 150  * After that unloading began and all domain facilities are teared down
 151  * such as execution of new threadpool jobs.
 152  */
 153 typedef enum {
 154         MONO_APPDOMAIN_CREATED,
 155         MONO_APPDOMAIN_UNLOADING_START,
 156         MONO_APPDOMAIN_UNLOADING,
 157         MONO_APPDOMAIN_UNLOADED
 158 } MonoAppDomainState;
 159
 160 typedef struct _MonoThunkFreeList {
 161         guint32 size;
 162         int length;             /* only valid for the wait list */
 163         struct _MonoThunkFreeList *next;
 164 } MonoThunkFreeList;
 165
 166 typedef struct _MonoJitCodeHash MonoJitCodeHash;
 167
 168 struct _MonoDomain {
 169         /*
 170          * This lock must never be taken before the loader lock,
 171          * i.e. if both are taken by the same thread, the loader lock
 172          * must taken first.
 173          */
 174         CRITICAL_SECTION    lock;
 175         MonoMemPool        *mp;
 176         MonoCodeManager    *code_mp;
 177         /*
 178          * keep all the managed objects close to each other for the precise GC
 179          * For the Boehm GC we additionally keep close also other GC-tracked pointers.
 180          */
 181 #define MONO_DOMAIN_FIRST_OBJECT setup
 182         MonoAppDomainSetup *setup;
 183         MonoAppDomain      *domain;
 184         MonoAppContext     *default_context;
 185         MonoException      *out_of_memory_ex;
 186         MonoException      *null_reference_ex;
 187         MonoException      *stack_overflow_ex;
 188         /* typeof (void) */
 189         MonoObject         *typeof_void;
 190         /*
 191          * The fields between FIRST_GC_TRACKED and LAST_GC_TRACKED are roots, but
 192          * not object references.
 193          */
 194 #define MONO_DOMAIN_FIRST_GC_TRACKED env
 195         MonoGHashTable     *env;
 196         MonoGHashTable     *ldstr_table;
 197         /* hashtables for Reflection handles */
 198         MonoGHashTable     *type_hash;
 199         MonoGHashTable     *refobject_hash;
 200         /* a GC-tracked array to keep references to the static fields of types */
 201         gpointer           *static_data_array;
 202         /* maps class -> type initialization exception object */
 203         MonoGHashTable    *type_init_exception_hash;
 204         /* maps delegate trampoline addr -> delegate object */
 205         MonoGHashTable     *delegate_hash_table;
 206 #define MONO_DOMAIN_LAST_GC_TRACKED delegate_hash_table
 207         guint32            state;
 208         /* Needed by Thread:GetDomainID() */
 209         gint32             domain_id;
 210         gint32             shadow_serial;
 211         unsigned char      inet_family_hint; // used in socket-io.c as a cache
 212         GSList             *domain_assemblies;
 213         MonoAssembly       *entry_assembly;
 214         char               *friendly_name;
 215         GHashTable         *class_vtable_hash;
 216         /* maps remote class key -> MonoRemoteClass */
 217         GHashTable         *proxy_vtable_hash;
 218         /* Protected by 'jit_code_hash_lock' */
 219         MonoInternalHashTable jit_code_hash;
 220         CRITICAL_SECTION    jit_code_hash_lock;
 221         int                 num_jit_info_tables;
 222         MonoJitInfoTable *
 223           volatile          jit_info_table;
 224         GSList             *jit_info_free_queue;
 225         /* Used when loading assemblies */
 226         gchar **search_path;
 227         gchar *private_bin_path;
 228
 229         /* Used by remoting proxies */
 230         MonoMethod         *create_proxy_for_type_method;
 231         MonoMethod         *private_invoke_method;
 232         /* Used to store offsets of thread and context static fields */
 233         GHashTable         *special_static_fields;
 234         /*
 235          * This must be a GHashTable, since these objects can't be finalized
 236          * if the hashtable contains a GC visible reference to them.
 237          */
 238         GHashTable         *finalizable_objects_hash;
 239 #ifndef HAVE_SGEN_GC
 240         /* Maps MonoObjects to a GSList of WeakTrackResurrection GCHandles pointing to them */
 241         GHashTable         *track_resurrection_objects_hash;
 242         /* Maps WeakTrackResurrection GCHandles to the MonoObjects they point to */
 243         GHashTable         *track_resurrection_handles_hash;
 244 #endif
 245         /* Protects the three hashes above */
 246         CRITICAL_SECTION   finalizable_objects_hash_lock;
 247         /* Used when accessing 'domain_assemblies' */
 248         CRITICAL_SECTION    assemblies_lock;
 249
 250         GHashTable         *method_rgctx_hash;
 251
 252         GHashTable         *generic_virtual_cases;
 253         MonoThunkFreeList **thunk_free_lists;
 254
 255         /* Information maintained by the JIT engine */
 256         gpointer runtime_info;
 257
 258         /*thread pool jobs, used to coordinate shutdown.*/
 259         int                                     threadpool_jobs;
 260         HANDLE                          cleanup_semaphore;
 261
 262         /* Contains the compiled runtime invoke wrapper used by finalizers */
 263         gpointer            finalize_runtime_invoke;
 264
 265         /* Contains the compiled runtime invoke wrapper used by async resylt creation to capture thread context*/
 266         gpointer            capture_context_runtime_invoke;
 267
 268         /* Contains the compiled method used by async resylt creation to capture thread context*/
 269         gpointer            capture_context_method;
 270 };
 271
 272 typedef struct  {
 273         guint16 major, minor, build, revision;
 274 } AssemblyVersionSet;
 275
 276 /* MonoRuntimeInfo: Contains information about versions supported by this runtime */
 277 typedef struct  {
 278         const char runtime_version [12];
 279         const char framework_version [4];
 280         const AssemblyVersionSet version_sets [2];
 281 } MonoRuntimeInfo;
 282
 283 #define mono_domain_lock(domain) mono_locks_acquire(&(domain)->lock, DomainLock)
 284 #define mono_domain_unlock(domain) mono_locks_release(&(domain)->lock, DomainLock)
 285 #define mono_domain_assemblies_lock(domain) mono_locks_acquire(&(domain)->assemblies_lock, DomainAssembliesLock)
 286 #define mono_domain_assemblies_unlock(domain) mono_locks_release(&(domain)->assemblies_lock, DomainAssembliesLock)
 287 #define mono_domain_jit_code_hash_lock(domain) mono_locks_acquire(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
 288 #define mono_domain_jit_code_hash_unlock(domain) mono_locks_release(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
 289
 290 typedef MonoDomain* (*MonoLoadFunc) (const char *filename, const char *runtime_version);
 291
 292 void
 293 mono_install_runtime_load  (MonoLoadFunc func) MONO_INTERNAL;
 294
 295 MonoDomain*
 296 mono_runtime_load (const char *filename, const char *runtime_version) MONO_INTERNAL;
 297
 298 typedef void (*MonoCreateDomainFunc) (MonoDomain *domain);
 299
 300 void
 301 mono_install_create_domain_hook (MonoCreateDomainFunc func) MONO_INTERNAL;
 302
 303 typedef void (*MonoFreeDomainFunc) (MonoDomain *domain);
 304
 305 void
 306 mono_install_free_domain_hook (MonoFreeDomainFunc func) MONO_INTERNAL;
 307
 308 void
 309 mono_init_com_types (void) MONO_INTERNAL;
 310
 311 void
 312 mono_cleanup (void) MONO_INTERNAL;
 313
 314 void
 315 mono_close_exe_image (void) MONO_INTERNAL;
 316
 317 void
 318 mono_jit_info_table_add    (MonoDomain *domain, MonoJitInfo *ji) MONO_INTERNAL;
 319
 320 void
 321 mono_jit_info_table_remove (MonoDomain *domain, MonoJitInfo *ji) MONO_INTERNAL;
 322
 323 void
 324 mono_jit_info_add_aot_module (MonoImage *image, gpointer start, gpointer end) MONO_INTERNAL;
 325
 326 MonoGenericJitInfo*
 327 mono_jit_info_get_generic_jit_info (MonoJitInfo *ji) MONO_INTERNAL;
 328
 329 MonoGenericSharingContext*
 330 mono_jit_info_get_generic_sharing_context (MonoJitInfo *ji) MONO_INTERNAL;
 331
 332 void
 333 mono_jit_info_set_generic_sharing_context (MonoJitInfo *ji, MonoGenericSharingContext *gsctx) MONO_INTERNAL;
 334
 335 MonoJitInfo*
 336 mono_domain_lookup_shared_generic (MonoDomain *domain, MonoMethod *method) MONO_INTERNAL;
 337
 338 char *
 339 mono_make_shadow_copy (const char *filename) MONO_INTERNAL;
 340
 341 gboolean
 342 mono_is_shadow_copy_enabled (MonoDomain *domain, const gchar *dir_name) MONO_INTERNAL;
 343
 344 gpointer
 345 mono_domain_alloc  (MonoDomain *domain, guint size) MONO_INTERNAL;
 346
 347 gpointer
 348 mono_domain_alloc0 (MonoDomain *domain, guint size) MONO_INTERNAL;
 349
 350 void*
 351 mono_domain_code_reserve (MonoDomain *domain, int size) MONO_INTERNAL;
 352
 353 void*
 354 mono_domain_code_reserve_align (MonoDomain *domain, int size, int alignment) MONO_INTERNAL;
 355
 356 void
 357 mono_domain_code_commit (MonoDomain *domain, void *data, int size, int newsize) MONO_INTERNAL;
 358
 359 void
 360 mono_domain_code_foreach (MonoDomain *domain, MonoCodeManagerFunc func, void *user_data) MONO_INTERNAL;
 361
 362 void
 363 mono_domain_set_internal_with_options (MonoDomain *domain, gboolean migrate_exception) MONO_INTERNAL;
 364
 365 /*
 366  * Installs a new function which is used to return a MonoJitInfo for a method inside
 367  * an AOT module.
 368  */
 369 typedef MonoJitInfo *(*MonoJitInfoFindInAot)         (MonoDomain *domain, MonoImage *image, gpointer addr);
 370 void          mono_install_jit_info_find_in_aot (MonoJitInfoFindInAot func) MONO_INTERNAL;
 371
 372 void
 373 mono_jit_code_hash_init (MonoInternalHashTable *jit_code_hash) MONO_INTERNAL;
 374
 375 MonoAppDomain *
 376 ves_icall_System_AppDomain_getCurDomain            (void) MONO_INTERNAL;
 377
 378 MonoAppDomain *
 379 ves_icall_System_AppDomain_getRootDomain           (void) MONO_INTERNAL;
 380
 381 MonoAppDomain *
 382 ves_icall_System_AppDomain_createDomain            (MonoString         *friendly_name,
 383                                                     MonoAppDomainSetup *setup) MONO_INTERNAL;
 384
 385 MonoObject *
 386 ves_icall_System_AppDomain_GetData                 (MonoAppDomain *ad,
 387                                                     MonoString    *name) MONO_INTERNAL;
 388
 389 MonoReflectionAssembly *
 390 ves_icall_System_AppDomain_LoadAssemblyRaw         (MonoAppDomain *ad,
 391                                                     MonoArray *raw_assembly,
 392                                                     MonoArray *raw_symbol_store,
 393                                                     MonoObject *evidence,
 394                                                     MonoBoolean refonly) MONO_INTERNAL;
 395
 396 void
 397 ves_icall_System_AppDomain_SetData                 (MonoAppDomain *ad,
 398                                                     MonoString    *name,
 399                                                     MonoObject    *data) MONO_INTERNAL;
 400
 401 MonoAppDomainSetup *
 402 ves_icall_System_AppDomain_getSetup                (MonoAppDomain *ad) MONO_INTERNAL;
 403
 404 MonoString *
 405 ves_icall_System_AppDomain_getFriendlyName         (MonoAppDomain *ad) MONO_INTERNAL;
 406
 407 MonoArray *
 408 ves_icall_System_AppDomain_GetAssemblies           (MonoAppDomain *ad,
 409                                                     MonoBoolean refonly) MONO_INTERNAL;
 410
 411 MonoReflectionAssembly *
 412 ves_icall_System_Reflection_Assembly_LoadFrom      (MonoString *fname,
 413                                                     MonoBoolean refonly) MONO_INTERNAL;
 414
 415 MonoReflectionAssembly *
 416 ves_icall_System_AppDomain_LoadAssembly            (MonoAppDomain *ad,
 417                                                     MonoString *assRef,
 418                                                     MonoObject    *evidence,
 419                                                     MonoBoolean refonly) MONO_INTERNAL;
 420
 421 gboolean
 422 ves_icall_System_AppDomain_InternalIsFinalizingForUnload (gint32 domain_id) MONO_INTERNAL;
 423
 424 void
 425 ves_icall_System_AppDomain_InternalUnload          (gint32 domain_id) MONO_INTERNAL;
 426
 427 gint32
 428 ves_icall_System_AppDomain_ExecuteAssembly         (MonoAppDomain *ad,
 429                                                                                                         MonoReflectionAssembly *refass,
 430                                                                                                         MonoArray     *args) MONO_INTERNAL;
 431
 432 MonoAppDomain *
 433 ves_icall_System_AppDomain_InternalSetDomain       (MonoAppDomain *ad) MONO_INTERNAL;
 434
 435 MonoAppDomain *
 436 ves_icall_System_AppDomain_InternalSetDomainByID   (gint32 domainid) MONO_INTERNAL;
 437
 438 void
 439 ves_icall_System_AppDomain_InternalPushDomainRef (MonoAppDomain *ad) MONO_INTERNAL;
 440
 441 void
 442 ves_icall_System_AppDomain_InternalPushDomainRefByID (gint32 domain_id) MONO_INTERNAL;
 443
 444 void
 445 ves_icall_System_AppDomain_InternalPopDomainRef (void) MONO_INTERNAL;
 446
 447 MonoAppContext *
 448 ves_icall_System_AppDomain_InternalGetContext      (void) MONO_INTERNAL;
 449
 450 MonoAppContext *
 451 ves_icall_System_AppDomain_InternalGetDefaultContext      (void) MONO_INTERNAL;
 452
 453 MonoAppContext *
 454 ves_icall_System_AppDomain_InternalSetContext      (MonoAppContext *mc) MONO_INTERNAL;
 455
 456 gint32
 457 ves_icall_System_AppDomain_GetIDFromDomain (MonoAppDomain * ad) MONO_INTERNAL;
 458
 459 MonoString *
 460 ves_icall_System_AppDomain_InternalGetProcessGuid (MonoString* newguid) MONO_INTERNAL;
 461
 462 MonoAssembly *
 463 mono_assembly_load_corlib (const MonoRuntimeInfo *runtime, MonoImageOpenStatus *status) MONO_INTERNAL;
 464
 465 const MonoRuntimeInfo*
 466 mono_get_runtime_info (void) MONO_INTERNAL;
 467
 468 void
 469 mono_runtime_set_no_exec (gboolean val) MONO_INTERNAL;
 470
 471 gboolean
 472 mono_runtime_get_no_exec (void) MONO_INTERNAL;
 473
 474 gboolean
 475 mono_assembly_name_parse (const char *name, MonoAssemblyName *aname) MONO_INTERNAL;
 476
 477 void
 478 mono_assembly_name_free (MonoAssemblyName *aname) MONO_INTERNAL;
 479
 480 MonoImage *mono_assembly_open_from_bundle (const char *filename,
 481                                            MonoImageOpenStatus *status,
 482                                            gboolean refonly) MONO_INTERNAL;
 483
 484 void
 485 mono_domain_add_class_static_data (MonoDomain *domain, MonoClass *klass, gpointer data, guint32 *bitmap);
 486
 487 MonoReflectionAssembly *
 488 mono_try_assembly_resolve (MonoDomain *domain, MonoString *fname, gboolean refonly) MONO_INTERNAL;
 489
 490 MonoAssembly* mono_assembly_load_full_nosearch (MonoAssemblyName *aname,
 491                                                 const char       *basedir,
 492                                                 MonoImageOpenStatus *status,
 493                                                 gboolean refonly) MONO_INTERNAL;
 494
 495 void mono_set_private_bin_path_from_config (MonoDomain *domain) MONO_INTERNAL;
 496
 497 int mono_framework_version (void) MONO_INTERNAL;
 498
 499 void mono_reflection_cleanup_domain (MonoDomain *domain) MONO_INTERNAL;
 500
 501 #endif /* __MONO_METADATA_DOMAIN_INTERNALS_H__ */