Re-Factor EventSource to Support Writing to EventPipe (#11435)
[platform/upstream/coreclr.git] / src / vm / mscorlib.cpp
1 // Licensed to the .NET Foundation under one or more agreements.
2 // The .NET Foundation licenses this file to you under the MIT license.
3 // See the LICENSE file in the project root for more information.
4 //
5
6
7 // 
8 // This file defines tables for references between VM and mscorlib.
9 //
10 // When compiling crossgen, this file is compiled with the FEATURE_XXX define settings matching the target.
11 // It allows us to strip features (e.g. refection only load) from crossgen without stripping them from the target.
12 //
13
14 #ifdef CROSSGEN_MSCORLIB
15 // Use minimal set of headers for crossgen
16 #include "windows.h"
17 #include "corinfo.h"
18 #else
19 #include "common.h"
20 #include "ecall.h"
21 #endif // CROSSGEN_MSCORLIB
22
23 #ifndef CROSSGEN_COMPILE
24 //
25 // Headers for all ECall entrypoints
26 //
27 #include "arraynative.h"
28 #include "stringnative.h"
29 #include "stringbuffer.h"
30 #include "objectnative.h"
31 #include "comdelegate.h"
32 #include "customattribute.h"
33 #include "comdynamic.h"
34 #include "excep.h"
35 #include "fcall.h"
36 #include "nlsinfo.h"
37 #include "clrconfignative.h"
38 #include "commodule.h"
39 #include "marshalnative.h"
40 #include "system.h"
41 #include "comutilnative.h"
42 #include "comsynchronizable.h"
43 #include "floatdouble.h"
44 #include "floatsingle.h"
45 #include "decimal.h"
46 #include "currency.h"
47 #include "comdatetime.h"
48 #include "number.h"
49 #include "compatibilityswitch.h"
50 #include "debugdebugger.h"
51 #include "assemblyname.hpp"
52 #include "assemblynative.hpp"
53 #include "comthreadpool.h"
54 #include "comwaithandle.h"
55 #include "nativeoverlapped.h"
56
57 #include "proftoeeinterfaceimpl.h"
58
59 #include "appdomainnative.hpp"
60 #include "arrayhelpers.h"
61 #include "runtimehandles.h"
62 #include "reflectioninvocation.h"
63 #include "managedmdimport.hpp"
64 #include "synchronizationcontextnative.h"
65 #include "commemoryfailpoint.h"
66 #include "typestring.h"
67 #include "comdependenthandle.h"
68 #include "weakreferencenative.h"
69 #include "varargsnative.h"
70
71 #ifdef MDA_SUPPORTED 
72 #include "mdaassistants.h"
73 #endif
74
75 #ifdef FEATURE_COMINTEROP
76 #include "variant.h"
77 #include "oavariant.h"
78 #include "registration.h"
79 #include "mngstdinterfaces.h"
80 #include "extensibleclassfactory.h"
81 #endif // FEATURE_COMINTEROP
82
83 #include "stubhelpers.h"
84 #include "ilmarshalers.h"
85
86 #ifdef FEATURE_MULTICOREJIT
87 #include "multicorejit.h"
88 #endif
89
90 #ifdef FEATURE_COMINTEROP
91 #include "windowsruntimebufferhelper.h"
92 #endif
93
94 #if defined(FEATURE_EVENTSOURCE_XPLAT)
95 #include "nativeeventsource.h"
96 #include "eventpipe.h"
97 #endif //defined(FEATURE_EVENTSOURCE_XPLAT)
98
99 #endif // CROSSGEN_MSCORLIB
100
101
102 #ifdef CROSSGEN_MSCORLIB
103
104 ///////////////////////////////////////////////////////////////////////////////
105 //
106 // Duplicate definitions of constants and datastructures required to define the tables
107 //
108
109 #define NumItems(s) (sizeof(s) / sizeof(s[0]))
110
111 #define GetEEFuncEntryPoint(pfn) 0x1001
112
113 enum {
114     FCFuncFlag_EndOfArray   = 0x01,
115     FCFuncFlag_HasSignature = 0x02,
116     FCFuncFlag_Unreferenced = 0x04, // Suppress unused fcall check
117     FCFuncFlag_QCall        = 0x08, // QCall - mscorlib.dll to mscorwks.dll transition implemented as PInvoke
118 };
119
120 struct ECClass
121 {
122     LPCSTR      m_szClassName;
123     LPCSTR      m_szNameSpace;
124     const LPVOID *  m_pECFunc;
125 };
126
127 struct HardCodedMetaSig
128 {
129     const BYTE* m_pMetaSig; // metasig prefixed with INT8 length:
130                             // length > 0 - resolved, lenght < 0 - has unresolved type references
131 };
132
133 enum BinderClassID
134 {
135 #define TYPEINFO(e,ns,c,s,g,ia,ip,if,im,gv)   CLASS__ ## e,
136 #include "cortypeinfo.h"
137 #undef TYPEINFO
138
139 #define DEFINE_CLASS(i,n,s)         CLASS__ ## i,
140 #include "mscorlib.h"
141
142     CLASS__MSCORLIB_COUNT,
143
144     CLASS__VOID     = CLASS__ELEMENT_TYPE_VOID,
145     CLASS__BOOLEAN  = CLASS__ELEMENT_TYPE_BOOLEAN,
146     CLASS__CHAR     = CLASS__ELEMENT_TYPE_CHAR,
147     CLASS__BYTE     = CLASS__ELEMENT_TYPE_U1,
148     CLASS__SBYTE    = CLASS__ELEMENT_TYPE_I1,
149     CLASS__INT16    = CLASS__ELEMENT_TYPE_I2,
150     CLASS__UINT16   = CLASS__ELEMENT_TYPE_U2,
151     CLASS__INT32    = CLASS__ELEMENT_TYPE_I4,
152     CLASS__UINT32   = CLASS__ELEMENT_TYPE_U4,
153     CLASS__INT64    = CLASS__ELEMENT_TYPE_I8,
154     CLASS__UINT64   = CLASS__ELEMENT_TYPE_U8,
155     CLASS__SINGLE   = CLASS__ELEMENT_TYPE_R4,
156     CLASS__DOUBLE   = CLASS__ELEMENT_TYPE_R8,
157     CLASS__STRING   = CLASS__ELEMENT_TYPE_STRING,
158     CLASS__TYPED_REFERENCE = CLASS__ELEMENT_TYPE_TYPEDBYREF,
159     CLASS__INTPTR   = CLASS__ELEMENT_TYPE_I,
160     CLASS__UINTPTR  = CLASS__ELEMENT_TYPE_U,
161     CLASS__OBJECT   = CLASS__ELEMENT_TYPE_OBJECT
162 };
163
164 struct MscorlibClassDescription
165 {
166     LPCSTR  nameSpace;
167     LPCSTR  name;
168 };
169
170 struct MscorlibMethodDescription
171 {
172     BinderClassID classID;
173     LPCSTR  name;
174     const HardCodedMetaSig * sig;
175 };
176
177 struct MscorlibFieldDescription
178 {
179     BinderClassID classID;
180     LPCSTR  name;
181 };
182
183 #endif // CROSSGEN_MSCORLIB
184
185
186 #ifdef CROSSGEN_MSCORLIB
187 // When compiling crossgen this namespace creates the second version of the tables than matches the target
188 namespace CrossGenMscorlib {
189 #endif
190
191
192 ///////////////////////////////////////////////////////////////////////////////
193 //
194 // Hardcoded Meta-Sig
195 //
196
197 //
198 // Helper enum with metasig lengths
199 //
200 // iterate over the metasig recursing into the complex types
201 #define DEFINE_METASIG(body)            body,
202 #define METASIG_ATOM(x)                 + 1
203 #define METASIG_RECURSE                 1
204 #define SM(varname, args, retval)       gsigl_SM_ ## varname = 1 + 1 retval args
205 #define IM(varname, args, retval)       gsigl_IM_ ## varname = 1 + 1 retval args
206 #define GM(varname, conv, n, args, retval) gsigl_GM_ ## varname = 1 + 1 + 1 + retval args
207 #define Fld(varname, val)               gsigl_Fld_ ## varname = 1 val
208 enum _gsigl {
209 #include "metasig.h"
210 };
211
212 //
213 // Helper enum with metasig argcount
214 //
215 // iterate over the metasig without recursing into the complex types
216 #define DEFINE_METASIG(body)            body,
217 #define METASIG_ATOM(x)                 + 1
218 #define METASIG_RECURSE                 0
219 #define SM(varname, args, retval)       gsigc_SM_ ## varname = 0 args
220 #define IM(varname, args, retval)       gsigc_IM_ ## varname = 0 args
221 #define GM(varname, conv, n, args, retval) gsigc_GM_ ## varname = 0 args
222 #define Fld(varname, val)               gsigc_Fld_ ## varname = 0
223 enum _gsigc {
224 #include "metasig.h"
225 };
226
227
228 //
229 // The actual array with the hardcoded metasig:
230 //
231 // There are 3 variations of the macros for Fields, Static Methods and Instance Methods.
232 //
233 // Each of them has 2 flavors: one for the fully baked signatures, and the other 
234 // for the signatures with unresolved type references
235 //
236 // The signatures with unresolved type references are marked with negative size, 
237 // and the pointer to them is non-const because of it will be overwritten with
238 // the pointer to the resolved signature at runtime.
239 //
240
241 #define DEFINE_METASIG(body)            body
242 #define DEFINE_METASIG_T(body)          _##body
243 #define METASIG_ATOM(x)                 x,
244 #define METASIG_RECURSE                 1
245
246 // define gsig_ ## varname before gsige_ ## varname to give a hint to the compiler about the desired layout
247
248 #define SM(varname, args, retval) extern const BYTE gsige_SM_ ## varname[];     \
249     const HardCodedMetaSig gsig_SM_ ## varname = { gsige_SM_ ## varname };      \
250     const BYTE gsige_SM_ ## varname[] = { gsigl_SM_ ## varname,                 \
251         IMAGE_CEE_CS_CALLCONV_DEFAULT, gsigc_SM_ ## varname, retval args };
252
253 #define IM(varname, args, retval) extern const BYTE gsige_IM_ ## varname[];     \
254     const HardCodedMetaSig gsig_IM_ ## varname = { gsige_IM_ ## varname };      \
255     const BYTE gsige_IM_ ## varname[] = { gsigl_IM_ ## varname,                 \
256         IMAGE_CEE_CS_CALLCONV_HASTHIS, gsigc_IM_ ## varname, retval args };
257
258 #define GM(varname, conv, n, args, retval) extern const BYTE gsige_GM_ ## varname[];    \
259     const HardCodedMetaSig gsig_GM_ ## varname = { gsige_GM_ ## varname };              \
260     const BYTE gsige_GM_ ## varname[] = { gsigl_GM_ ## varname,                         \
261         conv | IMAGE_CEE_CS_CALLCONV_GENERIC, n, gsigc_GM_ ## varname, retval args };
262
263 #define Fld(varname, val) extern const BYTE gsige_Fld_ ## varname[];            \
264     const HardCodedMetaSig gsig_Fld_ ## varname = { gsige_Fld_ ## varname };    \
265     const BYTE gsige_Fld_ ## varname[] = { gsigl_Fld_ ## varname,               \
266         IMAGE_CEE_CS_CALLCONV_FIELD, val };
267
268 #define _SM(varname, args, retval) extern const BYTE gsige_SM_ ## varname[];    \
269     HardCodedMetaSig gsig_SM_ ## varname = { gsige_SM_ ## varname };            \
270     const BYTE gsige_SM_ ## varname[] = { (BYTE) -gsigl_SM_ ## varname,         \
271         IMAGE_CEE_CS_CALLCONV_DEFAULT, gsigc_SM_ ## varname, retval args };
272
273 #define _IM(varname, args, retval) extern const BYTE gsige_IM_ ## varname[];    \
274     HardCodedMetaSig gsig_IM_ ## varname = { gsige_IM_ ## varname };            \
275     const BYTE gsige_IM_ ## varname[] = { (BYTE) -gsigl_IM_ ## varname,         \
276         IMAGE_CEE_CS_CALLCONV_HASTHIS, gsigc_IM_ ## varname, retval args };
277
278 #define _Fld(varname, val) extern const BYTE gsige_Fld_ ## varname[];           \
279     HardCodedMetaSig gsig_Fld_ ## varname = { gsige_Fld_ ## varname };          \
280     const BYTE gsige_Fld_ ## varname[] = { (BYTE) -gsigl_Fld_ ## varname,       \
281         IMAGE_CEE_CS_CALLCONV_FIELD, val };
282
283 #include "metasig.h"
284
285 #undef _SM
286 #undef _IM
287 #undef _Fld
288
289
290
291 #ifdef _DEBUG
292
293 //
294 // Make sure DEFINE_METASIG is used for signatures that do not reference other types
295 //
296 // counts number of type references in the signature and C_ASSERTs that 
297 // it is zero. An assertion failure results in error C2118: negative subscript.
298 #define DEFINE_METASIG(body)            body
299 #define DEFINE_METASIG_T(body)
300 #define METASIG_BODY(varname, types)    C_ASSERT(types 0 == 0);
301 #define METASIG_ATOM(x)                 0+
302 #define METASIG_RECURSE                 1
303 #define C(x)                            1+
304 #define g(x)                            1+
305 #include "metasig.h"
306
307 //
308 // Make sure DEFINE_METASIG_T is used only for signatures that reference 
309 // other types.
310 //
311 // counts number of type references in the signature and C_ASSERTs that 
312 // it is non zero. An assertion failure results in error C2118: negative subscript.
313 #define DEFINE_METASIG(body)
314 #define DEFINE_METASIG_T(body)          body
315 #define METASIG_BODY(varname, types)    C_ASSERT(types 0 != 0);
316 #define METASIG_ATOM(x)                 0+
317 #define METASIG_RECURSE                 1
318 #define C(x)                            1+
319 #define g(x)                            1+
320 #include "metasig.h"
321
322 #endif
323
324
325
326
327
328 ///////////////////////////////////////////////////////////////////////////////
329 //
330 // Mscorlib binder
331 //
332
333 // Extern definitions so that binder.cpp can see these tables
334 extern const MscorlibClassDescription c_rgMscorlibClassDescriptions[];
335 extern const USHORT c_nMscorlibClassDescriptions;
336
337 extern const MscorlibMethodDescription c_rgMscorlibMethodDescriptions[];
338 extern const USHORT c_nMscorlibMethodDescriptions;
339
340 extern const MscorlibFieldDescription c_rgMscorlibFieldDescriptions[];
341 extern const USHORT c_nMscorlibFieldDescriptions;
342
343 const MscorlibClassDescription c_rgMscorlibClassDescriptions[] =
344 {
345     #define TYPEINFO(e,ns,c,s,g,ia,ip,if,im,gv)   { ns, c },
346     #include "cortypeinfo.h"
347     #undef TYPEINFO
348     
349     #define DEFINE_CLASS(i,n,s)        { g_ ## n ## NS, # s },
350     #include "namespace.h"
351     #include "mscorlib.h"
352     
353     // Include all exception types here that are defined in mscorlib.  Omit exceptions defined elsewhere.
354     #define DEFINE_EXCEPTION(ns, reKind, bHRformessage, ...) { ns , # reKind },
355     #define DEFINE_EXCEPTION_HR_WINRT_ONLY(ns, reKind, ...)
356     #define DEFINE_EXCEPTION_IN_OTHER_FX_ASSEMBLY(ns, reKind, assemblySimpleName, publicKeyToken, bHRformessage, ...)
357     #include "rexcep.h"
358 };
359 const USHORT c_nMscorlibClassDescriptions = NumItems(c_rgMscorlibClassDescriptions);
360
361 #define gsig_NoSig (*(HardCodedMetaSig *)NULL)
362
363 const MscorlibMethodDescription c_rgMscorlibMethodDescriptions[] =
364 {
365     #define DEFINE_METHOD(c,i,s,g)          { CLASS__ ## c , # s, & gsig_ ## g },
366     #include "mscorlib.h"
367 };
368 const USHORT c_nMscorlibMethodDescriptions = NumItems(c_rgMscorlibMethodDescriptions) + 1;
369
370 const MscorlibFieldDescription c_rgMscorlibFieldDescriptions[] =
371 {
372     #define DEFINE_FIELD(c,i,s)           { CLASS__ ## c , # s },
373     #include "mscorlib.h"
374 };
375 const USHORT c_nMscorlibFieldDescriptions = NumItems(c_rgMscorlibFieldDescriptions) + 1;
376
377
378
379
380
381 ///////////////////////////////////////////////////////////////////////////////
382 //
383 // ECalls
384 //
385
386 // When compiling crossgen, we only need the target version of the ecall tables
387 #if !defined(CROSSGEN_COMPILE) || defined(CROSSGEN_MSCORLIB)
388
389 #ifdef CROSSGEN_COMPILE
390
391 #define QCFuncElement(name,impl) \
392     FCFuncFlag_QCall + FCFuncFlags(CORINFO_INTRINSIC_Illegal, ECall::InvalidDynamicFCallId), NULL, (LPVOID)name,
393
394 #define FCFuncFlags(intrinsicID, dynamicID) \
395     (BYTE*)( (((BYTE)intrinsicID) << 16) )
396
397 #else
398
399 #define QCFuncElement(name,impl) \
400     FCFuncFlag_QCall + FCFuncFlags(CORINFO_INTRINSIC_Illegal, ECall::InvalidDynamicFCallId), (LPVOID)(impl), (LPVOID)name,
401
402 #define FCFuncFlags(intrinsicID, dynamicID) \
403     (BYTE*)( (((BYTE)intrinsicID) << 16) + (((BYTE)dynamicID) << 24) )
404
405 #endif
406
407 #define FCFuncElement(name, impl) FCFuncFlags(CORINFO_INTRINSIC_Illegal, ECall::InvalidDynamicFCallId), \
408     (LPVOID)GetEEFuncEntryPoint(impl), (LPVOID)name,
409
410 #define FCFuncElementSig(name,sig,impl) \
411     FCFuncFlag_HasSignature + FCFuncElement(name, impl) (LPVOID)sig,
412
413 #define FCIntrinsic(name,impl,intrinsicID) FCFuncFlags(intrinsicID, ECall::InvalidDynamicFCallId), \
414     (LPVOID)GetEEFuncEntryPoint(impl), (LPVOID)name,
415
416 #define FCIntrinsicSig(name,sig,impl,intrinsicID) \
417     FCFuncFlag_HasSignature + FCIntrinsic(name,impl,intrinsicID) (LPVOID)sig,
418
419 #define FCDynamic(name,intrinsicID,dynamicID) FCFuncFlags(intrinsicID, dynamicID), \
420     NULL, (LPVOID)name,
421
422 #define FCDynamicSig(name,sig,intrinsicID,dynamicID) \
423     FCFuncFlag_HasSignature + FCDynamic(name,intrinsicID,dynamicID) (LPVOID)sig,
424
425 #define FCUnreferenced FCFuncFlag_Unreferenced +
426
427 #define FCFuncStart(name) static const LPVOID name[] = {
428 #define FCFuncEnd() FCFuncFlag_EndOfArray + FCFuncFlags(CORINFO_INTRINSIC_Illegal, ECall::InvalidDynamicFCallId) };
429
430 #include "ecalllist.h"
431
432
433 // Extern definitions so that ecall.cpp can see these tables
434 extern const ECClass c_rgECClasses[];
435 extern const int c_nECClasses;
436
437 const ECClass c_rgECClasses[] =
438 {
439 #define FCClassElement(name,namespace,funcs) {name, namespace, funcs},
440 #include "ecalllist.h"
441 };  // c_rgECClasses[]
442
443 const int c_nECClasses = NumItems(c_rgECClasses);
444
445 #endif // !CROSSGEN_COMPILE && CROSSGEN_MSCORLIB
446
447
448 #ifdef CROSSGEN_MSCORLIB
449 }; // namespace CrossGenMscorlib
450 #endif