2009-03-03 Zoltan Varga <vargaz@gmail.com>
[mono.git] / 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         MonoJitExceptionInfo clauses [MONO_ZERO_LEN_ARRAY];
127         /* There is an optional MonoGenericJitInfo after the clauses */
128 };
129
130 struct _MonoAppContext {
131         MonoObject obj;
132         gint32 domain_id;
133         gint32 context_id;
134         gpointer *static_data;
135 };
136
137 /*
138  * We have two unloading states because the domain
139  * must remain fully functional while AppDomain::DomainUnload is
140  * processed.
141  * After that unloading began and all domain facilities are teared down
142  * such as execution of new threadpool jobs.  
143  */
144 typedef enum {
145         MONO_APPDOMAIN_CREATED,
146         MONO_APPDOMAIN_UNLOADING_START,
147         MONO_APPDOMAIN_UNLOADING,
148         MONO_APPDOMAIN_UNLOADED
149 } MonoAppDomainState;
150
151 typedef struct _MonoThunkFreeList {
152         guint32 size;
153         int length;             /* only valid for the wait list */
154         struct _MonoThunkFreeList *next;
155 } MonoThunkFreeList;
156
157 typedef struct _MonoJitCodeHash MonoJitCodeHash;
158
159 struct _MonoDomain {
160         /*
161          * This lock must never be taken before the loader lock,
162          * i.e. if both are taken by the same thread, the loader lock
163          * must taken first.
164          */
165         CRITICAL_SECTION    lock;
166         MonoMemPool        *mp;
167         MonoCodeManager    *code_mp;
168         /*
169          * keep all the managed objects close to each other for the precise GC
170          * For the Boehm GC we additionally keep close also other GC-tracked pointers.
171          */
172 #define MONO_DOMAIN_FIRST_OBJECT setup
173         MonoAppDomainSetup *setup;
174         MonoAppDomain      *domain;
175         MonoAppContext     *default_context;
176         MonoException      *out_of_memory_ex;
177         MonoException      *null_reference_ex;
178         MonoException      *stack_overflow_ex;
179 #define MONO_DOMAIN_FIRST_GC_TRACKED env
180         MonoGHashTable     *env;
181         MonoGHashTable     *ldstr_table;
182         /* hashtables for Reflection handles */
183         MonoGHashTable     *type_hash;
184         MonoGHashTable     *refobject_hash;
185         /* a GC-tracked array to keep references to the static fields of types */
186         gpointer           *static_data_array;
187         /* maps class -> type initialization exception object */
188         MonoGHashTable    *type_init_exception_hash;
189         /* maps delegate trampoline addr -> delegate object */
190         MonoGHashTable     *delegate_hash_table;
191         /* typeof (void) */
192         MonoObject         *typeof_void;
193 #define MONO_DOMAIN_LAST_GC_TRACKED typeof_void
194         guint32            state;
195         /* Needed by Thread:GetDomainID() */
196         gint32             domain_id;
197         gint32             shadow_serial;
198         unsigned char      inet_family_hint; // used in socket-io.c as a cache
199         GSList             *domain_assemblies;
200         MonoAssembly       *entry_assembly;
201         char               *friendly_name;
202         GHashTable         *class_vtable_hash;
203         /* maps remote class key -> MonoRemoteClass */
204         GHashTable         *proxy_vtable_hash;
205         /* Protected by 'jit_code_hash_lock' */
206         MonoInternalHashTable jit_code_hash;
207         CRITICAL_SECTION    jit_code_hash_lock;
208         int                 num_jit_info_tables;
209         MonoJitInfoTable * 
210           volatile          jit_info_table;
211         GSList             *jit_info_free_queue;
212         /* Used when loading assemblies */
213         gchar **search_path;
214         gchar *private_bin_path;
215         
216         /* Used by remoting proxies */
217         MonoMethod         *create_proxy_for_type_method;
218         MonoMethod         *private_invoke_method;
219         /* Used to store offsets of thread and context static fields */
220         GHashTable         *special_static_fields;
221         /* 
222          * This must be a GHashTable, since these objects can't be finalized
223          * if the hashtable contains a GC visible reference to them.
224          */
225         GHashTable         *finalizable_objects_hash;
226         CRITICAL_SECTION   finalizable_objects_hash_lock;
227         /* Used when accessing 'domain_assemblies' */
228         CRITICAL_SECTION    assemblies_lock;
229
230         GHashTable         *method_rgctx_hash;
231
232         GHashTable         *generic_virtual_cases;
233         MonoThunkFreeList **thunk_free_lists;
234
235         /* Information maintained by the JIT engine */
236         gpointer runtime_info;
237
238         /*thread pool jobs, used to coordinate shutdown.*/
239         int                                     threadpool_jobs;
240         HANDLE                          cleanup_semaphore;
241         
242         /* Contains the compiled runtime invoke wrapper used by finalizers */
243         gpointer            finalize_runtime_invoke;
244 };
245
246 typedef struct  {
247         guint16 major, minor, build, revision;
248 } AssemblyVersionSet;
249
250 /* MonoRuntimeInfo: Contains information about versions supported by this runtime */
251 typedef struct  {
252         const char runtime_version [12];
253         const char framework_version [4];
254         const AssemblyVersionSet version_sets [2];
255 } MonoRuntimeInfo;
256
257 #define mono_domain_lock(domain) mono_locks_acquire(&(domain)->lock, DomainLock)
258 #define mono_domain_unlock(domain) mono_locks_release(&(domain)->lock, DomainLock)
259 #define mono_domain_assemblies_lock(domain) mono_locks_acquire(&(domain)->assemblies_lock, DomainAssembliesLock)
260 #define mono_domain_assemblies_unlock(domain) mono_locks_release(&(domain)->assemblies_lock, DomainAssembliesLock)
261 #define mono_domain_jit_code_hash_lock(domain) mono_locks_acquire(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
262 #define mono_domain_jit_code_hash_unlock(domain) mono_locks_release(&(domain)->jit_code_hash_lock, DomainJitCodeHashLock)
263
264 typedef MonoDomain* (*MonoLoadFunc) (const char *filename, const char *runtime_version);
265
266 void
267 mono_install_runtime_load  (MonoLoadFunc func) MONO_INTERNAL;
268
269 MonoDomain*
270 mono_runtime_load (const char *filename, const char *runtime_version) MONO_INTERNAL;
271
272 typedef void (*MonoCreateDomainFunc) (MonoDomain *domain);
273
274 void
275 mono_install_create_domain_hook (MonoCreateDomainFunc func) MONO_INTERNAL;
276
277 typedef void (*MonoFreeDomainFunc) (MonoDomain *domain);
278
279 void
280 mono_install_free_domain_hook (MonoFreeDomainFunc func) MONO_INTERNAL;
281
282 void 
283 mono_init_com_types (void) MONO_INTERNAL;
284
285 void 
286 mono_cleanup (void) MONO_INTERNAL;
287
288 void
289 mono_close_exe_image (void) MONO_INTERNAL;
290
291 void
292 mono_jit_info_table_add    (MonoDomain *domain, MonoJitInfo *ji) MONO_INTERNAL;
293
294 void
295 mono_jit_info_table_remove (MonoDomain *domain, MonoJitInfo *ji) MONO_INTERNAL;
296
297 void
298 mono_jit_info_add_aot_module (MonoImage *image, gpointer start, gpointer end) MONO_INTERNAL;
299
300 MonoGenericJitInfo*
301 mono_jit_info_get_generic_jit_info (MonoJitInfo *ji) MONO_INTERNAL;
302
303 MonoGenericSharingContext*
304 mono_jit_info_get_generic_sharing_context (MonoJitInfo *ji) MONO_INTERNAL;
305
306 void
307 mono_jit_info_set_generic_sharing_context (MonoJitInfo *ji, MonoGenericSharingContext *gsctx) MONO_INTERNAL;
308
309 MonoJitInfo*
310 mono_domain_lookup_shared_generic (MonoDomain *domain, MonoMethod *method) MONO_INTERNAL;
311
312 char *
313 mono_make_shadow_copy (const char *filename) MONO_INTERNAL;
314
315 gboolean
316 mono_is_shadow_copy_enabled (MonoDomain *domain, const gchar *dir_name) MONO_INTERNAL;
317
318 gpointer
319 mono_domain_alloc  (MonoDomain *domain, guint size) MONO_INTERNAL;
320
321 gpointer
322 mono_domain_alloc0 (MonoDomain *domain, guint size) MONO_INTERNAL;
323
324 void*
325 mono_domain_code_reserve (MonoDomain *domain, int size) MONO_INTERNAL;
326
327 void*
328 mono_domain_code_reserve_align (MonoDomain *domain, int size, int alignment) MONO_INTERNAL;
329
330 void
331 mono_domain_code_commit (MonoDomain *domain, void *data, int size, int newsize) MONO_INTERNAL;
332
333 void
334 mono_domain_code_foreach (MonoDomain *domain, MonoCodeManagerFunc func, void *user_data) MONO_INTERNAL;
335
336 /* 
337  * Installs a new function which is used to return a MonoJitInfo for a method inside
338  * an AOT module.
339  */
340 typedef MonoJitInfo *(*MonoJitInfoFindInAot)         (MonoDomain *domain, MonoImage *image, gpointer addr);
341 void          mono_install_jit_info_find_in_aot (MonoJitInfoFindInAot func) MONO_INTERNAL;
342
343 void
344 mono_jit_code_hash_init (MonoInternalHashTable *jit_code_hash) MONO_INTERNAL;
345
346 MonoAppDomain *
347 ves_icall_System_AppDomain_getCurDomain            (void) MONO_INTERNAL;
348
349 MonoAppDomain *
350 ves_icall_System_AppDomain_getRootDomain           (void) MONO_INTERNAL;
351
352 MonoAppDomain *
353 ves_icall_System_AppDomain_createDomain            (MonoString         *friendly_name,
354                                                     MonoAppDomainSetup *setup) MONO_INTERNAL;
355
356 MonoObject *
357 ves_icall_System_AppDomain_GetData                 (MonoAppDomain *ad, 
358                                                     MonoString    *name) MONO_INTERNAL;
359
360 MonoReflectionAssembly *
361 ves_icall_System_AppDomain_LoadAssemblyRaw         (MonoAppDomain *ad,
362                                                     MonoArray *raw_assembly, 
363                                                     MonoArray *raw_symbol_store,
364                                                     MonoObject *evidence,
365                                                     MonoBoolean refonly) MONO_INTERNAL;
366
367 void
368 ves_icall_System_AppDomain_SetData                 (MonoAppDomain *ad, 
369                                                     MonoString    *name, 
370                                                     MonoObject    *data) MONO_INTERNAL;
371
372 MonoAppDomainSetup *
373 ves_icall_System_AppDomain_getSetup                (MonoAppDomain *ad) MONO_INTERNAL;
374
375 MonoString *
376 ves_icall_System_AppDomain_getFriendlyName         (MonoAppDomain *ad) MONO_INTERNAL;
377
378 MonoArray *
379 ves_icall_System_AppDomain_GetAssemblies           (MonoAppDomain *ad,
380                                                     MonoBoolean refonly) MONO_INTERNAL;
381
382 MonoReflectionAssembly *
383 ves_icall_System_Reflection_Assembly_LoadFrom      (MonoString *fname,
384                                                     MonoBoolean refonly) MONO_INTERNAL;
385
386 MonoReflectionAssembly *
387 ves_icall_System_AppDomain_LoadAssembly            (MonoAppDomain *ad, 
388                                                     MonoString *assRef,
389                                                     MonoObject    *evidence,
390                                                     MonoBoolean refonly) MONO_INTERNAL;
391
392 gboolean
393 ves_icall_System_AppDomain_InternalIsFinalizingForUnload (gint32 domain_id) MONO_INTERNAL;
394
395 void
396 ves_icall_System_AppDomain_InternalUnload          (gint32 domain_id) MONO_INTERNAL;
397
398 gint32
399 ves_icall_System_AppDomain_ExecuteAssembly         (MonoAppDomain *ad, 
400                                                                                                         MonoReflectionAssembly *refass,
401                                                                                                         MonoArray     *args) MONO_INTERNAL;
402
403 MonoAppDomain * 
404 ves_icall_System_AppDomain_InternalSetDomain       (MonoAppDomain *ad) MONO_INTERNAL;
405
406 MonoAppDomain * 
407 ves_icall_System_AppDomain_InternalSetDomainByID   (gint32 domainid) MONO_INTERNAL;
408
409 void
410 ves_icall_System_AppDomain_InternalPushDomainRef (MonoAppDomain *ad) MONO_INTERNAL;
411
412 void
413 ves_icall_System_AppDomain_InternalPushDomainRefByID (gint32 domain_id) MONO_INTERNAL;
414
415 void
416 ves_icall_System_AppDomain_InternalPopDomainRef (void) MONO_INTERNAL;
417
418 MonoAppContext * 
419 ves_icall_System_AppDomain_InternalGetContext      (void) MONO_INTERNAL;
420
421 MonoAppContext * 
422 ves_icall_System_AppDomain_InternalGetDefaultContext      (void) MONO_INTERNAL;
423
424 MonoAppContext * 
425 ves_icall_System_AppDomain_InternalSetContext      (MonoAppContext *mc) MONO_INTERNAL;
426
427 gint32 
428 ves_icall_System_AppDomain_GetIDFromDomain (MonoAppDomain * ad) MONO_INTERNAL;
429
430 MonoString *
431 ves_icall_System_AppDomain_InternalGetProcessGuid (MonoString* newguid) MONO_INTERNAL;
432
433 MonoAssembly *
434 mono_assembly_load_corlib (const MonoRuntimeInfo *runtime, MonoImageOpenStatus *status) MONO_INTERNAL;
435
436 const MonoRuntimeInfo*
437 mono_get_runtime_info (void) MONO_INTERNAL;
438
439 void
440 mono_runtime_set_no_exec (gboolean val) MONO_INTERNAL;
441
442 gboolean
443 mono_runtime_get_no_exec (void) MONO_INTERNAL;
444
445 gboolean
446 mono_assembly_name_parse (const char *name, MonoAssemblyName *aname) MONO_INTERNAL;
447
448 void
449 mono_assembly_name_free (MonoAssemblyName *aname) MONO_INTERNAL;
450
451 MonoImage *mono_assembly_open_from_bundle (const char *filename,
452                                            MonoImageOpenStatus *status,
453                                            gboolean refonly) MONO_INTERNAL;
454
455 void
456 mono_domain_add_class_static_data (MonoDomain *domain, MonoClass *klass, gpointer data, guint32 *bitmap);
457
458 MonoReflectionAssembly *
459 mono_try_assembly_resolve (MonoDomain *domain, MonoString *fname, gboolean refonly) MONO_INTERNAL;
460
461 MonoAssembly* mono_assembly_load_full_nosearch (MonoAssemblyName *aname, 
462                                                 const char       *basedir, 
463                                                 MonoImageOpenStatus *status,
464                                                 gboolean refonly) MONO_INTERNAL;
465
466 void mono_set_private_bin_path_from_config (MonoDomain *domain) MONO_INTERNAL;
467
468 int mono_framework_version (void) MONO_INTERNAL;
469
470 #endif /* __MONO_METADATA_DOMAIN_INTERNALS_H__ */