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