gdbserver/win32-low.h

   1 /* Internal interfaces for the Win32 specific target code for gdbserver.
   2    Copyright (C) 2007-2020 Free Software Foundation, Inc.
   3
   4    This file is part of GDB.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #ifndef GDBSERVER_WIN32_LOW_H
  20 #define GDBSERVER_WIN32_LOW_H
  21
  22 #include <windows.h>
  23
  24 struct target_desc;
  25
  26 /* The inferior's target description.  This is a global because the
  27    Windows ports support neither bi-arch nor multi-process.  */
  28 extern const struct target_desc *win32_tdesc;
  29
  30 /* Thread information structure used to track extra information about
  31    each thread.  */
  32 typedef struct win32_thread_info
  33 {
  34   /* The Win32 thread identifier.  */
  35   DWORD tid;
  36
  37   /* The handle to the thread.  */
  38   HANDLE h;
  39
  40   /* Thread Information Block address.  */
  41   CORE_ADDR thread_local_base;
  42
  43   /* Non zero if SuspendThread was called on this thread.  */
  44   int suspended;
  45
  46 #ifdef _WIN32_WCE
  47   /* The context as retrieved right after suspending the thread. */
  48   CONTEXT base_context;
  49 #endif
  50
  51   /* The context of the thread, including any manipulations.  */
  52   CONTEXT context;
  53
  54   /* Whether debug registers changed since we last set CONTEXT back to
  55      the thread.  */
  56   int debug_registers_changed;
  57 } win32_thread_info;
  58
  59 struct win32_target_ops
  60 {
  61   /* Architecture-specific setup.  */
  62   void (*arch_setup) (void);
  63
  64   /* The number of target registers.  */
  65   int num_regs;
  66
  67   /* Perform initializations on startup.  */
  68   void (*initial_stuff) (void);
  69
  70   /* Fetch the context from the inferior.  */
  71   void (*get_thread_context) (win32_thread_info *th);
  72
  73   /* Called just before resuming the thread.  */
  74   void (*prepare_to_resume) (win32_thread_info *th);
  75
  76   /* Called when a thread was added.  */
  77   void (*thread_added) (win32_thread_info *th);
  78
  79   /* Fetch register from gdbserver regcache data.  */
  80   void (*fetch_inferior_register) (struct regcache *regcache,
  81                                    win32_thread_info *th, int r);
  82
  83   /* Store a new register value into the thread context of TH.  */
  84   void (*store_inferior_register) (struct regcache *regcache,
  85                                    win32_thread_info *th, int r);
  86
  87   void (*single_step) (win32_thread_info *th);
  88
  89   const unsigned char *breakpoint;
  90   int breakpoint_len;
  91
  92   /* Breakpoint/Watchpoint related functions.  See target.h for comments.  */
  93   int (*supports_z_point_type) (char z_type);
  94   int (*insert_point) (enum raw_bkpt_type type, CORE_ADDR addr,
  95                        int size, struct raw_breakpoint *bp);
  96   int (*remove_point) (enum raw_bkpt_type type, CORE_ADDR addr,
  97                        int size, struct raw_breakpoint *bp);
  98   int (*stopped_by_watchpoint) (void);
  99   CORE_ADDR (*stopped_data_address) (void);
 100 };
 101
 102 extern struct win32_target_ops the_low_target;
 103
 104 /* Target ops definitions for a Win32 target.  */
 105
 106 class win32_process_target : public process_stratum_target
 107 {
 108 public:
 109
 110   int create_inferior (const char *program,
 111                        const std::vector<char *> &program_args) override;
 112
 113   int attach (unsigned long pid) override;
 114
 115   int kill (process_info *proc) override;
 116
 117   int detach (process_info *proc) override;
 118
 119   void mourn (process_info *proc) override;
 120
 121   void join (int pid) override;
 122
 123   bool thread_alive (ptid_t pid) override;
 124
 125   void resume (thread_resume *resume_info, size_t n) override;
 126
 127   ptid_t wait (ptid_t ptid, target_waitstatus *status,
 128                int options) override;
 129
 130   void fetch_registers (regcache *regcache, int regno) override;
 131
 132   void store_registers (regcache *regcache, int regno) override;
 133
 134   int read_memory (CORE_ADDR memaddr, unsigned char *myaddr,
 135                    int len) override;
 136
 137   int write_memory (CORE_ADDR memaddr, const unsigned char *myaddr,
 138                     int len) override;
 139
 140   void request_interrupt () override;
 141
 142   bool supports_z_point_type (char z_type) override;
 143
 144   int insert_point (enum raw_bkpt_type type, CORE_ADDR addr,
 145                     int size, raw_breakpoint *bp) override;
 146
 147   int remove_point (enum raw_bkpt_type type, CORE_ADDR addr,
 148                     int size, raw_breakpoint *bp) override;
 149
 150   bool supports_hardware_single_step () override;
 151
 152   bool stopped_by_watchpoint () override;
 153
 154   CORE_ADDR stopped_data_address () override;
 155
 156 #ifdef _WIN32_WCE
 157   void hostio_last_error (char *buf) override;
 158 #endif
 159
 160   bool supports_qxfer_siginfo () override;
 161
 162   int qxfer_siginfo (const char *annex, unsigned char *readbuf,
 163                      unsigned const char *writebuf,
 164                      CORE_ADDR offset, int len) override;
 165
 166   bool supports_get_tib_address () override;
 167
 168   int get_tib_address (ptid_t ptid, CORE_ADDR *addr) override;
 169
 170   const gdb_byte *sw_breakpoint_from_kind (int kind, int *size) override;
 171 };
 172
 173 /* Retrieve the context for this thread, if not already retrieved.  */
 174 extern void win32_require_context (win32_thread_info *th);
 175
 176 /* Map the Windows error number in ERROR to a locale-dependent error
 177    message string and return a pointer to it.  Typically, the values
 178    for ERROR come from GetLastError.
 179
 180    The string pointed to shall not be modified by the application,
 181    but may be overwritten by a subsequent call to strwinerror
 182
 183    The strwinerror function does not change the current setting
 184    of GetLastError.  */
 185 extern char * strwinerror (DWORD error);
 186
 187 /* in wincecompat.c */
 188
 189 extern void to_back_slashes (char *);
 190
 191 #endif /* GDBSERVER_WIN32_LOW_H */