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