2009-02-25 Zoltan Varga <vargaz@gmail.com>
[mono.git] / mono / metadata / metadata-internals.h
1
2 #ifndef __MONO_METADATA_INTERNALS_H__
3 #define __MONO_METADATA_INTERNALS_H__
4
5 #include "mono/metadata/image.h"
6 #include "mono/metadata/blob.h"
7 #include "mono/metadata/mempool.h"
8 #include "mono/metadata/domain-internals.h"
9 #include "mono/utils/mono-hash.h"
10 #include "mono/utils/mono-compiler.h"
11 #include "mono/utils/mono-dl.h"
12 #include "mono/utils/monobitset.h"
13 #include "mono/utils/mono-property-hash.h"
14 #include "mono/utils/mono-value-hash.h"
15
16 #define MONO_SECMAN_FLAG_INIT(x)                (x & 0x2)
17 #define MONO_SECMAN_FLAG_GET_VALUE(x)           (x & 0x1)
18 #define MONO_SECMAN_FLAG_SET_VALUE(x,y)         do { x = ((y) ? 0x3 : 0x2); } while (0)
19
20 struct _MonoAssembly {
21         /* 
22          * The number of appdomains which have this assembly loaded plus the number of 
23          * assemblies referencing this assembly through an entry in their image->references
24          * arrays. The later is needed because entries in the image->references array
25          * might point to assemblies which are only loaded in some appdomains, and without
26          * the additional reference, they can be freed at any time.
27          * The ref_count is initially 0.
28          */
29         int ref_count; /* use atomic operations only */
30         char *basedir;
31         MonoAssemblyName aname;
32         MonoImage *image;
33         GSList *friend_assembly_names; /* Computed by mono_assembly_load_friends () */
34         guint8 friend_assembly_names_inited;
35         guint8 in_gac;
36         guint8 dynamic;
37         guint8 corlib_internal;
38         gboolean ref_only;
39         /* security manager flags (one bit is for lazy initialization) */
40         guint32 ecma:2;         /* Has the ECMA key */
41         guint32 aptc:2;         /* Has the [AllowPartiallyTrustedCallers] attributes */
42         guint32 fulltrust:2;    /* Has FullTrust permission */
43         guint32 unmanaged:2;    /* Has SecurityPermissionFlag.UnmanagedCode permission */
44         guint32 skipverification:2;     /* Has SecurityPermissionFlag.SkipVerification permission */
45 };
46
47 typedef struct {
48         const char* data;
49         guint32  size;
50 } MonoStreamHeader;
51
52 struct _MonoTableInfo {
53         const char *base;
54         guint       rows     : 24;
55         guint       row_size : 8;
56
57         /*
58          * Tables contain up to 9 columns and the possible sizes of the
59          * fields in the documentation are 1, 2 and 4 bytes.  So we
60          * can encode in 2 bits the size.
61          *
62          * A 32 bit value can encode the resulting size
63          *
64          * The top eight bits encode the number of columns in the table.
65          * we only need 4, but 8 is aligned no shift required. 
66          */
67         guint32   size_bitfield;
68 };
69
70 #define REFERENCE_MISSING ((gpointer) -1)
71
72 typedef struct _MonoDllMap MonoDllMap;
73
74 struct _MonoImage {
75         /*
76          * The number of assemblies which reference this MonoImage though their 'image'
77          * field plus the number of images which reference this MonoImage through their 
78          * 'modules' field, plus the number of threads holding temporary references to
79          * this image between calls of mono_image_open () and mono_image_close ().
80          */
81         int   ref_count;
82         void *raw_data_handle;
83         char *raw_data;
84         guint32 raw_data_len;
85         guint8 raw_buffer_used    : 1;
86         guint8 raw_data_allocated : 1;
87
88 #ifdef PLATFORM_WIN32
89         /* Module was loaded using LoadLibrary. */
90         guint8 is_module_handle : 1;
91
92         /* Module entry point is _CorDllMain. */
93         guint8 has_entry_point : 1;
94 #endif
95
96         /* Whenever this is a dynamically emitted module */
97         guint8 dynamic : 1;
98
99         /* Whenever this is a reflection only image */
100         guint8 ref_only : 1;
101
102         /* Whenever this image contains uncompressed metadata */
103         guint8 uncompressed_metadata : 1;
104
105         guint8 checked_module_cctor : 1;
106         guint8 has_module_cctor : 1;
107
108         guint8 idx_string_wide : 1;
109         guint8 idx_guid_wide : 1;
110         guint8 idx_blob_wide : 1;
111                             
112         char *name;
113         const char *assembly_name;
114         const char *module_name;
115         char *version;
116         gint16 md_version_major, md_version_minor;
117         char *guid;
118         void *image_info;
119         MonoMemPool         *mempool; /*protected by the image lock*/
120
121         char                *raw_metadata;
122                             
123         MonoStreamHeader     heap_strings;
124         MonoStreamHeader     heap_us;
125         MonoStreamHeader     heap_blob;
126         MonoStreamHeader     heap_guid;
127         MonoStreamHeader     heap_tables;
128                             
129         const char          *tables_base;
130
131         /**/
132         MonoTableInfo        tables [MONO_TABLE_NUM];
133
134         /*
135          * references is initialized only by using the mono_assembly_open
136          * function, and not by using the lowlevel mono_image_open.
137          *
138          * It is NULL terminated.
139          */
140         MonoAssembly **references;
141
142         MonoImage **modules;
143         guint32 module_count;
144         gboolean *modules_loaded;
145
146         MonoImage **files;
147
148         gpointer aot_module;
149
150         /*
151          * The Assembly this image was loaded from.
152          */
153         MonoAssembly *assembly;
154
155         /*
156          * Indexed by method tokens and typedef tokens.
157          */
158         MonoValueHashTable *method_cache; /*protected by the image lock*/
159         MonoInternalHashTable class_cache;
160
161         /* Indexed by memberref + methodspec tokens */
162         GHashTable *methodref_cache; /*protected by the image lock*/
163
164         /*
165          * Indexed by fielddef and memberref tokens
166          */
167         GHashTable *field_cache;
168
169         /* indexed by typespec tokens. */
170         GHashTable *typespec_cache;
171         /* indexed by token */
172         GHashTable *memberref_signatures;
173         GHashTable *helper_signatures;
174
175         /* Indexed by blob heap indexes */
176         GHashTable *method_signatures;
177
178         /*
179          * Indexes namespaces to hash tables that map class name to typedef token.
180          */
181         GHashTable *name_cache;
182
183         /*
184          * Indexed by MonoClass
185          */
186         GHashTable *array_cache;
187         GHashTable *ptr_cache;
188
189         GHashTable *szarray_cache;
190         /* This has a separate lock to improve scalability */
191         CRITICAL_SECTION szarray_cache_lock;
192
193         /*
194          * indexed by MonoMethodSignature 
195          */
196         GHashTable *delegate_begin_invoke_cache;
197         GHashTable *delegate_end_invoke_cache;
198         GHashTable *delegate_invoke_cache;
199         GHashTable *runtime_invoke_cache;
200
201         /*
202          * indexed by SignatureMethodPair
203          */
204         GHashTable *delegate_abstract_invoke_cache;
205
206         /*
207          * indexed by MonoMethod pointers 
208          */
209         GHashTable *runtime_invoke_direct_cache;
210         GHashTable *managed_wrapper_cache;
211         GHashTable *native_wrapper_cache;
212         GHashTable *native_wrapper_aot_cache;
213         GHashTable *remoting_invoke_cache;
214         GHashTable *synchronized_cache;
215         GHashTable *unbox_wrapper_cache;
216         GHashTable *cominterop_invoke_cache;
217         GHashTable *cominterop_wrapper_cache;
218         GHashTable *static_rgctx_invoke_cache; /* LOCKING: marshal lock */
219         GHashTable *thunk_invoke_cache;
220
221         /*
222          * indexed by MonoClass pointers
223          */
224         GHashTable *ldfld_wrapper_cache;
225         GHashTable *ldflda_wrapper_cache;
226         GHashTable *stfld_wrapper_cache;
227         GHashTable *isinst_cache;
228         GHashTable *castclass_cache;
229         GHashTable *proxy_isinst_cache;
230         GHashTable *rgctx_template_hash; /* LOCKING: templates lock */
231
232         /*
233          * indexed by token and MonoGenericContext pointer
234          */
235         GHashTable *generic_class_cache;
236
237         /* Contains rarely used fields of runtime structures belonging to this image */
238         MonoPropertyHash *property_hash;
239
240         void *reflection_info;
241
242         /*
243          * user_info is a public field and is not touched by the
244          * metadata engine
245          */
246         void *user_info;
247
248         /* dll map entries */
249         MonoDllMap *dll_map;
250
251         /* interfaces IDs from this image */
252         MonoBitSet *interface_bitset;
253
254         /*
255          * No other runtime locks must be taken while holding this lock.
256          * It's meant to be used only to mutate and query structures part of this image.
257          */
258         CRITICAL_SECTION    lock;
259 };
260
261 enum {
262         MONO_SECTION_TEXT,
263         MONO_SECTION_RSRC,
264         MONO_SECTION_RELOC,
265         MONO_SECTION_MAX
266 };
267
268 typedef struct {
269         GHashTable *hash;
270         char *data;
271         guint32 alloc_size; /* malloced bytes */
272         guint32 index;
273         guint32 offset; /* from start of metadata */
274 } MonoDynamicStream;
275
276 typedef struct {
277         guint32 alloc_rows;
278         guint32 rows;
279         guint8  row_size; /*  calculated later with column_sizes */
280         guint8  columns;
281         guint32 next_idx;
282         guint32 *values; /* rows * columns */
283 } MonoDynamicTable;
284
285 struct _MonoDynamicAssembly {
286         MonoAssembly assembly;
287         char *strong_name;
288         guint32 strong_name_size;
289         guint8 run;
290         guint8 save;
291 };
292
293 struct _MonoDynamicImage {
294         MonoImage image;
295         guint32 meta_size;
296         guint32 text_rva;
297         guint32 metadata_rva;
298         guint32 image_base;
299         guint32 cli_header_offset;
300         guint32 iat_offset;
301         guint32 idt_offset;
302         guint32 ilt_offset;
303         guint32 imp_names_offset;
304         struct {
305                 guint32 rva;
306                 guint32 size;
307                 guint32 offset;
308                 guint32 attrs;
309         } sections [MONO_SECTION_MAX];
310         GHashTable *typespec;
311         GHashTable *typeref;
312         GHashTable *handleref;
313         MonoGHashTable *tokens;
314         GHashTable *blob_cache;
315         GHashTable *standalonesig_cache;
316         GList *array_methods;
317         GPtrArray *gen_params;
318         MonoGHashTable *token_fixups;
319         GHashTable *method_to_table_idx;
320         GHashTable *field_to_table_idx;
321         GHashTable *method_aux_hash;
322         MonoGHashTable *generic_def_objects;
323         MonoGHashTable *methodspec;
324         gboolean run;
325         gboolean save;
326         gboolean initial_image;
327         guint32 pe_kind, machine;
328         char *strong_name;
329         guint32 strong_name_size;
330         char *win32_res;
331         guint32 win32_res_size;
332         guint8 *public_key;
333         int public_key_len;
334         MonoDynamicStream sheap;
335         MonoDynamicStream code; /* used to store method headers and bytecode */
336         MonoDynamicStream resources; /* managed embedded resources */
337         MonoDynamicStream us;
338         MonoDynamicStream blob;
339         MonoDynamicStream tstream;
340         MonoDynamicStream guid;
341         MonoDynamicTable tables [MONO_TABLE_NUM];
342 };
343
344 /* Contains information about assembly binding */
345 typedef struct _MonoAssemblyBindingInfo {
346         char *name;
347         char *culture;
348         guchar public_key_token [MONO_PUBLIC_KEY_TOKEN_LENGTH];
349         int major;
350         int minor;
351         AssemblyVersionSet old_version_bottom;
352         AssemblyVersionSet old_version_top;
353         AssemblyVersionSet new_version;
354         guint has_old_version_bottom : 1;
355         guint has_old_version_top : 1;
356         guint has_new_version : 1;
357         guint is_valid : 1;
358 } MonoAssemblyBindingInfo;
359
360 struct _MonoMethodHeader {
361         guint32      code_size;
362         const unsigned char  *code;
363         guint16      max_stack;
364         unsigned int num_clauses : 15;
365         /* if num_locals != 0, then the following apply: */
366         unsigned int init_locals : 1;
367         guint16      num_locals;
368         MonoExceptionClause *clauses;
369         MonoType    *locals [MONO_ZERO_LEN_ARRAY];
370 };
371
372 /* for use with allocated memory blocks (assumes alignment is to 8 bytes) */
373 guint mono_aligned_addr_hash (gconstpointer ptr) MONO_INTERNAL;
374
375 void
376 mono_image_check_for_module_cctor (MonoImage *image) MONO_INTERNAL;
377
378 gpointer
379 mono_image_alloc  (MonoImage *image, guint size) MONO_INTERNAL;
380
381 gpointer
382 mono_image_alloc0 (MonoImage *image, guint size) MONO_INTERNAL;
383
384 char*
385 mono_image_strdup (MonoImage *image, const char *s) MONO_INTERNAL;
386
387 GList*
388 g_list_prepend_image (MonoImage *image, GList *list, gpointer data) MONO_INTERNAL;
389
390 GSList*
391 g_slist_append_image (MonoImage *image, GSList *list, gpointer data) MONO_INTERNAL;
392
393 void
394 mono_image_lock (MonoImage *image) MONO_INTERNAL;
395
396 void
397 mono_image_unlock (MonoImage *image) MONO_INTERNAL;
398
399 gpointer
400 mono_image_property_lookup (MonoImage *image, gpointer subject, guint32 property) MONO_INTERNAL;
401
402 void
403 mono_image_property_insert (MonoImage *image, gpointer subject, guint32 property, gpointer value) MONO_INTERNAL;
404
405 void
406 mono_image_property_remove (MonoImage *image, gpointer subject) MONO_INTERNAL;
407
408
409 MonoType*
410 mono_metadata_get_shared_type (MonoType *type) MONO_INTERNAL;
411
412 void
413 mono_metadata_clean_for_image (MonoImage *image) MONO_INTERNAL;
414
415 void
416 mono_metadata_cleanup (void);
417
418 const char *   mono_meta_table_name              (int table) MONO_INTERNAL;
419 void           mono_metadata_compute_table_bases (MonoImage *meta) MONO_INTERNAL;
420
421 gboolean
422 mono_metadata_interfaces_from_typedef_full  (MonoImage             *image,
423                                                                                          guint32                table_index,
424                                                                                          MonoClass           ***interfaces,
425                                                                                          guint                 *count,
426                                                                                          MonoGenericContext    *context) MONO_INTERNAL;
427
428 MonoArrayType *
429 mono_metadata_parse_array_full              (MonoImage             *image,
430                                              MonoGenericContainer  *container,
431                                              const char            *ptr,
432                                              const char           **rptr) MONO_INTERNAL;
433
434 MonoType *
435 mono_metadata_parse_type_full               (MonoImage             *image,
436                                              MonoGenericContainer  *container,
437                                              MonoParseTypeMode      mode,
438                                              short                  opt_attrs,
439                                              const char            *ptr,
440                                              const char           **rptr);
441
442 MonoMethodSignature *
443 mono_metadata_parse_signature_full          (MonoImage             *image,
444                                              MonoGenericContainer  *generic_container,
445                                              guint32                token) MONO_INTERNAL;
446
447 MonoMethodSignature *
448 mono_metadata_parse_method_signature_full   (MonoImage             *image,
449                                              MonoGenericContainer  *generic_container,
450                                              int                     def,
451                                              const char             *ptr,
452                                              const char            **rptr);
453
454 MonoMethodHeader *
455 mono_metadata_parse_mh_full                 (MonoImage             *image,
456                                              MonoGenericContainer  *container,
457                                              const char            *ptr);
458
459 int* mono_metadata_get_param_attrs          (MonoImage *m, int def);
460
461 guint
462 mono_metadata_generic_context_hash          (const MonoGenericContext *context) MONO_INTERNAL;
463
464 gboolean
465 mono_metadata_generic_context_equal         (const MonoGenericContext *g1,
466                                              const MonoGenericContext *g2) MONO_INTERNAL;
467
468 MonoGenericInst *
469 mono_metadata_parse_generic_inst            (MonoImage             *image,
470                                              MonoGenericContainer  *container,
471                                              int                    count,
472                                              const char            *ptr,
473                                              const char           **rptr) MONO_INTERNAL;
474
475 MonoGenericInst *
476 mono_metadata_get_generic_inst              (int                    type_argc,
477                                              MonoType             **type_argv) MONO_INTERNAL;
478
479 MonoGenericClass *
480 mono_metadata_lookup_generic_class          (MonoClass             *gclass,
481                                              MonoGenericInst       *inst,
482                                              gboolean               is_dynamic) MONO_INTERNAL;
483
484 MonoGenericInst *
485 mono_metadata_inflate_generic_inst          (MonoGenericInst       *ginst,
486                                              MonoGenericContext    *context) MONO_INTERNAL;
487
488 void mono_dynamic_stream_reset  (MonoDynamicStream* stream) MONO_INTERNAL;
489 void mono_assembly_addref       (MonoAssembly *assembly) MONO_INTERNAL;
490 void mono_assembly_load_friends (MonoAssembly* ass) MONO_INTERNAL;
491 gboolean mono_assembly_has_skip_verification (MonoAssembly* ass) MONO_INTERNAL;
492
493 gboolean mono_public_tokens_are_equal (const unsigned char *pubt1, const unsigned char *pubt2) MONO_INTERNAL;
494
495 void mono_config_parse_publisher_policy (const char *filename, MonoAssemblyBindingInfo *binding_info) MONO_INTERNAL;
496
497 gboolean
498 mono_assembly_name_parse_full                (const char           *name,
499                                               MonoAssemblyName     *aname,
500                                               gboolean save_public_key,
501                                               gboolean *is_version_defined,
502                                                   gboolean *is_token_defined) MONO_INTERNAL;
503
504 guint32 mono_metadata_get_generic_param_row (MonoImage *image, guint32 token, guint32 *owner);
505
506 void mono_unload_interface_ids (MonoBitSet *bitset) MONO_INTERNAL;
507
508
509 MonoType *mono_metadata_type_dup (MonoImage *image, const MonoType *original) MONO_INTERNAL;
510 MonoMethodSignature  *mono_metadata_signature_dup_full (MonoImage *image,MonoMethodSignature *sig) MONO_INTERNAL;
511 MonoMethodSignature  *mono_metadata_signature_dup_mempool (MonoMemPool *mp, MonoMethodSignature *sig) MONO_INTERNAL;
512
513 MonoGenericInst *
514 mono_get_shared_generic_inst (MonoGenericContainer *container) MONO_INTERNAL;
515
516 int
517 mono_type_stack_size_internal (MonoType *t, int *align, gboolean allow_open) MONO_INTERNAL;
518
519 gboolean
520 mono_metadata_type_equal_full (MonoType *t1, MonoType *t2, gboolean signature_only) MONO_INTERNAL;
521
522 MonoMarshalSpec *
523 mono_metadata_parse_marshal_spec_full (MonoImage *image, const char *ptr) MONO_INTERNAL;
524
525 guint          mono_metadata_generic_inst_hash (gconstpointer data) MONO_INTERNAL;
526 gboolean       mono_metadata_generic_inst_equal (gconstpointer ka, gconstpointer kb) MONO_INTERNAL;
527
528 void
529 mono_metadata_field_info_with_mempool (
530                                           MonoImage *meta, 
531                                       guint32       table_index,
532                                       guint32      *offset,
533                                       guint32      *rva,
534                                       MonoMarshalSpec **marshal_spec);
535
536 MonoClassField*
537 mono_metadata_get_corresponding_field_from_generic_type_definition (MonoClassField *field) MONO_INTERNAL;
538
539 MonoEvent*
540 mono_metadata_get_corresponding_event_from_generic_type_definition (MonoEvent *event) MONO_INTERNAL;
541
542 MonoProperty*
543 mono_metadata_get_corresponding_property_from_generic_type_definition (MonoProperty *property) MONO_INTERNAL;
544
545 guint32
546 mono_metadata_signature_size (MonoMethodSignature *sig) MONO_INTERNAL;
547
548 #endif /* __MONO_METADATA_INTERNALS_H__ */
549