[flang] Implement a runtime routine to report fatal errors with source position

[PeteSteinfeld]

Summary

The title says it all.

I implemented a routine called "Crash" and added a test.

[klausler]

flang/runtime/stop.cpp

149

Could be one line with the use of an anonymous Terminator:

Fortran::runtime::Terminator{source, line}.Crash(message);

[PeteSteinfeld]

flang/runtime/stop.cpp

149

Thanks! I'll change it.

flang/include/flang/Runtime/stop.h

 void RTNAME(PauseStatementText)(const char *, size_t);
 NORETURN void RTNAME(FailImageStatement)(NO_ARGUMENTS);
 NORETURN void RTNAME(ProgramEndStatement)(NO_ARGUMENTS);
 
 // Extensions
 NORETURN void RTNAME(Exit)(int status = EXIT_SUCCESS);
 NORETURN void RTNAME(Abort)(NO_ARGUMENTS);
 
+// Crash with an error message when the program dynamically violates a Fortran
+// constraint.
+NORETURN void RTNAME(Crash)(const char *message, const char *source, int line);
+
 FORTRAN_EXTERN_C_END
 
 #endif // FORTRAN_RUNTIME_STOP_H_

flang/runtime/stop.cpp

 }
 
 [[noreturn]] void RTNAME(Exit)(int status) {
   CloseAllExternalUnits("CALL EXIT()");
   std::exit(status);
 }
 
 [[noreturn]] void RTNAME(Abort)() { std::abort(); }
+
+[[noreturn]] void RTNAME(Crash)(
+    const char *message, const char *source, int line) {
+  Fortran::runtime::Terminator{source, line}.Crash(message);
+}
 }

flang/unittests/Runtime/Stop.cpp

 
 TEST(TestProgramEnd, ExitTest) {
   EXPECT_EXIT(RTNAME(Exit)(), testing::ExitedWithCode(EXIT_SUCCESS), "");
   EXPECT_EXIT(
       RTNAME(Exit)(EXIT_FAILURE), testing::ExitedWithCode(EXIT_FAILURE), "");
 }
 
 TEST(TestProgramEnd, AbortTest) { EXPECT_DEATH(RTNAME(Abort)(), ""); }
+
+TEST(TestProgramEnd, CrashTest) {
+  static const std::string crashMessage{"bad user code"};
+  static const std::string fileName{"file name"};
+  static const std::string headMessage{"fatal Fortran runtime error\\("};
+  static const std::string tailMessage{":343\\): "};
+  static const std::string fullMessage{
+      headMessage + fileName + tailMessage + crashMessage};
+  EXPECT_DEATH(RTNAME(Crash)(crashMessage.c_str(), fileName.c_str(), 343),
+      fullMessage.c_str());
+}