crash_handler.h

Go to the documentation of this file.

#ifndef YAZE_UTIL_CRASH_HANDLER_H
#define YAZE_UTIL_CRASH_HANDLER_H
 
#include <filesystem>
#include <string>
 
namespace yaze {
namespace util {
 
class CrashHandler {
 public:
  static void Initialize(const std::string& version);
 
  static std::filesystem::path GetCrashLogDirectory();
 
  static std::filesystem::path GetMostRecentCrashLog();
 
  static bool HasUnacknowledgedCrashLog();
 
  static void AcknowledgeCrashLog();
 
  static void CleanupOldLogs(int keep_count = 5);
 
  static bool IsHeaderOnlyCrashLog(const std::filesystem::path& path);
 
  // Testing hooks: prepare the crash log path and header for `directory`
  // without installing signal handlers, drive the signal-path writer, and
  // release the file afterwards.
  static void PrepareCrashLogForTesting(const std::string& version,
                                        const std::filesystem::path& directory);
  static void WriteCrashLogForTesting(const char* data);
  static std::filesystem::path PendingCrashLogPathForTesting();
  static void ResetForTesting();
 
 private:
  // Builds the log path and header in static buffers so the signal handler
  // can create the file without allocating.
  static void PrepareCrashLog(const std::string& version,
                              const std::filesystem::path& directory);
 
  // Opens the log and writes the header on the first crash write. Uses only
  // async-signal-safe calls.
  static void OpenCrashLogFromSignalHandler();
 
  // Custom writer function for absl failure signal handler
  static void CrashLogWriter(const char* data);
 
  static std::string version_;
  static std::filesystem::path crash_log_path_;
  static int crash_log_fd_;
};
 
}  // namespace util
}  // namespace yaze
 
#endif  // YAZE_UTIL_CRASH_HANDLER_H