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