#ifndef __LINUX_DEBUGGER_MODULE__
#define __LINUX_DEBUGGER_MODULE__

#if defined(__EA64__) && defined(USE_LIBUNWIND) && !defined(__ANDROID__)
  #define HAVE_UPDATE_CALL_STACK
  struct libunwind_pair_name_t
  {
    const char *libx86_64_name;
    const char *libptrace_name;
  };

  static const libunwind_pair_name_t libunwind_pair_name[] =
  {
    { "libunwind-x86_64.so.8", "libunwind-ptrace.so.0" },
    { "libunwind-x86_64.so", "libunwind-ptrace.so" },
  };
#endif

#include <signal.h>
#include <sys/ptrace.h>
#include <sys/wait.h>
#include <sys/user.h>

#include "linuxbase_debmod.h"

extern "C"
{
#include <thread_db.h>
}

#include <deque>

typedef int HANDLE;
typedef uint32 DWORD;
#define INVALID_HANDLE_VALUE (-1)

using std::pair;
using std::make_pair;

//--------------------------------------------------------------------------
typedef std::map<ea_t, qstring> ea2name_t;
typedef std::map<qstring, ea_t> name2ea_t;

#ifndef WCONTINUED
#define WCONTINUED 8
#endif

#ifndef __WALL
#define __WALL 0x40000000
#endif

//--------------------------------------------------------------------------
// image information
struct image_info_t
{
  image_info_t() : base(BADADDR), size(0), dl_crc(0) {}
  image_info_t(
        ea_t _base,
        asize_t _size,
        const qstring &_fname,
        const qstring &_soname)
    : base(_base), size(_size), fname(_fname), soname(_soname), dl_crc(0) {}
  ea_t base;
  asize_t size;         // image size, currently 0
  qstring fname;
  qstring soname;
  ea2name_t names;
  qstring buildid;
  qstring debuglink;
  uint32 dl_crc;
};
typedef std::map<ea_t, image_info_t> images_t; // key: image base address

//--------------------------------------------------------------------------
enum thstate_t
{
  RUNNING,            // running
  STOPPED,            // waiting to be resumed after qwait
  DYING,              // we got a notification that the thread is about to die
  DEAD,               // dead thread; ignore any signals from it
};

//--------------------------------------------------------------------------
// thread information
struct thread_info_t
{
  thread_info_t(int t)
    : tid(t), suspend_count(0), user_suspend(0), child_signum(0), single_step(false),
      state(STOPPED), waiting_sigstop(false), got_pending_status(false), pending_status(0) {}
  int tid;
  int suspend_count;
  int user_suspend;
  int child_signum;
  bool single_step;
  thstate_t state;
  bool waiting_sigstop;
  bool got_pending_status;
  int pending_status;
  qstring name;   // thread name
  bool is_running(void) const
  {
    return state == RUNNING && !waiting_sigstop && !got_pending_status;
  }
};

//--------------------------------------------------------------------------
typedef std::map<HANDLE, thread_info_t> threads_t; // (tid -> info)

//--------------------------------------------------------------------------
enum ps_err_e
{
  PS_OK,      /* Success.  */
  PS_ERR,     /* Generic error.  */
  PS_BADPID,  /* Bad process handle.  */
  PS_BADLID,  /* Bad LWP id.  */
  PS_BADADDR, /* Bad address.  */
  PS_NOSYM,   /* Symbol not found.  */
  PS_NOFREGS  /* FPU register set not available.  */
};
struct ps_prochandle
{
  pid_t pid;
};

#ifndef UINT32_C
#  define UINT32_C uint32
#endif

//--------------------------------------------------------------------------
struct internal_bpt
{
  ea_t bpt_addr;
  uchar saved[BPT_CODE_SIZE];
  uchar nsaved;
  internal_bpt(): bpt_addr(0), nsaved(0) {}   //-V730 Not all members of a class are initialized
};

//--------------------------------------------------------------------------
struct mapfp_entry_t
{
  ea_t ea1;
  ea_t ea2;
  ea_t offset;
  uint64 inode;
  char perm[8];
  char device[8];
  uint8 bitness; // Number of bits in segment addresses (0-16bit, 1-32bit, 2-64bit)
  qstring fname;
  bool empty(void) const { return ea1 >= ea2; }
};

//--------------------------------------------------------------------------
struct chk_signal_info_t
{
  pid_t pid;
  int status;
  int timeout_ms;

  chk_signal_info_t(int _timeout_ms)
  {
    timeout_ms = _timeout_ms;
    pid = 0;
    status = 0;
  }
};

