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.
8 // FCall is a high-performance alternative to ECall. Unlike ECall, FCall
9 // methods do not necessarily create a frame. Jitted code calls directly
10 // to the FCall entry point. It is possible to do operations that need
11 // to have a frame within an FCall, you need to manually set up the frame
12 // before you do such operations.
14 // It is illegal to cause a GC or EH to happen in an FCALL before setting
15 // up a frame. To prevent accidentally violating this rule, FCALLs turn
16 // on BEGINGCFORBID, which insures that these things can't happen in a
17 // checked build without causing an ASSERTE. Once you set up a frame,
18 // this state is turned off as long as the frame is active, and then is
19 // turned on again when the frame is torn down. This mechanism should
20 // be sufficient to insure that the rules are followed.
22 // In general you set up a frame by using the following macros
24 // HELPER_METHOD_FRAME_BEGIN_RET*() // Use If the FCALL has a return value
25 // HELPER_METHOD_FRAME_BEGIN*() // Use If FCALL does not return a value
26 // HELPER_METHOD_FRAME_END*()
28 // These macros introduce a scope which is protected by an HelperMethodFrame.
29 // In this scope you can do EH or GC. There are rules associated with
30 // their use. In particular
32 // 1) These macros can only be used in the body of a FCALL (that is
33 // something using the FCIMPL* or HCIMPL* macros for their decaration.
35 // 2) You may not perform a 'return' within this scope..
37 // Compile time errors occur if you try to violate either of these rules.
39 // The frame that is set up does NOT protect any GC variables (in particular the
40 // arguments of the FCALL. Thus you need to do an explicit GCPROTECT once the
41 // frame is established if you need to protect an argument. There are flavors
42 // of HELPER_METHOD_FRAME that protect a certain number of GC variables. For
45 // HELPER_METHOD_FRAME_BEGIN_RET_2(arg1, arg2)
47 // will protect the GC variables arg1, and arg2 as well as erecting the frame.
49 // Another invariant that you must be aware of is the need to poll to see if
50 // a GC is needed by some other thread. Unless the FCALL is VERY short,
51 // every code path through the FCALL must do such a poll. The important
52 // thing here is that a poll will cause a GC, and thus you can only do it
53 // when all you GC variables are protected. To make things easier
54 // HELPER_METHOD_FRAMES that protect things automatically do this poll.
55 // If you don't need to protect anything HELPER_METHOD_FRAME_BEGIN_0
56 // will also do the poll.
58 // Sometimes it is convenient to do the poll a the end of the frame, you
59 // can use HELPER_METHOD_FRAME_BEGIN_NOPOLL and HELPER_METHOD_FRAME_END_POLL
60 // to do the poll at the end. If somewhere in the middle is the best
61 // place you can do that too with HELPER_METHOD_POLL()
63 // You don't need to erect a helper method frame to do a poll. FC_GC_POLL
64 // can do this (remember all your GC refs will be trashed).
66 // Finally if your method is VERY small, you can get away without a poll,
67 // you have to use FC_GC_POLL_NOT_NEEDED to mark this.
70 // It is possible to set up the frame as the first operation in the FCALL and
71 // tear it down as the last operation before returning. This works and is
72 // reasonably efficient (as good as an ECall), however, if it is the case that
73 // you can defer the setup of the frame to an unlikely code path (exception path)
74 // that is much better.
76 // If you defer setup of the frame, all codepaths leading to the frame setup
77 // must be wrapped with PERMIT_HELPER_METHOD_FRAME_BEGIN/END. These block
78 // certain compiler optimizations that interfere with the delayed frame setup.
79 // These macros are automatically included in the HCIMPL, FCIMPL, and frame
82 // <TODO>TODO: we should have a way of doing a trial allocation (an allocation that
83 // will fail if it would cause a GC). That way even FCALLs that need to allocate
84 // would not necessarily need to set up a frame. </TODO>
86 // It is common to only need to set up a frame in order to throw an exception.
87 // While this can be done by doing
89 // HELPER_METHOD_FRAME_BEGIN() // Use if FCALL does not return a value
90 // COMPlusThrow(execpt);
91 // HELPER_METHOD_FRAME_END()
93 // It is more efficient (in space) to use convenience macro FCTHROW that does
94 // this for you (sets up a frame, and does the throw).
98 // Since FCALLS have to conform to the EE calling conventions and not to C
99 // calling conventions, FCALLS, need to be declared using special macros (FCIMPL*)
100 // that implement the correct calling conventions. There are variants of these
101 // macros depending on the number of args, and sometimes the types of the
104 //------------------------------------------------------------------------
105 // A very simple example:
107 // FCIMPL2(INT32, Div, INT32 x, INT32 y)
110 // FCThrow(kDivideByZeroException);
116 // *** WATCH OUT FOR THESE GOTCHAS: ***
117 // ------------------------------------
118 // - In your FCDECL & FCIMPL protos, don't declare a param as type OBJECTREF
119 // or any of its deriveds. This will break on the checked build because
120 // __fastcall doesn't enregister C++ objects (which OBJECTREF is).
121 // Instead, you need to do something like;
123 // FCIMPL(.., .., Object* pObject0)
124 // OBJECTREF pObject = ObjectToOBJECTREF(pObject0);
127 // For similar reasons, use Object* rather than OBJECTREF as a return type.
128 // Consider either using ObjectToOBJECTREF or calling VALIDATEOBJECTREF
129 // to make sure your Object* is valid.
131 // - FCThrow() must be called directly from your FCall impl function: it
132 // cannot be called from a subfunction. Calling from a subfunction breaks
133 // the VC code parsing workaround that lets us recover the callee saved registers.
134 // Fortunately, you'll get a compile error complaining about an
135 // unknown variable "__me".
137 // - If your FCall returns VOID, you must use FCThrowVoid() rather than
138 // FCThrow(). This is because FCThrow() has to generate an unexecuted
139 // "return" statement for the code parser.
141 // - On x86, if first and/or second argument of your FCall cannot be passed
142 // in either of the __fastcall registers (ECX/EDX), you must use "V" versions
143 // of FCDECL and FCIMPL macros to enregister arguments correctly. Some of the
144 // most common types that fit this requirement are 64-bit values (i.e. INT64 or
145 // UINT64) and floating-point values (i.e. FLOAT or DOUBLE). For example, FCDECL3_IVI
146 // must be used for FCalls that take 3 arguments and 2nd argument is INT64 and
147 // FDECL2_VV must be used for FCalls that take 2 arguments where both are FLOAT.
149 // - You may use structs for protecting multiple OBJECTREF's simultaneously.
150 // In these cases, you must use a variant of a helper method frame with PROTECT
151 // in the name, to ensure all the OBJECTREF's in the struct get protected.
152 // Also, initialize all the OBJECTREF's first. Like this:
154 // FCIMPL4(Object*, COMNlsInfo::nativeChangeCaseString, LocaleIDObject* localeUNSAFE,
155 // INT_PTR pNativeTextInfo, StringObject* pStringUNSAFE, CLR_BOOL bIsToUpper)
157 // [ignoring CONTRACT for now]
160 // STRINGREF pResult;
161 // STRINGREF pString;
162 // LOCALEIDREF pLocale;
164 // gc.pResult = NULL;
165 // gc.pString = ObjectToSTRINGREF(pStringUNSAFE);
166 // gc.pLocale = (LOCALEIDREF)ObjectToOBJECTREF(localeUNSAFE);
168 // HELPER_METHOD_FRAME_BEGIN_RET_PROTECT(gc)
170 // If you forgot the PROTECT part, the macro will only protect the first OBJECTREF,
171 // introducing a subtle GC hole in your code. Fortunately, we now issue a
172 // compile-time error if you forget.
176 // An FCall target uses __fastcall or some other calling convention to
177 // match the IL calling convention exactly. Thus, a call to FCall is a direct
178 // call to the target w/ no intervening stub or frame.
180 // The tricky part is when FCThrow is called. FCThrow must generate
181 // a proper method frame before allocating and throwing the exception.
182 // To do this, it must recover several things:
184 // - The location of the FCIMPL's return address (since that's
185 // where the frame will be based.)
187 // - The on-entry values of the callee-saved regs; which must
188 // be recorded in the frame so that GC can update them.
189 // Depending on how VC compiles your FCIMPL, those values are still
190 // in the original registers or saved on the stack.
192 // To figure out which, FCThrow() generates the code:
194 // while (NULL == __FCThrow(__me, ...)) {};
197 // The "return" statement will never execute; but its presence guarantees
198 // that VC will follow the __FCThrow() call with a VC epilog
199 // that restores the callee-saved registers using a pretty small
200 // and predictable set of Intel opcodes. __FCThrow() parses this
201 // epilog and simulates its execution to recover the callee saved
204 // The while loop is to prevent the compiler from doing tail call optimizations.
205 // The helper frame interpretter needs the frame to be present.
207 // - The MethodDesc* that this FCall implements. This MethodDesc*
208 // is part of the frame and ensures that the FCall will appear
209 // in the exception's stack trace. To get this, FCDECL declares
210 // a static local __me, initialized to point to the FC target itself.
211 // This address is exactly what's stored in the ECall lookup tables;
212 // so __FCThrow() simply does a reverse lookup on that table to recover
221 #include "runtimeexceptionkind.h"
222 #include "debugreturn.h"
223 #include "stackprobe.h"
225 //==============================================================================================
226 // These macros defeat compiler optimizations that might mix nonvolatile
227 // register loads and stores with other code in the function body. This
228 // creates problems for the frame setup code, which assumes that any
229 // nonvolatiles that are saved at the point of the frame setup will be
230 // re-loaded when the frame is popped.
232 // Currently this is only known to be an issue on AMD64. It's uncertain
233 // whether it is an issue on x86.
234 //==============================================================================================
236 #if defined(_TARGET_AMD64_) && !defined(FEATURE_PAL)
239 // On AMD64 this is accomplished by including a setjmp anywhere in a function.
240 // Doesn't matter whether it is reachable or not, and in fact in optimized
241 // builds the setjmp is removed altogether.
246 // Use of setjmp is temporary, we will eventually have compiler intrinsics to
247 // disable the optimizations. Besides, we don't actually execute setjmp in
248 // these macros (or anywhere else in the VM on AMD64).
250 #pragma warning(disable:4611) // interaction between '_setjmp' and C++ object destruction is non-portable
254 // Linked list of unmanaged methods preceeding a HelperMethodFrame push. This
255 // is linked onto the current Thread. Each list entry is stack-allocated so it
256 // can be associated with an unmanaged frame. Each unmanaged frame needs to be
257 // associated with at least one list entry.
259 struct HelperMethodFrameCallerList
261 HelperMethodFrameCallerList *pCaller;
266 // Resets the Thread state at a new managed -> fcall transition.
268 class FCallTransitionState
272 FCallTransitionState () NOT_DEBUG({ LIMITED_METHOD_CONTRACT; });
273 ~FCallTransitionState () NOT_DEBUG({ LIMITED_METHOD_CONTRACT; });
278 HelperMethodFrameCallerList *m_pPreviousHelperMethodFrameCallerList;
283 // Pushes/pops state for each caller.
285 class PermitHelperMethodFrameState
289 PermitHelperMethodFrameState () NOT_DEBUG({ LIMITED_METHOD_CONTRACT; });
290 ~PermitHelperMethodFrameState () NOT_DEBUG({ LIMITED_METHOD_CONTRACT; });
292 static VOID CheckHelperMethodFramePermitted () NOT_DEBUG({ LIMITED_METHOD_CONTRACT; });
297 HelperMethodFrameCallerList m_ListEntry;
302 // Resets the Thread state after the HelperMethodFrame is pushed. At this
303 // point, the HelperMethodFrame is capable of unwinding to the managed code,
304 // so we can reset the Thread state for any nested fcalls.
306 class CompletedFCallTransitionState
310 CompletedFCallTransitionState () NOT_DEBUG({ LIMITED_METHOD_CONTRACT; });
311 ~CompletedFCallTransitionState () NOT_DEBUG({ LIMITED_METHOD_CONTRACT; });
316 HelperMethodFrameCallerList *m_pLastHelperMethodFrameCallerList;
320 #define PERMIT_HELPER_METHOD_FRAME_BEGIN() \
323 PermitHelperMethodFrameState ___PermitHelperMethodFrameState;
325 #define PERMIT_HELPER_METHOD_FRAME_END() \
334 #define FCALL_TRANSITION_BEGIN() \
335 FCallTransitionState ___FCallTransitionState; \
336 PERMIT_HELPER_METHOD_FRAME_BEGIN();
338 #define FCALL_TRANSITION_END() \
339 PERMIT_HELPER_METHOD_FRAME_END();
341 #define CHECK_HELPER_METHOD_FRAME_PERMITTED() \
342 PermitHelperMethodFrameState::CheckHelperMethodFramePermitted(); \
343 CompletedFCallTransitionState ___CompletedFCallTransitionState;
345 #else // unsupported processor
347 #define PERMIT_HELPER_METHOD_FRAME_BEGIN()
348 #define PERMIT_HELPER_METHOD_FRAME_END()
349 #define FCALL_TRANSITION_BEGIN()
350 #define FCALL_TRANSITION_END()
351 #define CHECK_HELPER_METHOD_FRAME_PERMITTED()
353 #endif // unsupported processor
355 //==============================================================================================
356 // This is where FCThrow ultimately ends up. Never call this directly.
357 // Use the FCThrow() macros. __FCThrowArgument is the helper to throw ArgumentExceptions
358 // with a resource taken from the managed resource manager.
359 //==============================================================================================
360 LPVOID __FCThrow(LPVOID me, enum RuntimeExceptionKind reKind, UINT resID, LPCWSTR arg1, LPCWSTR arg2, LPCWSTR arg3);
361 LPVOID __FCThrowArgument(LPVOID me, enum RuntimeExceptionKind reKind, LPCWSTR argumentName, LPCWSTR resourceName);
363 //==============================================================================================
364 // FDECLn: A set of macros for generating header declarations for FC targets.
365 // Use FIMPLn for the actual body.
366 //==============================================================================================
368 // Note: on the x86, these defs reverse all but the first two arguments
369 // (IL stack calling convention is reversed from __fastcall.)
372 // Calling convention for varargs
373 #define F_CALL_VA_CONV __cdecl
378 // Choose the appropriate calling convention for FCALL helpers on the basis of the JIT calling convention
380 #define F_CALL_CONV __attribute__((cdecl, regparm(3)))
382 // GCC fastcall convention (simulated via stdcall) is different from MSVC fastcall convention. GCC can use up
383 // to 3 registers to store parameters. The registers used are EAX, EDX, ECX. Dummy parameters and reordering
384 // of the actual parameters in the FCALL signature is used to make the calling convention to look like in MSVC.
385 #define SWIZZLE_REGARG_ORDER
387 #define F_CALL_CONV __fastcall
390 #define SWIZZLE_STKARG_ORDER
391 #else // _TARGET_X86_
394 // non-x86 platforms don't have messed-up calling convention swizzling
397 #endif // !_TARGET_X86_
399 #ifdef SWIZZLE_STKARG_ORDER
400 #ifdef SWIZZLE_REGARG_ORDER
402 #define FCDECL0(rettype, funcname) rettype F_CALL_CONV funcname()
403 #define FCDECL1(rettype, funcname, a1) rettype F_CALL_CONV funcname(int /* EAX */, int /* EDX */, a1)
404 #define FCDECL1_V(rettype, funcname, a1) rettype F_CALL_CONV funcname(int /* EAX */, int /* EDX */, int /* ECX */, a1)
405 #define FCDECL2(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1)
406 #define FCDECL2VA(rettype, funcname, a1, a2) rettype F_CALL_VA_CONV funcname(a1, a2, ...)
407 #define FCDECL2_VV(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(int /* EAX */, int /* EDX */, int /* ECX */, a2, a1)
408 #define FCDECL2_VI(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(int /* EAX */, int /* EDX */, a2, a1)
409 #define FCDECL2_IV(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(int /* EAX */, int /* EDX */, a1, a2)
410 #define FCDECL3(rettype, funcname, a1, a2, a3) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a3)
411 #define FCDECL3_IIV(rettype, funcname, a1, a2, a3) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a3)
412 #define FCDECL3_VII(rettype, funcname, a1, a2, a3) rettype F_CALL_CONV funcname(int /* EAX */, a3, a2, a1)
413 #define FCDECL3_IVV(rettype, funcname, a1, a2, a3) rettype F_CALL_CONV funcname(int /* EAX */, int /* EDX */, a1, a3, a2)
414 #define FCDECL3_IVI(rettype, funcname, a1, a2, a3) rettype F_CALL_CONV funcname(int /* EAX */, a3, a1, a2)
415 #define FCDECL3_VVI(rettype, funcname, a1, a2, a3) rettype F_CALL_CONV funcname(int /* EAX */, int /* EDX */, a3, a2, a1)
416 #define FCDECL4(rettype, funcname, a1, a2, a3, a4) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a4, a3)
417 #define FCDECL5(rettype, funcname, a1, a2, a3, a4, a5) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a5, a4, a3)
418 #define FCDECL6(rettype, funcname, a1, a2, a3, a4, a5, a6) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a6, a5, a4, a3)
419 #define FCDECL7(rettype, funcname, a1, a2, a3, a4, a5, a6, a7) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a7, a6, a5, a4, a3)
420 #define FCDECL8(rettype, funcname, a1, a2, a3, a4, a5, a6, a7, a8) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a8, a7, a6, a5, a4, a3)
421 #define FCDECL9(rettype, funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a9, a8, a7, a6, a5, a4, a3)
422 #define FCDECL10(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a10, a9, a8, a7, a6, a5, a4, a3)
423 #define FCDECL11(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a11, a10, a9, a8, a7, a6, a5, a4, a3)
424 #define FCDECL12(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a12, a11, a10, a9, a8, a7, a6, a5, a4, a3)
425 #define FCDECL13(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a13, a12, a11, a10, a9, a8, a7, a6, a5, a4, a3)
426 #define FCDECL14(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a14, a13, a12, a11, a10, a9, a8, a7, a6, a5, a4, a3)
428 #define FCDECL5_IVI(rettype, funcname, a1, a2, a3, a4, a5) rettype F_CALL_CONV funcname(int /* EAX */, a3, a1, a5, a4, a2)
429 #define FCDECL5_VII(rettype, funcname, a1, a2, a3, a4, a5) rettype F_CALL_CONV funcname(int /* EAX */, a3, a2, a5, a4, a1)
431 #else // SWIZZLE_REGARG_ORDER
433 #define FCDECL0(rettype, funcname) rettype F_CALL_CONV funcname()
434 #define FCDECL1(rettype, funcname, a1) rettype F_CALL_CONV funcname(a1)
435 #define FCDECL1_V(rettype, funcname, a1) rettype F_CALL_CONV funcname(a1)
436 #define FCDECL2(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(a1, a2)
437 #define FCDECL2VA(rettype, funcname, a1, a2) rettype F_CALL_VA_CONV funcname(a1, a2, ...)
438 #define FCDECL2_VV(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(a2, a1)
439 #define FCDECL2_VI(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(a2, a1)
440 #define FCDECL2_IV(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(a1, a2)
441 #define FCDECL3(rettype, funcname, a1, a2, a3) rettype F_CALL_CONV funcname(a1, a2, a3)
442 #define FCDECL3_IIV(rettype, funcname, a1, a2, a3) rettype F_CALL_CONV funcname(a1, a2, a3)
443 #define FCDECL3_VII(rettype, funcname, a1, a2, a3) rettype F_CALL_CONV funcname(a2, a3, a1)
444 #define FCDECL3_IVV(rettype, funcname, a1, a2, a3) rettype F_CALL_CONV funcname(a1, a3, a2)
445 #define FCDECL3_IVI(rettype, funcname, a1, a2, a3) rettype F_CALL_CONV funcname(a1, a3, a2)
446 #define FCDECL3_VVI(rettype, funcname, a1, a2, a3) rettype F_CALL_CONV funcname(a2, a1, a3)
447 #define FCDECL4(rettype, funcname, a1, a2, a3, a4) rettype F_CALL_CONV funcname(a1, a2, a4, a3)
448 #define FCDECL5(rettype, funcname, a1, a2, a3, a4, a5) rettype F_CALL_CONV funcname(a1, a2, a5, a4, a3)
449 #define FCDECL6(rettype, funcname, a1, a2, a3, a4, a5, a6) rettype F_CALL_CONV funcname(a1, a2, a6, a5, a4, a3)
450 #define FCDECL7(rettype, funcname, a1, a2, a3, a4, a5, a6, a7) rettype F_CALL_CONV funcname(a1, a2, a7, a6, a5, a4, a3)
451 #define FCDECL8(rettype, funcname, a1, a2, a3, a4, a5, a6, a7, a8) rettype F_CALL_CONV funcname(a1, a2, a8, a7, a6, a5, a4, a3)
452 #define FCDECL9(rettype, funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9) rettype F_CALL_CONV funcname(a1, a2, a9, a8, a7, a6, a5, a4, a3)
453 #define FCDECL10(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) rettype F_CALL_CONV funcname(a1, a2, a10, a9, a8, a7, a6, a5, a4, a3)
454 #define FCDECL11(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11) rettype F_CALL_CONV funcname(a1, a2, a11, a10, a9, a8, a7, a6, a5, a4, a3)
455 #define FCDECL12(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12) rettype F_CALL_CONV funcname(a1, a2, a12, a11, a10, a9, a8, a7, a6, a5, a4, a3)
456 #define FCDECL13(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13) rettype F_CALL_CONV funcname(a1, a2, a13, a12, a11, a10, a9, a8, a7, a6, a5, a4, a3)
457 #define FCDECL14(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14) rettype F_CALL_CONV funcname(a1, a2, a14, a13, a12, a11, a10, a9, a8, a7, a6, a5, a4, a3)
459 #define FCDECL5_IVI(rettype, funcname, a1, a2, a3, a4, a5) rettype F_CALL_CONV funcname(a1, a3, a5, a4, a2)
460 #define FCDECL5_VII(rettype, funcname, a1, a2, a3, a4, a5) rettype F_CALL_CONV funcname(a2, a3, a5, a4, a1)
462 #endif // !SWIZZLE_REGARG_ORDER
466 // don't use something like this... directly calling an FCALL from within the runtime breaks stackwalking because
467 // the FCALL reverse mapping only gets established in ECall::GetFCallImpl and that codepath is circumvented by
468 // directly calling and FCALL
469 // See below for usage of FC_CALL_INNER (used in SecurityStackWalk::Check presently)
471 #define FCCALL0(funcname) funcname()
472 #define FCCALL1(funcname, a1) funcname(a1)
473 #define FCCALL2(funcname, a1, a2) funcname(a1, a2)
474 #define FCCALL3(funcname, a1, a2, a3) funcname(a1, a2, a3)
475 #define FCCALL4(funcname, a1, a2, a3, a4) funcname(a1, a2, a4, a3)
476 #define FCCALL5(funcname, a1, a2, a3, a4, a5) funcname(a1, a2, a5, a4, a3)
477 #define FCCALL6(funcname, a1, a2, a3, a4, a5, a6) funcname(a1, a2, a6, a5, a4, a3)
478 #define FCCALL7(funcname, a1, a2, a3, a4, a5, a6, a7) funcname(a1, a2, a7, a6, a5, a4, a3)
479 #define FCCALL8(funcname, a1, a2, a3, a4, a5, a6, a7, a8) funcname(a1, a2, a8, a7, a6, a5, a4, a3)
480 #define FCCALL9(funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9) funcname(a1, a2, a9, a8, a7, a6, a5, a4, a3)
481 #define FCCALL10(funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) funcname(a1, a2, a10, a9, a8, a7, a6, a5, a4, a3)
482 #define FCCALL11(funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11) funcname(a1, a2, a11, a10, a9, a8, a7, a6, a5, a4, a3)
483 #define FCCALL12(funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12) funcname(a1, a2, a12, a11, a10, a9, a8, a7, a6, a5, a4, a3)
486 #else // !SWIZZLE_STKARG_ORDER
488 #define FCDECL0(rettype, funcname) rettype F_CALL_CONV funcname()
489 #define FCDECL1(rettype, funcname, a1) rettype F_CALL_CONV funcname(a1)
490 #define FCDECL1_V(rettype, funcname, a1) rettype F_CALL_CONV funcname(a1)
491 #define FCDECL2(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(a1, a2)
492 #define FCDECL2VA(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(a1, a2, ...)
493 #define FCDECL2_VV(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(a1, a2)
494 #define FCDECL2_VI(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(a1, a2)
495 #define FCDECL2_IV(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(a1, a2)
496 #define FCDECL3(rettype, funcname, a1, a2, a3) rettype F_CALL_CONV funcname(a1, a2, a3)
497 #define FCDECL3_IIV(rettype, funcname, a1, a2, a3) rettype F_CALL_CONV funcname(a1, a2, a3)
498 #define FCDECL3_VII(rettype, funcname, a1, a2, a3) rettype F_CALL_CONV funcname(a1, a2, a3)
499 #define FCDECL3_IVV(rettype, funcname, a1, a2, a3) rettype F_CALL_CONV funcname(a1, a2, a3)
500 #define FCDECL3_IVI(rettype, funcname, a1, a2, a3) rettype F_CALL_CONV funcname(a1, a2, a3)
501 #define FCDECL3_VVI(rettype, funcname, a1, a2, a3) rettype F_CALL_CONV funcname(a1, a2, a3)
502 #define FCDECL4(rettype, funcname, a1, a2, a3, a4) rettype F_CALL_CONV funcname(a1, a2, a3, a4)
503 #define FCDECL5(rettype, funcname, a1, a2, a3, a4, a5) rettype F_CALL_CONV funcname(a1, a2, a3, a4, a5)
504 #define FCDECL6(rettype, funcname, a1, a2, a3, a4, a5, a6) rettype F_CALL_CONV funcname(a1, a2, a3, a4, a5, a6)
505 #define FCDECL7(rettype, funcname, a1, a2, a3, a4, a5, a6, a7) rettype F_CALL_CONV funcname(a1, a2, a3, a4, a5, a6, a7)
506 #define FCDECL8(rettype, funcname, a1, a2, a3, a4, a5, a6, a7, a8) rettype F_CALL_CONV funcname(a1, a2, a3, a4, a5, a6, a7, a8)
507 #define FCDECL9(rettype, funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9) rettype F_CALL_CONV funcname(a1, a2, a3, a4, a5, a6, a7, a8, a9)
508 #define FCDECL10(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) rettype F_CALL_CONV funcname(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)
509 #define FCDECL11(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11) rettype F_CALL_CONV funcname(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11)
510 #define FCDECL12(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12) rettype F_CALL_CONV funcname(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12)
511 #define FCDECL13(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13) rettype F_CALL_CONV funcname(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13)
512 #define FCDECL14(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14) rettype F_CALL_CONV funcname(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14)
514 #define FCDECL5_IVI(rettype, funcname, a1, a2, a3, a4, a5) rettype F_CALL_CONV funcname(a1, a2, a3, a4, a5)
515 #define FCDECL5_VII(rettype, funcname, a1, a2, a3, a4, a5) rettype F_CALL_CONV funcname(a1, a2, a3, a4, a5)
517 #endif // !SWIZZLE_STKARG_ORDER
519 #define HELPER_FRAME_DECL(x) FrameWithCookie<HelperMethodFrame_##x##OBJ> __helperframe
521 // use the capture state machinery if the architecture has one
523 // For a normal build we create a loop (see explaination on RestoreState below)
524 // We don't want a loop here for PREFAST since that causes
525 // warning 263: Using _alloca in a loop
526 // And we can't use DEBUG_OK_TO_RETURN for PREFAST because the PREFAST version
527 // requires that you already be in a DEBUG_ASSURE_NO_RETURN_BEGIN scope
529 #define HelperMethodFrame_0OBJ HelperMethodFrame
530 #define HELPER_FRAME_ARGS(attribs) __me, attribs
531 #define FORLAZYMACHSTATE(x) x
533 #if defined(_PREFAST_)
534 #define FORLAZYMACHSTATE_BEGINLOOP(x) x
535 #define FORLAZYMACHSTATE_ENDLOOP(x)
536 #define FORLAZYMACHSTATE_DEBUG_OK_TO_RETURN_BEGIN
537 #define FORLAZYMACHSTATE_DEBUG_OK_TO_RETURN_END
539 #define FORLAZYMACHSTATE_BEGINLOOP(x) x do
540 #define FORLAZYMACHSTATE_ENDLOOP(x) while(x)
541 #define FORLAZYMACHSTATE_DEBUG_OK_TO_RETURN_BEGIN DEBUG_OK_TO_RETURN_BEGIN(LAZYMACHSTATE)
542 #define FORLAZYMACHSTATE_DEBUG_OK_TO_RETURN_END DEBUG_OK_TO_RETURN_END(LAZYMACHSTATE)
545 // BEGIN: before gcpoll
546 //FCallGCCanTriggerNoDtor __fcallGcCanTrigger;
547 //__fcallGcCanTrigger.Enter();
550 //__fcallGcCanTrigger.Leave(__FUNCTION__, __FILE__, __LINE__);
552 // We have to put DEBUG_OK_TO_RETURN_BEGIN around the FORLAZYMACHSTATE
553 // to allow the HELPER_FRAME to be installed inside an SO_INTOLERANT region
554 // which does not allow a return. The return is used by FORLAZYMACHSTATE
555 // to capture the state, but is not an actual return, so it is ok.
556 #define HELPER_METHOD_FRAME_BEGIN_EX_BODY(ret, helperFrame, gcpoll, allowGC) \
557 FORLAZYMACHSTATE_BEGINLOOP(int alwaysZero = 0;) \
559 INDEBUG(static BOOL __haveCheckedRestoreState = FALSE;) \
560 PERMIT_HELPER_METHOD_FRAME_BEGIN(); \
561 CHECK_HELPER_METHOD_FRAME_PERMITTED(); \
563 FORLAZYMACHSTATE_DEBUG_OK_TO_RETURN_BEGIN; \
564 FORLAZYMACHSTATE(CAPTURE_STATE(__helperframe.MachineState(), ret);) \
565 FORLAZYMACHSTATE_DEBUG_OK_TO_RETURN_END; \
566 INDEBUG(__helperframe.SetAddrOfHaveCheckedRestoreState(&__haveCheckedRestoreState)); \
567 DEBUG_ASSURE_NO_RETURN_BEGIN(HELPER_METHOD_FRAME); \
568 INCONTRACT(FCallGCCanTrigger::Enter()); \
569 __helperframe.Push(); \
570 MAKE_CURRENT_THREAD_AVAILABLE_EX(__helperframe.GetThread()); \
572 #define HELPER_METHOD_FRAME_BEGIN_EX(ret, helperFrame, gcpoll, allowGC) \
573 HELPER_METHOD_FRAME_BEGIN_EX_BODY(ret, helperFrame, gcpoll, allowGC) \
574 TESTHOOKCALL(AppDomainCanBeUnloaded(GET_THREAD()->GetDomain()->GetId().m_dwId,!allowGC)); \
575 /* <TODO>TODO TURN THIS ON!!! </TODO> */ \
577 INSTALL_MANAGED_EXCEPTION_DISPATCHER; \
578 INSTALL_UNWIND_AND_CONTINUE_HANDLER_FOR_HMF(&__helperframe);
580 #define HELPER_METHOD_FRAME_BEGIN_EX_NOTHROW(ret, helperFrame, gcpoll, allowGC, probeFailExpr) \
581 HELPER_METHOD_FRAME_BEGIN_EX_BODY(ret, helperFrame, gcpoll, allowGC) \
582 /* <TODO>TODO TURN THIS ON!!! </TODO> */ \
584 BEGIN_SO_INTOLERANT_CODE_NOTHROW(GET_THREAD(), probeFailExpr);
587 // The while(__helperframe.RestoreState() needs a bit of explanation.
588 // The issue is insuring that the same machine state (which registers saved)
589 // exists when the machine state is probed (when the frame is created, and
590 // when it is actually used (when the frame is popped. We do this by creating
591 // a flow of control from use to def. Note that 'RestoreState' always returns false
592 // we never actually loop, but the compiler does not know that, and thus
593 // will be forced to make the keep the state of register spills the same at
594 // the two locations.
596 #define HELPER_METHOD_FRAME_END_EX_BODY(gcpoll,allowGC) \
597 /* <TODO>TODO TURN THIS ON!!! </TODO> */ \
599 __helperframe.Pop(); \
600 DEBUG_ASSURE_NO_RETURN_END(HELPER_METHOD_FRAME); \
601 INCONTRACT(FCallGCCanTrigger::Leave(__FUNCTION__, __FILE__, __LINE__)); \
602 FORLAZYMACHSTATE(alwaysZero = \
603 HelperMethodFrameRestoreState(INDEBUG_COMMA(&__helperframe) \
604 __helperframe.MachineState());) \
605 PERMIT_HELPER_METHOD_FRAME_END() \
606 } FORLAZYMACHSTATE_ENDLOOP(alwaysZero);
608 #define HELPER_METHOD_FRAME_END_EX(gcpoll,allowGC) \
609 UNINSTALL_UNWIND_AND_CONTINUE_HANDLER; \
610 UNINSTALL_MANAGED_EXCEPTION_DISPATCHER; \
611 TESTHOOKCALL(AppDomainCanBeUnloaded(GET_THREAD()->GetDomain()->GetId().m_dwId,!allowGC)); \
612 HELPER_METHOD_FRAME_END_EX_BODY(gcpoll,allowGC);
614 #define HELPER_METHOD_FRAME_END_EX_NOTHROW(gcpoll,allowGC) \
615 END_SO_INTOLERANT_CODE; \
616 HELPER_METHOD_FRAME_END_EX_BODY(gcpoll,allowGC);
618 #define HELPER_METHOD_FRAME_BEGIN_ATTRIB(attribs) \
619 HELPER_METHOD_FRAME_BEGIN_EX( \
621 HELPER_FRAME_DECL(0)(HELPER_FRAME_ARGS(attribs)), \
622 HELPER_METHOD_POLL(),TRUE)
624 #define HELPER_METHOD_FRAME_BEGIN_0() \
625 HELPER_METHOD_FRAME_BEGIN_ATTRIB(Frame::FRAME_ATTR_NONE)
627 #define HELPER_METHOD_FRAME_BEGIN_ATTRIB_NOPOLL(attribs) \
628 HELPER_METHOD_FRAME_BEGIN_EX( \
630 HELPER_FRAME_DECL(0)(HELPER_FRAME_ARGS(attribs)), \
633 #define HELPER_METHOD_FRAME_BEGIN_NOPOLL() HELPER_METHOD_FRAME_BEGIN_ATTRIB_NOPOLL(Frame::FRAME_ATTR_NONE)
635 #define HELPER_METHOD_FRAME_BEGIN_ATTRIB_1(attribs, arg1) \
636 static_assert(sizeof(arg1) == sizeof(OBJECTREF), "GC protecting structs of multiple OBJECTREFs requires a PROTECT variant of the HELPER METHOD FRAME macro");\
637 HELPER_METHOD_FRAME_BEGIN_EX( \
639 HELPER_FRAME_DECL(1)(HELPER_FRAME_ARGS(attribs), \
640 (OBJECTREF*) &arg1), \
641 HELPER_METHOD_POLL(),TRUE)
643 #define HELPER_METHOD_FRAME_BEGIN_1(arg1) HELPER_METHOD_FRAME_BEGIN_ATTRIB_1(Frame::FRAME_ATTR_NONE, arg1)
645 #define HELPER_METHOD_FRAME_BEGIN_ATTRIB_2(attribs, arg1, arg2) \
646 static_assert(sizeof(arg1) == sizeof(OBJECTREF), "GC protecting structs of multiple OBJECTREFs requires a PROTECT variant of the HELPER METHOD FRAME macro");\
647 static_assert(sizeof(arg2) == sizeof(OBJECTREF), "GC protecting structs of multiple OBJECTREFs requires a PROTECT variant of the HELPER METHOD FRAME macro");\
648 HELPER_METHOD_FRAME_BEGIN_EX( \
650 HELPER_FRAME_DECL(2)(HELPER_FRAME_ARGS(attribs), \
651 (OBJECTREF*) &arg1, (OBJECTREF*) &arg2), \
652 HELPER_METHOD_POLL(),TRUE)
654 #define HELPER_METHOD_FRAME_BEGIN_2(arg1, arg2) HELPER_METHOD_FRAME_BEGIN_ATTRIB_2(Frame::FRAME_ATTR_NONE, arg1, arg2)
656 #define HELPER_METHOD_FRAME_BEGIN_PROTECT(gc) \
657 HELPER_METHOD_FRAME_BEGIN_EX( \
659 HELPER_FRAME_DECL(PROTECT)(HELPER_FRAME_ARGS(Frame::FRAME_ATTR_NONE), \
660 (OBJECTREF*)&(gc), sizeof(gc)/sizeof(OBJECTREF)), \
661 HELPER_METHOD_POLL(),TRUE)
663 #define HELPER_METHOD_FRAME_BEGIN_RET_ATTRIB_NOPOLL(attribs) \
664 HELPER_METHOD_FRAME_BEGIN_EX( \
666 HELPER_FRAME_DECL(0)(HELPER_FRAME_ARGS(attribs)), \
669 #define HELPER_METHOD_FRAME_BEGIN_RET_VC_ATTRIB_NOPOLL(attribs) \
670 HELPER_METHOD_FRAME_BEGIN_EX( \
672 HELPER_FRAME_DECL(0)(HELPER_FRAME_ARGS(attribs)), \
675 #define HELPER_METHOD_FRAME_BEGIN_RET_ATTRIB(attribs) \
676 HELPER_METHOD_FRAME_BEGIN_EX( \
678 HELPER_FRAME_DECL(0)(HELPER_FRAME_ARGS(attribs)), \
679 HELPER_METHOD_POLL(),TRUE)
681 #define HELPER_METHOD_FRAME_BEGIN_RET_0() \
682 HELPER_METHOD_FRAME_BEGIN_RET_ATTRIB(Frame::FRAME_ATTR_NONE)
684 #define HELPER_METHOD_FRAME_BEGIN_RET_VC_0() \
685 HELPER_METHOD_FRAME_BEGIN_EX( \
687 HELPER_FRAME_DECL(0)(HELPER_FRAME_ARGS(Frame::FRAME_ATTR_NONE)), \
688 HELPER_METHOD_POLL(),TRUE)
690 #define HELPER_METHOD_FRAME_BEGIN_RET_ATTRIB_1(attribs, arg1) \
691 static_assert(sizeof(arg1) == sizeof(OBJECTREF), "GC protecting structs of multiple OBJECTREFs requires a PROTECT variant of the HELPER METHOD FRAME macro");\
692 HELPER_METHOD_FRAME_BEGIN_EX( \
694 HELPER_FRAME_DECL(1)(HELPER_FRAME_ARGS(attribs), \
695 (OBJECTREF*) &arg1), \
696 HELPER_METHOD_POLL(),TRUE)
698 #define HELPER_METHOD_FRAME_BEGIN_RET_NOTHROW_1(probeFailExpr, arg1) \
699 static_assert(sizeof(arg1) == sizeof(OBJECTREF), "GC protecting structs of multiple OBJECTREFs requires a PROTECT variant of the HELPER METHOD FRAME macro");\
700 HELPER_METHOD_FRAME_BEGIN_EX_NOTHROW( \
702 HELPER_FRAME_DECL(1)(HELPER_FRAME_ARGS(Frame::FRAME_ATTR_NO_THREAD_ABORT), \
703 (OBJECTREF*) &arg1), \
704 HELPER_METHOD_POLL(), TRUE, probeFailExpr)
706 #define HELPER_METHOD_FRAME_BEGIN_RET_VC_ATTRIB_1(attribs, arg1) \
707 static_assert(sizeof(arg1) == sizeof(OBJECTREF), "GC protecting structs of multiple OBJECTREFs requires a PROTECT variant of the HELPER METHOD FRAME macro");\
708 HELPER_METHOD_FRAME_BEGIN_EX( \
710 HELPER_FRAME_DECL(1)(HELPER_FRAME_ARGS(attribs), \
711 (OBJECTREF*) &arg1), \
712 HELPER_METHOD_POLL(),TRUE)
714 #define HELPER_METHOD_FRAME_BEGIN_RET_ATTRIB_2(attribs, arg1, arg2) \
715 static_assert(sizeof(arg1) == sizeof(OBJECTREF), "GC protecting structs of multiple OBJECTREFs requires a PROTECT variant of the HELPER METHOD FRAME macro");\
716 static_assert(sizeof(arg2) == sizeof(OBJECTREF), "GC protecting structs of multiple OBJECTREFs requires a PROTECT variant of the HELPER METHOD FRAME macro");\
717 HELPER_METHOD_FRAME_BEGIN_EX( \
719 HELPER_FRAME_DECL(2)(HELPER_FRAME_ARGS(attribs), \
720 (OBJECTREF*) &arg1, (OBJECTREF*) &arg2), \
721 HELPER_METHOD_POLL(),TRUE)
723 #define HELPER_METHOD_FRAME_BEGIN_RET_VC_ATTRIB_2(attribs, arg1, arg2) \
724 static_assert(sizeof(arg1) == sizeof(OBJECTREF), "GC protecting structs of multiple OBJECTREFs requires a PROTECT variant of the HELPER METHOD FRAME macro");\
725 static_assert(sizeof(arg2) == sizeof(OBJECTREF), "GC protecting structs of multiple OBJECTREFs requires a PROTECT variant of the HELPER METHOD FRAME macro");\
726 HELPER_METHOD_FRAME_BEGIN_EX( \
728 HELPER_FRAME_DECL(2)(HELPER_FRAME_ARGS(attribs), \
729 (OBJECTREF*) &arg1, (OBJECTREF*) &arg2), \
730 HELPER_METHOD_POLL(),TRUE)
732 #define HELPER_METHOD_FRAME_BEGIN_RET_ATTRIB_PROTECT(attribs, gc) \
733 HELPER_METHOD_FRAME_BEGIN_EX( \
735 HELPER_FRAME_DECL(PROTECT)(HELPER_FRAME_ARGS(attribs), \
736 (OBJECTREF*)&(gc), sizeof(gc)/sizeof(OBJECTREF)), \
737 HELPER_METHOD_POLL(),TRUE)
739 #define HELPER_METHOD_FRAME_BEGIN_RET_VC_NOPOLL() \
740 HELPER_METHOD_FRAME_BEGIN_RET_VC_ATTRIB_NOPOLL(Frame::FRAME_ATTR_NONE)
742 #define HELPER_METHOD_FRAME_BEGIN_RET_NOPOLL() \
743 HELPER_METHOD_FRAME_BEGIN_RET_ATTRIB_NOPOLL(Frame::FRAME_ATTR_NONE)
745 #define HELPER_METHOD_FRAME_BEGIN_RET_1(arg1) \
746 static_assert(sizeof(arg1) == sizeof(OBJECTREF), "GC protecting structs of multiple OBJECTREFs requires a PROTECT variant of the HELPER METHOD FRAME macro");\
747 HELPER_METHOD_FRAME_BEGIN_RET_ATTRIB_1(Frame::FRAME_ATTR_NONE, arg1)
749 #define HELPER_METHOD_FRAME_BEGIN_RET_VC_1(arg1) \
750 static_assert(sizeof(arg1) == sizeof(OBJECTREF), "GC protecting structs of multiple OBJECTREFs requires a PROTECT variant of the HELPER METHOD FRAME macro");\
751 HELPER_METHOD_FRAME_BEGIN_RET_VC_ATTRIB_1(Frame::FRAME_ATTR_NONE, arg1)
753 #define HELPER_METHOD_FRAME_BEGIN_RET_2(arg1, arg2) \
754 static_assert(sizeof(arg1) == sizeof(OBJECTREF), "GC protecting structs of multiple OBJECTREFs requires a PROTECT variant of the HELPER METHOD FRAME macro");\
755 static_assert(sizeof(arg2) == sizeof(OBJECTREF), "GC protecting structs of multiple OBJECTREFs requires a PROTECT variant of the HELPER METHOD FRAME macro");\
756 HELPER_METHOD_FRAME_BEGIN_RET_ATTRIB_2(Frame::FRAME_ATTR_NONE, arg1, arg2)
758 #define HELPER_METHOD_FRAME_BEGIN_RET_VC_2(arg1, arg2) \
759 static_assert(sizeof(arg1) == sizeof(OBJECTREF), "GC protecting structs of multiple OBJECTREFs requires a PROTECT variant of the HELPER METHOD FRAME macro");\
760 static_assert(sizeof(arg2) == sizeof(OBJECTREF), "GC protecting structs of multiple OBJECTREFs requires a PROTECT variant of the HELPER METHOD FRAME macro");\
761 HELPER_METHOD_FRAME_BEGIN_RET_VC_ATTRIB_2(Frame::FRAME_ATTR_NONE, arg1, arg2)
763 #define HELPER_METHOD_FRAME_BEGIN_RET_PROTECT(gc) \
764 HELPER_METHOD_FRAME_BEGIN_RET_ATTRIB_PROTECT(Frame::FRAME_ATTR_NONE, gc)
767 #define HELPER_METHOD_FRAME_END() HELPER_METHOD_FRAME_END_EX({},FALSE)
768 #define HELPER_METHOD_FRAME_END_POLL() HELPER_METHOD_FRAME_END_EX(HELPER_METHOD_POLL(),TRUE)
769 #define HELPER_METHOD_FRAME_END_NOTHROW()HELPER_METHOD_FRAME_END_EX_NOTHROW({},FALSE)
771 // This is the fastest way to do a GC poll if you have already erected a HelperMethodFrame
772 #define HELPER_METHOD_POLL() { __helperframe.Poll(); INCONTRACT(__fCallCheck.SetDidPoll()); }
774 // The HelperMethodFrame knows how to get its return address. Let other code get at it, too.
775 // (Uses comma operator to call InsureInit & discard result.
776 #define HELPER_METHOD_FRAME_GET_RETURN_ADDRESS() \
777 ( static_cast<UINT_PTR>( (__helperframe.InsureInit(false, NULL)), (__helperframe.MachineState()->GetRetAddr()) ) )
779 // Very short routines, or routines that are guarenteed to force GC or EH
780 // don't need to poll the GC. USE VERY SPARINGLY!!!
781 #define FC_GC_POLL_NOT_NEEDED() INCONTRACT(__fCallCheck.SetNotNeeded())
783 Object* FC_GCPoll(void* me, Object* objToProtect = NULL);
785 #define FC_GC_POLL_EX(ret) \
787 INCONTRACT(Thread::TriggersGC(GetThread());) \
788 INCONTRACT(__fCallCheck.SetDidPoll();) \
789 if (g_TrapReturningThreads.LoadWithoutBarrier()) \
791 if (FC_GCPoll(__me)) \
793 while (0 == FC_NO_TAILCALL) { }; /* side effect the compile can't remove */ \
797 #define FC_GC_POLL() FC_GC_POLL_EX(;)
798 #define FC_GC_POLL_RET() FC_GC_POLL_EX(0)
800 #define FC_GC_POLL_AND_RETURN_OBJREF(obj) \
802 INCONTRACT(__fCallCheck.SetDidPoll();) \
803 Object* __temp = OBJECTREFToObject(obj); \
804 if (g_TrapReturningThreads.LoadWithoutBarrier()) \
806 __temp = FC_GCPoll(__me, __temp); \
807 while (0 == FC_NO_TAILCALL) { }; /* side effect the compile can't remove */ \
812 #if defined(ENABLE_CONTRACTS)
813 #define FC_CAN_TRIGGER_GC() FCallGCCanTrigger::Enter()
814 #define FC_CAN_TRIGGER_GC_END() FCallGCCanTrigger::Leave(__FUNCTION__, __FILE__, __LINE__)
816 #define FC_CAN_TRIGGER_GC_HAVE_THREAD(thread) FCallGCCanTrigger::Enter(thread)
817 #define FC_CAN_TRIGGER_GC_HAVE_THREADEND(thread) FCallGCCanTrigger::Leave(thread, __FUNCTION__, __FILE__, __LINE__)
819 // turns on forbidGC for the lifetime of the instance
824 ForbidGC(const char *szFile, int lineNum);
828 // this little helper class checks to make certain
829 // 1) ForbidGC is set throughout the routine.
830 // 2) Sometime during the routine, a GC poll is done
832 class FCallCheck : public ForbidGC {
834 FCallCheck(const char *szFile, int lineNum);
836 void SetDidPoll() {LIMITED_METHOD_CONTRACT; didGCPoll = true; }
837 void SetNotNeeded() {LIMITED_METHOD_CONTRACT; notNeeded = true; }
841 DWORD unbreakableLockCount;
843 bool didGCPoll; // GC poll was done
844 bool notNeeded; // GC poll not needed
845 unsigned __int64 startTicks; // tick count at begining of FCall
848 // FC_COMMON_PROLOG is used for both FCalls and HCalls
849 #define FC_COMMON_PROLOG(target, assertFn) \
850 /* The following line has to be first. We do not want to trash last error */ \
851 DWORD __lastError = ::GetLastError(); \
852 static void* __cache = 0; \
853 assertFn(__cache, (LPVOID)target); \
855 Thread *_pThread = GetThread(); \
856 Thread::ObjectRefFlush(_pThread); \
857 /*_ASSERTE (_pThread->IsSOTolerant() ||*/ \
858 /* _pThread->HasThreadStateNC(Thread::TSNC_DisableSOCheckInHCALL)); */ \
860 FCallCheck __fCallCheck(__FILE__, __LINE__); \
861 FCALL_TRANSITION_BEGIN(); \
862 ::SetLastError(__lastError); \
864 void FCallAssert(void*& cache, void* target);
865 void HCallAssert(void*& cache, void* target);
868 #define FC_COMMON_PROLOG(target, assertFn) FCALL_TRANSITION_BEGIN()
869 #define FC_CAN_TRIGGER_GC()
870 #define FC_CAN_TRIGGER_GC_END()
871 #endif // ENABLE_CONTRACTS
874 // Macros that allows fcall to be split into two function to avoid the helper frame overhead on common fast
877 // The helper routine needs to know the name of the routine that called it so that it can look up the name of
878 // the managed routine this code is associted with (for managed stack traces). This is passed with the
879 // FC_INNER_PROLOG macro.
881 // The helper can set up a HELPER_METHOD_FRAME, but should pass the
882 // Frame::FRAME_ATTR_EXACT_DEPTH|Frame::FRAME_ATTR_CAPTURE_DEPTH_2 which indicates the exact number of
883 // unwinds to do to get back to managed code. Currently we only support depth 2 which means that the
884 // HELPER_METHOD_FRAME needs to be set up in the function directly called by the FCALL. The helper should
885 // use the NOINLINE macro to prevent the compiler from inlining it into the FCALL (which would obviously
886 // mess up the unwind count).
888 // The other invarient that needs to hold is that the epilog walker needs to be able to get from the call to
889 // the helper routine to the end of the FCALL using trivial heurisitics. The easiest (and only supported)
890 // way of doing this is to place your helper right before a return (eg at the end of the method). Generally
891 // this is not a problem at all, since the FCALL itself will pick off some common case and then tail-call to
892 // the helper for everything else. You must use the code:FC_INNER_RETURN macros to do the call, to insure
893 // that the C++ compiler does not tail-call optimize the call to the inner function and mess up the stack
896 // see code:ObjectNative::GetClass for an example
898 #define FC_INNER_PROLOG(outerfuncname) \
900 __me = GetEEFuncEntryPointMacro(outerfuncname); \
901 FC_CAN_TRIGGER_GC(); \
902 INCONTRACT(FCallCheck __fCallCheck(__FILE__, __LINE__));
904 // This variant should be used for inner fcall functions that have the
905 // __me value passed as an argument to the function. This allows
906 // inner functions to be shared across multiple fcalls.
907 #define FC_INNER_PROLOG_NO_ME_SETUP() \
908 FC_CAN_TRIGGER_GC(); \
909 INCONTRACT(FCallCheck __fCallCheck(__FILE__, __LINE__));
911 #define FC_INNER_EPILOG() \
912 FC_CAN_TRIGGER_GC_END();
914 // If you are using FC_INNER, and you are tail calling to the helper method (a common case), then you need
915 // to use the FC_INNER_RETURN macros (there is one for methods that return a value and another if the
916 // function returns void). This macro's purpose is to inhibit any tail calll optimization the C++ compiler
917 // might do, which would otherwise confuse the epilog walker.
919 // * See #FC_INNER for more
920 extern int FC_NO_TAILCALL;
921 #define FC_INNER_RETURN(type, expr) \
922 type __retVal = expr; \
923 while (0 == FC_NO_TAILCALL) { }; /* side effect the compile can't remove */ \
926 #define FC_INNER_RETURN_VOID(stmt) \
928 while (0 == FC_NO_TAILCALL) { }; /* side effect the compile can't remove */ \
931 //==============================================================================================
932 // FIMPLn: A set of macros for generating the proto for the actual
933 // implementation (use FDECLN for header protos.)
935 // The hidden "__me" variable lets us recover the original MethodDesc*
936 // so any thrown exceptions will have the correct stack trace. FCThrow()
937 // passes this along to __FCThrowInternal().
938 //==============================================================================================
940 #define GetEEFuncEntryPointMacro(func) ((LPVOID)(func))
942 #define FCIMPL_PROLOG(funcname) \
944 __me = GetEEFuncEntryPointMacro(funcname); \
945 FC_COMMON_PROLOG(__me, FCallAssert)
948 #if defined(_DEBUG) && !defined(CROSSGEN_COMPILE) && !defined(__GNUC__)
949 // Build the list of all fcalls signatures. It is used in binder.cpp to verify
950 // compatibility of managed and unmanaged fcall signatures. The check is currently done
952 #define CHECK_FCALL_SIGNATURE
955 #ifdef CHECK_FCALL_SIGNATURE
958 FCSigCheck(void* fnc, char* sig)
960 LIMITED_METHOD_CONTRACT;
963 next = g_pFCSigCheck;
964 g_pFCSigCheck = this;
971 static FCSigCheck* g_pFCSigCheck;
974 #define FCSIGCHECK(funcname, signature) \
975 static FCSigCheck UNIQUE_LABEL(FCSigCheck)(GetEEFuncEntryPointMacro(funcname), signature);
977 #else // CHECK_FCALL_SIGNATURE
979 #define FCSIGCHECK(funcname, signature)
981 #endif // !CHECK_FCALL_SIGNATURE
984 #ifdef SWIZZLE_STKARG_ORDER
985 #ifdef SWIZZLE_REGARG_ORDER
987 #define FCIMPL0(rettype, funcname) rettype F_CALL_CONV funcname() { FCIMPL_PROLOG(funcname)
988 #define FCIMPL1(rettype, funcname, a1) rettype F_CALL_CONV funcname(int /* EAX */, int /* EDX */, a1) { FCIMPL_PROLOG(funcname)
989 #define FCIMPL1_V(rettype, funcname, a1) rettype F_CALL_CONV funcname(int /* EAX */, int /* EDX */, int /* ECX */, a1) { FCIMPL_PROLOG(funcname)
990 #define FCIMPL2(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1) { FCIMPL_PROLOG(funcname)
991 #define FCIMPL2_VV(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(int /* EAX */, int /* EDX */, int /* ECX */, a2, a1) { FCIMPL_PROLOG(funcname)
992 #define FCIMPL2_VI(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(int /* EAX */, int /* EDX */, a2, a1) { FCIMPL_PROLOG(funcname)
993 #define FCIMPL2_IV(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(int /* EAX */, int /* EDX */, a1, a2) { FCIMPL_PROLOG(funcname)
994 #define FCIMPL3(rettype, funcname, a1, a2, a3) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a3) { FCIMPL_PROLOG(funcname)
995 #define FCIMPL3_IIV(rettype, funcname, a1, a2, a3) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a3) { FCIMPL_PROLOG(funcname)
996 #define FCIMPL3_VII(rettype, funcname, a1, a2, a3) rettype F_CALL_CONV funcname(int /* EAX */, a3, a2, a1) { FCIMPL_PROLOG(funcname)
997 #define FCIMPL3_IVV(rettype, funcname, a1, a2, a3) rettype F_CALL_CONV funcname(int /* EAX */, int /* EDX */, a1, a3, a2) { FCIMPL_PROLOG(funcname)
998 #define FCIMPL3_IVI(rettype, funcname, a1, a2, a3) rettype F_CALL_CONV funcname(int /* EAX */, a3, a1, a2) { FCIMPL_PROLOG(funcname)
999 #define FCIMPL3_VVI(rettype, funcname, a1, a2, a3) rettype F_CALL_CONV funcname(int /* EAX */, int /* EDX */, a3, a2, a1) { FCIMPL_PROLOG(funcname)
1000 #define FCIMPL4(rettype, funcname, a1, a2, a3, a4) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a4, a3) { FCIMPL_PROLOG(funcname)
1001 #define FCIMPL5(rettype, funcname, a1, a2, a3, a4, a5) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a5, a4, a3) { FCIMPL_PROLOG(funcname)
1002 #define FCIMPL6(rettype, funcname, a1, a2, a3, a4, a5, a6) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a6, a5, a4, a3) { FCIMPL_PROLOG(funcname)
1003 #define FCIMPL7(rettype, funcname, a1, a2, a3, a4, a5, a6, a7) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a7, a6, a5, a4, a3) { FCIMPL_PROLOG(funcname)
1004 #define FCIMPL8(rettype, funcname, a1, a2, a3, a4, a5, a6, a7, a8) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a8, a7, a6, a5, a4, a3) { FCIMPL_PROLOG(funcname)
1005 #define FCIMPL9(rettype, funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a9, a8, a7, a6, a5, a4, a3) { FCIMPL_PROLOG(funcname)
1006 #define FCIMPL10(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a10, a9, a8, a7, a6, a5, a4, a3) { FCIMPL_PROLOG(funcname)
1007 #define FCIMPL11(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a11, a10, a9, a8, a7, a6, a5, a4, a3) { FCIMPL_PROLOG(funcname)
1008 #define FCIMPL12(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a12, a11, a10, a9, a8, a7, a6, a5, a4, a3) { FCIMPL_PROLOG(funcname)
1009 #define FCIMPL13(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a13, a12, a11, a10, a9, a8, a7, a6, a5, a4, a3) { FCIMPL_PROLOG(funcname)
1010 #define FCIMPL14(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a14, a13, a12, a11, a10, a9, a8, a7, a6, a5, a4, a3) { FCIMPL_PROLOG(funcname)
1012 #define FCIMPL5_IVI(rettype, funcname, a1, a2, a3, a4, a5) rettype F_CALL_CONV funcname(int /* EAX */, a3, a1, a5, a4, a2) { FCIMPL_PROLOG(funcname)
1013 #define FCIMPL5_VII(rettype, funcname, a1, a2, a3, a4, a5) rettype F_CALL_CONV funcname(int /* EAX */, a3, a2, a5, a4, a1) { FCIMPL_PROLOG(funcname)
1015 #else // SWIZZLE_REGARG_ORDER
1017 #define FCIMPL0(rettype, funcname) FCSIGCHECK(funcname, #rettype) \
1018 rettype F_CALL_CONV funcname() { FCIMPL_PROLOG(funcname)
1019 #define FCIMPL1(rettype, funcname, a1) FCSIGCHECK(funcname, #rettype "," #a1) \
1020 rettype F_CALL_CONV funcname(a1) { FCIMPL_PROLOG(funcname)
1021 #define FCIMPL1_V(rettype, funcname, a1) FCSIGCHECK(funcname, #rettype "," "V" #a1) \
1022 rettype F_CALL_CONV funcname(a1) { FCIMPL_PROLOG(funcname)
1023 #define FCIMPL2(rettype, funcname, a1, a2) FCSIGCHECK(funcname, #rettype "," #a1 "," #a2) \
1024 rettype F_CALL_CONV funcname(a1, a2) { FCIMPL_PROLOG(funcname)
1025 #define FCIMPL2VA(rettype, funcname, a1, a2) FCSIGCHECK(funcname, #rettype "," #a1 "," #a2 "," "...") \
1026 rettype F_CALL_VA_CONV funcname(a1, a2, ...) { FCIMPL_PROLOG(funcname)
1027 #define FCIMPL2_VV(rettype, funcname, a1, a2) FCSIGCHECK(funcname, #rettype "," "V" #a1 "," "V" #a2) \
1028 rettype F_CALL_CONV funcname(a2, a1) { FCIMPL_PROLOG(funcname)
1029 #define FCIMPL2_VI(rettype, funcname, a1, a2) FCSIGCHECK(funcname, #rettype "," "V" #a1 "," #a2) \
1030 rettype F_CALL_CONV funcname(a2, a1) { FCIMPL_PROLOG(funcname)
1031 #define FCIMPL2_IV(rettype, funcname, a1, a2) FCSIGCHECK(funcname, #rettype "," #a1 "," "V" #a2) \
1032 rettype F_CALL_CONV funcname(a1, a2) { FCIMPL_PROLOG(funcname)
1033 #define FCIMPL3(rettype, funcname, a1, a2, a3) FCSIGCHECK(funcname, #rettype "," #a1 "," #a2 "," #a3) \
1034 rettype F_CALL_CONV funcname(a1, a2, a3) { FCIMPL_PROLOG(funcname)
1035 #define FCIMPL3_IIV(rettype, funcname, a1, a2, a3) FCSIGCHECK(funcname, #rettype "," #a1 "," #a2 "," "V" #a3) \
1036 rettype F_CALL_CONV funcname(a1, a2, a3) { FCIMPL_PROLOG(funcname)
1037 #define FCIMPL3_VII(rettype, funcname, a1, a2, a3) FCSIGCHECK(funcname, #rettype "," "V" #a1 "," #a2 "," #a3) \
1038 rettype F_CALL_CONV funcname(a2, a3, a1) { FCIMPL_PROLOG(funcname)
1039 #define FCIMPL3_IVV(rettype, funcname, a1, a2, a3) FCSIGCHECK(funcname, #rettype "," #a1 "," "V" #a2 "," "V" #a3) \
1040 rettype F_CALL_CONV funcname(a1, a3, a2) { FCIMPL_PROLOG(funcname)
1041 #define FCIMPL3_IVI(rettype, funcname, a1, a2, a3) FCSIGCHECK(funcname, #rettype "," #a1 "," "V" #a2 "," #a3) \
1042 rettype F_CALL_CONV funcname(a1, a3, a2) { FCIMPL_PROLOG(funcname)
1043 #define FCIMPL3_VVI(rettype, funcname, a1, a2, a3) FCSIGCHECK(funcname, #rettype "," "V" #a1 "," "V" #a2 "," #a3) \
1044 rettype F_CALL_CONV funcname(a2, a1, a3) { FCIMPL_PROLOG(funcname)
1045 #define FCIMPL4(rettype, funcname, a1, a2, a3, a4) FCSIGCHECK(funcname, #rettype "," #a1 "," #a2 "," #a3 "," #a4) \
1046 rettype F_CALL_CONV funcname(a1, a2, a4, a3) { FCIMPL_PROLOG(funcname)
1047 #define FCIMPL5(rettype, funcname, a1, a2, a3, a4, a5) FCSIGCHECK(funcname, #rettype "," #a1 "," #a2 "," #a3 "," #a4 "," #a5) \
1048 rettype F_CALL_CONV funcname(a1, a2, a5, a4, a3) { FCIMPL_PROLOG(funcname)
1049 #define FCIMPL6(rettype, funcname, a1, a2, a3, a4, a5, a6) FCSIGCHECK(funcname, #rettype "," #a1 "," #a2 "," #a3 "," #a4 "," #a5 "," #a6) \
1050 rettype F_CALL_CONV funcname(a1, a2, a6, a5, a4, a3) { FCIMPL_PROLOG(funcname)
1051 #define FCIMPL7(rettype, funcname, a1, a2, a3, a4, a5, a6, a7) FCSIGCHECK(funcname, #rettype "," #a1 "," #a2 "," #a3 "," #a4 "," #a5 "," #a6 "," #a7) \
1052 rettype F_CALL_CONV funcname(a1, a2, a7, a6, a5, a4, a3) { FCIMPL_PROLOG(funcname)
1053 #define FCIMPL8(rettype, funcname, a1, a2, a3, a4, a5, a6, a7, a8) FCSIGCHECK(funcname, #rettype "," #a1 "," #a2 "," #a3 "," #a4 "," #a5 "," #a6 "," #a7 "," #a8) \
1054 rettype F_CALL_CONV funcname(a1, a2, a8, a7, a6, a5, a4, a3) { FCIMPL_PROLOG(funcname)
1055 #define FCIMPL9(rettype, funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9) FCSIGCHECK(funcname, #rettype "," #a1 "," #a2 "," #a3 "," #a4 "," #a5 "," #a6 "," #a7 "," #a8 "," #a9) \
1056 rettype F_CALL_CONV funcname(a1, a2, a9, a8, a7, a6, a5, a4, a3) { FCIMPL_PROLOG(funcname)
1057 #define FCIMPL10(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) FCSIGCHECK(funcname, #rettype "," #a1 "," #a2 "," #a3 "," #a4 "," #a5 "," #a6 "," #a7 "," #a8 "," #a9 "," #a10) \
1058 rettype F_CALL_CONV funcname(a1, a2, a10, a9, a8, a7, a6, a5, a4, a3) { FCIMPL_PROLOG(funcname)
1059 #define FCIMPL11(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11) FCSIGCHECK(funcname, #rettype "," #a1 "," #a2 "," #a3 "," #a4 "," #a5 "," #a6 "," #a7 "," #a8 "," #a9 "," #a10 "," #a11) \
1060 rettype F_CALL_CONV funcname(a1, a2, a11, a10, a9, a8, a7, a6, a5, a4, a3) { FCIMPL_PROLOG(funcname)
1061 #define FCIMPL12(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12) FCSIGCHECK(funcname, #rettype "," #a1 "," #a2 "," #a3 "," #a4 "," #a5 "," #a6 "," #a7 "," #a8 "," #a9 "," #a10 "," #a11 "," #a12) \
1062 rettype F_CALL_CONV funcname(a1, a2, a12, a11, a10, a9, a8, a7, a6, a5, a4, a3) { FCIMPL_PROLOG(funcname)
1063 #define FCIMPL13(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13) FCSIGCHECK(funcname, #rettype "," #a1 "," #a2 "," #a3 "," #a4 "," #a5 "," #a6 "," #a7 "," #a8 "," #a9 "," #a10 "," #a11 "," #a12 "," #a13) \
1064 rettype F_CALL_CONV funcname(a1, a2, a13, a12, a11, a10, a9, a8, a7, a6, a5, a4, a3) { FCIMPL_PROLOG(funcname)
1065 #define FCIMPL14(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14) FCSIGCHECK(funcname, #rettype "," #a1 "," #a2 "," #a3 "," #a4 "," #a5 "," #a6 "," #a7 "," #a8 "," #a9 "," #a10 "," #a11 "," #a12 "," #a13 "," #a14) \
1066 rettype F_CALL_CONV funcname(a1, a2, a14, a13, a12, a11, a10, a9, a8, a7, a6, a5, a4, a3) { FCIMPL_PROLOG(funcname)
1068 #define FCIMPL5_IVI(rettype, funcname, a1, a2, a3, a4, a5) FCSIGCHECK(funcname, #rettype "," #a1 "," "V" #a2 "," #a3 "," #a4 "," #a5) \
1069 rettype F_CALL_CONV funcname(a1, a3, a5, a4, a2) { FCIMPL_PROLOG(funcname)
1070 #define FCIMPL5_VII(rettype, funcname, a1, a2, a3, a4, a5) FCSIGCHECK(funcname, #rettype "," "V" #a1 "," #a2 "," #a3 "," #a4 "," #a5) \
1071 rettype F_CALL_CONV funcname(a2, a3, a5, a4, a1) { FCIMPL_PROLOG(funcname)
1073 #endif // !SWIZZLE_REGARG_ORDER
1075 #else // SWIZZLE_STKARG_ORDER
1077 #define FCIMPL0(rettype, funcname) rettype funcname() { FCIMPL_PROLOG(funcname)
1078 #define FCIMPL1(rettype, funcname, a1) rettype funcname(a1) { FCIMPL_PROLOG(funcname)
1079 #define FCIMPL1_V(rettype, funcname, a1) rettype funcname(a1) { FCIMPL_PROLOG(funcname)
1080 #define FCIMPL2(rettype, funcname, a1, a2) rettype funcname(a1, a2) { FCIMPL_PROLOG(funcname)
1081 #define FCIMPL2VA(rettype, funcname, a1, a2) rettype funcname(a1, a2, ...) { FCIMPL_PROLOG(funcname)
1082 #define FCIMPL2_VV(rettype, funcname, a1, a2) rettype funcname(a1, a2) { FCIMPL_PROLOG(funcname)
1083 #define FCIMPL2_VI(rettype, funcname, a1, a2) rettype funcname(a1, a2) { FCIMPL_PROLOG(funcname)
1084 #define FCIMPL2_IV(rettype, funcname, a1, a2) rettype funcname(a1, a2) { FCIMPL_PROLOG(funcname)
1085 #define FCIMPL3(rettype, funcname, a1, a2, a3) rettype funcname(a1, a2, a3) { FCIMPL_PROLOG(funcname)
1086 #define FCIMPL3_IIV(rettype, funcname, a1, a2, a3) rettype funcname(a1, a2, a3) { FCIMPL_PROLOG(funcname)
1087 #define FCIMPL3_IVV(rettype, funcname, a1, a2, a3) rettype funcname(a1, a2, a3) { FCIMPL_PROLOG(funcname)
1088 #define FCIMPL3_VII(rettype, funcname, a1, a2, a3) rettype funcname(a1, a2, a3) { FCIMPL_PROLOG(funcname)
1089 #define FCIMPL3_IVI(rettype, funcname, a1, a2, a3) rettype funcname(a1, a2, a3) { FCIMPL_PROLOG(funcname)
1090 #define FCIMPL3_VVI(rettype, funcname, a1, a2, a3) rettype funcname(a1, a2, a3) { FCIMPL_PROLOG(funcname)
1091 #define FCIMPL4(rettype, funcname, a1, a2, a3, a4) rettype funcname(a1, a2, a3, a4) { FCIMPL_PROLOG(funcname)
1092 #define FCIMPL5(rettype, funcname, a1, a2, a3, a4, a5) rettype funcname(a1, a2, a3, a4, a5) { FCIMPL_PROLOG(funcname)
1093 #define FCIMPL6(rettype, funcname, a1, a2, a3, a4, a5, a6) rettype funcname(a1, a2, a3, a4, a5, a6) { FCIMPL_PROLOG(funcname)
1094 #define FCIMPL7(rettype, funcname, a1, a2, a3, a4, a5, a6, a7) rettype funcname(a1, a2, a3, a4, a5, a6, a7) { FCIMPL_PROLOG(funcname)
1095 #define FCIMPL8(rettype, funcname, a1, a2, a3, a4, a5, a6, a7, a8) rettype funcname(a1, a2, a3, a4, a5, a6, a7, a8) { FCIMPL_PROLOG(funcname)
1096 #define FCIMPL9(rettype, funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9) rettype funcname(a1, a2, a3, a4, a5, a6, a7, a8, a9) { FCIMPL_PROLOG(funcname)
1097 #define FCIMPL10(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) rettype funcname(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) { FCIMPL_PROLOG(funcname)
1098 #define FCIMPL11(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11) rettype funcname(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11) { FCIMPL_PROLOG(funcname)
1099 #define FCIMPL12(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12) rettype funcname(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12) { FCIMPL_PROLOG(funcname)
1100 #define FCIMPL13(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13) rettype funcname(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13) { FCIMPL_PROLOG(funcname)
1101 #define FCIMPL14(rettype,funcname, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14) rettype funcname(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14) { FCIMPL_PROLOG(funcname)
1103 #define FCIMPL5_IVI(rettype, funcname, a1, a2, a3, a4, a5) rettype funcname(a1, a2, a3, a4, a5) { FCIMPL_PROLOG(funcname)
1104 #define FCIMPL5_VII(rettype, funcname, a1, a2, a3, a4, a5) rettype funcname(a1, a2, a3, a4, a5) { FCIMPL_PROLOG(funcname)
1106 #endif // !SWIZZLE_STKARG_ORDER
1108 //==============================================================================================
1109 // Use this to terminte an FCIMPLEND.
1110 //==============================================================================================
1112 #define FCIMPL_EPILOG() FCALL_TRANSITION_END()
1114 #define FCIMPLEND FCIMPL_EPILOG(); }
1116 #define HCIMPL_PROLOG(funcname) LPVOID __me; __me = 0; FC_COMMON_PROLOG(funcname, HCallAssert)
1118 // HCIMPL macros are just like their FCIMPL counterparts, however
1119 // they do not remember the function they come from. Thus they will not
1120 // show up in a stack trace. This is what you want for JIT helpers and the like
1122 #ifdef SWIZZLE_STKARG_ORDER
1123 #ifdef SWIZZLE_REGARG_ORDER
1125 #define HCIMPL0(rettype, funcname) rettype F_CALL_CONV funcname() { HCIMPL_PROLOG(funcname)
1126 #define HCIMPL1(rettype, funcname, a1) rettype F_CALL_CONV funcname(int /* EAX */, int /* EDX */, a1) { HCIMPL_PROLOG(funcname)
1127 #define HCIMPL1_RAW(rettype, funcname, a1) rettype F_CALL_CONV funcname(int /* EAX */, int /* EDX */, a1) {
1128 #define HCIMPL1_V(rettype, funcname, a1) rettype F_CALL_CONV funcname(int /* EAX */, int /* EDX */, int /* ECX */, a1) { HCIMPL_PROLOG(funcname)
1129 #define HCIMPL2(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1) { HCIMPL_PROLOG(funcname)
1130 #define HCIMPL2_RAW(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1) {
1131 #define HCIMPL2_VV(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(int /* EAX */, int /* EDX */, int /* ECX */, a2, a1) { HCIMPL_PROLOG(funcname)
1132 #define HCIMPL2_IV(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(int /* EAX */, int /* EDX */, a1, a2) { HCIMPL_PROLOG(funcname)
1133 #define HCIMPL2VA(rettype, funcname, a1, a2) rettype F_CALL_VA_CONV funcname(a1, a2, ...) { HCIMPL_PROLOG(funcname)
1134 #define HCIMPL3(rettype, funcname, a1, a2, a3) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a3) { HCIMPL_PROLOG(funcname)
1135 #define HCIMPL4(rettype, funcname, a1, a2, a3, a4) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a4, a3) { HCIMPL_PROLOG(funcname)
1136 #define HCIMPL5(rettype, funcname, a1, a2, a3, a4, a5) rettype F_CALL_CONV funcname(int /* EAX */, a2, a1, a5, a4, a3) { HCIMPL_PROLOG(funcname)
1138 #define HCCALL1(funcname, a1) funcname(0, 0, a1)
1139 #define HCCALL1_V(funcname, a1) funcname(0, 0, 0, a1)
1140 #define HCCALL2(funcname, a1, a2) funcname(0, a2, a1)
1141 #define HCCALL3(funcname, a1, a2, a3) funcname(0, a2, a1, a3)
1142 #define HCCALL4(funcname, a1, a2, a3, a4) funcname(0, a2, a1, a4, a3)
1143 #define HCCALL5(funcname, a1, a2, a3, a4, a5) funcname(0, a2, a1, a5, a4, a3)
1144 #define HCCALL1_PTR(rettype, funcptr, a1) rettype (F_CALL_CONV * funcptr)(int /* EAX */, int /* EDX */, a1)
1145 #define HCCALL2_PTR(rettype, funcptr, a1, a2) rettype (F_CALL_CONV * funcptr)(int /* EAX */, a2, a1)
1146 #else // SWIZZLE_REGARG_ORDER
1148 #define HCIMPL0(rettype, funcname) rettype F_CALL_CONV funcname() { HCIMPL_PROLOG(funcname)
1149 #define HCIMPL1(rettype, funcname, a1) rettype F_CALL_CONV funcname(a1) { HCIMPL_PROLOG(funcname)
1150 #define HCIMPL1_RAW(rettype, funcname, a1) rettype F_CALL_CONV funcname(a1) {
1151 #define HCIMPL1_V(rettype, funcname, a1) rettype F_CALL_CONV funcname(a1) { HCIMPL_PROLOG(funcname)
1152 #define HCIMPL2(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(a1, a2) { HCIMPL_PROLOG(funcname)
1153 #define HCIMPL2_RAW(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(a1, a2) {
1154 #define HCIMPL2_VV(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(a2, a1) { HCIMPL_PROLOG(funcname)
1155 #define HCIMPL2_IV(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(a1, a2) { HCIMPL_PROLOG(funcname)
1156 #define HCIMPL2VA(rettype, funcname, a1, a2) rettype F_CALL_VA_CONV funcname(a1, a2, ...) { HCIMPL_PROLOG(funcname)
1157 #define HCIMPL3(rettype, funcname, a1, a2, a3) rettype F_CALL_CONV funcname(a1, a2, a3) { HCIMPL_PROLOG(funcname)
1158 #define HCIMPL4(rettype, funcname, a1, a2, a3, a4) rettype F_CALL_CONV funcname(a1, a2, a4, a3) { HCIMPL_PROLOG(funcname)
1159 #define HCIMPL5(rettype, funcname, a1, a2, a3, a4, a5) rettype F_CALL_CONV funcname(a1, a2, a5, a4, a3) { HCIMPL_PROLOG(funcname)
1161 #define HCCALL1(funcname, a1) funcname(a1)
1162 #define HCCALL1_V(funcname, a1) funcname(a1)
1163 #define HCCALL2(funcname, a1, a2) funcname(a1, a2)
1164 #define HCCALL3(funcname, a1, a2, a3) funcname(a1, a2, a3)
1165 #define HCCALL4(funcname, a1, a2, a3, a4) funcname(a1, a2, a4, a3)
1166 #define HCCALL5(funcname, a1, a2, a3, a4, a5) funcname(a1, a2, a5, a4, a3)
1167 #define HCCALL1_PTR(rettype, funcptr, a1) rettype (F_CALL_CONV * funcptr)(a1)
1168 #define HCCALL2_PTR(rettype, funcptr, a1, a2) rettype (F_CALL_CONV * funcptr)(a1, a2)
1169 #endif // !SWIZZLE_REGARG_ORDER
1170 #else // SWIZZLE_STKARG_ORDER
1172 #define HCIMPL0(rettype, funcname) rettype F_CALL_CONV funcname() { HCIMPL_PROLOG(funcname)
1173 #define HCIMPL1(rettype, funcname, a1) rettype F_CALL_CONV funcname(a1) { HCIMPL_PROLOG(funcname)
1174 #define HCIMPL1_RAW(rettype, funcname, a1) rettype F_CALL_CONV funcname(a1) {
1175 #define HCIMPL1_V(rettype, funcname, a1) rettype F_CALL_CONV funcname(a1) { HCIMPL_PROLOG(funcname)
1176 #define HCIMPL2(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(a1, a2) { HCIMPL_PROLOG(funcname)
1177 #define HCIMPL2_RAW(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(a1, a2) {
1178 #define HCIMPL2_VV(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(a1, a2) { HCIMPL_PROLOG(funcname)
1179 #define HCIMPL2_IV(rettype, funcname, a1, a2) rettype F_CALL_CONV funcname(a1, a2) { HCIMPL_PROLOG(funcname)
1180 #define HCIMPL2VA(rettype, funcname, a1, a2) rettype F_CALL_VA_CONV funcname(a1, a2, ...) { HCIMPL_PROLOG(funcname)
1181 #define HCIMPL3(rettype, funcname, a1, a2, a3) rettype F_CALL_CONV funcname(a1, a2, a3) { HCIMPL_PROLOG(funcname)
1182 #define HCIMPL4(rettype, funcname, a1, a2, a3, a4) rettype F_CALL_CONV funcname(a1, a2, a3, a4) { HCIMPL_PROLOG(funcname)
1183 #define HCIMPL5(rettype, funcname, a1, a2, a3, a4, a5) rettype F_CALL_CONV funcname(a1, a2, a3, a4, a5) { HCIMPL_PROLOG(funcname)
1185 #define HCCALL1(funcname, a1) funcname(a1)
1186 #define HCCALL1_V(funcname, a1) funcname(a1)
1187 #define HCCALL2(funcname, a1, a2) funcname(a1, a2)
1188 #define HCCALL3(funcname, a1, a2, a3) funcname(a1, a2, a3)
1189 #define HCCALL4(funcname, a1, a2, a3, a4) funcname(a1, a2, a3, a4)
1190 #define HCCALL5(funcname, a1, a2, a3, a4, a5) funcname(a1, a2, a3, a4, a5)
1191 #define HCCALL1_PTR(rettype, funcptr, a1) rettype (F_CALL_CONV * funcptr)(a1)
1192 #define HCCALL2_PTR(rettype, funcptr, a1, a2) rettype (F_CALL_CONV * funcptr)(a1, a2)
1194 #endif // !SWIZZLE_STKARG_ORDER
1196 #define HCIMPLEND_RAW }
1197 #define HCIMPLEND FCALL_TRANSITION_END(); }
1200 //==============================================================================================
1201 // Throws an exception from an FCall. See rexcep.h for a list of valid
1203 //==============================================================================================
1204 #define FCThrow(reKind) FCThrowEx(reKind, 0, 0, 0, 0)
1206 //==============================================================================================
1207 // This version lets you attach a message with inserts (similar to
1209 //==============================================================================================
1210 #define FCThrowEx(reKind, resID, arg1, arg2, arg3) \
1213 __FCThrow(__me, reKind, resID, arg1, arg2, arg3)) {}; \
1217 //==============================================================================================
1218 // Like FCThrow but can be used for a VOID-returning FCall. The only
1219 // difference is in the "return" statement.
1220 //==============================================================================================
1221 #define FCThrowVoid(reKind) FCThrowExVoid(reKind, 0, 0, 0, 0)
1223 //==============================================================================================
1224 // This version lets you attach a message with inserts (similar to
1226 //==============================================================================================
1227 #define FCThrowExVoid(reKind, resID, arg1, arg2, arg3) \
1230 __FCThrow(__me, reKind, resID, arg1, arg2, arg3)) {}; \
1234 // Use FCThrowRes to throw an exception with a localized error message from the
1235 // ResourceManager in managed code.
1236 #define FCThrowRes(reKind, resourceName) FCThrowArgumentEx(reKind, NULL, resourceName)
1237 #define FCThrowArgumentNull(argName) FCThrowArgumentEx(kArgumentNullException, argName, NULL)
1238 #define FCThrowArgumentOutOfRange(argName, message) FCThrowArgumentEx(kArgumentOutOfRangeException, argName, message)
1239 #define FCThrowArgument(argName, message) FCThrowArgumentEx(kArgumentException, argName, message)
1241 #define FCThrowArgumentEx(reKind, argName, resourceName) \
1244 __FCThrowArgument(__me, reKind, argName, resourceName)) {}; \
1248 // Use FCThrowRes to throw an exception with a localized error message from the
1249 // ResourceManager in managed code.
1250 #define FCThrowResVoid(reKind, resourceName) FCThrowArgumentVoidEx(reKind, NULL, resourceName)
1251 #define FCThrowArgumentNullVoid(argName) FCThrowArgumentVoidEx(kArgumentNullException, argName, NULL)
1252 #define FCThrowArgumentOutOfRangeVoid(argName, message) FCThrowArgumentVoidEx(kArgumentOutOfRangeException, argName, message)
1253 #define FCThrowArgumentVoid(argName, message) FCThrowArgumentVoidEx(kArgumentException, argName, message)
1255 #define FCThrowArgumentVoidEx(reKind, argName, resourceName) \
1258 __FCThrowArgument(__me, reKind, argName, resourceName)) {}; \
1264 // The x86 JIT calling convention expects returned small types (e.g. bool) to be
1265 // widened on return. The C/C++ calling convention does not guarantee returned
1266 // small types to be widened. The small types has to be artifically widened on return
1267 // to fit x86 JIT calling convention. Thus fcalls returning small types has to
1268 // use the FC_XXX_RET types to force C/C++ compiler to do the widening.
1270 // The most common small return type of FCALLs is bool. The widening of bool is
1271 // especially tricky since the value has to be also normalized. FC_BOOL_RET and
1272 // FC_RETURN_BOOL macros are provided to make it fool-proof. FCALLs returning bool
1273 // should be implemented using following pattern:
1275 // FCIMPL0(FC_BOOL_RET, Foo) // the return type should be FC_BOOL_RET
1278 // FC_RETURN_BOOL(ret); // return statements should be FC_RETURN_BOOL
1281 // This rules are verified in binder.cpp if COMPlus_ConsistencyCheck is set.
1285 // Use prefast build to ensure that functions returning FC_BOOL_RET
1286 // are using FC_RETURN_BOOL to return it. Missing FC_RETURN_BOOL will
1287 // result into type mismatch error in prefast builds. This will also
1288 // catch misuses of FC_BOOL_RET for other places (e.g. in FCALL parameters).
1290 typedef LPVOID FC_BOOL_RET;
1291 #define FC_RETURN_BOOL(x) do { return (LPVOID)!!(x); } while(0)
1295 #if defined(_TARGET_X86_) || defined(_TARGET_AMD64_)
1296 // The return value is artifically widened on x86 and amd64
1297 typedef INT32 FC_BOOL_RET;
1299 typedef CLR_BOOL FC_BOOL_RET;
1302 #define FC_RETURN_BOOL(x) do { return !!(x); } while(0)
1307 #if defined(_TARGET_X86_) || defined(_TARGET_AMD64_)
1308 // The return value is artifically widened on x86 and amd64
1309 typedef UINT32 FC_CHAR_RET;
1310 typedef INT32 FC_INT8_RET;
1311 typedef UINT32 FC_UINT8_RET;
1312 typedef INT32 FC_INT16_RET;
1313 typedef UINT32 FC_UINT16_RET;
1315 typedef CLR_CHAR FC_CHAR_RET;
1316 typedef INT8 FC_INT8_RET;
1317 typedef UINT8 FC_UINT8_RET;
1318 typedef INT16 FC_INT16_RET;
1319 typedef UINT16 FC_UINT16_RET;
1323 // FC_TypedByRef should be used for TypedReferences in FCall signatures
1324 #if defined(UNIX_AMD64_ABI) && !defined(FEATURE_UNIX_AMD64_STRUCT_PASSING)
1325 // Explicitly pass the TypedReferences by reference
1326 #define FC_TypedByRef TypedByRef&
1327 #define FC_DECIMAL DECIMAL&
1329 #define FC_TypedByRef TypedByRef
1330 #define FC_DECIMAL DECIMAL
1334 // The fcall entrypoints has to be at unique addresses. Use this helper macro to make
1335 // the code of the fcalls unique if you get assert in ecall.cpp that mentions it.
1336 // The parameter of the FCUnique macro is an arbitrary 32-bit random non-zero number.
1337 #define FCUnique(unique) { Volatile<int> u = (unique); while (u.LoadWithoutBarrier() == 0) { }; }
1342 // FCALL contracts come in two forms:
1344 // Short form that should be used if the FCALL contract does not have any extras like preconditions, failure injection. Example:
1346 // FCIMPL0(void, foo)
1351 // Long form that should be used otherwise. Example:
1353 // FCIMPL1(void, foo, void *p)
1357 // PRECONDITION(CheckPointer(p));
1363 // FCALL_CHECK defines the actual contract conditions required for FCALLs
1365 #define FCALL_CHECK \
1367 DISABLED(GC_TRIGGERS); /* FCALLS with HELPER frames have issues with GC_TRIGGERS */ \
1372 // FCALL_CONTRACT should be the following shortcut:
1374 // #define FCALL_CONTRACT CONTRACTL { FCALL_CHECK; } CONTRACTL_END;
1376 // Since there is very little value in having runtime contracts in FCalls, FCALL_CONTRACT is defined as static contract only for performance reasons.
1378 #define FCALL_CONTRACT \
1379 STATIC_CONTRACT_SO_TOLERANT; \
1380 STATIC_CONTRACT_THROWS; \
1381 /* FCALLS are a special case contract wise, they are "NOTRIGGER, unless you setup a frame" */ \
1382 STATIC_CONTRACT_GC_NOTRIGGER; \
1383 STATIC_CONTRACT_MODE_COOPERATIVE
1385 #endif //__FCall_h__