This repository has been archived by the owner on Jan 23, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2.7k
/
ilmarshalers.h
3479 lines (2934 loc) · 109 KB
/
ilmarshalers.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
//
// File: ILMarshalers.h
//
//
#include "common.h"
#ifdef FEATURE_COMINTEROP
#include "winstring.h"
#endif //FEATURE_COMINTEROP
#include "stubgen.h"
#include "binder.h"
#include "marshalnative.h"
#include "clrvarargs.h"
#ifdef FEATURE_COMINTEROP
#include "stdinterfaces.h"
#endif
#define LOCAL_NUM_UNUSED ((DWORD)-1)
class ILStubMarshalHome
{
public:
typedef enum
{
HomeType_Unspecified = 0,
HomeType_ILLocal = 1,
HomeType_ILArgument = 2,
HomeType_ILByrefLocal = 3,
HomeType_ILByrefArgument = 4
} MarshalHomeType;
private:
MarshalHomeType m_homeType;
DWORD m_dwHomeIndex;
public:
void InitHome(MarshalHomeType homeType, DWORD dwHomeIndex)
{
LIMITED_METHOD_CONTRACT;
m_homeType = homeType;
m_dwHomeIndex = dwHomeIndex;
}
void EmitLoadHome(ILCodeStream* pslILEmit)
{
CONTRACTL
{
THROWS;
GC_TRIGGERS;
MODE_ANY;
}
CONTRACTL_END;
switch (m_homeType)
{
case HomeType_ILLocal: pslILEmit->EmitLDLOC(m_dwHomeIndex); break;
case HomeType_ILArgument: pslILEmit->EmitLDARG(m_dwHomeIndex); break;
default:
UNREACHABLE_MSG("unexpected homeType passed to EmitLoadHome");
break;
}
}
void EmitLoadHomeAddr(ILCodeStream* pslILEmit)
{
CONTRACTL
{
THROWS;
GC_TRIGGERS;
MODE_ANY;
}
CONTRACTL_END;
switch (m_homeType)
{
case HomeType_ILLocal: pslILEmit->EmitLDLOCA(m_dwHomeIndex); break;
case HomeType_ILArgument: pslILEmit->EmitLDARGA(m_dwHomeIndex); break;
case HomeType_ILByrefLocal: pslILEmit->EmitLDLOC(m_dwHomeIndex); break;
case HomeType_ILByrefArgument: pslILEmit->EmitLDARG(m_dwHomeIndex); break;
default:
UNREACHABLE_MSG("unexpected homeType passed to EmitLoadHomeAddr");
break;
}
}
void EmitStoreHome(ILCodeStream* pslILEmit)
{
CONTRACTL
{
THROWS;
GC_TRIGGERS;
MODE_ANY;
}
CONTRACTL_END;
switch (m_homeType)
{
case HomeType_ILLocal: pslILEmit->EmitSTLOC(m_dwHomeIndex); break;
case HomeType_ILArgument: pslILEmit->EmitSTARG(m_dwHomeIndex); break;
default:
UNREACHABLE_MSG("unexpected homeType passed to EmitStoreHome");
break;
}
}
void EmitStoreHomeAddr(ILCodeStream* pslILEmit)
{
CONTRACTL
{
THROWS;
GC_TRIGGERS;
MODE_ANY;
}
CONTRACTL_END;
switch (m_homeType)
{
case HomeType_ILByrefLocal: pslILEmit->EmitSTLOC(m_dwHomeIndex); break;
case HomeType_ILByrefArgument: pslILEmit->EmitSTARG(m_dwHomeIndex); break;
default:
UNREACHABLE_MSG("unexpected homeType passed to EmitStoreHomeAddr");
break;
}
}
void EmitCopyFromByrefArg(ILCodeStream* pslILEmit, LocalDesc* pManagedType, DWORD argidx)
{
CONTRACTL
{
THROWS;
GC_TRIGGERS;
MODE_ANY;
}
CONTRACTL_END;
if (pManagedType->IsValueClass())
{
EmitLoadHomeAddr(pslILEmit); // dest
pslILEmit->EmitLDARG(argidx); // src
pslILEmit->EmitCPOBJ(pslILEmit->GetToken(pManagedType->InternalToken));
}
else
{
pslILEmit->EmitLDARG(argidx);
pslILEmit->EmitLDIND_T(pManagedType);
EmitStoreHome(pslILEmit);
}
}
void EmitCopyToByrefArg(ILCodeStream* pslILEmit, LocalDesc* pManagedType, DWORD argidx)
{
CONTRACTL
{
THROWS;
GC_TRIGGERS;
MODE_ANY;
}
CONTRACTL_END;
if (pManagedType->IsValueClass())
{
pslILEmit->EmitLDARG(argidx); // dest
EmitLoadHomeAddr(pslILEmit); // src
pslILEmit->EmitCPOBJ(pslILEmit->GetToken(pManagedType->InternalToken));
}
else
{
pslILEmit->EmitLDARG(argidx);
EmitLoadHome(pslILEmit);
pslILEmit->EmitSTIND_T(pManagedType);
}
}
void EmitCopyToByrefArgWithNullCheck(ILCodeStream* pslILEmit, LocalDesc* pManagedType, DWORD argidx)
{
CONTRACTL
{
THROWS;
GC_TRIGGERS;
MODE_ANY;
}
CONTRACTL_END;
ILCodeLabel* pNullRefLabel = pslILEmit->NewCodeLabel();
// prevent null-ref exception by an explicit check
pslILEmit->EmitLDARG(argidx);
pslILEmit->EmitBRFALSE(pNullRefLabel);
EmitCopyToByrefArg(pslILEmit, pManagedType, argidx);
pslILEmit->EmitLabel(pNullRefLabel);
}
};
class ILMarshaler
{
protected:
#ifdef _DEBUG
const static UINT s_cbStackAllocThreshold = 128;
#else
const static UINT s_cbStackAllocThreshold = 2048;
#endif // _DEBUG
OverrideProcArgs* m_pargs;
NDirectStubLinker* m_pslNDirect;
ILCodeStream* m_pcsMarshal;
ILCodeStream* m_pcsUnmarshal;
UINT m_argidx;
DWORD m_dwMarshalFlags;
ILStubMarshalHome m_nativeHome;
ILStubMarshalHome m_managedHome;
DWORD m_dwMngdMarshalerLocalNum;
public:
ILMarshaler() :
m_pslNDirect(NULL)
{
}
virtual ~ILMarshaler()
{
LIMITED_METHOD_CONTRACT;
}
void SetNDirectStubLinker(NDirectStubLinker* pslNDirect)
{
LIMITED_METHOD_CONTRACT;
CONSISTENCY_CHECK(NULL == m_pslNDirect);
m_pslNDirect = pslNDirect;
}
void Init(ILCodeStream* pcsMarshal,
ILCodeStream* pcsUnmarshal,
UINT argidx,
DWORD dwMarshalFlags,
OverrideProcArgs* pargs)
{
LIMITED_METHOD_CONTRACT;
CONSISTENCY_CHECK_MSG(m_pslNDirect != NULL, "please call SetNDirectStubLinker() before EmitMarshalArgument or EmitMarshalReturnValue");
m_pcsMarshal = pcsMarshal;
m_pcsUnmarshal = pcsUnmarshal;
m_pargs = pargs;
m_dwMarshalFlags = dwMarshalFlags;
m_argidx = argidx;
m_dwMngdMarshalerLocalNum = -1;
}
protected:
static inline bool IsCLRToNative(DWORD dwMarshalFlags)
{
LIMITED_METHOD_CONTRACT;
return (0 != (dwMarshalFlags & MARSHAL_FLAG_CLR_TO_NATIVE));
}
static inline bool IsIn(DWORD dwMarshalFlags)
{
LIMITED_METHOD_CONTRACT;
return (0 != (dwMarshalFlags & MARSHAL_FLAG_IN));
}
static inline bool IsOut(DWORD dwMarshalFlags)
{
LIMITED_METHOD_CONTRACT;
return (0 != (dwMarshalFlags & MARSHAL_FLAG_OUT));
}
static inline bool IsByref(DWORD dwMarshalFlags)
{
LIMITED_METHOD_CONTRACT;
return (0 != (dwMarshalFlags & MARSHAL_FLAG_BYREF));
}
static inline bool IsHresultSwap(DWORD dwMarshalFlags)
{
LIMITED_METHOD_CONTRACT;
return (0 != (dwMarshalFlags & MARSHAL_FLAG_HRESULT_SWAP));
}
static inline bool IsRetval(DWORD dwMarshalFlags)
{
LIMITED_METHOD_CONTRACT;
return (0 != (dwMarshalFlags & MARSHAL_FLAG_RETVAL));
}
static inline bool IsHiddenLengthParam(DWORD dwMarshalFlags)
{
LIMITED_METHOD_CONTRACT;
return (0 != (dwMarshalFlags & MARSHAL_FLAG_HIDDENLENPARAM));
}
void EmitLoadManagedValue(ILCodeStream* pslILEmit)
{
WRAPPER_NO_CONTRACT;
m_managedHome.EmitLoadHome(pslILEmit);
}
void EmitLoadNativeValue(ILCodeStream* pslILEmit)
{
WRAPPER_NO_CONTRACT;
m_nativeHome.EmitLoadHome(pslILEmit);
}
void EmitLoadManagedHomeAddr(ILCodeStream* pslILEmit)
{
WRAPPER_NO_CONTRACT;
m_managedHome.EmitLoadHomeAddr(pslILEmit);
}
void EmitLoadNativeHomeAddr(ILCodeStream* pslILEmit)
{
WRAPPER_NO_CONTRACT;
m_nativeHome.EmitLoadHomeAddr(pslILEmit);
}
void EmitStoreManagedValue(ILCodeStream* pslILEmit)
{
WRAPPER_NO_CONTRACT;
m_managedHome.EmitStoreHome(pslILEmit);
}
void EmitStoreManagedHomeAddr(ILCodeStream* pslILEmit)
{
WRAPPER_NO_CONTRACT;
m_managedHome.EmitStoreHomeAddr(pslILEmit);
}
void EmitStoreNativeValue(ILCodeStream* pslILEmit)
{
WRAPPER_NO_CONTRACT;
m_nativeHome.EmitStoreHome(pslILEmit);
}
void EmitStoreNativeHomeAddr(ILCodeStream* pslILEmit)
{
WRAPPER_NO_CONTRACT;
m_nativeHome.EmitStoreHomeAddr(pslILEmit);
}
public:
virtual bool SupportsArgumentMarshal(DWORD dwMarshalFlags, UINT* pErrorResID)
{
LIMITED_METHOD_CONTRACT;
return true;
}
virtual bool SupportsReturnMarshal(DWORD dwMarshalFlags, UINT* pErrorResID)
{
LIMITED_METHOD_CONTRACT;
return true;
}
// True if marshaling creates data that could need cleanup.
bool NeedsMarshalCleanupIndex()
{
WRAPPER_NO_CONTRACT;
return (NeedsClearNative() || NeedsClearCLR());
}
// True if unmarshaling creates data that could need exception cleanup ("rollback").
bool NeedsUnmarshalCleanupIndex()
{
WRAPPER_NO_CONTRACT;
return (NeedsClearNative() && !IsCLRToNative(m_dwMarshalFlags));
}
void EmitMarshalArgument(
ILCodeStream* pcsMarshal,
ILCodeStream* pcsUnmarshal,
UINT argidx,
DWORD dwMarshalFlags,
OverrideProcArgs* pargs)
{
STANDARD_VM_CONTRACT;
Init(pcsMarshal, pcsUnmarshal, argidx, dwMarshalFlags, pargs);
// We could create the marshaler in the marshal stream right before it's needed (i.e. within the try block),
// or in the setup stream (outside of the try block). For managed-to-unmanaged marshaling it does not actually
// make much difference except that using setup stream saves us from cleaning up already-marshaled arguments
// in case of an exception. For unmanaged-to-managed, we may need to perform cleanup of the incoming arguments
// before we were able to marshal them. Therefore this must not happen within the try block so we don't try
// to use marshalers that have not been initialized. Potentially leaking unmanaged resources is by-design and
// there's not much we can do about it (we cannot do cleanup if we cannot create the marshaler).
EmitCreateMngdMarshaler(m_pslNDirect->GetSetupCodeStream());
if (IsCLRToNative(dwMarshalFlags))
{
if (IsByref(dwMarshalFlags))
{
EmitMarshalArgumentCLRToNativeByref();
}
else
{
EmitMarshalArgumentCLRToNative();
}
}
else
{
if (IsByref(dwMarshalFlags))
{
EmitMarshalArgumentNativeToCLRByref();
}
else
{
EmitMarshalArgumentNativeToCLR();
}
}
}
#ifdef FEATURE_COMINTEROP
void EmitMarshalHiddenLengthArgument(ILCodeStream *pcsMarshal,
ILCodeStream *pcsUnmarshal,
MarshalInfo *pArrayInfo,
UINT arrayIndex,
DWORD dwMarshalFlags,
UINT hiddenArgIndex,
OverrideProcArgs *pargs,
__out DWORD *pdwHiddenLengthManagedHomeLocal,
__out DWORD *pdwHiddenLengthNativeHomeLocal)
{
CONTRACTL
{
STANDARD_VM_CHECK;
PRECONDITION(IsHiddenLengthParam(dwMarshalFlags));
}
CONTRACTL_END;
Init(pcsMarshal, pcsUnmarshal, hiddenArgIndex, dwMarshalFlags, pargs);
EmitCreateMngdMarshaler(m_pslNDirect->GetSetupCodeStream());
// Create a local to be the home of the length parameter
DWORD dwManagedLocalHome = m_pcsMarshal->NewLocal(GetManagedType());
m_managedHome.InitHome(ILStubMarshalHome::HomeType_ILLocal, dwManagedLocalHome);
*pdwHiddenLengthManagedHomeLocal = dwManagedLocalHome;
// managed length = 0
m_pcsMarshal->EmitLDC(0);
m_pcsMarshal->EmitCONV_T(pArrayInfo->GetHiddenLengthParamElementType());
m_pcsMarshal->EmitSTLOC(dwManagedLocalHome);
// And a local to be the home of the marshaled length
LocalDesc nativeArgType(GetNativeType());
DWORD dwNativeHomeLocal = m_pcsMarshal->NewLocal(nativeArgType);
if (IsByref(dwMarshalFlags))
{
nativeArgType.MakeByRef();
}
m_nativeHome.InitHome(ILStubMarshalHome::HomeType_ILLocal, dwNativeHomeLocal);
*pdwHiddenLengthNativeHomeLocal = dwNativeHomeLocal;
// Update the native signature to contain the new native parameter
m_pcsMarshal->SetStubTargetArgType(&nativeArgType, false);
if (IsCLRToNative(dwMarshalFlags))
{
// Load the length of the array into the local
if (IsIn(dwMarshalFlags))
{
ILCodeLabel *pSkipGetLengthLabel = m_pcsMarshal->NewCodeLabel();
m_pcsMarshal->EmitLDARG(arrayIndex);
m_pcsMarshal->EmitBRFALSE(pSkipGetLengthLabel);
m_pcsMarshal->EmitLDARG(arrayIndex);
if (IsByref(dwMarshalFlags))
{
// if (*array == null) goto pSkipGetLengthLabel
m_pcsMarshal->EmitLDIND_REF();
m_pcsMarshal->EmitBRFALSE(pSkipGetLengthLabel);
// array = *array
m_pcsMarshal->EmitLDARG(arrayIndex);
m_pcsMarshal->EmitLDIND_REF();
}
m_pcsMarshal->EmitLDLEN();
m_pcsMarshal->EmitCONV_T(pArrayInfo->GetHiddenLengthParamElementType());
m_pcsMarshal->EmitSTLOC(dwManagedLocalHome);
m_pcsMarshal->EmitLabel(pSkipGetLengthLabel);
}
if (IsByref(dwMarshalFlags))
{
EmitMarshalArgumentContentsCLRToNativeByref(true);
}
else
{
EmitMarshalArgumentContentsCLRToNative();
}
}
else
{
// Load the length of the array into the local
if (IsIn(dwMarshalFlags))
{
m_pcsMarshal->EmitLDARG(hiddenArgIndex);
if (IsByref(dwMarshalFlags))
{
LocalDesc nativeParamType(GetNativeType());
m_pcsMarshal->EmitLDIND_T(&nativeParamType);
}
m_pcsMarshal->EmitSTLOC(dwNativeHomeLocal);
}
if (IsByref(dwMarshalFlags))
{
EmitMarshalArgumentContentsNativeToCLRByref(true);
}
else
{
EmitMarshalArgumentContentsNativeToCLR();
}
// We can't copy the final length back to the parameter just yet, since we don't know what
// local the array lives in. Instead, we rely on the hidden length array marshaler to copy
// the value into the out parameter for us.
}
}
#endif // FEATURE_COMINTEROP
virtual void EmitSetupArgument(ILCodeStream* pslILEmit)
{
STANDARD_VM_CONTRACT;
if (IsCLRToNative(m_dwMarshalFlags))
{
if (IsNativePassedByRef())
{
EmitLoadNativeHomeAddr(pslILEmit);
}
else
{
EmitLoadNativeValue(pslILEmit);
}
}
else
{
if (IsManagedPassedByRef())
{
EmitLoadManagedHomeAddr(pslILEmit);
}
else
{
EmitLoadManagedValue(pslILEmit);
}
}
}
virtual void EmitMarshalReturnValue(
ILCodeStream* pcsMarshal,
ILCodeStream* pcsUnmarshal,
ILCodeStream* pcsDispatch,
UINT argidx,
UINT16 wNativeSize,
DWORD dwMarshalFlags,
OverrideProcArgs* pargs)
{
STANDARD_VM_CONTRACT;
Init(pcsMarshal, pcsUnmarshal, argidx, dwMarshalFlags, pargs);
LocalDesc nativeType = GetNativeType();
LocalDesc managedType = GetManagedType();
bool byrefNativeReturn = false;
CorElementType typ = ELEMENT_TYPE_VOID;
UINT32 nativeSize = 0;
bool nativeMethodIsMemberFunction = (m_pslNDirect->TargetHasThis() && IsCLRToNative(m_dwMarshalFlags))
|| (m_pslNDirect->HasThis() && !IsCLRToNative(m_dwMarshalFlags))
|| ((CorInfoCallConv)m_pslNDirect->GetStubTargetCallingConv() == CORINFO_CALLCONV_THISCALL);
// we need to convert value type return types to primitives as
// JIT does not inline P/Invoke calls that return structures
if (nativeType.IsValueClass())
{
if (wNativeSize == VARIABLESIZE)
{
// the unmanaged type size is variable
nativeSize = m_pargs->m_pMT->GetNativeSize();
}
else
{
// the unmanaged type size is fixed
nativeSize = wNativeSize;
}
#if defined(_TARGET_X86_) || (defined(_TARGET_AMD64_) && defined(_WIN32))
// JIT32 and JIT64 (which is only used on the Windows Desktop CLR) has a problem generating
// code for the pinvoke ILStubs which do a return using a struct type. Therefore, we
// change the signature of calli to return void and make the return buffer as first argument.
// For Windows AMD64 and x86, we need to use a return buffer for native member functions returning structures.
// for X86 Windows non-member functions we bash the return type from struct to U1, U2, U4 or U8
// and use byrefNativeReturn for all other structs.
// for UNIX_X86_ABI, we always need a return buffer argument for any size of structs.
#if defined(_WIN32)
if (nativeMethodIsMemberFunction)
{
byrefNativeReturn = true;
}
else
#endif // _WIN32
{
#ifndef _TARGET_AMD64_
switch (nativeSize)
{
#ifndef UNIX_X86_ABI
case 1: typ = ELEMENT_TYPE_U1; break;
case 2: typ = ELEMENT_TYPE_U2; break;
case 4: typ = ELEMENT_TYPE_U4; break;
case 8: typ = ELEMENT_TYPE_U8; break;
#endif // UNIX_X86_ABI
default: byrefNativeReturn = true; break;
}
#endif // _TARGET_AMD64_
}
#endif // defined(_TARGET_X86_) || (defined(_TARGET_AMD64_) && defined(_WIN32))
}
if (IsHresultSwap(dwMarshalFlags) || (byrefNativeReturn && (IsCLRToNative(m_dwMarshalFlags) || nativeMethodIsMemberFunction)))
{
LocalDesc extraParamType = nativeType;
extraParamType.MakeByRef();
m_pcsMarshal->SetStubTargetArgType(&extraParamType, false);
if (byrefNativeReturn && !IsCLRToNative(m_dwMarshalFlags))
{
// If doing a native->managed call and returning a structure by-ref,
// the native signature has an extra param for the struct return
// than the managed signature. Adjust the target stack delta to account this extra
// parameter.
m_pslNDirect->AdjustTargetStackDeltaForExtraParam();
// We also need to account for the lack of a return value in the native signature.
// To do this, we adjust the stack delta again for the return parameter.
m_pslNDirect->AdjustTargetStackDeltaForExtraParam();
}
if (IsHresultSwap(dwMarshalFlags))
{
// HRESULT swapping: the original return value is transformed into an extra
// byref parameter and the target is expected to return an HRESULT
m_pcsMarshal->SetStubTargetReturnType(ELEMENT_TYPE_I4); // native method returns an HRESULT
}
else
{
// byref structure return: the original return value is transformed into an
// extra byref parameter and the target is not expected to return anything
//
// note: we do this only for forward calls because [unmanaged calling conv.
// uses byref return] implies [managed calling conv. uses byref return]
m_pcsMarshal->SetStubTargetReturnType(ELEMENT_TYPE_VOID);
}
}
else
{
if (typ != ELEMENT_TYPE_VOID)
{
// small structure return: the original return value is transformed into
// ELEMENT_TYPE_U1, ELEMENT_TYPE_U2, ELEMENT_TYPE_U4, or ELEMENT_TYPE_U8
m_pcsMarshal->SetStubTargetReturnType(typ);
}
else
{
m_pcsMarshal->SetStubTargetReturnType(&nativeType);
}
}
m_managedHome.InitHome(ILStubMarshalHome::HomeType_ILLocal, m_pcsMarshal->NewLocal(managedType));
m_nativeHome.InitHome(ILStubMarshalHome::HomeType_ILLocal, m_pcsMarshal->NewLocal(nativeType));
EmitCreateMngdMarshaler(m_pcsMarshal);
if (IsCLRToNative(dwMarshalFlags))
{
if (IsHresultSwap(dwMarshalFlags) || byrefNativeReturn)
{
EmitReInitNative(m_pcsMarshal);
EmitLoadNativeHomeAddr(pcsDispatch); // load up the byref native type as an extra arg
}
else
{
if (typ != ELEMENT_TYPE_VOID)
{
// small structure forward: the returned integer is memcpy'd into native home
// of the structure
DWORD dwTempLocalNum = m_pcsUnmarshal->NewLocal(typ);
m_pcsUnmarshal->EmitSTLOC(dwTempLocalNum);
// cpblk
m_nativeHome.EmitLoadHomeAddr(m_pcsUnmarshal);
m_pcsUnmarshal->EmitLDLOCA(dwTempLocalNum);
m_pcsUnmarshal->EmitLDC(nativeSize);
m_pcsUnmarshal->EmitCPBLK();
}
else
{
EmitStoreNativeValue(m_pcsUnmarshal);
}
}
if (NeedsMarshalCleanupIndex())
{
m_pslNDirect->EmitSetArgMarshalIndex(m_pcsUnmarshal, NDirectStubLinker::CLEANUP_INDEX_ARG0_MARSHAL + m_argidx);
}
EmitConvertSpaceAndContentsNativeToCLR(m_pcsUnmarshal);
EmitCleanupCLRToNative();
EmitLoadManagedValue(m_pcsUnmarshal);
}
else
{
EmitStoreManagedValue(m_pcsUnmarshal);
if (NeedsMarshalCleanupIndex())
{
m_pslNDirect->EmitSetArgMarshalIndex(m_pcsUnmarshal, NDirectStubLinker::CLEANUP_INDEX_ARG0_MARSHAL + m_argidx);
}
if (IsHresultSwap(dwMarshalFlags))
{
// we have to skip unmarshaling return value into the HRESULT-swapped argument
// if the argument came as NULL (otherwise we would leak unmanaged resources as
// we have no way of passing them back to the caller)
ILCodeLabel *pSkipConversionLabel = m_pcsUnmarshal->NewCodeLabel();
m_pcsUnmarshal->EmitLDARG(argidx);
m_pcsUnmarshal->EmitBRFALSE(pSkipConversionLabel);
EmitConvertSpaceAndContentsCLRToNative(m_pcsUnmarshal);
m_pcsUnmarshal->EmitLabel(pSkipConversionLabel);
}
else
{
EmitConvertSpaceAndContentsCLRToNative(m_pcsUnmarshal);
}
if (NeedsUnmarshalCleanupIndex())
{
// if an exception is thrown after this point, we will clean up the unmarshaled retval
m_pslNDirect->EmitSetArgMarshalIndex(m_pcsUnmarshal, NDirectStubLinker::CLEANUP_INDEX_RETVAL_UNMARSHAL);
}
EmitCleanupNativeToCLR();
if (IsHresultSwap(dwMarshalFlags))
{
// we tolerate NULL here mainly for backward compatibility reasons
m_nativeHome.EmitCopyToByrefArgWithNullCheck(m_pcsUnmarshal, &nativeType, argidx);
m_pcsUnmarshal->EmitLDC(S_OK);
}
else if (byrefNativeReturn && nativeMethodIsMemberFunction)
{
m_nativeHome.EmitCopyToByrefArg(m_pcsUnmarshal, &nativeType, argidx);
}
else
{
if (typ != ELEMENT_TYPE_VOID)
{
// small structure return (reverse): native home of the structure is memcpy'd
// into the integer to be returned from the stub
DWORD dwTempLocalNum = m_pcsUnmarshal->NewLocal(typ);
// cpblk
m_pcsUnmarshal->EmitLDLOCA(dwTempLocalNum);
m_nativeHome.EmitLoadHomeAddr(m_pcsUnmarshal);
m_pcsUnmarshal->EmitLDC(nativeSize);
m_pcsUnmarshal->EmitCPBLK();
m_pcsUnmarshal->EmitLDLOC(dwTempLocalNum);
}
else
{
EmitLoadNativeValue(m_pcsUnmarshal);
}
}
// make sure we free (and zero) the return value if an exception is thrown
EmitExceptionCleanupNativeToCLR();
}
}
protected:
virtual void EmitCreateMngdMarshaler(ILCodeStream* pslILEmit)
{
LIMITED_METHOD_CONTRACT;
}
virtual void EmitLoadMngdMarshaler(ILCodeStream* pslILEmit)
{
CONTRACTL
{
THROWS;
GC_TRIGGERS;
MODE_ANY;
}
CONTRACTL_END;
CONSISTENCY_CHECK((DWORD)-1 != m_dwMngdMarshalerLocalNum);
pslILEmit->EmitLDLOC(m_dwMngdMarshalerLocalNum);
}
void EmitSetupSigAndDefaultHomesCLRToNative()
{
CONTRACTL
{
STANDARD_VM_CHECK;
PRECONDITION(IsCLRToNative(m_dwMarshalFlags) && !IsByref(m_dwMarshalFlags));
}
CONTRACTL_END;
LocalDesc nativeArgType = GetNativeType();
DWORD dwNativeHomeLocalNum = m_pcsMarshal->NewLocal(nativeArgType);
m_pcsMarshal->SetStubTargetArgType(&nativeArgType);
m_managedHome.InitHome(ILStubMarshalHome::HomeType_ILArgument, m_argidx);
m_nativeHome.InitHome(ILStubMarshalHome::HomeType_ILLocal, dwNativeHomeLocalNum);
}
void EmitCleanupCLRToNativeTemp()
{
STANDARD_VM_CONTRACT;
if (NeedsClearNative())
{
CONSISTENCY_CHECK(NeedsMarshalCleanupIndex());
ILCodeStream* pcsCleanup = m_pslNDirect->GetCleanupCodeStream();
ILCodeLabel* pSkipClearNativeLabel = pcsCleanup->NewCodeLabel();
m_pslNDirect->EmitCheckForArgCleanup(pcsCleanup,
NDirectStubLinker::CLEANUP_INDEX_ARG0_MARSHAL + m_argidx,
NDirectStubLinker::BranchIfNotMarshaled,
pSkipClearNativeLabel);
EmitClearNativeTemp(pcsCleanup);
pcsCleanup->EmitLabel(pSkipClearNativeLabel);
}
}
void EmitCleanupCLRToNative()
{
STANDARD_VM_CONTRACT;
if (NeedsClearNative())
{
CONSISTENCY_CHECK(NeedsMarshalCleanupIndex());
ILCodeStream* pcsCleanup = m_pslNDirect->GetCleanupCodeStream();
ILCodeLabel* pSkipClearNativeLabel = pcsCleanup->NewCodeLabel();
m_pslNDirect->EmitCheckForArgCleanup(pcsCleanup,
NDirectStubLinker::CLEANUP_INDEX_ARG0_MARSHAL + m_argidx,
NDirectStubLinker::BranchIfNotMarshaled,
pSkipClearNativeLabel);
EmitClearNative(pcsCleanup);
pcsCleanup->EmitLabel(pSkipClearNativeLabel);
}
}
virtual void EmitMarshalArgumentCLRToNative()
{
CONTRACTL
{
STANDARD_VM_CHECK;
PRECONDITION(IsCLRToNative(m_dwMarshalFlags) && !IsByref(m_dwMarshalFlags));
}
CONTRACTL_END;
EmitSetupSigAndDefaultHomesCLRToNative();
EmitMarshalArgumentContentsCLRToNative();
}
void EmitMarshalArgumentContentsCLRToNative()
{
CONTRACTL
{
STANDARD_VM_CHECK;
PRECONDITION(IsCLRToNative(m_dwMarshalFlags) && !IsByref(m_dwMarshalFlags));
}
CONTRACTL_END;
//
// marshal
//
if (IsIn(m_dwMarshalFlags))
{
EmitConvertSpaceAndContentsCLRToNativeTemp(m_pcsMarshal);
}
else
{
EmitConvertSpaceCLRToNativeTemp(m_pcsMarshal);
}
//
// unmarshal
//
if (IsOut(m_dwMarshalFlags))
{
if (IsIn(m_dwMarshalFlags))
{
EmitClearCLRContents(m_pcsUnmarshal);
}
EmitConvertContentsNativeToCLR(m_pcsUnmarshal);
}
EmitCleanupCLRToNativeTemp();
}
void EmitSetupSigAndDefaultHomesCLRToNativeByref(bool fBlittable = false)
{
CONTRACTL
{
STANDARD_VM_CHECK;
PRECONDITION(IsCLRToNative(m_dwMarshalFlags) && IsByref(m_dwMarshalFlags));
}
CONTRACTL_END;
LocalDesc nativeType = GetNativeType();
LocalDesc managedType = GetManagedType();
LocalDesc nativeArgType = nativeType;
nativeArgType.MakeByRef();
m_pcsMarshal->SetStubTargetArgType(&nativeArgType);
if (fBlittable)
{
// we will not work with the actual data but only with a pointer to that data
// (the managed and native type had better be the same if it's blittable)
_ASSERTE(nativeType.ElementType[0] == managedType.ElementType[0]);
// native home will keep the containing object pinned
nativeType.MakeByRef();
nativeType.MakePinned();
m_managedHome.InitHome(ILStubMarshalHome::HomeType_ILByrefArgument, m_argidx);
m_nativeHome.InitHome(ILStubMarshalHome::HomeType_ILByrefLocal, m_pcsMarshal->NewLocal(nativeType));
}
else
{
m_managedHome.InitHome(ILStubMarshalHome::HomeType_ILLocal, m_pcsMarshal->NewLocal(managedType));
m_nativeHome.InitHome(ILStubMarshalHome::HomeType_ILLocal, m_pcsMarshal->NewLocal(nativeType));
}
}
virtual void EmitMarshalArgumentCLRToNativeByref()
{
CONTRACTL
{
STANDARD_VM_CHECK;
PRECONDITION(IsCLRToNative(m_dwMarshalFlags) && IsByref(m_dwMarshalFlags));
}
CONTRACTL_END;
EmitSetupSigAndDefaultHomesCLRToNativeByref();
EmitMarshalArgumentContentsCLRToNativeByref(false);
}
void EmitMarshalArgumentContentsCLRToNativeByref(bool managedHomeAlreadyInitialized)
{
CONTRACTL
{
STANDARD_VM_CHECK;
PRECONDITION(IsCLRToNative(m_dwMarshalFlags) && IsByref(m_dwMarshalFlags));
}
CONTRACTL_END;
LocalDesc managedType = GetManagedType();
//
// marshal
//
if (IsIn(m_dwMarshalFlags) && ! IsOut(m_dwMarshalFlags))
{
if (!managedHomeAlreadyInitialized)
{
m_managedHome.EmitCopyFromByrefArg(m_pcsMarshal, &managedType, m_argidx);