//--------------------------------------------------------------------------
enum attach_mode_t
{
  AMT_NO_ATTACH,
  AMT_ATTACH_NORMAL,
  AMT_ATTACH_BROKEN
};

//--------------------------------------------------------------------------
class linux_debmod_t : public linuxbase_debmod_t
{
  typedef linuxbase_debmod_t inherited;

  // thread_db related data and functions:
  struct ps_prochandle prochandle;
  td_thragent_t *ta;

  internal_bpt birth_bpt; // thread created
  internal_bpt death_bpt; // thread exited
  internal_bpt shlib_bpt; // shared lib list changed
  bool complained_shlib_bpt;

  void make_android_abspath(qstring *in_out_path);
  bool add_android_shlib_bpt(const meminfo_vec_t &miv, bool attaching);

  bool add_internal_bp(internal_bpt &bp, ea_t addr);
  bool erase_internal_bp(internal_bpt &bp);

  bool tdb_enable_event(td_event_e event, internal_bpt *bp);
  void tdb_update_threads(void);
  bool tdb_new(void);
  void tdb_delete(void);
  void tdb_handle_messages(int pid);
  void dead_thread(int tid, thstate_t state);
  void store_pending_signal(int pid, int status);

  bool activate_multithreading();

  // procfs
  void procfs_collect_threads(void);
  bool attach_collected_thread(unsigned long lwp);
  bool get_thread_name(qstring *thr_name, thid_t tid);
  void update_thread_names(thread_name_vec_t *thr_names);

  // list of debug names not yet sent to IDA
  name_info_t pending_names;
  name_info_t nptl_names;

  pid_t check_for_signal(int *status, int pid, int timeout_ms) const;

  int find_largest_addrsize(const meminfo_vec_t &miv);
  void _import_dll(image_info_t &ii);
  void _import_symbols_from_file(name_info_t *out, image_info_t &ii);

public:
  easet_t dlls_to_import;          // list of dlls to import information from
  images_t dlls;                   // list of loaded DLLs
  threads_t threads;
  qvector<thid_t> deleted_threads;
  qvector<thid_t> seen_threads;    // thread was born and appeared too early
#ifdef HAVE_UPDATE_CALL_STACK
  qstring libunwind_path;
#endif

  // debugged process information
  HANDLE process_handle;
  HANDLE thread_handle;
  bool threads_collected = false;

  bool exited;             // Did the process exit?

  easet_t removed_bpts; // removed breakpoints

  FILE *mapfp;             // map file handle

  int npending_signals;    // number of pending signals
  bool may_run;
  bool requested_to_suspend;
  bool in_event;           // IDA kernel is handling a debugger event

  qstring interp;

  qstring exe_path;        // name of the executable file

  ea_t nptl_base;          // base of 'libpthread.so'

  linux_debmod_t();
  ~linux_debmod_t();

  thread_info_t &add_thread(int tid);
  void del_thread(int tid);
  thread_info_t *get_thread(thid_t tid);
  bool retrieve_pending_signal(pid_t *pid, int *status);
  int get_debug_event(debug_event_t *event, int timeout_ms);
  bool del_pending_event(event_id_t id, const char *module_name);
  void enqueue_event(const debug_event_t &ev, queue_pos_t pos);
  bool suspend_all_threads(void);
  bool resume_all_threads(void);
  int dbg_freeze_threads(thid_t tid, bool exclude=true);
  int dbg_thaw_threads(thid_t tid, bool exclude=true);
  void set_thread_state(thread_info_t &ti, thstate_t state) const;
  bool resume_app(thid_t tid);
  bool has_pending_events(void);
  bool read_asciiz(tid_t tid, ea_t ea, char *buf, size_t bufsize, bool suspend=false);
  int _read_memory(int tid, ea_t ea, void *buffer, int size, bool suspend=false);
  int _write_memory(int tid, ea_t ea, const void *buffer, int size, bool suspend=false);
  void add_dll(ea_t base, asize_t size, const char *modname, const char *soname);
  asize_t calc_module_size(const meminfo_vec_t &miv, const memory_info_t *mi) const;
  void enum_names(const char *libpath=nullptr);
  bool add_shlib_bpt(const meminfo_vec_t &miv, bool attaching);
  bool gen_library_events(int tid);
  bool emulate_retn(int tid);
  void cleanup(void);
  bool handle_process_start(pid_t pid, attach_mode_t attaching);
  drc_t get_memory_info(meminfo_vec_t &areas, bool suspend);
  bool set_hwbpts(HANDLE hThread) const;
  virtual bool refresh_hwbpts() override;
  void handle_dll_movements(const meminfo_vec_t &miv);
  bool idaapi thread_get_fs_base(thid_t tid, int reg_idx, ea_t *pea) const;
  bool read_mapping(mapfp_entry_t *me);
  bool get_soname(const char *fname, qstring *soname) const;
  ea_t find_pending_name(const char *name);
  bool handle_hwbpt(debug_event_t *event);
  bool thread_is_known(const td_thrinfo_t &info) const;
  bool listen_thread_events(const td_thrinfo_t &info, const td_thrhandle_t *th_p);
  void attach_to_thread(const td_thrinfo_t &info);
  bool attach_to_thread(int tid, ea_t ea);
  void handle_extended_wait(bool *handled, const chk_signal_info_t &csi);
  bool finish_attaching(int tid, ea_t ea, bool use_ip);
  bool check_for_new_events(chk_signal_info_t *csi, bool *event_prepared);

