lldb/source/Plugins/Process/Utility/StopInfoMachException.h

   1 //===-- StopInfoMachException.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 #ifndef LLDB_SOURCE_PLUGINS_PROCESS_UTILITY_STOPINFOMACHEXCEPTION_H
  10 #define LLDB_SOURCE_PLUGINS_PROCESS_UTILITY_STOPINFOMACHEXCEPTION_H
  11
  12 #include <optional>
  13 #include <string>
  14
  15 #include "lldb/Target/StopInfo.h"
  16
  17 #if defined(__APPLE__)
  18 // Needed for the EXC_* defines
  19 #include <mach/exception.h>
  20 #endif
  21
  22 namespace lldb_private {
  23
  24 class StopInfoMachException : public StopInfo {
  25   /// Determine the pointer-authentication related failure that caused this
  26   /// exception. Returns true and fills out the failure description if there
  27   /// is auth-related failure, and returns false otherwise.
  28   bool DeterminePtrauthFailure(ExecutionContext &exe_ctx);
  29
  30 public:
  31   // Constructors and Destructors
  32   StopInfoMachException(Thread &thread, uint32_t exc_type,
  33                         uint32_t exc_data_count, uint64_t exc_code,
  34                         uint64_t exc_subcode)
  35       : StopInfo(thread, exc_type), m_exc_data_count(exc_data_count),
  36         m_exc_code(exc_code), m_exc_subcode(exc_subcode) {}
  37
  38   ~StopInfoMachException() override = default;
  39
  40   lldb::StopReason GetStopReason() const override {
  41     return lldb::eStopReasonException;
  42   }
  43
  44   const char *GetDescription() override;
  45
  46 #if defined(__APPLE__)
  47   struct MachException {
  48     static const char *Name(exception_type_t exc_type);
  49     static std::optional<exception_type_t> ExceptionCode(const char *name);
  50   };
  51 #endif
  52
  53   // Since some mach exceptions will be reported as breakpoints, signals,
  54   // or trace, we use this static accessor which will translate the mach
  55   // exception into the correct StopInfo.
  56   static lldb::StopInfoSP CreateStopReasonWithMachException(
  57       Thread &thread, uint32_t exc_type, uint32_t exc_data_count,
  58       uint64_t exc_code, uint64_t exc_sub_code, uint64_t exc_sub_sub_code,
  59       bool pc_already_adjusted = true, bool adjust_pc_if_needed = false);
  60
  61 protected:
  62   uint32_t m_exc_data_count;
  63   uint64_t m_exc_code;
  64   uint64_t m_exc_subcode;
  65 };
  66
  67 } // namespace lldb_private
  68
  69 #endif // LLDB_SOURCE_PLUGINS_PROCESS_UTILITY_STOPINFOMACHEXCEPTION_H