forked from dotnet/runtime
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathBuiltInCOMTests.cs
More file actions
1547 lines (1314 loc) · 71.5 KB
/
BuiltInCOMTests.cs
File metadata and controls
1547 lines (1314 loc) · 71.5 KB
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.
using System;
using System.Collections.Generic;
using System.Linq;
using Microsoft.Diagnostics.DataContractReader.Contracts;
using Moq;
using Xunit;
using Microsoft.Diagnostics.Internal.RuntimeMemoryMocks;
namespace Microsoft.Diagnostics.DataContractReader.Tests;
public class BuiltInCOMTests
{
private const ulong AllocationRangeStart = 0x00000000_20000000;
private const ulong AllocationRangeEnd = 0x00000000_30000000;
private const uint TestRCWInterfaceCacheSize = 8;
private static readonly MockDescriptors.TypeFields RCWFields = new MockDescriptors.TypeFields()
{
DataType = DataType.RCW,
Fields =
[
new(nameof(Data.RCW.NextCleanupBucket), DataType.pointer),
new(nameof(Data.RCW.NextRCW), DataType.pointer),
new(nameof(Data.RCW.Flags), DataType.uint32),
new(nameof(Data.RCW.CtxCookie), DataType.pointer),
new(nameof(Data.RCW.CtxEntry), DataType.pointer),
new(nameof(Data.RCW.InterfaceEntries), DataType.pointer),
new(nameof(Data.RCW.IdentityPointer), DataType.pointer),
new(nameof(Data.RCW.SyncBlockIndex), DataType.uint32),
new(nameof(Data.RCW.VTablePtr), DataType.pointer),
new(nameof(Data.RCW.CreatorThread), DataType.pointer),
new(nameof(Data.RCW.RefCount), DataType.uint32),
new(nameof(Data.RCW.UnknownPointer), DataType.pointer),
]
};
private static readonly MockDescriptors.TypeFields InterfaceEntryFields = new MockDescriptors.TypeFields()
{
DataType = DataType.InterfaceEntry,
Fields =
[
new(nameof(Data.InterfaceEntry.MethodTable), DataType.pointer),
new(nameof(Data.InterfaceEntry.Unknown), DataType.pointer),
]
};
private static readonly MockDescriptors.TypeFields CtxEntryFields = new MockDescriptors.TypeFields()
{
DataType = DataType.CtxEntry,
Fields =
[
new(nameof(Data.CtxEntry.STAThread), DataType.pointer),
new(nameof(Data.CtxEntry.CtxCookie), DataType.pointer),
]
};
private static void BuiltInCOMContractHelper(
MockTarget.Architecture arch,
Action<MockMemorySpace.Builder, TargetTestHelpers, Dictionary<DataType, Target.TypeInfo>> configure,
Action<Target> testCase,
ISyncBlock? syncBlock = null)
{
TargetTestHelpers targetTestHelpers = new(arch);
MockMemorySpace.Builder builder = new(targetTestHelpers);
Dictionary<DataType, Target.TypeInfo> types = MockDescriptors.GetTypesForTypeFields(
targetTestHelpers,
[RCWFields, InterfaceEntryFields, CtxEntryFields]);
configure(builder, targetTestHelpers, types);
(string Name, ulong Value)[] globals =
[
(nameof(Constants.Globals.RCWInterfaceCacheSize), TestRCWInterfaceCacheSize),
];
var target = new TestPlaceholderTarget(arch, builder.GetMemoryContext().ReadFromTarget, types, globals);
ISyncBlock syncBlockContract = syncBlock ?? Mock.Of<ISyncBlock>();
target.SetContracts(Mock.Of<ContractRegistry>(
c => c.BuiltInCOM == ((IContractFactory<IBuiltInCOM>)new BuiltInCOMFactory()).CreateContract(target, 1)
&& c.SyncBlock == syncBlockContract));
testCase(target);
}
/// <summary>
/// Allocates an RCW mock with the interface entries embedded inline (matching the real C++ layout
/// where m_aInterfaceEntries is an inline array within the RCW struct).
/// Returns the address of the RCW.
/// </summary>
private static TargetPointer AddRCWWithInlineEntries(
MockMemorySpace.Builder builder,
TargetTestHelpers targetTestHelpers,
Dictionary<DataType, Target.TypeInfo> types,
MockMemorySpace.BumpAllocator allocator,
(TargetPointer MethodTable, TargetPointer Unknown)[] entries,
TargetPointer ctxCookie = default)
{
Target.TypeInfo rcwTypeInfo = types[DataType.RCW];
Target.TypeInfo entryTypeInfo = types[DataType.InterfaceEntry];
uint entrySize = entryTypeInfo.Size!.Value;
uint entriesOffset = (uint)rcwTypeInfo.Fields[nameof(Data.RCW.InterfaceEntries)].Offset;
// The RCW block must be large enough to hold the RCW header plus all inline entries
uint totalSize = entriesOffset + entrySize * TestRCWInterfaceCacheSize;
MockMemorySpace.HeapFragment fragment = allocator.Allocate(totalSize, "RCW with inline entries");
Span<byte> data = fragment.Data;
// Write RCW header fields
targetTestHelpers.WritePointer(
data.Slice(rcwTypeInfo.Fields[nameof(Data.RCW.CtxCookie)].Offset),
ctxCookie);
// Write the inline interface entries starting at entriesOffset
for (int i = 0; i < entries.Length && i < TestRCWInterfaceCacheSize; i++)
{
Span<byte> entryData = data.Slice((int)(entriesOffset + i * entrySize));
targetTestHelpers.WritePointer(
entryData.Slice(entryTypeInfo.Fields[nameof(Data.InterfaceEntry.MethodTable)].Offset),
entries[i].MethodTable);
targetTestHelpers.WritePointer(
entryData.Slice(entryTypeInfo.Fields[nameof(Data.InterfaceEntry.Unknown)].Offset),
entries[i].Unknown);
}
builder.AddHeapFragment(fragment);
return fragment.Address;
}
// Flag values matching the C++ runtime
private const ulong IsLayoutCompleteFlag = 0x10;
// LinkedWrapperTerminator: (PTR_ComCallWrapper)-1, all bits set
private const ulong LinkedWrapperTerminator = ulong.MaxValue;
private const uint NumVtablePtrs = 5;
private const ulong ComRefcountMask = 0x000000007FFFFFFF;
// Addresses of slots that hold the tear-off function pointers (the globals are indirect pointers)
private const ulong TearOffAddRefSlot = 0xE000_0000;
private const ulong TearOffAddRefSimpleSlot = 0xE000_0100;
private const ulong TearOffAddRefSimpleInnerSlot = 0xE000_0200;
// Fake tear-off function addresses used in tests (must not collide with real data values)
private const ulong TearOffAddRefAddr = 0xF000_0001;
private const ulong TearOffAddRefSimpleAddr = 0xF000_0002;
private const ulong TearOffAddRefSimpleInnerAddr = 0xF000_0003;
// CCWThisMask: ~0x3f on 64-bit, ~0x1f on 32-bit (matches enum_ThisMask in ComCallWrapper)
private static ulong GetCCWThisMask(int pointerSize) => pointerSize == 8 ? ~0x3FUL : ~0x1FUL;
private const ulong AllocationStart = 0x0001_0000;
private const ulong AllocationEnd = 0x0002_0000;
/// <summary>
/// Creates type infos for ComCallWrapper, SimpleComCallWrapper, and ComMethodTable
/// using a simplified in-test layout:
/// ComCallWrapper: SimpleWrapper at 0, IPtr (=m_rgpIPtr[0]) at P, Next at 6P
/// SimpleComCallWrapper: RefCount (uint64) at 0, Flags (uint32) at 8,
/// MainWrapper (pointer) at 12, VTablePtr (pointer) at 12+P
/// ComCallWrapper: SimpleWrapper (pointer) at 0, IPtr (pointer) at P, Next (pointer) at 6P, Handle (pointer) at 7P
/// SimpleComCallWrapper: RefCount (uint64) at 0, Flags (uint32) at 8, MainWrapper (pointer) at 12,
/// VTablePtr (pointer) at 12+P, OuterIUnknown (pointer) at 12+2P
/// ComMethodTable: Flags (nuint) at 0, MethodTable (pointer) at P, size = 2P
/// </summary>
private static Dictionary<DataType, Target.TypeInfo> CreateTypeInfos(int pointerSize)
{
int P = pointerSize;
return new Dictionary<DataType, Target.TypeInfo>
{
[DataType.ComCallWrapper] = new Target.TypeInfo()
{
Fields = new Dictionary<string, Target.FieldInfo>()
{
[nameof(Data.ComCallWrapper.SimpleWrapper)] = new Target.FieldInfo { Offset = 0, Type = DataType.pointer },
[nameof(Data.ComCallWrapper.IPtr)] = new Target.FieldInfo { Offset = P, Type = DataType.pointer },
[nameof(Data.ComCallWrapper.Next)] = new Target.FieldInfo { Offset = 6 * P, Type = DataType.pointer },
[nameof(Data.ComCallWrapper.Handle)] = new Target.FieldInfo { Offset = 7 * P, Type = DataType.pointer },
}
},
[DataType.SimpleComCallWrapper] = new Target.TypeInfo()
{
Fields = new Dictionary<string, Target.FieldInfo>()
{
[nameof(Data.SimpleComCallWrapper.RefCount)] = new Target.FieldInfo { Offset = 0, Type = DataType.uint64 },
[nameof(Data.SimpleComCallWrapper.Flags)] = new Target.FieldInfo { Offset = 8, Type = DataType.uint32 },
[nameof(Data.SimpleComCallWrapper.MainWrapper)] = new Target.FieldInfo { Offset = 12, Type = DataType.pointer },
[nameof(Data.SimpleComCallWrapper.VTablePtr)] = new Target.FieldInfo { Offset = 12 + P, Type = DataType.pointer },
[nameof(Data.SimpleComCallWrapper.OuterIUnknown)] = new Target.FieldInfo { Offset = 12 + 2 * P, Type = DataType.pointer },
}
},
[DataType.ComMethodTable] = new Target.TypeInfo()
{
Size = (uint)(2 * P),
Fields = new Dictionary<string, Target.FieldInfo>()
{
[nameof(Data.ComMethodTable.Flags)] = new Target.FieldInfo { Offset = 0, Type = DataType.nuint },
[nameof(Data.ComMethodTable.MethodTable)] = new Target.FieldInfo { Offset = P, Type = DataType.pointer },
}
},
};
}
private static Target CreateTarget(MockTarget.Architecture arch, MockMemorySpace.Builder builder, Dictionary<DataType, Target.TypeInfo> types)
{
int P = arch.Is64Bit ? 8 : 4;
// The TearOff globals are indirect pointers: the global stores a pointer to a slot,
// and the slot contains the actual function address.
void AddIndirectPointer(MockMemorySpace.Builder b, TargetTestHelpers h, ulong slotAddr, ulong value)
{
var frag = new MockMemorySpace.HeapFragment
{
Name = $"TearOffSlot@0x{slotAddr:X}",
Address = slotAddr,
Data = new byte[h.PointerSize],
};
h.WritePointer(frag.Data, value);
b.AddHeapFragment(frag);
}
var helpers = new TargetTestHelpers(arch);
AddIndirectPointer(builder, helpers, TearOffAddRefSlot, TearOffAddRefAddr);
AddIndirectPointer(builder, helpers, TearOffAddRefSimpleSlot, TearOffAddRefSimpleAddr);
AddIndirectPointer(builder, helpers, TearOffAddRefSimpleInnerSlot, TearOffAddRefSimpleInnerAddr);
(string Name, ulong Value)[] globals =
[
(Constants.Globals.CCWNumInterfaces, NumVtablePtrs),
(Constants.Globals.CCWThisMask, GetCCWThisMask(P)),
(Constants.Globals.TearOffAddRef, TearOffAddRefSlot),
(Constants.Globals.TearOffAddRefSimple, TearOffAddRefSimpleSlot),
(Constants.Globals.TearOffAddRefSimpleInner, TearOffAddRefSimpleInnerSlot),
];
var target = new TestPlaceholderTarget(arch, builder.GetMemoryContext().ReadFromTarget, types, globals);
target.SetContracts(Mock.Of<ContractRegistry>(
c => c.BuiltInCOM == ((IContractFactory<IBuiltInCOM>)new BuiltInCOMFactory()).CreateContract(target, 1)));
return target;
}
[Theory]
[ClassData(typeof(MockTarget.StdArch))]
public void GetSimpleComCallWrapperData_RefCount_ReturnsMaskedValue(MockTarget.Architecture arch)
{
var helpers = new TargetTestHelpers(arch);
var builder = new MockMemorySpace.Builder(helpers);
int P = helpers.PointerSize;
ulong simpleWrapperAddr = 0x5000;
// Raw refcount has CLEANUP_SENTINEL (bit 31) set plus a visible count of 0x1234_5678.
ulong rawRefCount = 0x0000_0000_1234_5678UL | 0x80000000UL;
var simpleWrapperFragment = new MockMemorySpace.HeapFragment
{
Name = "SimpleComCallWrapper",
Address = simpleWrapperAddr,
Data = new byte[12 + 3 * P],
};
helpers.Write(simpleWrapperFragment.Data.AsSpan(0, 8), rawRefCount);
ulong ccwAddr = 0x4000;
helpers.WritePointer(simpleWrapperFragment.Data.AsSpan(12, P), ccwAddr);
builder.AddHeapFragment(simpleWrapperFragment);
var ccwFragment = new MockMemorySpace.HeapFragment
{
Name = "ComCallWrapper",
Address = ccwAddr,
Data = new byte[8 * P],
};
helpers.WritePointer(ccwFragment.Data.AsSpan(0, P), simpleWrapperAddr);
helpers.WritePointer(ccwFragment.Data.AsSpan(6 * P, P), LinkedWrapperTerminator);
builder.AddHeapFragment(ccwFragment);
Target target = CreateTarget(arch, builder, CreateTypeInfos(P));
var builtInCOM = target.Contracts.BuiltInCOM;
SimpleComCallWrapperData data = builtInCOM.GetSimpleComCallWrapperData(new TargetPointer(ccwAddr));
// RefCount should have the CLEANUP_SENTINEL bit stripped by the contract.
Assert.Equal(rawRefCount & ComRefcountMask, data.RefCount);
Assert.True(data.IsNeutered);
}
[Theory]
[ClassData(typeof(MockTarget.StdArch))]
public void GetSimpleComCallWrapperData_IsHandleWeak_FlagSet_ReturnsTrue(MockTarget.Architecture arch)
{
var helpers = new TargetTestHelpers(arch);
var builder = new MockMemorySpace.Builder(helpers);
int P = helpers.PointerSize;
const uint IsHandleWeakFlag = 0x4;
ulong simpleWrapperAddr = 0x5000;
ulong ccwAddr = 0x4000;
var simpleWrapperFragment = new MockMemorySpace.HeapFragment
{
Name = "SimpleComCallWrapper",
Address = simpleWrapperAddr,
Data = new byte[12 + 3 * P],
};
helpers.Write(simpleWrapperFragment.Data.AsSpan(8, 4), IsHandleWeakFlag);
helpers.WritePointer(simpleWrapperFragment.Data.AsSpan(12, P), ccwAddr);
builder.AddHeapFragment(simpleWrapperFragment);
var ccwFragment = new MockMemorySpace.HeapFragment
{
Name = "ComCallWrapper",
Address = ccwAddr,
Data = new byte[8 * P],
};
helpers.WritePointer(ccwFragment.Data.AsSpan(0, P), simpleWrapperAddr);
helpers.WritePointer(ccwFragment.Data.AsSpan(6 * P, P), LinkedWrapperTerminator);
builder.AddHeapFragment(ccwFragment);
Target target = CreateTarget(arch, builder, CreateTypeInfos(P));
var builtInCOM = target.Contracts.BuiltInCOM;
SimpleComCallWrapperData data = builtInCOM.GetSimpleComCallWrapperData(new TargetPointer(ccwAddr));
Assert.True(data.IsHandleWeak);
}
[Theory]
[ClassData(typeof(MockTarget.StdArch))]
public void GetSimpleComCallWrapperData_IsHandleWeak_FlagNotSet_ReturnsFalse(MockTarget.Architecture arch)
{
var helpers = new TargetTestHelpers(arch);
var builder = new MockMemorySpace.Builder(helpers);
int P = helpers.PointerSize;
ulong simpleWrapperAddr = 0x5000;
ulong ccwAddr = 0x4000;
var simpleWrapperFragment = new MockMemorySpace.HeapFragment
{
Name = "SimpleComCallWrapper",
Address = simpleWrapperAddr,
Data = new byte[12 + 3 * P],
};
helpers.WritePointer(simpleWrapperFragment.Data.AsSpan(12, P), ccwAddr);
builder.AddHeapFragment(simpleWrapperFragment);
var ccwFragment = new MockMemorySpace.HeapFragment
{
Name = "ComCallWrapper",
Address = ccwAddr,
Data = new byte[8 * P],
};
helpers.WritePointer(ccwFragment.Data.AsSpan(0, P), simpleWrapperAddr);
helpers.WritePointer(ccwFragment.Data.AsSpan(6 * P, P), LinkedWrapperTerminator);
builder.AddHeapFragment(ccwFragment);
Target target = CreateTarget(arch, builder, CreateTypeInfos(P));
var builtInCOM = target.Contracts.BuiltInCOM;
SimpleComCallWrapperData data = builtInCOM.GetSimpleComCallWrapperData(new TargetPointer(ccwAddr));
Assert.False(data.IsHandleWeak);
}
[Theory]
[ClassData(typeof(MockTarget.StdArch))]
public void GetSimpleComCallWrapperData_IsNeutered_SentinelBitSet_ReturnsTrue(MockTarget.Architecture arch)
{
var helpers = new TargetTestHelpers(arch);
var builder = new MockMemorySpace.Builder(helpers);
int P = helpers.PointerSize;
ulong simpleWrapperAddr = 0x5000;
ulong ccwAddr = 0x4000;
ulong rawRefCount = 0x80000000UL; // CLEANUP_SENTINEL bit set
var simpleWrapperFragment = new MockMemorySpace.HeapFragment
{
Name = "SimpleComCallWrapper",
Address = simpleWrapperAddr,
Data = new byte[12 + 3 * P],
};
helpers.Write(simpleWrapperFragment.Data.AsSpan(0, 8), rawRefCount);
helpers.WritePointer(simpleWrapperFragment.Data.AsSpan(12, P), ccwAddr);
builder.AddHeapFragment(simpleWrapperFragment);
var ccwFragment = new MockMemorySpace.HeapFragment
{
Name = "ComCallWrapper",
Address = ccwAddr,
Data = new byte[8 * P],
};
helpers.WritePointer(ccwFragment.Data.AsSpan(0, P), simpleWrapperAddr);
helpers.WritePointer(ccwFragment.Data.AsSpan(6 * P, P), LinkedWrapperTerminator);
builder.AddHeapFragment(ccwFragment);
Target target = CreateTarget(arch, builder, CreateTypeInfos(P));
var builtInCOM = target.Contracts.BuiltInCOM;
SimpleComCallWrapperData data = builtInCOM.GetSimpleComCallWrapperData(new TargetPointer(ccwAddr));
Assert.True(data.IsNeutered);
}
[Theory]
[ClassData(typeof(MockTarget.StdArch))]
public void GetSimpleComCallWrapperData_IsNeutered_SentinelBitClear_ReturnsFalse(MockTarget.Architecture arch)
{
var helpers = new TargetTestHelpers(arch);
var builder = new MockMemorySpace.Builder(helpers);
int P = helpers.PointerSize;
ulong simpleWrapperAddr = 0x5000;
ulong ccwAddr = 0x4000;
ulong rawRefCount = 3UL; // non-zero ref count, no sentinel
var simpleWrapperFragment = new MockMemorySpace.HeapFragment
{
Name = "SimpleComCallWrapper",
Address = simpleWrapperAddr,
Data = new byte[12 + 3 * P],
};
helpers.Write(simpleWrapperFragment.Data.AsSpan(0, 8), rawRefCount);
helpers.WritePointer(simpleWrapperFragment.Data.AsSpan(12, P), ccwAddr);
builder.AddHeapFragment(simpleWrapperFragment);
var ccwFragment = new MockMemorySpace.HeapFragment
{
Name = "ComCallWrapper",
Address = ccwAddr,
Data = new byte[8 * P],
};
helpers.WritePointer(ccwFragment.Data.AsSpan(0, P), simpleWrapperAddr);
helpers.WritePointer(ccwFragment.Data.AsSpan(6 * P, P), LinkedWrapperTerminator);
builder.AddHeapFragment(ccwFragment);
Target target = CreateTarget(arch, builder, CreateTypeInfos(P));
var builtInCOM = target.Contracts.BuiltInCOM;
SimpleComCallWrapperData data = builtInCOM.GetSimpleComCallWrapperData(new TargetPointer(ccwAddr));
Assert.False(data.IsNeutered);
}
[Theory]
[ClassData(typeof(MockTarget.StdArch))]
public void GetSimpleComCallWrapperData_IsAggregated_FlagSet_ReturnsTrue(MockTarget.Architecture arch)
{
var helpers = new TargetTestHelpers(arch);
var builder = new MockMemorySpace.Builder(helpers);
int P = helpers.PointerSize;
ulong simpleWrapperAddr = 0x5000;
ulong ccwAddr = 0x4000;
var simpleWrapperFragment = new MockMemorySpace.HeapFragment
{
Name = "SimpleComCallWrapper",
Address = simpleWrapperAddr,
Data = new byte[12 + 3 * P],
};
helpers.Write(simpleWrapperFragment.Data.AsSpan(8, 4), (uint)0x1); // IsAggregated flag
helpers.WritePointer(simpleWrapperFragment.Data.AsSpan(12, P), ccwAddr);
builder.AddHeapFragment(simpleWrapperFragment);
var ccwFragment = new MockMemorySpace.HeapFragment
{
Name = "ComCallWrapper",
Address = ccwAddr,
Data = new byte[8 * P],
};
helpers.WritePointer(ccwFragment.Data.AsSpan(0, P), simpleWrapperAddr);
helpers.WritePointer(ccwFragment.Data.AsSpan(6 * P, P), LinkedWrapperTerminator);
builder.AddHeapFragment(ccwFragment);
Target target = CreateTarget(arch, builder, CreateTypeInfos(P));
var builtInCOM = target.Contracts.BuiltInCOM;
SimpleComCallWrapperData data = builtInCOM.GetSimpleComCallWrapperData(new TargetPointer(ccwAddr));
Assert.True(data.IsAggregated);
}
[Theory]
[ClassData(typeof(MockTarget.StdArch))]
public void GetSimpleComCallWrapperData_IsAggregated_FlagNotSet_ReturnsFalse(MockTarget.Architecture arch)
{
var helpers = new TargetTestHelpers(arch);
var builder = new MockMemorySpace.Builder(helpers);
int P = helpers.PointerSize;
ulong simpleWrapperAddr = 0x5000;
ulong ccwAddr = 0x4000;
var simpleWrapperFragment = new MockMemorySpace.HeapFragment
{
Name = "SimpleComCallWrapper",
Address = simpleWrapperAddr,
Data = new byte[12 + 3 * P],
};
helpers.WritePointer(simpleWrapperFragment.Data.AsSpan(12, P), ccwAddr);
builder.AddHeapFragment(simpleWrapperFragment);
var ccwFragment = new MockMemorySpace.HeapFragment
{
Name = "ComCallWrapper",
Address = ccwAddr,
Data = new byte[8 * P],
};
helpers.WritePointer(ccwFragment.Data.AsSpan(0, P), simpleWrapperAddr);
helpers.WritePointer(ccwFragment.Data.AsSpan(6 * P, P), LinkedWrapperTerminator);
builder.AddHeapFragment(ccwFragment);
Target target = CreateTarget(arch, builder, CreateTypeInfos(P));
var builtInCOM = target.Contracts.BuiltInCOM;
SimpleComCallWrapperData data = builtInCOM.GetSimpleComCallWrapperData(new TargetPointer(ccwAddr));
Assert.False(data.IsAggregated);
}
[Theory]
[ClassData(typeof(MockTarget.StdArch))]
public void GetSimpleComCallWrapperData_IsExtendsCOMObject_FlagSet_ReturnsTrue(MockTarget.Architecture arch)
{
var helpers = new TargetTestHelpers(arch);
var builder = new MockMemorySpace.Builder(helpers);
int P = helpers.PointerSize;
ulong simpleWrapperAddr = 0x5000;
ulong ccwAddr = 0x4000;
var simpleWrapperFragment = new MockMemorySpace.HeapFragment
{
Name = "SimpleComCallWrapper",
Address = simpleWrapperAddr,
Data = new byte[12 + 3 * P],
};
helpers.Write(simpleWrapperFragment.Data.AsSpan(8, 4), (uint)0x2); // IsExtendsCom flag
helpers.WritePointer(simpleWrapperFragment.Data.AsSpan(12, P), ccwAddr);
builder.AddHeapFragment(simpleWrapperFragment);
var ccwFragment = new MockMemorySpace.HeapFragment
{
Name = "ComCallWrapper",
Address = ccwAddr,
Data = new byte[8 * P],
};
helpers.WritePointer(ccwFragment.Data.AsSpan(0, P), simpleWrapperAddr);
helpers.WritePointer(ccwFragment.Data.AsSpan(6 * P, P), LinkedWrapperTerminator);
builder.AddHeapFragment(ccwFragment);
Target target = CreateTarget(arch, builder, CreateTypeInfos(P));
var builtInCOM = target.Contracts.BuiltInCOM;
SimpleComCallWrapperData data = builtInCOM.GetSimpleComCallWrapperData(new TargetPointer(ccwAddr));
Assert.True(data.IsExtendsCOMObject);
}
[Theory]
[ClassData(typeof(MockTarget.StdArch))]
public void GetSimpleComCallWrapperData_IsExtendsCOMObject_FlagNotSet_ReturnsFalse(MockTarget.Architecture arch)
{
var helpers = new TargetTestHelpers(arch);
var builder = new MockMemorySpace.Builder(helpers);
int P = helpers.PointerSize;
ulong simpleWrapperAddr = 0x5000;
ulong ccwAddr = 0x4000;
var simpleWrapperFragment = new MockMemorySpace.HeapFragment
{
Name = "SimpleComCallWrapper",
Address = simpleWrapperAddr,
Data = new byte[12 + 3 * P],
};
helpers.WritePointer(simpleWrapperFragment.Data.AsSpan(12, P), ccwAddr);
builder.AddHeapFragment(simpleWrapperFragment);
var ccwFragment = new MockMemorySpace.HeapFragment
{
Name = "ComCallWrapper",
Address = ccwAddr,
Data = new byte[8 * P],
};
helpers.WritePointer(ccwFragment.Data.AsSpan(0, P), simpleWrapperAddr);
helpers.WritePointer(ccwFragment.Data.AsSpan(6 * P, P), LinkedWrapperTerminator);
builder.AddHeapFragment(ccwFragment);
Target target = CreateTarget(arch, builder, CreateTypeInfos(P));
var builtInCOM = target.Contracts.BuiltInCOM;
SimpleComCallWrapperData data = builtInCOM.GetSimpleComCallWrapperData(new TargetPointer(ccwAddr));
Assert.False(data.IsExtendsCOMObject);
}
[Theory]
[ClassData(typeof(MockTarget.StdArch))]
public void GetCCWInterfaces_SingleWrapper_SkipsNullAndIncompleteSlots(MockTarget.Architecture arch)
{
var helpers = new TargetTestHelpers(arch);
var builder = new MockMemorySpace.Builder(helpers);
int P = helpers.PointerSize;
uint cmtSize = (uint)(2 * P);
var allocator = builder.CreateAllocator(AllocationStart, AllocationEnd);
// SimpleComCallWrapper (MainWrapper will point to the CCW below)
var simpleWrapperFrag = allocator.Allocate((ulong)(12 + 3 * P), "SimpleComCallWrapper");
builder.AddHeapFragment(simpleWrapperFrag);
// ComCallWrapper: SimpleWrapper + 5 slots + Next + Handle = 8 pointers
var ccwFrag = allocator.Allocate((ulong)(8 * P), "ComCallWrapper");
builder.AddHeapFragment(ccwFrag);
// Write sccw.MainWrapper = ccwFrag.Address (start wrapper)
Span<byte> sccwData = builder.BorrowAddressRange(simpleWrapperFrag.Address, 12 + 2 * P);
helpers.WritePointer(sccwData.Slice(12, P), ccwFrag.Address);
// Slot 0: IUnknown (layout complete; MethodTable is Null per spec for first wrapper's slot 0)
var cmt0Frag = allocator.Allocate(cmtSize, "ComMethodTable[0]");
builder.AddHeapFragment(cmt0Frag);
ulong vtable0 = cmt0Frag.Address + cmtSize;
// Slot 1: incomplete layout (should be skipped)
var cmt1Frag = allocator.Allocate(cmtSize, "ComMethodTable[1]");
builder.AddHeapFragment(cmt1Frag);
ulong vtable1 = cmt1Frag.Address + cmtSize;
// Slot 2: layout complete with a MethodTable
ulong expectedMethodTable2 = 0xdead_0002;
var cmt2Frag = allocator.Allocate(cmtSize, "ComMethodTable[2]");
builder.AddHeapFragment(cmt2Frag);
ulong vtable2 = cmt2Frag.Address + cmtSize;
// Write CCW
Span<byte> ccw = builder.BorrowAddressRange(ccwFrag.Address, 7 * P);
helpers.WritePointer(ccw.Slice(0, P), simpleWrapperFrag.Address); // SimpleWrapper
helpers.WritePointer(ccw.Slice(1 * P, P), vtable0); // slot 0
helpers.WritePointer(ccw.Slice(2 * P, P), vtable1); // slot 1 (incomplete)
helpers.WritePointer(ccw.Slice(3 * P, P), vtable2); // slot 2
helpers.WritePointer(ccw.Slice(4 * P, P), 0); // slot 3 (null)
helpers.WritePointer(ccw.Slice(5 * P, P), 0); // slot 4 (null)
helpers.WritePointer(ccw.Slice(6 * P, P), LinkedWrapperTerminator); // Next = terminator
// Write ComMethodTable data
Span<byte> d0 = builder.BorrowAddressRange(cmt0Frag.Address, (int)cmtSize);
helpers.WriteNUInt(d0.Slice(0, P), new TargetNUInt(IsLayoutCompleteFlag));
helpers.WritePointer(d0.Slice(P, P), 0);
Span<byte> d1 = builder.BorrowAddressRange(cmt1Frag.Address, (int)cmtSize);
helpers.WriteNUInt(d1.Slice(0, P), new TargetNUInt(0)); // NOT layout complete
Span<byte> d2 = builder.BorrowAddressRange(cmt2Frag.Address, (int)cmtSize);
helpers.WriteNUInt(d2.Slice(0, P), new TargetNUInt(IsLayoutCompleteFlag));
helpers.WritePointer(d2.Slice(P, P), expectedMethodTable2);
Target target = CreateTarget(arch, builder, CreateTypeInfos(P));
List<COMInterfacePointerData> interfaces =
target.Contracts.BuiltInCOM.GetCCWInterfaces(new TargetPointer(ccwFrag.Address)).ToList();
// Only slot 0 and slot 2 appear: slot 1 is incomplete, slots 3/4 are null
Assert.Equal(2, interfaces.Count);
// Slot 0: IUnknown (first wrapper, index 0) => MethodTable = Null
Assert.Equal(ccwFrag.Address + (ulong)P, interfaces[0].InterfacePointerAddress.Value);
Assert.Equal(TargetPointer.Null.Value, interfaces[0].MethodTable.Value);
// Slot 2: at offset 3*P from CCW base (IPtr + 2*P)
Assert.Equal(ccwFrag.Address + (ulong)(3 * P), interfaces[1].InterfacePointerAddress.Value);
Assert.Equal(expectedMethodTable2, interfaces[1].MethodTable.Value);
}
[Theory]
[ClassData(typeof(MockTarget.StdArch))]
public void GetCCWInterfaces_MultipleWrappers_WalksChain(MockTarget.Architecture arch)
{
var helpers = new TargetTestHelpers(arch);
var builder = new MockMemorySpace.Builder(helpers);
int P = helpers.PointerSize;
uint cmtSize = (uint)(2 * P);
var allocator = builder.CreateAllocator(AllocationStart, AllocationEnd);
// SimpleComCallWrapper (shared by both wrappers; MainWrapper will point to first CCW)
var simpleWrapperFrag = allocator.Allocate((ulong)(12 + 3 * P), "SimpleComCallWrapper");
builder.AddHeapFragment(simpleWrapperFrag);
// First CCW: slot 0 = IUnknown; slots 1-4 = null; Next -> second CCW
var ccw1Frag = allocator.Allocate((ulong)(8 * P), "ComCallWrapper[1]");
builder.AddHeapFragment(ccw1Frag);
var cmt1_0Frag = allocator.Allocate(cmtSize, "ComMethodTable ccw1[0]");
builder.AddHeapFragment(cmt1_0Frag);
ulong vtable1_0 = cmt1_0Frag.Address + cmtSize;
// Second CCW: slot 0 = IClassX, slot 2 = interface; Next = terminator
var ccw2Frag = allocator.Allocate((ulong)(8 * P), "ComCallWrapper[2]");
builder.AddHeapFragment(ccw2Frag);
ulong expectedMT_slot0 = 0xbbbb_0000;
var cmt2_0Frag = allocator.Allocate(cmtSize, "ComMethodTable ccw2[0]");
builder.AddHeapFragment(cmt2_0Frag);
ulong vtable2_0 = cmt2_0Frag.Address + cmtSize;
ulong expectedMT_slot2 = 0xcccc_0002;
var cmt2_2Frag = allocator.Allocate(cmtSize, "ComMethodTable ccw2[2]");
builder.AddHeapFragment(cmt2_2Frag);
ulong vtable2_2 = cmt2_2Frag.Address + cmtSize;
// Write sccw.MainWrapper = ccw1Frag.Address (start wrapper)
Span<byte> sccwData = builder.BorrowAddressRange(simpleWrapperFrag.Address, 12 + 2 * P);
helpers.WritePointer(sccwData.Slice(12, P), ccw1Frag.Address);
// Write first CCW
Span<byte> w1 = builder.BorrowAddressRange(ccw1Frag.Address, 7 * P);
helpers.WritePointer(w1.Slice(0, P), simpleWrapperFrag.Address); // SimpleWrapper
helpers.WritePointer(w1.Slice(1 * P, P), vtable1_0); // slot 0
helpers.WritePointer(w1.Slice(2 * P, P), 0); // slot 1
helpers.WritePointer(w1.Slice(3 * P, P), 0); // slot 2
helpers.WritePointer(w1.Slice(4 * P, P), 0); // slot 3
helpers.WritePointer(w1.Slice(5 * P, P), 0); // slot 4
helpers.WritePointer(w1.Slice(6 * P, P), ccw2Frag.Address); // Next -> ccw2
// Write second CCW
Span<byte> w2 = builder.BorrowAddressRange(ccw2Frag.Address, 7 * P);
helpers.WritePointer(w2.Slice(0, P), simpleWrapperFrag.Address); // SimpleWrapper
helpers.WritePointer(w2.Slice(1 * P, P), vtable2_0); // slot 0
helpers.WritePointer(w2.Slice(2 * P, P), 0); // slot 1
helpers.WritePointer(w2.Slice(3 * P, P), vtable2_2); // slot 2
helpers.WritePointer(w2.Slice(4 * P, P), 0); // slot 3
helpers.WritePointer(w2.Slice(5 * P, P), 0); // slot 4
helpers.WritePointer(w2.Slice(6 * P, P), LinkedWrapperTerminator); // Next = terminator
// Write ComMethodTable for first CCW slot 0 (MethodTable unused for first-wrapper slot 0)
Span<byte> d1_0 = builder.BorrowAddressRange(cmt1_0Frag.Address, (int)cmtSize);
helpers.WriteNUInt(d1_0.Slice(0, P), new TargetNUInt(IsLayoutCompleteFlag));
helpers.WritePointer(d1_0.Slice(P, P), 0);
// Write ComMethodTable for second CCW slot 0
Span<byte> d2_0 = builder.BorrowAddressRange(cmt2_0Frag.Address, (int)cmtSize);
helpers.WriteNUInt(d2_0.Slice(0, P), new TargetNUInt(IsLayoutCompleteFlag));
helpers.WritePointer(d2_0.Slice(P, P), expectedMT_slot0);
// Write ComMethodTable for second CCW slot 2
Span<byte> d2_2 = builder.BorrowAddressRange(cmt2_2Frag.Address, (int)cmtSize);
helpers.WriteNUInt(d2_2.Slice(0, P), new TargetNUInt(IsLayoutCompleteFlag));
helpers.WritePointer(d2_2.Slice(P, P), expectedMT_slot2);
Target target = CreateTarget(arch, builder, CreateTypeInfos(P));
List<COMInterfacePointerData> interfaces =
target.Contracts.BuiltInCOM.GetCCWInterfaces(new TargetPointer(ccw1Frag.Address)).ToList();
// 3 interfaces: ccw1 slot0 (IUnknown), ccw2 slot0 (IClassX), ccw2 slot2 (interface)
Assert.Equal(3, interfaces.Count);
// First wrapper, slot 0: IUnknown => MethodTable = Null
Assert.Equal(ccw1Frag.Address + (ulong)P, interfaces[0].InterfacePointerAddress.Value);
Assert.Equal(TargetPointer.Null.Value, interfaces[0].MethodTable.Value);
// Second wrapper, slot 0: IClassX - has a MethodTable (not first wrapper)
Assert.Equal(ccw2Frag.Address + (ulong)P, interfaces[1].InterfacePointerAddress.Value);
Assert.Equal(expectedMT_slot0, interfaces[1].MethodTable.Value);
// Second wrapper, slot 2
Assert.Equal(ccw2Frag.Address + (ulong)(3 * P), interfaces[2].InterfacePointerAddress.Value);
Assert.Equal(expectedMT_slot2, interfaces[2].MethodTable.Value);
}
[Theory]
[ClassData(typeof(MockTarget.StdArch))]
public void GetCCWInterfaces_LinkedWrapper_WalksFullChainFromAnyWrapper(MockTarget.Architecture arch)
{
var helpers = new TargetTestHelpers(arch);
var builder = new MockMemorySpace.Builder(helpers);
int P = helpers.PointerSize;
uint cmtSize = (uint)(2 * P);
var allocator = builder.CreateAllocator(AllocationStart, AllocationEnd);
// SimpleComCallWrapper; MainWrapper → first CCW (set up below)
var simpleWrapperFrag = allocator.Allocate((ulong)(12 + 3 * P), "SimpleComCallWrapper");
builder.AddHeapFragment(simpleWrapperFrag);
// First (start) CCW: one interface in slot 0 (IUnknown), Next → second CCW
var ccw1Frag = allocator.Allocate((ulong)(8 * P), "ComCallWrapper[1]");
builder.AddHeapFragment(ccw1Frag);
var cmt1Frag = allocator.Allocate(cmtSize, "ComMethodTable[1]");
builder.AddHeapFragment(cmt1Frag);
ulong vtable1 = cmt1Frag.Address + cmtSize;
// Second (linked) CCW: one interface in slot 1, Next = terminator
var ccw2Frag = allocator.Allocate((ulong)(8 * P), "ComCallWrapper[2]");
builder.AddHeapFragment(ccw2Frag);
ulong expectedMT = 0xaaaa_0001;
var cmt2Frag = allocator.Allocate(cmtSize, "ComMethodTable[2]");
builder.AddHeapFragment(cmt2Frag);
ulong vtable2 = cmt2Frag.Address + cmtSize;
// sccw.MainWrapper = ccw1 (the start wrapper)
Span<byte> sccwData = builder.BorrowAddressRange(simpleWrapperFrag.Address, 12 + 2 * P);
helpers.WritePointer(sccwData.Slice(12, P), ccw1Frag.Address);
// Write first CCW
Span<byte> w1 = builder.BorrowAddressRange(ccw1Frag.Address, 7 * P);
helpers.WritePointer(w1.Slice(0, P), simpleWrapperFrag.Address);
helpers.WritePointer(w1.Slice(1 * P, P), vtable1); // slot 0
helpers.WritePointer(w1.Slice(2 * P, P), 0);
helpers.WritePointer(w1.Slice(3 * P, P), 0);
helpers.WritePointer(w1.Slice(4 * P, P), 0);
helpers.WritePointer(w1.Slice(5 * P, P), 0);
helpers.WritePointer(w1.Slice(6 * P, P), ccw2Frag.Address); // Next → ccw2
// Write second CCW
Span<byte> w2 = builder.BorrowAddressRange(ccw2Frag.Address, 7 * P);
helpers.WritePointer(w2.Slice(0, P), simpleWrapperFrag.Address);
helpers.WritePointer(w2.Slice(1 * P, P), 0); // slot 0 null
helpers.WritePointer(w2.Slice(2 * P, P), vtable2); // slot 1
helpers.WritePointer(w2.Slice(3 * P, P), 0);
helpers.WritePointer(w2.Slice(4 * P, P), 0);
helpers.WritePointer(w2.Slice(5 * P, P), 0);
helpers.WritePointer(w2.Slice(6 * P, P), LinkedWrapperTerminator);
// ComMethodTable for ccw1 slot 0 (IUnknown; MethodTable null for slot 0 of first wrapper)
Span<byte> d1 = builder.BorrowAddressRange(cmt1Frag.Address, (int)cmtSize);
helpers.WriteNUInt(d1.Slice(0, P), new TargetNUInt(IsLayoutCompleteFlag));
helpers.WritePointer(d1.Slice(P, P), 0);
// ComMethodTable for ccw2 slot 1
Span<byte> d2 = builder.BorrowAddressRange(cmt2Frag.Address, (int)cmtSize);
helpers.WriteNUInt(d2.Slice(0, P), new TargetNUInt(IsLayoutCompleteFlag));
helpers.WritePointer(d2.Slice(P, P), expectedMT);
Target target = CreateTarget(arch, builder, CreateTypeInfos(P));
// Passing the start CCW enumerates both wrappers' interfaces.
List<COMInterfacePointerData> interfacesFromStart =
target.Contracts.BuiltInCOM.GetCCWInterfaces(new TargetPointer(ccw1Frag.Address)).ToList();
Assert.Equal(2, interfacesFromStart.Count);
// ccw1 slot 0: IUnknown → MethodTable = Null (first wrapper, slot 0)
Assert.Equal(ccw1Frag.Address + (ulong)P, interfacesFromStart[0].InterfacePointerAddress.Value);
Assert.Equal(TargetPointer.Null.Value, interfacesFromStart[0].MethodTable.Value);
// ccw2 slot 1
Assert.Equal(ccw2Frag.Address + (ulong)(2 * P), interfacesFromStart[1].InterfacePointerAddress.Value);
Assert.Equal(expectedMT, interfacesFromStart[1].MethodTable.Value);
// Passing the second (non-start) CCW also navigates to the start and enumerates the full chain.
List<COMInterfacePointerData> interfacesFromLinked =
target.Contracts.BuiltInCOM.GetCCWInterfaces(new TargetPointer(ccw2Frag.Address)).ToList();
Assert.Equal(interfacesFromStart.Count, interfacesFromLinked.Count);
for (int i = 0; i < interfacesFromStart.Count; i++)
{
Assert.Equal(interfacesFromStart[i].InterfacePointerAddress.Value, interfacesFromLinked[i].InterfacePointerAddress.Value);
Assert.Equal(interfacesFromStart[i].MethodTable.Value, interfacesFromLinked[i].MethodTable.Value);
}
}
[Theory]
[ClassData(typeof(MockTarget.StdArch))]
public void GetRCWInterfaces_ReturnsFilledEntries(MockTarget.Architecture arch)
{
TargetPointer rcwAddress = default;
(TargetPointer MethodTable, TargetPointer Unknown)[] expectedEntries =
[
(new TargetPointer(0x1000), new TargetPointer(0x2000)),
(new TargetPointer(0x3000), new TargetPointer(0x4000)),
];
BuiltInCOMContractHelper(arch,
(builder, targetTestHelpers, types) =>
{
MockMemorySpace.BumpAllocator allocator = builder.CreateAllocator(AllocationRangeStart, AllocationRangeEnd);
rcwAddress = AddRCWWithInlineEntries(builder, targetTestHelpers, types, allocator, expectedEntries);
},
(target) =>
{
IBuiltInCOM contract = target.Contracts.BuiltInCOM;
Assert.NotNull(contract);
List<(TargetPointer MethodTable, TargetPointer Unknown)> results =
contract.GetRCWInterfaces(rcwAddress).ToList();
Assert.Equal(expectedEntries.Length, results.Count);
for (int i = 0; i < expectedEntries.Length; i++)
{
Assert.Equal(expectedEntries[i].MethodTable, results[i].MethodTable);
Assert.Equal(expectedEntries[i].Unknown, results[i].Unknown);
}
});
}
[Theory]
[ClassData(typeof(MockTarget.StdArch))]
public void GetCCWInterfaces_ComIpAddress_ResolvesToCCW(MockTarget.Architecture arch)
{
var helpers = new TargetTestHelpers(arch);
var builder = new MockMemorySpace.Builder(helpers);
int P = helpers.PointerSize;
uint cmtSize = (uint)(2 * P);
var allocator = builder.CreateAllocator(AllocationStart, AllocationEnd);
// SimpleComCallWrapper; MainWrapper → CCW (aligned, set up below)
var simpleWrapperFrag = allocator.Allocate((ulong)(12 + 3 * P), "SimpleComCallWrapper");
builder.AddHeapFragment(simpleWrapperFrag);
// Place the CCW at a CCWThisMask-aligned address so that (ccwAddr + P) & thisMask == ccwAddr.
// On 64-bit: alignment = 64 bytes; on 32-bit: alignment = 32 bytes.
ulong thisMask = GetCCWThisMask(P);
ulong alignment = ~thisMask + 1; // = 64 on 64-bit, 32 on 32-bit
ulong alignedCCWAddr = (AllocationStart + 0x200 + alignment - 1) & thisMask;
var ccwFrag = new MockMemorySpace.HeapFragment
{
Name = "ComCallWrapper",
Address = alignedCCWAddr,
Data = new byte[8 * P],
};
builder.AddHeapFragment(ccwFrag);
// sccw.MainWrapper = ccwFrag.Address (start wrapper)
Span<byte> sccwData = builder.BorrowAddressRange(simpleWrapperFrag.Address, 12 + 3 * P);
helpers.WritePointer(sccwData.Slice(12, P), ccwFrag.Address);
// Allocate CMT and a vtable extension right after it so vtable = cmtFrag.Address + cmtSize.
// The vtable extension holds vtable slots [0] (QI) and [1] (AddRef = TearOffAddRefAddr).
var cmtFrag = allocator.Allocate(cmtSize, "ComMethodTable");
builder.AddHeapFragment(cmtFrag);
ulong vtable = cmtFrag.Address + cmtSize;
var vtableExtFrag = new MockMemorySpace.HeapFragment
{
Name = "VtableExt",
Address = vtable,
Data = new byte[2 * P],
};
builder.AddHeapFragment(vtableExtFrag);
Span<byte> vtableExtData = builder.BorrowAddressRange(vtable, 2 * P);
helpers.WritePointer(vtableExtData.Slice(0, P), 0); // slot 0: QI
helpers.WritePointer(vtableExtData.Slice(P, P), TearOffAddRefAddr); // slot 1: AddRef = tear-off
// Write the CCW: slot 0 (IP[0]) = vtable, rest null, Next = terminator
Span<byte> ccwData = builder.BorrowAddressRange(ccwFrag.Address, 8 * P);
helpers.WritePointer(ccwData.Slice(0, P), simpleWrapperFrag.Address);
helpers.WritePointer(ccwData.Slice(1 * P, P), vtable); // IP[0]
helpers.WritePointer(ccwData.Slice(2 * P, P), 0);
helpers.WritePointer(ccwData.Slice(3 * P, P), 0);
helpers.WritePointer(ccwData.Slice(4 * P, P), 0);
helpers.WritePointer(ccwData.Slice(5 * P, P), 0);
helpers.WritePointer(ccwData.Slice(6 * P, P), LinkedWrapperTerminator);
// Write CMT: LayoutComplete, MethodTable = null (slot 0 of first wrapper)
Span<byte> cmtData = builder.BorrowAddressRange(cmtFrag.Address, (int)cmtSize);
helpers.WriteNUInt(cmtData.Slice(0, P), new TargetNUInt(IsLayoutCompleteFlag));
helpers.WritePointer(cmtData.Slice(P, P), 0);
Target target = CreateTarget(arch, builder, CreateTypeInfos(P));
// COM IP = alignedCCWAddr + P (= address of IP[0] slot within the CCW).
// *comIP = vtable; vtable[1] = TearOffAddRefAddr → detected as standard CCW IP.
// (alignedCCWAddr + P) & thisMask = alignedCCWAddr (since P < alignment).
ulong comIPAddr = alignedCCWAddr + (ulong)P;
// GetCCWFromInterfacePointer resolves the COM IP to the start CCW pointer.
TargetPointer startCCWFromIP = target.Contracts.BuiltInCOM.GetCCWFromInterfacePointer(new TargetPointer(comIPAddr));
Assert.Equal(ccwFrag.Address, startCCWFromIP.Value);
// A direct CCW pointer is not a COM IP; GetCCWFromInterfacePointer returns Null.
TargetPointer nullResult = target.Contracts.BuiltInCOM.GetCCWFromInterfacePointer(new TargetPointer(ccwFrag.Address));
Assert.Equal(TargetPointer.Null, nullResult);
// GetCCWInterfaces works with either the resolved IP or the direct CCW pointer.
List<COMInterfacePointerData> ifacesDirect =
target.Contracts.BuiltInCOM.GetCCWInterfaces(new TargetPointer(ccwFrag.Address)).ToList();
List<COMInterfacePointerData> ifacesFromIP =
target.Contracts.BuiltInCOM.GetCCWInterfaces(startCCWFromIP).ToList();
// Both paths should produce the same interfaces
Assert.Equal(ifacesDirect.Count, ifacesFromIP.Count);
for (int i = 0; i < ifacesDirect.Count; i++)
{
Assert.Equal(ifacesDirect[i].InterfacePointerAddress.Value, ifacesFromIP[i].InterfacePointerAddress.Value);
Assert.Equal(ifacesDirect[i].MethodTable.Value, ifacesFromIP[i].MethodTable.Value);
}
}
[Theory]
[ClassData(typeof(MockTarget.StdArch))]
public void GetRCWInterfaces_SkipsEntriesWithNullUnknown(MockTarget.Architecture arch)
{
TargetPointer rcwAddress = default;
// The IsFree() check uses only Unknown == null; entries with Unknown == null are skipped.
(TargetPointer MethodTable, TargetPointer Unknown)[] entries =
[
(new TargetPointer(0x1000), new TargetPointer(0x2000)),
(TargetPointer.Null, TargetPointer.Null), // free entry (Unknown == null)
(new TargetPointer(0x5000), new TargetPointer(0x6000)),
];
BuiltInCOMContractHelper(arch,
(builder, targetTestHelpers, types) =>
{
MockMemorySpace.BumpAllocator allocator = builder.CreateAllocator(AllocationRangeStart, AllocationRangeEnd);
rcwAddress = AddRCWWithInlineEntries(builder, targetTestHelpers, types, allocator, entries);
},
(target) =>
{
IBuiltInCOM contract = target.Contracts.BuiltInCOM;
List<(TargetPointer MethodTable, TargetPointer Unknown)> results =
contract.GetRCWInterfaces(rcwAddress).ToList();
// Only the 2 entries with non-null Unknown are returned