shylie/llvm-project
1
0
Fork 0
Code Issues Pull Requests Actions 6 Packages Projects Releases Wiki Activity

[flang][runtime] Detect byte order reversal problems (#129093)

Browse Source 
When reading an unformatted sequential file with variable-length
records, detect byte order reversal problems with the first record's
header and footer words, and emit a more detailed error message.
This commit is contained in:
Peter Klausler 2025-02-27 16:16:15 -08:00 committed by GitHub
parent 5401c675eb
commit abe1ecff54
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 37 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
flang-rt/lib/runtime/unit.cpp
View File

@ -511,7 +511,7 @@ void ExternalFileUnit::EndIoStatement() {
void ExternalFileUnit::BeginSequentialVariableUnformattedInputRecord(
IoErrorHandler &handler) {
RUNTIME_CHECK(handler, access == Access::Sequential);
std::int32_t header{0}, footer{0};
std::uint32_t header{0}, footer{0};
std::size_t need{recordOffsetInFrame_ + sizeof header};
std::size_t got{ReadFrame(frameOffsetInFile_, need, handler)};
// Try to emit informative errors to help debug corrupted files.
@ -528,17 +528,41 @@ void ExternalFileUnit::BeginSequentialVariableUnformattedInputRecord(
recordLength = sizeof header + header; // does not include footer
need = recordOffsetInFrame_ + *recordLength + sizeof footer;
got = ReadFrame(frameOffsetInFile_, need, handler);
if (got < need) {
if (got >= need) {
footer = ReadHeaderOrFooter(recordOffsetInFrame_ + *recordLength);
}
if (frameOffsetInFile_ == 0 && recordOffsetInFrame_ == 0 &&
(got < need || footer != header)) {
// Maybe an omitted or incorrect byte swap flag setting?
// Try it the other way, since this is the first record.
// (N.B. Won't work on files starting with empty records, but there's
// no good way to know later if all preceding records were empty.)
swapEndianness_ = !swapEndianness_;
std::uint32_t header2{ReadHeaderOrFooter(0)};
std::size_t recordLength2{sizeof header2 + header2};
std::size_t need2{recordLength2 + sizeof footer};
std::size_t got2{ReadFrame(0, need2, handler)};
if (got2 >= need2) {
std::uint32_t footer2{ReadHeaderOrFooter(recordLength2)};
if (footer2 == header2) {
error = "Unformatted variable-length sequential file input "
"failed on the first record, probably due to a need "
"for byte order data conversion; consider adding "
"CONVERT='SWAP' to the OPEN statement or adding "
"FORT_CONVERT=SWAP to the execution environment";
}
}
swapEndianness_ = !swapEndianness_;
}
if (error) {
} else if (got < need) {
error = "Unformatted variable-length sequential file input failed at "
"record #%jd (file offset %jd): hit EOF reading record with "
"length %jd bytes";
} else {
footer = ReadHeaderOrFooter(recordOffsetInFrame_ + *recordLength);
if (footer != header) {
error = "Unformatted variable-length sequential file input failed at "
"record #%jd (file offset %jd): record header has length %jd "
"that does not match record footer (%jd)";
}
} else if (footer != header) {
error = "Unformatted variable-length sequential file input failed at "
"record #%jd (file offset %jd): record header has length %jd "
"that does not match record footer (%jd)";
}
}
if (error) {
@ -590,7 +614,7 @@ void ExternalFileUnit::BackspaceFixedRecord(IoErrorHandler &handler) {
void ExternalFileUnit::BackspaceVariableUnformattedRecord(
IoErrorHandler &handler) {
std::int32_t header{0};
std::uint32_t header{0};
auto headerBytes{static_cast<std::int64_t>(sizeof header)};
frameOffsetInFile_ += recordOffsetInFrame_;
recordOffsetInFrame_ = 0;
@ -775,8 +799,8 @@ void ExternalFileUnit::PopChildIo(ChildIo &child) {
child_.reset(child.AcquirePrevious().release()); // deletes top child
}
std::int32_t ExternalFileUnit::ReadHeaderOrFooter(std::int64_t frameOffset) {
std::int32_t word;
std::uint32_t ExternalFileUnit::ReadHeaderOrFooter(std::int64_t frameOffset) {
std::uint32_t word;
char *wordPtr{reinterpret_cast<char *>(&word)};
std::memcpy(wordPtr, Frame() + frameOffset, sizeof word);
if (swapEndianness_) {

2
flang-rt/lib/runtime/unit.h
View File

@ -210,7 +210,7 @@ private:
RT_API_ATTRS void CommitWrites();
RT_API_ATTRS bool CheckDirectAccess(IoErrorHandler &);
RT_API_ATTRS void HitEndOnRead(IoErrorHandler &);
RT_API_ATTRS std::int32_t ReadHeaderOrFooter(std::int64_t frameOffset);
RT_API_ATTRS std::uint32_t ReadHeaderOrFooter(std::int64_t frameOffset);
Lock lock_;