[flang-commits] [flang] 0006354 - [flang] Further implementation of external I/O unit operations (part 6)

peter klausler via flang-commits flang-commits at lists.llvm.org
Fri Jul 3 17:31:47 PDT 2020


Author: peter klausler
Date: 2020-07-03T17:31:01-07:00
New Revision: 0006354c3b832c73ab86f9220a2c250afa243afa

URL: https://github.com/llvm/llvm-project/commit/0006354c3b832c73ab86f9220a2c250afa243afa
DIFF: https://github.com/llvm/llvm-project/commit/0006354c3b832c73ab86f9220a2c250afa243afa.diff

LOG: [flang] Further implementation of external I/O unit operations (part 6)

Rework initial implementation of external I/O unit operations to
fix problems exposed in unit tests (in a later patch).  Add flushing.

Reviewed By: sscalpone

Differential Revision: https://reviews.llvm.org/D83147

Added: 
    

Modified: 
    flang/runtime/unit-map.cpp
    flang/runtime/unit-map.h
    flang/runtime/unit.cpp
    flang/runtime/unit.h

Removed: 
    


################################################################################
diff  --git a/flang/runtime/unit-map.cpp b/flang/runtime/unit-map.cpp
index 5cbbf059d5f8..905beb4d084f 100644
--- a/flang/runtime/unit-map.cpp
+++ b/flang/runtime/unit-map.cpp
@@ -63,6 +63,15 @@ void UnitMap::CloseAll(IoErrorHandler &handler) {
   }
 }
 
