1 //===-- runtime/io-error.h --------------------------------------*- C++ -*-===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 // Distinguishes I/O error conditions; fatal ones lead to termination, 10 // and those that the user program has chosen to handle are recorded 11 // so that the highest-priority one can be returned as IOSTAT=. 12 // IOSTAT error codes are raw errno values augmented with values for 13 // Fortran-specific errors. 14 15 #ifndef FORTRAN_RUNTIME_IO_ERROR_H_ 16 #define FORTRAN_RUNTIME_IO_ERROR_H_ 17 18 #include "terminator.h" 19 #include "flang/Runtime/iostat.h" 20 #include "flang/Runtime/memory.h" 21 #include <cinttypes> 22 23 namespace Fortran::runtime::io { 24 25 // See 12.11 in Fortran 2018 26 class IoErrorHandler : public Terminator { 27 public: 28 using Terminator::Terminator; 29 explicit RT_API_ATTRS IoErrorHandler(const Terminator &that) 30 : Terminator{that} {} 31 RT_API_ATTRS void HasIoStat() { flags_ |= hasIoStat; } 32 RT_API_ATTRS void HasErrLabel() { flags_ |= hasErr; } 33 RT_API_ATTRS void HasEndLabel() { flags_ |= hasEnd; } 34 RT_API_ATTRS void HasEorLabel() { flags_ |= hasEor; } 35 RT_API_ATTRS void HasIoMsg() { flags_ |= hasIoMsg; } 36 RT_API_ATTRS void HasRec() { flags_ |= hasRec; } 37 38 RT_API_ATTRS bool InError() const { 39 return ioStat_ != IostatOk || pendingError_ != IostatOk; 40 } 41 42 // For I/O statements that detect fatal errors in their 43 // Begin...() API routines before it is known whether they 44 // have error handling control list items. Such statements 45 // have an ErroneousIoStatementState with a pending error. 46 RT_API_ATTRS void SetPendingError(int iostat) { pendingError_ = iostat; } 47 48 RT_API_ATTRS void SignalError(int iostatOrErrno, const char *msg, ...); 49 RT_API_ATTRS void SignalError(int iostatOrErrno); 50 template <typename... X> 51 RT_API_ATTRS void SignalError(const char *msg, X &&...xs) { 52 SignalError(IostatGenericError, msg, std::forward<X>(xs)...); 53 } 54 55 RT_API_ATTRS void Forward(int iostatOrErrno, const char *, std::size_t); 56 57 void SignalErrno(); // SignalError(errno) 58 RT_API_ATTRS void 59 SignalEnd(); // input only; EOF on internal write is an error 60 RT_API_ATTRS void 61 SignalEor(); // non-advancing input only; EOR on write is an error 62 RT_API_ATTRS void SignalPendingError(); 63 64 RT_API_ATTRS int GetIoStat() const { return ioStat_; } 65 RT_API_ATTRS bool GetIoMsg(char *, std::size_t); 66 67 private: 68 enum Flag : std::uint8_t { 69 hasIoStat = 1, // IOSTAT= 70 hasErr = 2, // ERR= 71 hasEnd = 4, // END= 72 hasEor = 8, // EOR= 73 hasIoMsg = 16, // IOMSG= 74 hasRec = 32, // REC= 75 }; 76 std::uint8_t flags_{0}; 77 int ioStat_{IostatOk}; 78 OwningPtr<char> ioMsg_; 79 int pendingError_{IostatOk}; 80 }; 81 82 } // namespace Fortran::runtime::io 83 #endif // FORTRAN_RUNTIME_IO_ERROR_H_ 84