2008-07-31 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 typedef struct {
127         MonoJitInfo *ji;
128         MonoCodeManager *code_mp;
129 } MonoJitDynamicMethodInfo;
130
131 struct _MonoAppContext {
132         MonoObject obj;
133         gint32 domain_id;
134         gint32 context_id;
135         gpointer *static_data;
136 };
137
138 typedef enum {
139         MONO_APPDOMAIN_CREATED,
140         MONO_APPDOMAIN_UNLOADING,
141         MONO_APPDOMAIN_UNLOADED
142 } MonoAppDomainState;
143
144 typedef struct _MonoJitCodeHash MonoJitCodeHash;
145
146 struct _MonoDomain {
147         CRITICAL_SECTION    lock;
148         MonoMemPool        *mp;
149         MonoCodeManager    *code_mp;
150         /*
151          * keep all the managed objects close to each other for the precise GC
152          * For the Boehm GC we additionally keep close also other GC-tracked pointers.
153          */
154 #define MONO_DOMAIN_FIRST_OBJECT setup
155         MonoAppDomainSetup *setup;
156         MonoAppDomain      *domain;
157         MonoAppContext     *default_context;
158         MonoException      *out_of_memory_ex;
159         MonoException      *null_reference_ex;
160         MonoException      *stack_overflow_ex;
161 #define MONO_DOMAIN_FIRST_GC_TRACKED env
162         MonoGHashTable     *env;
163         MonoGHashTable     *ldstr_table;
164         /* hashtables for Reflection handles */
165         MonoGHashTable     *type_hash;
166         MonoGHashTable     *refobject_hash;
167         /* a GC-tracked array to keep references to the static fields of types */
168         gpointer           *static_data_array;
169         /* maps class -> type initialization exception object */
170         MonoGHashTable    *type_init_exception_hash;
171         /* maps delegate trampoline addr -> delegate object */
172         MonoGHashTable     *delegate_hash_table;
173 #define MONO_DOMAIN_LAST_GC_TRACKED delegate_hash_table
174         guint32            state;
175         /* Needed by Thread:GetDomainID() */
176         gint32             domain_id;
177         gint32             shadow_serial;
178         unsigned char      inet_family_hint; // used in socket-io.c as a cache
179         GSList             *domain_assemblies;
180         MonoAssembly       *entry_assembly;
181         char               *friendly_name;
182         GHashTable         *class_vtable_hash;
183         /* maps remote class key -> MonoRemoteClass */
184         GHashTable         *proxy_vtable_hash;
185         /* Protected by 'jit_code_hash_lock' */
186         MonoInternalHashTable jit_code_hash;
187         CRITICAL_SECTION    jit_code_hash_lock;
188         /* maps MonoMethod -> MonoJitDynamicMethodInfo */
189         GHashTable         *dynamic_code_hash;
190         int                 num_jit_info_tables;
191         MonoJitInfoTable * 
192           volatile          jit_info_table;
193         GSList             *jit_info_free_queue;
194         /* Used when loading assemblies */
195         gchar **search_path;
196         gchar *private_bin_path;
197         
198         /* Used by remoting proxies */
199         MonoMethod         *create_proxy_for_type_method;
200         MonoMethod         *private_invoke_method;
201         /* Used to store offsets of thread and context static fields */
202         GHashTable         *special_static_fields;
203         GHashTable         *jump_target_hash;
204         GHashTable         *class_init_trampoline_hash;
205         GHashTable         *jump_trampoline_hash;
206         GHashTable         *jit_trampoline_hash;
207         GHashTable         *delegate_trampoline_hash;
208         /* 
209          * This must be a GHashTable, since these objects can't be finalized
210          * if the hashtable contains a GC visible reference to them.
211          */
212         GHashTable         *finalizable_objects_hash;
213         /* Used when accessing 'domain_assemblies' */
214         CRITICAL_SECTION    assemblies_lock;
215
216         GHashTable         *shared_generics_hash;
217         GHashTable         *method_rgctx_hash;
218         GHashTable     *method_code_hash;
219 };
220
221 typedef struct  {
222         guint16 major, minor, build, revision;
223 } AssemblyVersionSet;
224
225 /* MonoRuntimeInfo: Contains information about versions supported by this runtime */
226 typedef struct  {
227         const char runtime_version [12];
228         const char framework_version [4];
229         const AssemblyVersionSet version_sets [2];
230 } MonoRuntimeInfo;
231
232 #define mono_domain_lock(domain)   EnterCriticalSection(&(domain)->lock)
233 #define mono_domain_unlock(domain) LeaveCriticalSection(&(domain)->lock)
234 #define mono_domain_assemblies_lock(domain)   EnterCriticalSection(&(domain)->assemblies_lock)
235 #define mono_domain_assemblies_unlock(domain) LeaveCriticalSection(&(domain)->assemblies_lock)
236 #define mono_domain_jit_code_hash_lock(domain)   EnterCriticalSection(&(domain)->jit_code_hash_lock)
237 #define mono_domain_jit_code_hash_unlock(domain) LeaveCriticalSection(&(domain)->jit_code_hash_lock)
238
239 typedef MonoDomain* (*MonoLoadFunc) (const char *filename, const char *runtime_version);
240
241 void
242 mono_install_runtime_load  (MonoLoadFunc func) MONO_INTERNAL;
243
244 MonoDomain*
245 mono_runtime_load (const char *filename, const char *runtime_version) MONO_INTERNAL;
246
247 void 
248 mono_init_com_types (void) MONO_INTERNAL;
249
250 void 
251 mono_cleanup (void) MONO_INTERNAL;
252
253 void
254 mono_close_exe_image (void) MONO_INTERNAL;
255
256 void
257 mono_jit_info_table_add    (MonoDomain *domain, MonoJitInfo *ji) MONO_INTERNAL;
258
259 void
260 mono_jit_info_table_remove (MonoDomain *domain, MonoJitInfo *ji) MONO_INTERNAL;
261
262 void
263 mono_jit_info_add_aot_module (MonoImage *image, gpointer start, gpointer end) MONO_INTERNAL;
264
265 MonoGenericJitInfo*
266 mono_jit_info_get_generic_jit_info (MonoJitInfo *ji) MONO_INTERNAL;
267
268 MonoGenericSharingContext*
269 mono_jit_info_get_generic_sharing_context (MonoJitInfo *ji) MONO_INTERNAL;
270
271 void
272 mono_jit_info_set_generic_sharing_context (MonoJitInfo *ji, MonoGenericSharingContext *gsctx) MONO_INTERNAL;
273
274 MonoJitInfo*
275 mono_domain_lookup_shared_generic (MonoDomain *domain, MonoMethod *method) MONO_INTERNAL;
276
277 void
278 mono_domain_register_shared_generic (MonoDomain *domain, MonoMethod *method, MonoJitInfo *jit_info) MONO_INTERNAL;
279
280 char *
281 mono_make_shadow_copy (const char *filename);
282
283 /* 
284  * Installs a new function which is used to return a MonoJitInfo for a method inside
285  * an AOT module.
286  */
287 typedef MonoJitInfo *(*MonoJitInfoFindInAot)         (MonoDomain *domain, MonoImage *image, gpointer addr);
288 void          mono_install_jit_info_find_in_aot (MonoJitInfoFindInAot func) MONO_INTERNAL;
289
290 void
291 mono_jit_code_hash_init (MonoInternalHashTable *jit_code_hash) MONO_INTERNAL;
292
293 MonoAppDomain *
294 ves_icall_System_AppDomain_getCurDomain            (void) MONO_INTERNAL;
295
296 MonoAppDomain *
297 ves_icall_System_AppDomain_getRootDomain           (void) MONO_INTERNAL;
298
299 MonoAppDomain *
300 ves_icall_System_AppDomain_createDomain            (MonoString         *friendly_name,
301                                                     MonoAppDomainSetup *setup) MONO_INTERNAL;
302
303 MonoObject *
304 ves_icall_System_AppDomain_GetData                 (MonoAppDomain *ad, 
305                                                     MonoString    *name) MONO_INTERNAL;
306
307 MonoReflectionAssembly *
308 ves_icall_System_AppDomain_LoadAssemblyRaw         (MonoAppDomain *ad,
309                                                     MonoArray *raw_assembly, 
310                                                     MonoArray *raw_symbol_store,
311                                                     MonoObject *evidence,
312                                                     MonoBoolean refonly) MONO_INTERNAL;
313
314 void
315 ves_icall_System_AppDomain_SetData                 (MonoAppDomain *ad, 
316                                                     MonoString    *name, 
317                                                     MonoObject    *data) MONO_INTERNAL;
318
319 MonoAppDomainSetup *
320 ves_icall_System_AppDomain_getSetup                (MonoAppDomain *ad) MONO_INTERNAL;
321
322 MonoString *
323 ves_icall_System_AppDomain_getFriendlyName         (MonoAppDomain *ad) MONO_INTERNAL;
324
325 MonoArray *
326 ves_icall_System_AppDomain_GetAssemblies           (MonoAppDomain *ad,
327                                                     MonoBoolean refonly) MONO_INTERNAL;
328
329 MonoReflectionAssembly *
330 ves_icall_System_Reflection_Assembly_LoadFrom      (MonoString *fname,
331                                                     MonoBoolean refonly) MONO_INTERNAL;
332
333 MonoReflectionAssembly *
334 ves_icall_System_AppDomain_LoadAssembly            (MonoAppDomain *ad, 
335                                                     MonoString *assRef,
336                                                     MonoObject    *evidence,
337                                                     MonoBoolean refonly) MONO_INTERNAL;
338
339 gboolean
340 ves_icall_System_AppDomain_InternalIsFinalizingForUnload (gint32 domain_id) MONO_INTERNAL;
341
342 void
343 ves_icall_System_AppDomain_InternalUnload          (gint32 domain_id) MONO_INTERNAL;
344
345 gint32
346 ves_icall_System_AppDomain_ExecuteAssembly         (MonoAppDomain *ad, 
347                                                                                                         MonoReflectionAssembly *refass,
348                                                                                                         MonoArray     *args) MONO_INTERNAL;
349
350 MonoAppDomain * 
351 ves_icall_System_AppDomain_InternalSetDomain       (MonoAppDomain *ad) MONO_INTERNAL;
352
353 MonoAppDomain * 
354 ves_icall_System_AppDomain_InternalSetDomainByID   (gint32 domainid) MONO_INTERNAL;
355
356 void
357 ves_icall_System_AppDomain_InternalPushDomainRef (MonoAppDomain *ad) MONO_INTERNAL;
358
359 void
360 ves_icall_System_AppDomain_InternalPushDomainRefByID (gint32 domain_id) MONO_INTERNAL;
361
362 void
363 ves_icall_System_AppDomain_InternalPopDomainRef (void) MONO_INTERNAL;
364
365 MonoAppContext * 
366 ves_icall_System_AppDomain_InternalGetContext      (void) MONO_INTERNAL;
367
368 MonoAppContext * 
369 ves_icall_System_AppDomain_InternalGetDefaultContext      (void) MONO_INTERNAL;
370
371 MonoAppContext * 
372 ves_icall_System_AppDomain_InternalSetContext      (MonoAppContext *mc) MONO_INTERNAL;
373
374 gint32 
375 ves_icall_System_AppDomain_GetIDFromDomain (MonoAppDomain * ad) MONO_INTERNAL;
376
377 MonoString *
378 ves_icall_System_AppDomain_InternalGetProcessGuid (MonoString* newguid) MONO_INTERNAL;
379
380 MonoAssembly *
381 mono_assembly_load_corlib (const MonoRuntimeInfo *runtime, MonoImageOpenStatus *status) MONO_INTERNAL;
382
383 const MonoRuntimeInfo*
384 mono_get_runtime_info (void) MONO_INTERNAL;
385
386 gboolean
387 mono_assembly_name_parse (const char *name, MonoAssemblyName *aname) MONO_INTERNAL;
388
389 void
390 mono_assembly_name_free (MonoAssemblyName *aname) MONO_INTERNAL;
391
392 MonoImage *mono_assembly_open_from_bundle (const char *filename,
393                                            MonoImageOpenStatus *status,
394                                            gboolean refonly) MONO_INTERNAL;
395
396 void
397 mono_domain_add_class_static_data (MonoDomain *domain, MonoClass *klass, gpointer data, guint32 *bitmap);
398
399 MonoReflectionAssembly *
400 mono_try_assembly_resolve (MonoDomain *domain, MonoString *fname, gboolean refonly) MONO_INTERNAL;
401
402 MonoAssembly* mono_assembly_load_full_nosearch (MonoAssemblyName *aname, 
403                                                 const char       *basedir, 
404                                                 MonoImageOpenStatus *status,
405                                                 gboolean refonly) MONO_INTERNAL;
406
407 #endif /* __MONO_METADATA_DOMAIN_INTERNALS_H__ */