lldb/source/Plugins/Process/FreeBSD-Kernel-Core/ProcessFreeBSDKernelCore.h

//===----------------------------------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#ifndef LLDB_SOURCE_PLUGINS_PROCESS_FREEBSDKERNEL_PROCESSFREEBSDKERNELCORE_H
#define LLDB_SOURCE_PLUGINS_PROCESS_FREEBSDKERNEL_PROCESSFREEBSDKERNELCORE_H

#include "lldb/Core/Debugger.h"
#include "lldb/Core/Module.h"
#include "lldb/Target/PostMortemProcess.h"

#include <kvm.h>

class ProcessFreeBSDKernelCore : public lldb_private::PostMortemProcess {
public:
  ProcessFreeBSDKernelCore(lldb::TargetSP target_sp, lldb::ListenerSP listener,
                           const lldb_private::FileSpec &core_file);

  ~ProcessFreeBSDKernelCore();

  static lldb::ProcessSP
  CreateInstance(lldb::TargetSP target_sp, lldb::ListenerSP listener,
                 const lldb_private::FileSpec *crash_file_path,
                 bool can_connect);

  static void Initialize();

  static void DebuggerInitialize(lldb_private::Debugger &debugger);

  static void Terminate();

  static llvm::StringRef GetPluginNameStatic() { return "freebsd-kernel-core"; }

  static llvm::StringRef GetPluginDescriptionStatic() {
    return "FreeBSD kernel core debugging plug-in.";
  }

  llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }

  bool CanDebug(lldb::TargetSP target_sp,
                bool plugin_specified_by_name) override;

  lldb_private::CommandObject *GetPluginCommandObject() override;

  lldb_private::Status DoLoadCore() override;

  lldb_private::DynamicLoader *GetDynamicLoader() override;

  lldb_private::Status DoDestroy() override;

  void RefreshStateAfterStop() override;

  size_t DoWriteMemory(lldb::addr_t addr, const void *buf, size_t size,
                       lldb_private::Status &error) override;

protected:
  friend class CommandObjectProcessFreeBSDKernelCoreRefreshThreads;

  bool DoUpdateThreadList(lldb_private::ThreadList &old_thread_list,
                          lldb_private::ThreadList &new_thread_list) override;

  size_t DoReadMemory(const lldb_private::ProcessAddress &addr, void *buf,
                      size_t size, lldb_private::Status &error) override;

  lldb::addr_t FindSymbol(const char *name);

private:
  static inline thread_local lldb_private::Module *g_kvm_kernel_module =
      nullptr;

  static int ResolveKVMSymbol(const char *name, kvaddr_t *value);

  static kvm_t *OpenKVM(const lldb::ModuleSP &kernel_module,
                        const lldb_private::FileSpec &core_file, int flags,
                        char *errbuf);

  void SetKernelDisplacement();

  void PrintUnreadMessage();

  const char *GetError();

  std::unique_ptr<lldb_private::CommandObjectMultiword> m_command_sp;

  bool m_printed_unread_message = false;

  kvm_t *m_kvm;
};

#endif // LLDB_SOURCE_PLUGINS_PROCESS_FREEBSDKERNEL_PROCESSFREEBSDKERNELCORE_H