+void UnitMap::FlushAll(IoErrorHandler &handler) {
+  CriticalSection critical{lock_};
+  for (int j{0}; j < buckets_; ++j) {
+    for (Chain *p{bucket_[j].get()}; p; p = p->next.get()) {
+      p->unit.Flush(handler);
+    }
+  }
+}
+
 ExternalFileUnit &UnitMap::Create(int n, const Terminator &terminator) {
   Chain &chain{*New<Chain>{terminator}(n).release()};
   chain.next.reset(&chain);

diff  --git a/flang/runtime/unit-map.h b/flang/runtime/unit-map.h
index 8b8afb3b4638..286cb066fcd4 100644
--- a/flang/runtime/unit-map.h
+++ b/flang/runtime/unit-map.h
@@ -49,6 +49,7 @@ class UnitMap {
 
   void DestroyClosed(ExternalFileUnit &);
   void CloseAll(IoErrorHandler &);
+  void FlushAll(IoErrorHandler &);
 
 private:
   struct Chain {

diff  --git a/flang/runtime/unit.cpp b/flang/runtime/unit.cpp
index 2eee142081a5..2193ee0f6aca 100644
--- a/flang/runtime/unit.cpp
+++ b/flang/runtime/unit.cpp
@@ -17,6 +17,7 @@ namespace Fortran::runtime::io {
 // should work without a Fortran main program.
 static Lock unitMapLock;
 static UnitMap *unitMap{nullptr};
+static ExternalFileUnit *defaultInput{nullptr};
 static ExternalFileUnit *defaultOutput{nullptr};
 
 void FlushOutputOnCrash(const Terminator &terminator) {
@@ -70,14 +71,48 @@ void ExternalFileUnit::OpenUnit(OpenStatus status, Position position,
       return;
     }
     // Otherwise, OPEN on open unit with new FILE= implies CLOSE
+    DoImpliedEndfile(handler);
     Flush(handler);
     Close(CloseStatus::Keep, handler);
   }
   set_path(std::move(newPath), newPathLength);
   Open(status, position, handler);
+  auto totalBytes{knownSize()};
+  if (access == Access::Direct) {
+    if (!isFixedRecordLength || !recordLength) {
+      handler.SignalError(IostatOpenBadRecl,
+          "OPEN(UNIT=%d,ACCESS='DIRECT'): record length is not known",
+          unitNumber());
+    } else if (*recordLength <= 0) {
+      handler.SignalError(IostatOpenBadRecl,
+          "OPEN(UNIT=%d,ACCESS='DIRECT',RECL=%jd): record length is invalid",
+          unitNumber(), static_cast<std::intmax_t>(*recordLength));
+    } else if (!totalBytes) {
+      handler.SignalError(IostatOpenUnknownSize,
+          "OPEN(UNIT=%d,ACCESS='DIRECT'): file size is not known");
+    } else if (*totalBytes % *recordLength != 0) {
+      handler.SignalError(IostatOpenBadAppend,
+          "OPEN(UNIT=%d,ACCESS='DIRECT',RECL=%jd): record length is not an "
+          "even divisor of the file size %jd",
+          unitNumber(), static_cast<std::intmax_t>(*recordLength),
+          static_cast<std::intmax_t>(*totalBytes));
+    }
+  }
+  if (position == Position::Append) {
+    if (*totalBytes && recordLength && *recordLength) {
+      endfileRecordNumber = 1 + (*totalBytes / *recordLength);
+    } else {
+      // Fake it so that we can backspace relative from the end
+      endfileRecordNumber = std::numeric_limits<std::int64_t>::max() - 1;
+    }
+    currentRecordNumber = *endfileRecordNumber;
+  } else {
+    currentRecordNumber = 1;
+  }
 }
 
 void ExternalFileUnit::CloseUnit(CloseStatus status, IoErrorHandler &handler) {
+  DoImpliedEndfile(handler);
   Flush(handler);
   Close(status, handler);
 }
@@ -86,6 +121,29 @@ void ExternalFileUnit::DestroyClosed() {
   GetUnitMap().DestroyClosed(*this); // destroys *this
 }
 
+bool ExternalFileUnit::SetDirection(
+    Direction direction, IoErrorHandler &handler) {
+  if (direction == Direction::Input) {
+    if (mayRead()) {
+      direction_ = Direction::Input;
+      return true;
+    } else {
+      handler.SignalError(IostatReadFromWriteOnly,
+          "READ(UNIT=%d) with ACTION='WRITE'", unitNumber());
+      return false;
+    }
+  } else {
+    if (mayWrite()) {
+      direction_ = Direction::Output;
+      return true;
+    } else {
+      handler.SignalError(IostatWriteToReadOnly,
+          "WRITE(UNIT=%d) with ACTION='READ'", unitNumber());
+      return false;
+    }
+  }
+}
+
 UnitMap &ExternalFileUnit::GetUnitMap() {
   if (unitMap) {
     return *unitMap;
@@ -95,18 +153,22 @@ UnitMap &ExternalFileUnit::GetUnitMap() {
     return *unitMap;
   }
   Terminator terminator{__FILE__, __LINE__};
+  IoErrorHandler handler{terminator};
   unitMap = New<UnitMap>{terminator}().release();
   ExternalFileUnit &out{ExternalFileUnit::LookUpOrCreate(6, terminator)};
   out.Predefine(1);
   out.set_mayRead(false);
   out.set_mayWrite(true);
   out.set_mayPosition(false);
+  out.SetDirection(Direction::Output, handler);
   defaultOutput = &out;
   ExternalFileUnit &in{ExternalFileUnit::LookUpOrCreate(5, terminator)};
   in.Predefine(0);
   in.set_mayRead(true);
   in.set_mayWrite(false);
   in.set_mayPosition(false);
+  in.SetDirection(Direction::Input, handler);
+  defaultInput = ∈
   // TODO: Set UTF-8 mode from the environment
   return *unitMap;
 }
@@ -120,53 +182,106 @@ void ExternalFileUnit::CloseAll(IoErrorHandler &handler) {
   defaultOutput = nullptr;
 }
 
+void ExternalFileUnit::FlushAll(IoErrorHandler &handler) {
+  CriticalSection critical{unitMapLock};
+  if (unitMap) {
+    unitMap->FlushAll(handler);
+  }
+}
+
 bool ExternalFileUnit::Emit(
     const char *data, std::size_t bytes, IoErrorHandler &handler) {
   auto furthestAfter{std::max(furthestPositionInRecord,
       positionInRecord + static_cast<std::int64_t>(bytes))};
   if (furthestAfter > recordLength.value_or(furthestAfter)) {
-    handler.SignalError(IostatRecordWriteOverrun);
+    handler.SignalError(IostatRecordWriteOverrun,
+        "Attempt to write %zd bytes to position %jd in a fixed-size record of "
+        "%jd bytes",
+        bytes, static_cast<std::intmax_t>(positionInRecord),
+        static_cast<std::intmax_t>(*recordLength));
     return false;
   }
   WriteFrame(frameOffsetInFile_, recordOffsetInFrame_ + furthestAfter, handler);
   if (positionInRecord > furthestPositionInRecord) {
-    std::memset(Frame() + furthestPositionInRecord, ' ',
+    std::memset(Frame() + recordOffsetInFrame_ + furthestPositionInRecord, ' ',
         positionInRecord - furthestPositionInRecord);
   }
-  std::memcpy(Frame() + positionInRecord, data, bytes);
+  std::memcpy(Frame() + recordOffsetInFrame_ + positionInRecord, data, bytes);
   positionInRecord += bytes;
   furthestPositionInRecord = furthestAfter;
   return true;
 }
 
+bool ExternalFileUnit::Receive(
+    char *data, std::size_t bytes, IoErrorHandler &handler) {
+  RUNTIME_CHECK(handler, direction_ == Direction::Input);
+  auto furthestAfter{std::max(furthestPositionInRecord,
+      positionInRecord + static_cast<std::int64_t>(bytes))};
+  if (furthestAfter > recordLength.value_or(furthestAfter)) {
+    handler.SignalError(IostatRecordReadOverrun,
+        "Attempt to read %zd bytes at position %jd in a record of %jd bytes",
+        bytes, static_cast<std::intmax_t>(positionInRecord),
+        static_cast<std::intmax_t>(*recordLength));
+    return false;
+  }
+  auto need{recordOffsetInFrame_ + furthestAfter};
+  auto got{ReadFrame(frameOffsetInFile_, need, handler)};
+  if (got >= need) {
+    std::memcpy(data, Frame() + recordOffsetInFrame_ + positionInRecord, bytes);
+    positionInRecord += bytes;
+    furthestPositionInRecord = furthestAfter;
+    return true;
+  } else {
+    handler.SignalEnd();
+    endfileRecordNumber = currentRecordNumber;
+    return false;
+  }
+}
+
 std::optional<char32_t> ExternalFileUnit::GetCurrentChar(
     IoErrorHandler &handler) {
-  isReading_ = true; // TODO: manage read/write transitions
-  if (isUnformatted) {
-    handler.Crash("GetCurrentChar() called for unformatted input");
-    return std::nullopt;
-  }
-  std::size_t chunk{256}; // for stream input
-  if (recordLength.has_value()) {
-    if (positionInRecord >= *recordLength) {
-      return std::nullopt;
-    }
-    chunk = *recordLength - positionInRecord;
+  RUNTIME_CHECK(handler, direction_ == Direction::Input);
+  if (const char *p{FrameNextInput(handler, 1)}) {
+    // TODO: UTF-8 decoding; may have to get more bytes in a loop
+    return *p;
   }
-  auto at{recordOffsetInFrame_ + positionInRecord};
-  std::size_t need{static_cast<std::size_t>(at + 1)};
-  std::size_t want{need + chunk};
-  auto got{ReadFrame(frameOffsetInFile_, want, handler)};
-  if (got <= need) {
-    endfileRecordNumber = currentRecordNumber;
+  return std::nullopt;
+}
+
+const char *ExternalFileUnit::FrameNextInput(
+    IoErrorHandler &handler, std::size_t bytes) {
+  RUNTIME_CHECK(handler, !isUnformatted);
+  if (static_cast<std::int64_t>(positionInRecord + bytes) <=
+      recordLength.value_or(positionInRecord + bytes)) {
+    auto at{recordOffsetInFrame_ + positionInRecord};
+    auto need{static_cast<std::size_t>(at + bytes)};
+    auto got{ReadFrame(frameOffsetInFile_, need, handler)};
+    SetSequentialVariableFormattedRecordLength();
+    if (got >= need) {
+      return Frame() + at;
+    }
     handler.SignalEnd();
-    return std::nullopt;
+    endfileRecordNumber = currentRecordNumber;
   }
-  const char *p{Frame() + at};
-  if (isUTF8) {
-    // TODO: UTF-8 decoding
+  return nullptr;
+}
+
+bool ExternalFileUnit::SetSequentialVariableFormattedRecordLength() {
+  if (recordLength || access != Access::Sequential) {
+    return true;
+  }
+  if (FrameLength() > recordOffsetInFrame_) {
+    const char *record{Frame() + recordOffsetInFrame_};
+    if (const char *nl{reinterpret_cast<const char *>(
+            std::memchr(record, '\n', FrameLength() - recordOffsetInFrame_))}) {
+      recordLength = nl - record;
+      if (*recordLength > 0 && record[*recordLength - 1] == '\r') {
+        --*recordLength;
+      }
+      return true;
+    }
   }
-  return *p;
+  return false;
 }
 
 void ExternalFileUnit::SetLeftTabLimit() {
@@ -174,55 +289,87 @@ void ExternalFileUnit::SetLeftTabLimit() {
   positionInRecord = furthestPositionInRecord;
 }
 
+void ExternalFileUnit::BeginReadingRecord(IoErrorHandler &handler) {
+  RUNTIME_CHECK(handler, direction_ == Direction::Input);
+  if (access == Access::Sequential) {
+    if (endfileRecordNumber && currentRecordNumber >= *endfileRecordNumber) {
+      handler.SignalEnd();
+    } else if (isFixedRecordLength) {
+      RUNTIME_CHECK(handler, recordLength.has_value());
+      auto need{static_cast<std::size_t>(recordOffsetInFrame_ + *recordLength)};
+      auto got{ReadFrame(frameOffsetInFile_, need, handler)};
+      if (got < need) {
+        handler.SignalEnd();
+      }
+    } else if (isUnformatted) {
+      BeginSequentialVariableUnformattedInputRecord(handler);
+    } else { // formatted
+      BeginSequentialVariableFormattedInputRecord(handler);
+    }
+  }
+}
+
 bool ExternalFileUnit::AdvanceRecord(IoErrorHandler &handler) {
   bool ok{true};
-  if (isReading_) {
+  if (direction_ == Direction::Input) {
     if (access == Access::Sequential) {
-      if (isUnformatted) {
-        NextSequentialUnformattedInputRecord(handler);
-      } else {
-        NextSequentialFormattedInputRecord(handler);
+      RUNTIME_CHECK(handler, recordLength.has_value());
+      if (isFixedRecordLength) {
+        frameOffsetInFile_ += recordOffsetInFrame_ + *recordLength;
+        recordOffsetInFrame_ = 0;
+      } else if (isUnformatted) {
+        // Retain footer in frame for more efficient BACKSPACE
+        frameOffsetInFile_ += recordOffsetInFrame_ + *recordLength;
+        recordOffsetInFrame_ = sizeof(std::uint32_t);
+        recordLength.reset();
+      } else { // formatted
+        if (Frame()[recordOffsetInFrame_ + *recordLength] == '\r') {
+          ++recordOffsetInFrame_;
+        }
+        recordOffsetInFrame_ += *recordLength + 1;
+        RUNTIME_CHECK(handler, Frame()[recordOffsetInFrame_ - 1] == '\n');
+        recordLength.reset();
       }
     }
-  } else if (!isUnformatted) {
-    if (recordLength.has_value()) {
-      // fill fixed-size record
-      if (furthestPositionInRecord < *recordLength) {
-        WriteFrame(frameOffsetInFile_, *recordLength, handler);
-        std::memset(Frame() + recordOffsetInFrame_ + furthestPositionInRecord,
-            ' ', *recordLength - furthestPositionInRecord);
+  } else { // Direction::Output
+    if (!isUnformatted) {
+      if (isFixedRecordLength && recordLength) {
+        if (furthestPositionInRecord < *recordLength) {
+          WriteFrame(frameOffsetInFile_, *recordLength, handler);
+          std::memset(Frame() + recordOffsetInFrame_ + furthestPositionInRecord,
+              ' ', *recordLength - furthestPositionInRecord);
+        }
+      } else {
+        positionInRecord = furthestPositionInRecord;
+        ok &= Emit("\n", 1, handler); // TODO: Windows CR+LF
       }
-    } else {
-      positionInRecord = furthestPositionInRecord;
-      ok &= Emit("\n", 1, handler); // TODO: Windows CR+LF
-      frameOffsetInFile_ += recordOffsetInFrame_ + furthestPositionInRecord;
-      recordOffsetInFrame_ = 0;
     }
+    frameOffsetInFile_ +=
+        recordOffsetInFrame_ + recordLength.value_or(furthestPositionInRecord);
+    recordOffsetInFrame_ = 0;
+    impliedEndfile_ = true;
   }
   ++currentRecordNumber;
-  positionInRecord = 0;
-  furthestPositionInRecord = 0;
-  leftTabLimit.reset();
+  BeginRecord();
   return ok;
 }
 
 void ExternalFileUnit::BackspaceRecord(IoErrorHandler &handler) {
-  if (!isReading_) {
-    handler.Crash("ExternalFileUnit::BackspaceRecord() called during writing");
-    // TODO: create endfile record, &c.
-  }
-  if (access == Access::Sequential) {
-    if (isUnformatted) {
-      BackspaceSequentialUnformattedRecord(handler);
+  if (access != Access::Sequential) {
+    handler.SignalError(IostatBackspaceNonSequential,
+        "BACKSPACE(UNIT=%d) on non-sequential file", unitNumber());
+  } else {
+    DoImpliedEndfile(handler);
+    --currentRecordNumber;
+    BeginRecord();
+    if (isFixedRecordLength) {
+      BackspaceFixedRecord(handler);
+    } else if (isUnformatted) {
+      BackspaceVariableUnformattedRecord(handler);
     } else {
-      BackspaceSequentialFormattedRecord(handler);
+      BackspaceVariableFormattedRecord(handler);
     }
-  } else {
-    // TODO
   }
-  positionInRecord = 0;
-  furthestPositionInRecord = 0;
-  leftTabLimit.reset();
 }
 
 void ExternalFileUnit::FlushIfTerminal(IoErrorHandler &handler) {
@@ -231,6 +378,30 @@ void ExternalFileUnit::FlushIfTerminal(IoErrorHandler &handler) {
   }
 }
 
+void ExternalFileUnit::Endfile(IoErrorHandler &handler) {
+  if (access != Access::Sequential) {
+    handler.SignalError(IostatEndfileNonSequential,
+        "ENDFILE(UNIT=%d) on non-sequential file", unitNumber());
+  } else if (!mayWrite()) {
+    handler.SignalError(IostatEndfileUnwritable,
+        "ENDFILE(UNIT=%d) on read-only file", unitNumber());
+  } else {
+    DoEndfile(handler);
+  }
+}
+
+void ExternalFileUnit::Rewind(IoErrorHandler &handler) {
+  if (access == Access::Direct) {
+    handler.SignalError(IostatRewindNonSequential,
+        "REWIND(UNIT=%d) on non-sequential file", unitNumber());
+  } else {
+    DoImpliedEndfile(handler);
+    SetPosition(0);
+    currentRecordNumber = 1;
+    // TODO: reset endfileRecordNumber?
+  }
+}
+
 void ExternalFileUnit::EndIoStatement() {
   frameOffsetInFile_ += recordOffsetInFrame_;
   recordOffsetInFrame_ = 0;
@@ -239,51 +410,36 @@ void ExternalFileUnit::EndIoStatement() {
   lock_.Drop();
 }
 
-void ExternalFileUnit::NextSequentialUnformattedInputRecord(
+void ExternalFileUnit::BeginSequentialVariableUnformattedInputRecord(
     IoErrorHandler &handler) {
   std::int32_t header{0}, footer{0};
-  // Retain previous footer (if any) in frame for more efficient BACKSPACE
-  std::size_t retain{sizeof header};
-  if (recordLength) { // not first record - advance to next
-    ++currentRecordNumber;
-    if (endfileRecordNumber && currentRecordNumber >= *endfileRecordNumber) {
-      handler.SignalEnd();
-      return;
-    }
-    frameOffsetInFile_ +=
-        recordOffsetInFrame_ + *recordLength + 2 * sizeof header;
-    recordOffsetInFrame_ = 0;
-  } else {
-    retain = 0;
-  }
-  std::size_t need{retain + sizeof header};
-  std::size_t got{ReadFrame(frameOffsetInFile_ - retain, need, handler)};
+  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.
   const char *error{nullptr};
   if (got < need) {
-    if (got == retain) {
+    if (got == recordOffsetInFrame_) {
       handler.SignalEnd();
     } else {
-      error = "Unformatted sequential file input failed at record #%jd (file "
-              "offset %jd): truncated record header";
+      error = "Unformatted variable-length sequential file input failed at "
+              "record #%jd (file offset %jd): truncated record header";
     }
   } else {
-    std::memcpy(&header, Frame() + retain, sizeof header);
-    need = retain + header + 2 * sizeof header;
-    got = ReadFrame(frameOffsetInFile_ - retain,
-        need + sizeof header /* next one */, handler);
+    std::memcpy(&header, Frame() + recordOffsetInFrame_, sizeof header);
+    recordLength = sizeof header + header; // does not include footer
+    need = recordOffsetInFrame_ + *recordLength + sizeof footer;
+    got = ReadFrame(frameOffsetInFile_, need, handler);
     if (got < need) {
-      error = "Unformatted sequential file input failed at record #%jd (file "
-              "offset %jd): hit EOF reading record with length %jd bytes";
+      error = "Unformatted variable-length sequential file input failed at "
+              "record #%jd (file offset %jd): hit EOF reading record with "
+              "length %jd bytes";
     } else {
-      const char *start{Frame() + retain + sizeof header};
-      std::memcpy(&footer, start + header, sizeof footer);
+      std::memcpy(&footer, Frame() + recordOffsetInFrame_ + *recordLength,
+          sizeof footer);
       if (footer != header) {
-        error = "Unformatted sequential file input failed at record #%jd (file "
-                "offset %jd): record header has length %jd that does not match "
-                "record footer (%jd)";
-      } else {
-        recordLength = 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)";
       }
     }
   }
@@ -291,70 +447,66 @@ void ExternalFileUnit::NextSequentialUnformattedInputRecord(
     handler.SignalError(error, static_cast<std::intmax_t>(currentRecordNumber),
         static_cast<std::intmax_t>(frameOffsetInFile_),
         static_cast<std::intmax_t>(header), static_cast<std::intmax_t>(footer));
+    // TODO: error recovery
   }
   positionInRecord = sizeof header;
 }
 
-void ExternalFileUnit::NextSequentialFormattedInputRecord(
+void ExternalFileUnit::BeginSequentialVariableFormattedInputRecord(
     IoErrorHandler &handler) {
-  static constexpr std::size_t chunk{256};
-  std::size_t length{0};
-  if (recordLength.has_value()) {
-    // not first record - advance to next
-    ++currentRecordNumber;
-    if (endfileRecordNumber && currentRecordNumber >= *endfileRecordNumber) {
-      handler.SignalEnd();
-      return;
-    }
-    if (Frame()[*recordLength] == '\r') {
-      ++*recordLength;
-    }
-    recordOffsetInFrame_ += *recordLength + 1;
+  if (this == defaultInput && defaultOutput) {
+    defaultOutput->Flush(handler);
   }
-  while (true) {
-    std::size_t got{ReadFrame(
-        frameOffsetInFile_, recordOffsetInFrame_ + length + chunk, handler)};
-    if (got <= recordOffsetInFrame_ + length) {
+  std::size_t length{0};
+  do {
+    std::size_t need{recordOffsetInFrame_ + length + 1};
+    length = ReadFrame(frameOffsetInFile_, need, handler);
+    if (length < need) {
       handler.SignalEnd();
       break;
     }
-    const char *frame{Frame() + recordOffsetInFrame_};
-    if (const char *nl{reinterpret_cast<const char *>(
-            std::memchr(frame + length, '\n', chunk))}) {
-      recordLength = nl - (frame + length) + 1;
-      if (*recordLength > 0 && frame[*recordLength - 1] == '\r') {
-        --*recordLength;
-      }
-      return;
-    }
-    length += got;
+  } while (!SetSequentialVariableFormattedRecordLength());
+}
+
+void ExternalFileUnit::BackspaceFixedRecord(IoErrorHandler &handler) {
+  RUNTIME_CHECK(handler, recordLength.has_value());
+  if (frameOffsetInFile_ < *recordLength) {
+    handler.SignalError(IostatBackspaceAtFirstRecord);
+  } else {
+    frameOffsetInFile_ -= *recordLength;
   }
 }
 
-void ExternalFileUnit::BackspaceSequentialUnformattedRecord(
+void ExternalFileUnit::BackspaceVariableUnformattedRecord(
     IoErrorHandler &handler) {
   std::int32_t header{0}, footer{0};
-  RUNTIME_CHECK(handler, currentRecordNumber > 1);
-  --currentRecordNumber;
-  int overhead{static_cast<int>(2 * sizeof header)};
+  auto headerBytes{static_cast<std::int64_t>(sizeof header)};
+  frameOffsetInFile_ += recordOffsetInFrame_;
+  recordOffsetInFrame_ = 0;
+  if (frameOffsetInFile_ <= headerBytes) {
+    handler.SignalError(IostatBackspaceAtFirstRecord);
+    return;
+  }
   // Error conditions here cause crashes, not file format errors, because the
   // validity of the file structure before the current record will have been
-  // checked informatively in NextSequentialUnformattedInputRecord().
-  RUNTIME_CHECK(handler, frameOffsetInFile_ >= overhead);
+  // checked informatively in NextSequentialVariableUnformattedInputRecord().
   std::size_t got{
-      ReadFrame(frameOffsetInFile_ - sizeof footer, sizeof footer, handler)};
+      ReadFrame(frameOffsetInFile_ - headerBytes, headerBytes, handler)};
   RUNTIME_CHECK(handler, got >= sizeof footer);
   std::memcpy(&footer, Frame(), sizeof footer);
-  RUNTIME_CHECK(handler, frameOffsetInFile_ >= footer + overhead);
-  frameOffsetInFile_ -= footer + 2 * sizeof footer;
-  auto extra{std::max<std::size_t>(sizeof footer, frameOffsetInFile_)};
-  std::size_t want{extra + footer + 2 * sizeof footer};
-  got = ReadFrame(frameOffsetInFile_ - extra, want, handler);
-  RUNTIME_CHECK(handler, got >= want);
-  std::memcpy(&header, Frame() + extra, sizeof header);
-  RUNTIME_CHECK(handler, header == footer);
-  positionInRecord = sizeof header;
   recordLength = footer;
+  RUNTIME_CHECK(handler, frameOffsetInFile_ >= *recordLength + 2 * headerBytes);
+  frameOffsetInFile_ -= *recordLength + 2 * headerBytes;
+  if (frameOffsetInFile_ >= headerBytes) {
+    frameOffsetInFile_ -= headerBytes;
+    recordOffsetInFrame_ = headerBytes;
+  }
+  auto need{static_cast<std::size_t>(
+      recordOffsetInFrame_ + sizeof header + *recordLength)};
+  got = ReadFrame(frameOffsetInFile_, need, handler);
+  RUNTIME_CHECK(handler, got >= need);
+  std::memcpy(&header, Frame() + recordOffsetInFrame_, sizeof header);
+  RUNTIME_CHECK(handler, header == *recordLength);
 }
 
 // There's no portable memrchr(), unfortunately, and strrchr() would
@@ -368,50 +520,54 @@ static const char *FindLastNewline(const char *str, std::size_t length) {
   return nullptr;
 }
 
-void ExternalFileUnit::BackspaceSequentialFormattedRecord(
+void ExternalFileUnit::BackspaceVariableFormattedRecord(
     IoErrorHandler &handler) {
-  std::int64_t start{frameOffsetInFile_ + recordOffsetInFrame_};
-  --currentRecordNumber;
-  RUNTIME_CHECK(handler, currentRecordNumber > 0);
-  if (currentRecordNumber == 1) {
-    // To simplify the code below, treat a backspace to the first record
-    // as a special case;
-    RUNTIME_CHECK(handler, start > 0);
-    *recordLength = start - 1;
-    frameOffsetInFile_ = 0;
-    recordOffsetInFrame_ = 0;
-    ReadFrame(0, *recordLength + 1, handler);
-  } else {
-    RUNTIME_CHECK(handler, start > 1);
-    std::int64_t at{start - 2}; // byte before previous record's newline
-    while (true) {
+  // File offset of previous record's newline
+  auto prevNL{
+      frameOffsetInFile_ + static_cast<std::int64_t>(recordOffsetInFrame_) - 1};
+  if (prevNL < 0) {
+    handler.SignalError(IostatBackspaceAtFirstRecord);
+    return;
+  }
+  while (true) {
+    if (frameOffsetInFile_ < prevNL) {
       if (const char *p{
-              FindLastNewline(Frame(), at - frameOffsetInFile_ + 1)}) {
-        // This is the newline that ends the record before the previous one.
+              FindLastNewline(Frame(), prevNL - 1 - frameOffsetInFile_)}) {
         recordOffsetInFrame_ = p - Frame() + 1;
-        *recordLength = start - 1 - (frameOffsetInFile_ + recordOffsetInFrame_);
+        *recordLength = prevNL - (frameOffsetInFile_ + recordOffsetInFrame_);
         break;
       }
-      RUNTIME_CHECK(handler, frameOffsetInFile_ > 0);
-      at = frameOffsetInFile_ - 1;
-      if (auto bytesBefore{BytesBufferedBeforeFrame()}) {
-        frameOffsetInFile_ = FrameAt() - bytesBefore;
-      } else {
-        static constexpr int chunk{1024};
-        frameOffsetInFile_ = std::max<std::int64_t>(0, at - chunk);
-      }
-      std::size_t want{static_cast<std::size_t>(start - frameOffsetInFile_)};
-      std::size_t got{ReadFrame(frameOffsetInFile_, want, handler)};
-      RUNTIME_CHECK(handler, got >= want);
     }
+    if (frameOffsetInFile_ == 0) {
+      recordOffsetInFrame_ = 0;
+      *recordLength = prevNL;
+      break;
+    }
+    frameOffsetInFile_ -= std::min<std::int64_t>(frameOffsetInFile_, 1024);
+    auto need{static_cast<std::size_t>(prevNL + 1 - frameOffsetInFile_)};
+    auto got{ReadFrame(frameOffsetInFile_, need, handler)};
+    RUNTIME_CHECK(handler, got >= need);
   }
-  std::size_t want{
-      static_cast<std::size_t>(recordOffsetInFrame_ + *recordLength + 1)};
-  RUNTIME_CHECK(handler, FrameLength() >= want);
   RUNTIME_CHECK(handler, Frame()[recordOffsetInFrame_ + *recordLength] == '\n');
   if (*recordLength > 0 &&
       Frame()[recordOffsetInFrame_ + *recordLength - 1] == '\r') {
     --*recordLength;
   }
 }
+
+void ExternalFileUnit::DoImpliedEndfile(IoErrorHandler &handler) {
+  if (impliedEndfile_) {
+    impliedEndfile_ = false;
+    if (access == Access::Sequential && mayPosition()) {
+      DoEndfile(handler);
+    }
+  }
+}
+
+void ExternalFileUnit::DoEndfile(IoErrorHandler &handler) {
+  endfileRecordNumber = currentRecordNumber;
+  Truncate(frameOffsetInFile_ + recordOffsetInFrame_, handler);
+  BeginRecord();
+  impliedEndfile_ = false;
+}
 } // namespace Fortran::runtime::io

diff  --git a/flang/runtime/unit.h b/flang/runtime/unit.h
index cb40ddebacc5..bdc7a94e0a1a 100644
--- a/flang/runtime/unit.h
+++ b/flang/runtime/unit.h
@@ -43,12 +43,15 @@ class ExternalFileUnit : public ConnectionState,
   static ExternalFileUnit *LookUpForClose(int unit);
   static int NewUnit(const Terminator &);
   static void CloseAll(IoErrorHandler &);
+  static void FlushAll(IoErrorHandler &);
 
   void OpenUnit(OpenStatus, Position, OwningPtr<char> &&path,
       std::size_t pathLength, IoErrorHandler &);
   void CloseUnit(CloseStatus, IoErrorHandler &);
   void DestroyClosed();
 
+  bool SetDirection(Direction, IoErrorHandler &);
+
   template <typename A, typename... X>
   IoStatementState &BeginIoStatement(X &&... xs) {
     // TODO: Child data transfer statements vs. locking
@@ -61,27 +64,38 @@ class ExternalFileUnit : public ConnectionState,
     return *io_;
   }
 
-  bool Emit(const char *, std::size_t bytes, IoErrorHandler &);
+  bool Emit(const char *, std::size_t, IoErrorHandler &);
+  bool Receive(char *, std::size_t, IoErrorHandler &);
   std::optional<char32_t> GetCurrentChar(IoErrorHandler &);
   void SetLeftTabLimit();
+  void BeginReadingRecord(IoErrorHandler &);
   bool AdvanceRecord(IoErrorHandler &);
   void BackspaceRecord(IoErrorHandler &);
   void FlushIfTerminal(IoErrorHandler &);
+  void Endfile(IoErrorHandler &);
+  void Rewind(IoErrorHandler &);
   void EndIoStatement();
   void SetPosition(std::int64_t pos) {
     frameOffsetInFile_ = pos;
     recordOffsetInFrame_ = 0;
+    BeginRecord();
   }
 
 private:
   static UnitMap &GetUnitMap();
-  void NextSequentialUnformattedInputRecord(IoErrorHandler &);
-  void NextSequentialFormattedInputRecord(IoErrorHandler &);
-  void BackspaceSequentialUnformattedRecord(IoErrorHandler &);
-  void BackspaceSequentialFormattedRecord(IoErrorHandler &);
+  const char *FrameNextInput(IoErrorHandler &, std::size_t);
+  void BeginSequentialVariableUnformattedInputRecord(IoErrorHandler &);
+  void BeginSequentialVariableFormattedInputRecord(IoErrorHandler &);
+  void BackspaceFixedRecord(IoErrorHandler &);
+  void BackspaceVariableUnformattedRecord(IoErrorHandler &);
+  void BackspaceVariableFormattedRecord(IoErrorHandler &);
+  bool SetSequentialVariableFormattedRecordLength();
+  void DoImpliedEndfile(IoErrorHandler &);
+  void DoEndfile(IoErrorHandler &);
 
   int unitNumber_{-1};
-  bool isReading_{false};
+  Direction direction_{Direction::Output};
+  bool impliedEndfile_{false}; // seq. output has taken place
 
   Lock lock_;
 
@@ -100,9 +114,10 @@ class ExternalFileUnit : public ConnectionState,
 
   // Subtle: The beginning of the frame can't be allowed to advance
   // during a single list-directed READ due to the possibility of a
-  // multi-record CHARACTER value with a "r*" repeat count.
+  // multi-record CHARACTER value with a "r*" repeat count.  So we
+  // manage the frame and the current record therein separately.
   std::int64_t frameOffsetInFile_{0};
-  std::int64_t recordOffsetInFrame_{0}; // of currentRecordNumber
+  std::size_t recordOffsetInFrame_{0}; // of currentRecordNumber
 };
 
 } // namespace Fortran::runtime::io


        


More information about the flang-commits mailing list