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