Skip to content

[ILASM] Added /DET flag for deterministic compilations #85344

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 32 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
1419f57
Added '/DET' flag to ILASM for deterministic compilations
TIHan Apr 25, 2023
d3b329c
Using 'm_pInternalEmitForDeterministicMvid'
TIHan Apr 25, 2023
0357bf1
Removing use of BCRYPT APIs. Added TODOs.
TIHan Apr 25, 2023
54147cc
Add use of BCYRPT for windows-only. Added TODO for non-win32.
TIHan Apr 25, 2023
5516e77
Preliminary work for deterministic PDB guid
TIHan Apr 25, 2023
d6a16fa
Fixed ordering problem
TIHan Apr 25, 2023
f2e4d2c
Computing checksum and using result for the PDB guid
TIHan Apr 25, 2023
89df2d8
Refactoring apis
TIHan Apr 26, 2023
7374450
Added PdbChecksum and Deterministic Debug Directory entries
TIHan Apr 26, 2023
7a0dfcb
Minor whitespace cleanup
TIHan Apr 26, 2023
615c6ce
Merge remote-tracking branch 'upstream/main' into ilasm-det
TIHan Jul 14, 2023
68482a4
mering with main
TIHan Jun 4, 2024
ef59bed
Fix build
TIHan Jun 4, 2024
028a8b6
Added IILAsmPortablePdbWriter interface
TIHan Jun 4, 2024
e1a10f8
Checking deterministic output for ILASM for all roundtrip tests
TIHan Jun 4, 2024
8ba6868
Fixed getting interface. Testing determinism of pdb.
TIHan Jun 5, 2024
c023315
add comment
TIHan Jun 5, 2024
9e14b48
Remove use of goto
TIHan Jun 5, 2024
4038a1f
Added sha256 for non-win32
TIHan Jun 5, 2024
69fadf4
Using different impl for getting sha256 of a file in python. Using sh…
TIHan Jun 5, 2024
936f0a3
Trying to fix build
TIHan Jun 5, 2024
d6b4258
Fix build
TIHan Jun 6, 2024
9c1a645
disable testing determinism due to timeouts
TIHan Jun 6, 2024
e8b9b7f
Merge remote-tracking branch 'upstream/main' into ilasm-det
TIHan Jul 23, 2024
3331d9d
Temporarily disable emitting debug directories to see if the tests ti…
TIHan Jul 23, 2024
7df2c80
Merge branch 'ilasm-det' of https://github.com/TIHan/runtime into ila…
TIHan Jul 23, 2024
e78450f
Merge remote-tracking branch 'upstream/main' into ilasm-det
TIHan Jul 24, 2024
8e357b8
Renable deterministic tests and debug directory creation
TIHan Jul 24, 2024
8867295
Added sha256.cpp
TIHan Jul 24, 2024
6dd077f
Remove sha256 impl for now
TIHan Jul 24, 2024
ce016fa
memset for now
TIHan Jul 24, 2024
0086e7d
Temp disable det testing
TIHan Jul 25, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/coreclr/dlls/mscorpe/pewriter.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -618,6 +618,11 @@ HRESULT PEWriter::Init(PESectionMan *pFrom, DWORD createFlags)
m_ntHeaders->FileHeader.Characteristics |= VAL16(IMAGE_FILE_RELOCS_STRIPPED);
}

if (createFlags & ICEE_CREATE_FILE_DET)
{
m_ntHeaders->FileHeader.TimeDateStamp = VAL32(0);
}

