-
Notifications
You must be signed in to change notification settings - Fork 4k
/
PeWriter.cs
7879 lines (6784 loc) · 322 KB
/
PeWriter.cs
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
// Copyright (c) Microsoft Open Technologies, Inc. All Rights Reserved. Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Diagnostics;
using System.IO;
using System.Linq;
using System.Reflection;
using System.Reflection.Emit;
using System.Reflection.Metadata;
using System.Reflection.Metadata.Ecma335;
using System.Runtime.InteropServices;
using System.Text;
using System.Threading;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CodeGen;
using Microsoft.CodeAnalysis.Collections;
using Roslyn.Utilities;
namespace Microsoft.Cci
{
internal abstract class PeWriter
{
/// <summary>
/// This is the maximum length of a type or member name in metadata, assuming
/// the name is in UTF-8 format and not (yet) null-terminated.
/// </summary>
/// <remarks>
/// Source names may have to be shorter still to accommodate mangling.
/// Used for event names, field names, property names, field names, method def names,
/// member ref names, type def (full) names, type ref (full) names, exported type
/// (full) names, parameter names, manifest resource names, and unmanaged method names
/// (ImplMap table).
///
/// See CLI Part II, section 22.
/// </remarks>
internal const int NameLengthLimit = 1024 - 1; //MAX_CLASS_NAME = 1024 in dev11
/// <summary>
/// This is the maximum length of a path in metadata, assuming the path is in UTF-8
/// format and not (yet) null-terminated.
/// </summary>
/// <remarks>
/// Used for file names, module names, and module ref names.
///
/// See CLI Part II, section 22.
/// </remarks>
internal const int PathLengthLimit = 260 - 1; //MAX_PATH = 1024 in dev11
/// <summary>
/// This is the maximum length of a string in the PDB, assuming it is in UTF-8 format
/// and not (yet) null-terminated.
/// </summary>
/// <remarks>
/// Used for import strings, locals, and local constants.
/// </remarks>
internal const int PdbLengthLimit = 2046; // Empirical, based on when ISymUnmanagedWriter2 methods start throwing.
private static readonly Encoding Utf8Encoding = Encoding.UTF8;
protected PeWriter(
Microsoft.CodeAnalysis.Emit.Context context,
CommonMessageProvider messageProvider,
PdbWriter/*?*/ pdbWriter,
bool allowMissingMethodBodies,
bool foldIdenticalMethodBodies,
CancellationToken cancellationToken)
{
this.module = context.Module;
// EDMAURER provide some reasonable size estimates for these that will avoid
// much of the reallocation that would occur when growing these from empty.
methodBodyIndex = new Dictionary<IMethodDefinition, uint>(module.HintNumberOfMethodDefinitions);
signatureIndex = new Dictionary<ISignature, uint>(module.HintNumberOfMethodDefinitions); //ignores field signatures
numTypeDefsEstimate = module.HintNumberOfMethodDefinitions / 6;
exportedTypeIndex = new Dictionary<ITypeReference, uint>(numTypeDefsEstimate);
exportedTypeList = new List<ITypeReference>(numTypeDefsEstimate);
this.Context = context;
this.messageProvider = messageProvider;
this.emitRuntimeStartupStub = module.RequiresStartupStub;
this.pdbWriter = pdbWriter;
this.allowMissingMethodBodies = allowMissingMethodBodies;
this.cancellationToken = cancellationToken;
this.sizeOfImportAddressTable = this.emitRuntimeStartupStub ? (!this.module.Requires64bits ? 8u : 16u) : 0;
if (pdbWriter != null)
{
pdbWriter.SetMetadataEmitter(this);
}
if (foldIdenticalMethodBodies)
{
possiblyDuplicateMethodBodies = new Dictionary<byte[], uint>(ByteSequenceComparer.Instance);
}
}
private readonly int numTypeDefsEstimate;
private int NumberOfTypeDefsEstimate { get { return numTypeDefsEstimate; } }
/// <summary>
/// Returns true if writing full metadata, false if writing delta.
/// </summary>
private bool IsFullMetadata
{
get { return this.Generation == 0; }
}
/// <summary>
/// True if writing delta metadata in a minimal format.
/// </summary>
private bool IsMinimalDelta
{
get { return !IsFullMetadata; }
}
protected Guid ModuleVersionId
{
get { return this.module.PersistentIdentifier; }
}
/// <summary>
/// Returns metadata generation ordinal. Zero for
/// full metadata and non-zero for delta.
/// </summary>
protected abstract ushort Generation { get; }
/// <summary>
/// Returns unique Guid for this delta, or default(Guid)
/// if full metadata.
/// </summary>
protected abstract Guid EncId { get; }
/// <summary>
/// Returns Guid of previous delta, or default(Guid)
/// if full metadata or generation 1 delta.
/// </summary>
protected abstract Guid EncBaseId { get; }
/// <summary>
/// Returns true if the metadata stream should be compressed.
/// </summary>
protected abstract bool CompressMetadataStream { get; }
/// <summary>
/// Returns true and the 1-based index of the type definition
/// if the type definition is recognized. Otherwise returns false.
/// The index is into the full metadata.
/// </summary>
protected abstract bool TryGetTypeDefIndex(ITypeDefinition def, out uint index);
/// <summary>
/// The 1-based index of the type definition.
/// The index is into the full metadata.
/// </summary>
protected abstract uint GetTypeDefIndex(ITypeDefinition def);
/// <summary>
/// The type definition at the 0-based index into the full set. Deltas
/// are only required to support indexing into current generation.
/// </summary>
protected abstract ITypeDefinition GetTypeDef(int index);
/// <summary>
/// The type definitions to be emitted, in row order. These
/// are just the type definitions from the current generation.
/// </summary>
protected abstract IReadOnlyList<ITypeDefinition> GetTypeDefs();
/// <summary>
/// The 1-based index of the event definition.
/// The index is into the full metadata.
/// </summary>
protected abstract uint GetEventDefIndex(IEventDefinition def);
/// <summary>
/// The event definitions to be emitted, in row order. These
/// are just the event definitions from the current generation.
/// </summary>
protected abstract IReadOnlyList<IEventDefinition> GetEventDefs();
/// <summary>
/// The 1-based index of the field definition.
/// The index is into the full metadata.
/// </summary>
protected abstract uint GetFieldDefIndex(IFieldDefinition def);
/// <summary>
/// The field definitions to be emitted, in row order. These
/// are just the field definitions from the current generation.
/// </summary>
protected abstract IReadOnlyList<IFieldDefinition> GetFieldDefs();
/// <summary>
/// Returns true and the 1-based index of the method definition
/// if the method definition is recognized. Otherwise returns false.
/// The index is into the full metadata.
/// </summary>
protected abstract bool TryGetMethodDefIndex(IMethodDefinition def, out uint index);
/// <summary>
/// The 1-based index of the method definition.
/// The index is into the full metadata.
/// </summary>
protected abstract uint GetMethodDefIndex(IMethodDefinition def);
/// <summary>
/// The method definition at the 0-based index into the full set. Deltas
/// are only required to support indexing into current generation.
/// </summary>
protected abstract IMethodDefinition GetMethodDef(int index);
/// <summary>
/// The method definitions to be emitted, in row order. These
/// are just the method definitions from the current generation.
/// </summary>
protected abstract IReadOnlyList<IMethodDefinition> GetMethodDefs();
/// <summary>
/// The 1-based index of the property definition.
/// The index is into the full metadata.
/// </summary>
protected abstract uint GetPropertyDefIndex(IPropertyDefinition def);
/// <summary>
/// The property definitions to be emitted, in row order. These
/// are just the property definitions from the current generation.
/// </summary>
protected abstract IReadOnlyList<IPropertyDefinition> GetPropertyDefs();
/// <summary>
/// The 1-based index of the parameter definition.
/// The index is into the full metadata.
/// </summary>
protected abstract uint GetParameterDefIndex(IParameterDefinition def);
/// <summary>
/// The parameter definitions to be emitted, in row order. These
/// are just the parameter definitions from the current generation.
/// </summary>
protected abstract IReadOnlyList<IParameterDefinition> GetParameterDefs();
/// <summary>
/// The 1-based index of the generic parameter definition.
/// The index is into the full metadata.
/// </summary>
protected abstract uint GetGenericParameterIndex(IGenericParameter def);
/// <summary>
/// The generic parameter definitions to be emitted, in row order. These
/// are just the generic parameter definitions from the current generation.
/// </summary>
protected abstract IReadOnlyList<IGenericParameter> GetGenericParameters();
/// <summary>
/// The 1-based index of the first field of the type.
/// </summary>
protected abstract uint GetFieldDefIndex(INamedTypeDefinition typeDef);
/// <summary>
/// The 1-based index of the first method of the type.
/// </summary>
protected abstract uint GetMethodDefIndex(INamedTypeDefinition typeDef);
/// <summary>
/// The 1-based index of the first parameter of the method.
/// </summary>
protected abstract uint GetParameterDefIndex(IMethodDefinition methodDef);
/// <summary>
/// Return the 1-based index of the assembly reference, adding
/// the reference to the index for this generation if missing.
/// The index is into the full metadata. However, deltas
/// are not required to return rows from previous generations.
/// </summary>
protected abstract uint GetOrAddAssemblyRefIndex(IAssemblyReference reference);
/// <summary>
/// The assembly references to be emitted, in row order. These
/// are just the assembly references from the current generation.
/// </summary>
protected abstract IReadOnlyList<IAssemblyReference> GetAssemblyRefs();
// ModuleRef table contains module names for TypeRefs that target types in netmodules (represented by IModuleReference),
// and module names specified by P/Invokes (plain strings). Names in the table must be unique and are case sensitive.
//
// Spec 22.31 (ModuleRef : 0x1A)
// "Name should match an entry in the Name column of the File table. Moreover, that entry shall enable the
// CLI to locate the target module (typically it might name the file used to hold the module)"
//
// This is not how the Dev10 compilers and ILASM work. An entry is added to File table only for resources and netmodules.
// Entries aren't added for P/Invoked modules.
/// <summary>
/// Return the 1-based index of the module reference, adding
/// the reference to the index for this generation if missing.
/// The index is into the full metadata. However, deltas
/// are not required to return rows from previous generations.
/// </summary>
protected abstract uint GetOrAddModuleRefIndex(string reference);
/// <summary>
/// The module references to be emitted, in row order. These
/// are just the module references from the current generation.
/// </summary>
protected abstract IReadOnlyList<string> GetModuleRefs();
/// <summary>
/// Return the 1-based index of the member reference, adding
/// the reference to the index for this generation if missing.
/// The index is into the full metadata. However, deltas
/// are not required to return rows from previous generations.
/// </summary>
protected abstract uint GetOrAddMemberRefIndex(ITypeMemberReference reference);
/// <summary>
/// The member references to be emitted, in row order. These
/// are just the member references from the current generation.
/// </summary>
protected abstract IReadOnlyList<ITypeMemberReference> GetMemberRefs();
/// <summary>
/// Return the 1-based index of the method spec, adding
/// the spec to the index for this generation if missing.
/// The index is into the full metadata. However, deltas
/// are not required to return rows from previous generations.
/// </summary>
protected abstract uint GetOrAddMethodSpecIndex(IGenericMethodInstanceReference reference);
/// <summary>
/// The method specs to be emitted, in row order. These
/// are just the method specs from the current generation.
/// </summary>
protected abstract IReadOnlyList<IGenericMethodInstanceReference> GetMethodSpecs();
/// <summary>
/// Return true and the 1-based index of the type reference
/// if the reference is available in the current generation.
/// The index is into the full metadata. However, deltas
/// are not required to return rows from previous generations.
/// </summary>
protected abstract bool TryGetTypeRefIndex(ITypeReference reference, out uint index);
/// <summary>
/// Return the 1-based index of the type reference, adding
/// the reference to the index for this generation if missing.
/// The index is into the full metadata. However, deltas
/// are not required to return rows from previous generations.
/// </summary>
protected abstract uint GetOrAddTypeRefIndex(ITypeReference reference);
/// <summary>
/// The type references to be emitted, in row order. These
/// are just the type references from the current generation.
/// </summary>
protected abstract IReadOnlyList<ITypeReference> GetTypeRefs();
/// <summary>
/// Return the 1-based index of the type spec, adding
/// the spec to the index for this generation if missing.
/// The index is into the full metadata. However, deltas
/// are not required to return rows from previous generations.
/// </summary>
protected abstract uint GetOrAddTypeSpecIndex(ITypeReference reference);
/// <summary>
/// The type specs to be emitted, in row order. These
/// are just the type specs from the current generation.
/// </summary>
protected abstract IReadOnlyList<ITypeReference> GetTypeSpecs();
/// <summary>
/// Return the 1-based index of the signature index, adding
/// the signature to the index for this generation if missing.
/// The index is into the full metadata. However, deltas
/// are not required to return rows from previous generations.
/// </summary>
protected abstract uint GetOrAddStandAloneSignatureIndex(uint blobIndex);
/// <summary>
/// The signature indices to be emitted, in row order. These
/// are just the signature indices from the current generation.
/// </summary>
protected abstract IReadOnlyList<uint> GetStandAloneSignatures();
protected abstract IEnumerable<INamespaceTypeDefinition> GetTopLevelTypes(IModule module);
protected abstract void CreateIndicesForNonTypeMembers(ITypeDefinition typeDef);
/// <summary>
/// Offset into full metadata blob stream.
/// </summary>
protected abstract uint GetBlobStreamOffset();
/// <summary>
/// Offset into full metadata string stream.
/// </summary>
protected abstract uint GetStringStreamOffset();
/// <summary>
/// Offset into full metadata user string stream.
/// </summary>
protected abstract uint GetUserStringStreamOffset();
/// <summary>
/// Return a visitor for traversing all references to be emitted.
/// </summary>
protected abstract ReferenceIndexer CreateReferenceVisitor();
/// <summary>
/// Invoked after serializing the method body.
/// </summary>
protected virtual void OnSerializedMethodBody(IMethodDefinition method, IMethodBody body)
{
}
/// <summary>
/// Invoked after serializing metadata tables.
/// </summary>
protected virtual void OnSerializedMetadataTables()
{
}
/// <summary>
/// Populate EventMap table.
/// </summary>
protected abstract void PopulateEventMapTableRows(List<EventMapRow> table);
/// <summary>
/// Populate PropertyMap table.
/// </summary>
protected abstract void PopulatePropertyMapTableRows(List<PropertyMapRow> table);
/// <summary>
/// Populate EncLog table.
/// </summary>
protected abstract void PopulateEncLogTableRows(List<EncLogRow> table);
/// <summary>
/// Populate EncMap table.
/// </summary>
protected abstract void PopulateEncMapTableRows(List<EncMapRow> table);
// If true, it is allowed to have methods not have bodies (for emitting metadata-only
// assembly)
internal readonly bool allowMissingMethodBodies;
private readonly CancellationToken cancellationToken;
protected readonly IModule module;
public readonly Microsoft.CodeAnalysis.Emit.Context Context;
private readonly CommonMessageProvider messageProvider;
// progress:
private bool streamsAreComplete;
private bool tableIndicesAreComplete;
private uint[] pseudoSymbolTokenToTokenMap;
private List<uint> pseudoStringTokenToTokenMap;
private readonly ClrHeader clrHeader = new ClrHeader();
private readonly bool emitRuntimeStartupStub;
private readonly BinaryWriter coverageDataWriter = new BinaryWriter(new MemoryStream());
private readonly SectionHeader coverSection = new SectionHeader();
private PeDebugDirectory/*?*/ debugDirectory;
private MemoryStream headerStream = new MemoryStream(1024);
// #String heap
private Dictionary<string, uint> stringIndex = new Dictionary<string, uint>(128);
private Dictionary<uint, uint> stringIndexMap;
protected readonly BinaryWriter stringWriter = new BinaryWriter(new MemoryStream(1024));
// #US heap
private readonly Dictionary<string, uint> userStringIndex = new Dictionary<string, uint>();
protected readonly BinaryWriter userStringWriter = new BinaryWriter(new MemoryStream(1024), true);
// #Blob heap
private readonly Dictionary<byte[], uint> blobIndex = new Dictionary<byte[], uint>(ByteSequenceComparer.Instance);
protected readonly BinaryWriter blobWriter = new BinaryWriter(new MemoryStream(1024));
// #GUID heap
private readonly Dictionary<Guid, uint> guidIndex = new Dictionary<Guid, uint>();
protected readonly BinaryWriter guidWriter = new BinaryWriter(new MemoryStream(16)); // full metadata has just a single guid
private readonly Dictionary<ICustomAttribute, uint> customAtributeSignatureIndex = new Dictionary<ICustomAttribute, uint>();
private readonly MemoryStream emptyStream = new MemoryStream(0);
private readonly Dictionary<ITypeReference, uint> typeSpecSignatureIndex = new Dictionary<ITypeReference, uint>();
private readonly Dictionary<ITypeReference, uint> exportedTypeIndex;
private readonly List<ITypeReference> exportedTypeList;
private readonly Dictionary<string, uint> fileRefIndex = new Dictionary<string, uint>(32); //more than enough in most cases
private readonly List<IFileReference> fileRefList = new List<IFileReference>(32);
private readonly Dictionary<IFieldReference, uint> fieldSignatureIndex = new Dictionary<IFieldReference, uint>();
private uint localDefSignatureToken;
private readonly Dictionary<ILocalDefinition, ushort> localDefIndex = new Dictionary<ILocalDefinition, ushort>();
private readonly Dictionary<ISignature, uint> signatureIndex;
private readonly Dictionary<IMarshallingInformation, uint> marshallingDescriptorIndex = new Dictionary<IMarshallingInformation, uint>();
private readonly Dictionary<IMethodDefinition, uint> methodBodyIndex;
protected readonly List<IMethodImplementation> methodImplList = new List<IMethodImplementation>();
private readonly Dictionary<IGenericMethodInstanceReference, uint> methodInstanceSignatureIndex = new Dictionary<IGenericMethodInstanceReference, uint>();
// A map of method body to RVA.
private readonly Dictionary<byte[], uint> possiblyDuplicateMethodBodies;
private readonly MemoryStream methodStream = new MemoryStream(32 * 1024);
private uint tokenOfMethodWithModuleInfo;
private IMethodBody previousMethodBodyWithUsingInfo;
private byte blobIndexSize;
private byte stringIndexSize;
private byte guidIndexSize;
private byte customAttributeTypeCodedIndexSize;
private byte declSecurityCodedIndexSize;
private byte eventDefIndexSize;
private byte fieldDefIndexSize;
private byte genericParamIndexSize;
private byte hasConstantCodedIndexSize;
private byte hasCustomAttributeCodedIndexSize;
private byte hasFieldMarshalCodedIndexSize;
private byte hasSemanticsCodedIndexSize;
private byte implementationCodedIndexSize;
private byte memberForwardedCodedIndexSize;
private byte memberRefParentCodedIndexSize;
private byte methodDefIndexSize;
private byte methodDefOrRefCodedIndexSize;
private byte moduleRefIndexSize;
private byte parameterIndexSize;
private byte propertyDefIndexSize;
private byte resolutionScopeCodedIndexSize;
private byte typeDefIndexSize;
private byte typeDefOrRefCodedIndexSize;
private byte typeOrMethodDefCodedIndexSize;
private readonly uint[] tableSizes = new uint[MetadataTokens.TableCount];
private readonly NtHeader ntHeader = new NtHeader();
private readonly PdbWriter pdbWriter;
private readonly BinaryWriter rdataWriter = new BinaryWriter(new MemoryStream());
private readonly SectionHeader relocSection = new SectionHeader();
private readonly SectionHeader resourceSection = new SectionHeader();
private readonly BinaryWriter resourceWriter = new BinaryWriter(new MemoryStream(1024));
private readonly BinaryWriter sdataWriter = new BinaryWriter(new MemoryStream());
private readonly SectionHeader rdataSection = new SectionHeader();
private readonly SectionHeader sdataSection = new SectionHeader();
private readonly uint sizeOfImportAddressTable;
private readonly BinaryWriter textDataWriter = new BinaryWriter(new MemoryStream());
private readonly SectionHeader textSection = new SectionHeader();
private readonly SectionHeader textDataSection = new SectionHeader();
private readonly SectionHeader textMethodBodySection = new SectionHeader();
private readonly SectionHeader tlsSection = new SectionHeader();
private readonly BinaryWriter tlsDataWriter = new BinaryWriter(new MemoryStream());
private readonly BinaryWriter win32ResourceWriter = new BinaryWriter(new MemoryStream(1024));
// Well known dummy cor library types whose refs are used for attaching assembly attributes off within net modules
// There is no guarantee the types actually exist in a cor library
internal static readonly string dummyAssemblyAttributeParentNamespace = "System.Runtime.CompilerServices";
internal static readonly string dummyAssemblyAttributeParentName = "AssemblyAttributesGoHere";
internal static readonly string[,] dummyAssemblyAttributeParentQualifier = new string[2, 2] { { "", "M" }, { "S", "SM" } };
private readonly uint[,] dummyAssemblyAttributeParent = new uint[2, 2] { { 0, 0 }, { 0, 0 } };
private static readonly byte[] dosHeader = new byte[]
{
0x4d, 0x5a, 0x90, 0x00, 0x03, 0x00, 0x00, 0x00,
0x04, 0x00, 0x00, 0x00, 0xff, 0xff, 0x00, 0x00,
0xb8, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x40, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00,
0x0e, 0x1f, 0xba, 0x0e, 0x00, 0xb4, 0x09, 0xcd,
0x21, 0xb8, 0x01, 0x4c, 0xcd, 0x21, 0x54, 0x68,
0x69, 0x73, 0x20, 0x70, 0x72, 0x6f, 0x67, 0x72,
0x61, 0x6d, 0x20, 0x63, 0x61, 0x6e, 0x6e, 0x6f,
0x74, 0x20, 0x62, 0x65, 0x20, 0x72, 0x75, 0x6e,
0x20, 0x69, 0x6e, 0x20, 0x44, 0x4f, 0x53, 0x20,
0x6d, 0x6f, 0x64, 0x65, 0x2e, 0x0d, 0x0d, 0x0a,
0x24, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
};
/// <summary>
/// Wraps a virtual string table index.
/// An override to SerializeIndex does the resolving at the right time.
/// </summary>
private struct StringIdx
{
private readonly uint virtIdx;
internal static readonly StringIdx Empty = new StringIdx(0u);
internal StringIdx(uint virtIdx)
{
this.virtIdx = virtIdx;
}
internal uint Resolve(Dictionary<uint, uint> map)
{
return map[this.virtIdx];
}
}
/// <summary>
/// Fills in stringIndexMap with data from stringIndex and write to stringWriter.
/// Releases stringIndex as the stringTable is sealed after this point.
/// </summary>
private void FoldStrings()
{
// Sort by suffix and remove stringIndex
var sorted = new List<KeyValuePair<string, uint>>(this.stringIndex);
sorted.Sort(new SuffixSort());
this.stringIndex = null;
// Create VirtIdx to Idx map and add entry for empty string
this.stringIndexMap = new Dictionary<uint, uint>(sorted.Count);
this.stringIndexMap.Add(0, 0);
// Find strings that can be folded
string prev = String.Empty;
foreach (KeyValuePair<string, uint> cur in sorted)
{
uint position = this.stringWriter.BaseStream.Position + this.GetStringStreamOffset();
// It is important to use ordinal comparison otherwise we'll use the current culture!
if (prev.EndsWith(cur.Key, StringComparison.Ordinal))
{
// Map over the tail of prev string. Watch for null-terminator of prev string.
this.stringIndexMap.Add(cur.Value, position - (uint)(Utf8Encoding.GetByteCount(cur.Key) + 1));
}
else
{
this.stringIndexMap.Add(cur.Value, position);
// TODO (tomat): consider reusing the buffer instead of allocating a new one for each string
this.stringWriter.WriteBytes(Utf8Encoding.GetBytes(cur.Key));
this.stringWriter.WriteByte(0);
}
prev = cur.Key;
}
}
/// <summary>
/// Sorts strings such that a string is followed immediately by all strings
/// that are a suffix of it.
/// </summary>
private class SuffixSort : IComparer<KeyValuePair<string, uint>>
{
public int Compare(KeyValuePair<string, uint> xPair, KeyValuePair<string, uint> yPair)
{
string x = xPair.Key;
string y = yPair.Key;
for (int i = x.Length - 1, j = y.Length - 1; i >= 0 & j >= 0; i--, j--)
{
if (x[i] < y[j])
{
return -1;
}
if (x[i] > y[j])
{
return +1;
}
}
return y.Length.CompareTo(x.Length);
}
}
public static void WritePeToStream(Microsoft.CodeAnalysis.Emit.Context context, CommonMessageProvider messageProvider, System.IO.Stream stream, CancellationToken cancellationToken)
{
WritePeToStream(
context,
messageProvider,
stream,
pdbWriter: null,
allowMissingMethodBodies: false,
foldDuplicateMethodBodies: false,
cancellationToken: cancellationToken);
}
public static void WritePeToStream(
Microsoft.CodeAnalysis.Emit.Context context,
CommonMessageProvider messageProvider,
System.IO.Stream stream,
PdbWriter pdbWriter,
bool allowMissingMethodBodies,
bool foldDuplicateMethodBodies,
CancellationToken cancellationToken)
{
var writer = new FullPeWriter(context, messageProvider, pdbWriter, allowMissingMethodBodies, foldDuplicateMethodBodies, cancellationToken);
writer.WritePeToStream(stream);
if (pdbWriter != null)
{
var entryPoint = context.Module.EntryPoint;
if (entryPoint != null && entryPoint.GetResolvedMethod(context) != null)
{
pdbWriter.SetEntryPoint(writer.GetMethodToken(entryPoint));
}
var assembly = context.Module.AsAssembly;
if (assembly != null && assembly.Kind == ModuleKind.WindowsRuntimeMetadata)
{
// Dev12: If compiling to winmdobj, we need to add to PDB source spans of
// all types and members for better error reporting by WinMDExp.
pdbWriter.WriteDefinitionLocations(
writer, context.Module.GetSymbolToLocationMap());
}
}
}
internal void WritePeToStream(System.IO.Stream stream)
{
PopulateTablesAndSerializeMethodBodies(separateMethodIL: false);
var metadataStream = new MemoryStream(16 * 1024);
SerializeMetadata(metadataStream, separateMethodIL: false);
// fill in header fields.
FillInNtHeader();
FillInClrHeader();
// write to pe stream.
WriteHeaders(stream);
WriteTextSection(stream, metadataStream);
WriteRdataSection(stream);
WriteSdataSection(stream);
WriteCoverSection(stream);
WriteTlsSection(stream);
WriteResourceSection(stream);
WriteRelocSection(stream);
}
internal void WriteMetadataAndIL(Stream metadataStream, Stream ilStream)
{
PopulateTablesAndSerializeMethodBodies(separateMethodIL: true);
var stream = new MemoryStream(16 * 1024);
SerializeMetadata(stream, separateMethodIL: true);
this.methodStream.WriteTo(ilStream);
stream.WriteTo(metadataStream);
}
private void PopulateTablesAndSerializeMethodBodies(bool separateMethodIL)
{
// Extract information from object model into tables, indices and streams
CreateIndices();
SerializeMethodBodies(separateMethodIL);
PopulateTableRows();
FoldStrings(); // Do this as soon as table rows are done and before we need to final size of string table
FillInSectionHeaders(); // Do this here so that tables and win32 resources can contain actual RVAs without the need for fixups.
}
private static uint Aligned(uint position, uint alignment)
{
uint result = position & ~(alignment - 1);
if (result == position)
{
return result;
}
return result + alignment;
}
private uint ComputeStrongNameSignatureSize()
{
IAssembly/*?*/ assembly = this.module.AsAssembly;
if (assembly == null)
{
return 0;
}
// EDMAURER the count of characters divided by two because the each pair of characters will turn in to one byte.
uint keySize = assembly.SignatureKey == null ? 0u : (uint)assembly.SignatureKey.Length / 2;
if (keySize == 0)
keySize = IteratorHelper.EnumerableCount(assembly.PublicKey);
if (keySize == 0)
{
return 0;
}
return keySize < 128 + 32 ? 128u : keySize - 32;
}
private uint ComputeOffsetToDebugTable()
{
uint result = this.ComputeOffsetToMetadata();
result += this.ComputeSizeOfMetadata();
result += Aligned(this.resourceWriter.BaseStream.Length, 4);
result += this.ComputeStrongNameSignatureSize(); // size of strong name hash
return result;
}
private uint ComputeOffsetToImportTable()
{
uint result = this.ComputeOffsetToDebugTable();
result += this.ComputeSizeOfDebugTable(result);
result += 0; // TODO: size of unmanaged export stubs (when and if these are ever supported).
return result;
}
private uint ComputeOffsetToMetadata()
{
uint result = 0;
result += this.sizeOfImportAddressTable;
result += 72; // size of CLR header
result += Aligned(this.methodStream.Length, 4);
return result;
}
private uint ComputeSizeOfDebugTable(uint offsetToMetadata)
{
if (this.pdbWriter == null)
{
return 0;
}
this.debugDirectory = this.pdbWriter.GetDebugDirectory();
this.debugDirectory.TimeDateStamp = this.ntHeader.TimeDateStamp;
this.debugDirectory.PointerToRawData = offsetToMetadata + 0x1c;
return 0x1c + (uint)this.debugDirectory.Data.Length;
}
private uint SizeOfGeneralMetadataHeader
{
get { return (uint)(this.IsMinimalDelta ? 124 : 108); }
}
private uint ComputeSizeOfMetadata()
{
uint result = this.SizeOfGeneralMetadataHeader;
result += Aligned(this.ComputeSizeOfMetadataTablesStream(), 4);
result += Aligned(this.stringWriter.BaseStream.Length, 4);
if (this.userStringWriter.BaseStream.Length == 1)
{
this.GetUserStringToken(" ");
}
result += Aligned(this.userStringWriter.BaseStream.Length, 4);
result += Aligned(this.guidWriter.BaseStream.Length, 4);
result += Aligned(this.blobWriter.BaseStream.Length, 4);
return result;
}
private uint ComputeSizeOfMetadataTablesStream()
{
this.ComputeColumnSizes();
uint result = this.ComputeSizeOfTablesHeader();
result += this.tableSizes[(byte)TableIndex.Module] * (2u + 3u * this.guidIndexSize + this.stringIndexSize);
result += this.tableSizes[(byte)TableIndex.TypeRef] * (0u + this.resolutionScopeCodedIndexSize + this.stringIndexSize + this.stringIndexSize);
result += this.tableSizes[(byte)TableIndex.TypeDef] * (4u + this.stringIndexSize + this.stringIndexSize + this.typeDefOrRefCodedIndexSize + this.fieldDefIndexSize + this.methodDefIndexSize);
Debug.Assert(this.tableSizes[(byte)TableIndex.FieldPtr] == 0);
result += this.tableSizes[(byte)TableIndex.Field] * (2u + this.stringIndexSize + this.blobIndexSize);
Debug.Assert(this.tableSizes[(byte)TableIndex.MethodPtr] == 0);
result += this.tableSizes[(byte)TableIndex.MethodDef] * (8u + this.stringIndexSize + this.blobIndexSize + this.parameterIndexSize);
Debug.Assert(this.tableSizes[(byte)TableIndex.ParamPtr] == 0);
result += this.tableSizes[(byte)TableIndex.Param] * (4u + this.stringIndexSize);
result += this.tableSizes[(byte)TableIndex.InterfaceImpl] * (0u + this.typeDefIndexSize + this.typeDefOrRefCodedIndexSize);
result += this.tableSizes[(byte)TableIndex.MemberRef] * (0u + this.memberRefParentCodedIndexSize + this.stringIndexSize + this.blobIndexSize);
result += this.tableSizes[(byte)TableIndex.Constant] * (2u + this.hasConstantCodedIndexSize + this.blobIndexSize);
result += this.tableSizes[(byte)TableIndex.CustomAttribute] * (0u + this.hasCustomAttributeCodedIndexSize + this.customAttributeTypeCodedIndexSize + this.blobIndexSize);
result += this.tableSizes[(byte)TableIndex.FieldMarshal] * (0u + this.hasFieldMarshalCodedIndexSize + this.blobIndexSize);
result += this.tableSizes[(byte)TableIndex.DeclSecurity] * (2u + this.declSecurityCodedIndexSize + this.blobIndexSize);
result += this.tableSizes[(byte)TableIndex.ClassLayout] * (6u + this.typeDefIndexSize);
result += this.tableSizes[(byte)TableIndex.FieldLayout] * (4u + this.fieldDefIndexSize);
result += this.tableSizes[(byte)TableIndex.StandAloneSig] * (0u + this.blobIndexSize);
result += this.tableSizes[(byte)TableIndex.EventMap] * (0u + this.typeDefIndexSize + this.eventDefIndexSize);
Debug.Assert(this.tableSizes[(byte)TableIndex.EventPtr] == 0);
result += this.tableSizes[(byte)TableIndex.Event] * (2u + this.stringIndexSize + this.typeDefOrRefCodedIndexSize);
result += this.tableSizes[(byte)TableIndex.PropertyMap] * (0u + this.typeDefIndexSize + this.propertyDefIndexSize);
Debug.Assert(this.tableSizes[(byte)TableIndex.PropertyPtr] == 0);
result += this.tableSizes[(byte)TableIndex.Property] * (2u + this.stringIndexSize + this.blobIndexSize);
result += this.tableSizes[(byte)TableIndex.MethodSemantics] * (2u + this.methodDefIndexSize + this.hasSemanticsCodedIndexSize);
result += this.tableSizes[(byte)TableIndex.MethodImpl] * (0u + this.typeDefIndexSize + this.methodDefOrRefCodedIndexSize + this.methodDefOrRefCodedIndexSize);
result += this.tableSizes[(byte)TableIndex.ModuleRef] * (0u + this.stringIndexSize);
result += this.tableSizes[(byte)TableIndex.TypeSpec] * (0u + this.blobIndexSize);
result += this.tableSizes[(byte)TableIndex.ImplMap] * (2u + this.memberForwardedCodedIndexSize + this.stringIndexSize + this.moduleRefIndexSize);
result += this.tableSizes[(byte)TableIndex.FieldRva] * (4u + this.fieldDefIndexSize);
result += this.tableSizes[(byte)TableIndex.EncLog] * (8u);
result += this.tableSizes[(byte)TableIndex.EncMap] * (4u);
result += this.tableSizes[(byte)TableIndex.Assembly] * (16u + this.blobIndexSize + this.stringIndexSize + this.stringIndexSize);
Debug.Assert(this.tableSizes[(byte)TableIndex.AssemblyProcessor] == 0);
Debug.Assert(this.tableSizes[(byte)TableIndex.AssemblyOS] == 0);
result += this.tableSizes[(byte)TableIndex.AssemblyRef] * (12u + this.blobIndexSize + this.stringIndexSize + this.stringIndexSize + this.blobIndexSize);
Debug.Assert(this.tableSizes[(byte)TableIndex.AssemblyRefProcessor] == 0);
Debug.Assert(this.tableSizes[(byte)TableIndex.AssemblyRefOS] == 0);
result += this.tableSizes[(byte)TableIndex.File] * (4u + this.stringIndexSize + this.blobIndexSize);
result += this.tableSizes[(byte)TableIndex.ExportedType] * (8u + this.stringIndexSize + this.stringIndexSize + this.implementationCodedIndexSize);
result += this.tableSizes[(byte)TableIndex.ManifestResource] * (8u + this.stringIndexSize + this.implementationCodedIndexSize);
result += this.tableSizes[(byte)TableIndex.NestedClass] * (0u + this.typeDefIndexSize + this.typeDefIndexSize);
result += this.tableSizes[(byte)TableIndex.GenericParam] * (4u + this.typeOrMethodDefCodedIndexSize + this.stringIndexSize);
result += this.tableSizes[(byte)TableIndex.MethodSpec] * (0u + this.methodDefOrRefCodedIndexSize + this.blobIndexSize);
result += this.tableSizes[(byte)TableIndex.GenericParamConstraint] * (0u + this.genericParamIndexSize + this.typeDefOrRefCodedIndexSize);
return result + 1;
}
private uint ComputeSizeOfPeHeaders()
{
ushort numberOfSections = 1; // .text
if (this.emitRuntimeStartupStub) numberOfSections++; //.reloc
if (this.tlsDataWriter.BaseStream.Length > 0) numberOfSections++; //.tls
if (this.rdataWriter.BaseStream.Length > 0) numberOfSections++; //.rdata
if (this.sdataWriter.BaseStream.Length > 0) numberOfSections++; //.sdata
if (this.coverageDataWriter.BaseStream.Length > 0) numberOfSections++; //.cover
if (!IteratorHelper.EnumerableIsEmpty(this.module.Win32Resources) ||
this.module.Win32ResourceSection != null)
numberOfSections++; //.rsrc;
this.ntHeader.NumberOfSections = numberOfSections;
uint sizeOfPeHeaders = 128 + 4 + 20 + 224 + 40u * numberOfSections;
if (this.module.Requires64bits)
{
sizeOfPeHeaders += 16;
}
return sizeOfPeHeaders;
}
private uint ComputeSizeOfTextSection()
{
uint textSectionLength = this.ComputeOffsetToImportTable();
if (this.emitRuntimeStartupStub)
{
textSectionLength += !this.module.Requires64bits ? 66u : 70u; //size of import table
textSectionLength += 14; //size of name table
textSectionLength = Aligned(textSectionLength, !this.module.Requires64bits ? 4u : 8u); //optional padding to make startup stub's target address align on word or double word boundary
textSectionLength += !this.module.Requires64bits ? 8u : 16u; //fixed size of runtime startup stub
}
textSectionLength += Aligned(this.textDataWriter.BaseStream.Length, 4);
this.streamsAreComplete = true;
return textSectionLength;
}
private uint ComputeSizeOfWin32Resources()
{
this.SerializeWin32Resources();
uint result = 0;
if (this.win32ResourceWriter.BaseStream.Length > 0)
{
result += Aligned(this.win32ResourceWriter.BaseStream.Length, 4);
} // result += Aligned(this.win32ResourceWriter.BaseStream.Length+1, 8);
return result;
}
private void CreateMethodBodyReferenceIndex()
{
int count;
var referencesInIL = module.ReferencesInIL(out count);
this.pseudoSymbolTokenToTokenMap = new uint[count];
uint cur = 0;
foreach (IReference o in referencesInIL)
{
ITypeReference/*?*/ typeReference = o as ITypeReference;
if (typeReference != null)
{
this.pseudoSymbolTokenToTokenMap[cur] = this.GetTypeToken(typeReference);
}
else
{
IFieldReference/*?*/ fieldReference = o as IFieldReference;
if (fieldReference != null)
{
this.pseudoSymbolTokenToTokenMap[cur] = this.GetFieldToken(fieldReference);
}
else
{
IMethodReference/*?*/ methodReference = o as IMethodReference;
if (methodReference != null)
{
this.pseudoSymbolTokenToTokenMap[cur] = this.GetMethodToken(methodReference);
}
else
{
throw ExceptionUtilities.UnexpectedValue(o);
}
}
}
cur++;
}
}
private void CreateIndices()
{
cancellationToken.ThrowIfCancellationRequested();
this.CreateUserStringIndices();