  virtual void init_reg_ctx() override;
  virtual void idaapi dbg_set_debugging(bool _debug_debugger) override;
  virtual drc_t idaapi dbg_init(uint32_t *flags2, qstring *errbuf) override;
  virtual void idaapi dbg_term(void) override;
  virtual drc_t idaapi dbg_detach_process(void) override;
  virtual drc_t idaapi dbg_start_process(
        const char *path,
        const char *args,
        launch_env_t *envs,
        const char *startdir,
        int flags,
        const char *input_path,
        uint32 input_file_crc32,
        qstring *errbuf) override;
  virtual gdecode_t idaapi dbg_get_debug_event(debug_event_t *event, int timeout_ms) override;
  virtual drc_t idaapi dbg_attach_process(pid_t process_id, int event_id, int flags, qstring *errbuf) override;
  virtual drc_t idaapi dbg_prepare_to_pause_process(qstring *errbuf) override;
  virtual drc_t idaapi dbg_exit_process(qstring *errbuf) override;
  virtual drc_t idaapi dbg_continue_after_event(const debug_event_t *event) override;
  virtual void idaapi dbg_stopped_at_debug_event(import_infos_t *infos, bool dlls_added, thread_name_vec_t *thr_names) override;
  virtual drc_t idaapi dbg_thread_suspend(thid_t thread_id) override;
  virtual drc_t idaapi dbg_thread_continue(thid_t thread_id) override;
  virtual drc_t idaapi dbg_set_resume_mode(thid_t thread_id, resume_mode_t resmod) override;
  virtual drc_t idaapi dbg_read_registers(
        thid_t thread_id,
        int clsmask,
        regval_t *values,
        qstring *errbuf) override;
  virtual drc_t idaapi dbg_write_register(
        thid_t thread_id,
        int reg_idx,
        const regval_t *value,
        qstring *errbuf) override;
  virtual drc_t idaapi dbg_thread_get_sreg_base(ea_t *ea, thid_t thread_id, int sreg_value, qstring *errbuf) override;
  virtual drc_t idaapi dbg_get_memory_info(meminfo_vec_t &areas, qstring *errbuf) override;
#ifdef HAVE_UPDATE_CALL_STACK
  virtual drc_t idaapi dbg_update_call_stack(thid_t tid, call_stack_t *) override;
#endif
  virtual ssize_t idaapi dbg_read_memory(ea_t ea, void *buffer, size_t size, qstring *errbuf) override;
  virtual ssize_t idaapi dbg_write_memory(ea_t ea, const void *buffer, size_t size, qstring *errbuf) override;
  virtual int idaapi dbg_add_bpt(bytevec_t *orig_bytes, bpttype_t type, ea_t ea, int len) override;
  virtual int idaapi dbg_del_bpt(bpttype_t type, ea_t ea, const uchar *orig_bytes, int len) override;
  virtual int idaapi handle_ioctl(int fn, const void *buf, size_t size, void **outbuf, ssize_t *outsize) override;
  virtual bool idaapi write_registers(
        thid_t tid,
        int start,
        int count,
        const regval_t *values) override;
  virtual int dbg_freeze_threads_except(thid_t tid) override { return dbg_freeze_threads(tid); }
  virtual int dbg_thaw_threads_except(thid_t tid) override { return dbg_thaw_threads(tid); }

  virtual bool idaapi dbg_continue_broken_connection(pid_t pid) override;
  virtual bool idaapi dbg_prepare_broken_connection(void) override;

  // thread_db
  void display_thrinfo(thid_t tid);
  void display_all_threads();

  void cleanup_breakpoints(void);
  void cleanup_signals(void);

  bool fix_instruction_pointer(void) const;
#ifdef __ARM__
  virtual void adjust_swbpt(ea_t *p_ea, int *p_len) override;
#endif

#ifdef LDEB
  void log(thid_t tid, const char *format, ...);
#endif
};

#endif