// Linker version should be consistent with current VC level
m_ntHeaders->OptionalHeader.MajorLinkerVersion = 11;
m_ntHeaders->OptionalHeader.MinorLinkerVersion = 0;
Expand Down
12 changes: 12 additions & 0 deletions src/coreclr/ilasm/assem.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Assembler::Assembler()
{
m_pDisp = NULL;
m_pEmitter = NULL;
m_pInternalEmitForDeterministicMvid = NULL;
m_pImporter = NULL;

char* pszFQN = new char[16];
Expand Down Expand Up @@ -107,6 +108,7 @@ Assembler::Assembler()
m_fGeneratePDB = FALSE;
m_fIsMscorlib = FALSE;
m_fOptimize = FALSE;
m_fDeterministic = FALSE;
m_tkSysObject = 0;
m_tkSysString = 0;
m_tkSysValue = 0;
Expand Down Expand Up @@ -207,6 +209,11 @@ Assembler::~Assembler()
m_pEmitter->Release();
m_pEmitter = NULL;
}
if (m_pInternalEmitForDeterministicMvid != NULL)
{
m_pInternalEmitForDeterministicMvid->Release();
m_pInternalEmitForDeterministicMvid = NULL;
}
if (m_pPortablePdbWriter != NULL)
{
delete m_pPortablePdbWriter;
Expand All @@ -233,6 +240,11 @@ BOOL Assembler::Init(BOOL generatePdb)

if (FAILED(CreateICeeFileGen(&m_pCeeFileGen))) return FALSE;

if (m_fDeterministic)
{
m_dwCeeFileFlags |= ICEE_CREATE_FILE_DET;
}

if (FAILED(m_pCeeFileGen->CreateCeeFileEx(&m_pCeeFile,(ULONG)m_dwCeeFileFlags))) return FALSE;

if (FAILED(m_pCeeFileGen->GetSectionCreate(m_pCeeFile, ".il", sdReadOnly, &m_pILSection))) return FALSE;
Expand Down
5 changes: 1 addition & 4 deletions src/coreclr/ilasm/assembler.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2434,13 +2434,10 @@ void Assembler::SetPdbFileName(_In_ __nullterminated char* szName)
HRESULT Assembler::SavePdbFile()
{
HRESULT hr = S_OK;
mdMethodDef entryPoint;

if (FAILED(hr = (m_pPortablePdbWriter == NULL ? E_FAIL : S_OK))) goto exit;
if (FAILED(hr = (m_pPortablePdbWriter->GetEmitter() == NULL ? E_FAIL : S_OK))) goto exit;
if (FAILED(hr = m_pCeeFileGen->GetEntryPoint(m_pCeeFile, &entryPoint))) goto exit;
if (FAILED(hr = m_pPortablePdbWriter->BuildPdbStream(m_pEmitter, entryPoint))) goto exit;
if (FAILED(hr = m_pPortablePdbWriter->GetEmitter()->Save(m_wzPdbFileName, 0))) goto exit;
if (FAILED(hr = m_pPortablePdbWriter->GetEmitter()->Save(m_wzPdbFileName, NULL))) goto exit;

exit:
return hr;
Expand Down
4 changes: 3 additions & 1 deletion src/coreclr/ilasm/assembler.h
Original file line number Diff line number Diff line change
Expand Up @@ -752,6 +752,7 @@ class Assembler {
BOOL m_fIsMscorlib;
BOOL m_fTolerateDupMethods;
BOOL m_fOptimize;
BOOL m_fDeterministic;
mdToken m_tkSysObject;
mdToken m_tkSysString;
mdToken m_tkSysValue;
Expand All @@ -760,6 +761,7 @@ class Assembler {

IMetaDataDispenserEx2 *m_pDisp;
IMetaDataEmit3 *m_pEmitter;
IMDInternalEmit *m_pInternalEmitForDeterministicMvid;
ICeeFileGen *m_pCeeFileGen;
IMetaDataImport2 *m_pImporter; // Import interface.
HCEEFILE m_pCeeFile;
Expand Down Expand Up @@ -845,7 +847,7 @@ class Assembler {
BOOL EmitClass(Class *pClass);
HRESULT CreatePEFile(_In_ __nullterminated WCHAR *pwzOutputFilename);
HRESULT CreateTLSDirectory();
HRESULT CreateDebugDirectory();
HRESULT CreateDebugDirectory(BYTE(&pdbChecksum)[32]);
HRESULT InitMetaData();
Class *FindCreateClass(_In_ __nullterminated const char *pszFQN);
BOOL EmitFieldRef(_In_z_ char *pszArg, int opcode);
Expand Down
4 changes: 4 additions & 0 deletions src/coreclr/ilasm/main.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -315,6 +315,10 @@ extern "C" int _cdecl wmain(int argc, _In_ WCHAR **argv)
{
pAsm->m_fOptimize = TRUE;
}
else if (!_stricmp(szOpt, "DET"))
{
pAsm->m_fDeterministic = TRUE;
}
else if (!_stricmp(szOpt, "X64"))
{
pAsm->m_dwCeeFileFlags &= ~ICEE_CREATE_MACHINE_MASK;
Expand Down
25 changes: 25 additions & 0 deletions src/coreclr/ilasm/portable_pdb.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,10 @@ HRESULT PortablePdbWriter::Init(IMetaDataDispenserEx2* mdDispenser)
0,
IID_IMetaDataEmit3,
(IUnknown**)&m_pdbEmitter);

if (FAILED(hr)) goto exit;

hr = m_pdbEmitter->QueryInterface(IID_IILAsmPortablePdbWriter, (void**)&m_ilasmPdbWriter);
exit:
return hr;
}
Expand All @@ -120,6 +124,16 @@ ULONG PortablePdbWriter::GetTimestamp()
return m_pdbStream.id.pdbTimeStamp;
}

void PortablePdbWriter::SetGuid(REFGUID newGuid)
{
m_pdbStream.id.pdbGuid = newGuid;
}

void PortablePdbWriter::SetTimestamp(const ULONG newTimestamp)
{
m_pdbStream.id.pdbTimeStamp = newTimestamp;
}

Document* PortablePdbWriter::GetCurrentDocument()
{
return m_currentDocument;
Expand All @@ -143,6 +157,17 @@ HRESULT PortablePdbWriter::BuildPdbStream(IMetaDataEmit3* peEmitter, mdMethodDef
return hr;
}

HRESULT PortablePdbWriter::ComputeSha256PdbStreamChecksum(BYTE(&checksum)[32])
{
return m_ilasmPdbWriter->ComputeSha256PdbStreamChecksum(checksum);
}

HRESULT PortablePdbWriter::ChangePdbStreamGuid(REFGUID newGuid)
{
m_pdbStream.id.pdbGuid = newGuid;
return m_ilasmPdbWriter->ChangePdbStreamGuid(newGuid);
}

HRESULT PortablePdbWriter::DefineDocument(char* name, GUID* language)
{
HRESULT hr = S_OK;
Expand Down
13 changes: 9 additions & 4 deletions src/coreclr/ilasm/portable_pdb.h
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,12 @@ class PortablePdbWriter
IMetaDataEmit3* GetEmitter();
GUID* GetGuid();
ULONG GetTimestamp();
void SetGuid(REFGUID newGuid);
void SetTimestamp(const ULONG newTimestamp);
Document* GetCurrentDocument();
HRESULT BuildPdbStream(IMetaDataEmit3* peEmitter, mdMethodDef entryPoint);
HRESULT ComputeSha256PdbStreamChecksum(BYTE (&checksum)[32]);
HRESULT ChangePdbStreamGuid(REFGUID newGuid);
HRESULT DefineDocument(char* name, GUID* language);
HRESULT DefineSequencePoints(Method* method);
HRESULT DefineLocalScope(Method* method);
Expand All @@ -59,10 +63,11 @@ class PortablePdbWriter
BOOL _DefineLocalScope(mdMethodDef methodDefToken, Scope* currScope);

private:
IMetaDataEmit3* m_pdbEmitter;
PORT_PDB_STREAM m_pdbStream;
DocumentList m_documentList;
Document* m_currentDocument;
IMetaDataEmit3* m_pdbEmitter;
IILAsmPortablePdbWriter* m_ilasmPdbWriter;
PORT_PDB_STREAM m_pdbStream;
DocumentList m_documentList;
Document* m_currentDocument;
};

#endif
Loading
Loading