1 /* Internal interfaces for the Win32 specific target code for gdbserver.
2    Copyright (C) 2007-2021 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 #include "nat/windows-nat.h"
24 
25 struct target_desc;
26 
27 /* The inferior's target description.  This is a global because the
28    Windows ports support neither bi-arch nor multi-process.  */
29 extern const struct target_desc *win32_tdesc;
30 #ifdef __x86_64__
31 extern const struct target_desc *wow64_win32_tdesc;
32 
33 typedef BOOL (WINAPI *winapi_Wow64GetThreadContext) (HANDLE, PWOW64_CONTEXT);
34 extern winapi_Wow64GetThreadContext win32_Wow64GetThreadContext;
35 #endif
36 
37 struct win32_target_ops
38 {
39   /* Architecture-specific setup.  */
40   void (*arch_setup) (void);
41 
42   /* The number of target registers.  */
43   int (*num_regs) (void);
44 
45   /* Perform initializations on startup.  */
46   void (*initial_stuff) (void);
47 
48   /* Fetch the context from the inferior.  */
49   void (*get_thread_context) (windows_nat::windows_thread_info *th);
50 
51   /* Called just before resuming the thread.  */
52   void (*prepare_to_resume) (windows_nat::windows_thread_info *th);
53 
54   /* Called when a thread was added.  */
55   void (*thread_added) (windows_nat::windows_thread_info *th);
56 
57   /* Fetch register from gdbserver regcache data.  */
58   void (*fetch_inferior_register) (struct regcache *regcache,
59 				   windows_nat::windows_thread_info *th,
60 				   int r);
61 
62   /* Store a new register value into the thread context of TH.  */
63   void (*store_inferior_register) (struct regcache *regcache,
64 				   windows_nat::windows_thread_info *th,
65 				   int r);
66 
67   void (*single_step) (windows_nat::windows_thread_info *th);
68 
69   const unsigned char *breakpoint;
70   int breakpoint_len;
71 
72   /* Amount by which to decrement the PC after a breakpoint is
73      hit.  */
74   int decr_pc_after_break;
75 
76   /* Get the PC register from REGCACHE.  */
77   CORE_ADDR (*get_pc) (struct regcache *regcache);
78   /* Set the PC register in REGCACHE.  */
79   void (*set_pc) (struct regcache *regcache, CORE_ADDR newpc);
80 
81   /* Breakpoint/Watchpoint related functions.  See target.h for comments.  */
82   int (*supports_z_point_type) (char z_type);
83   int (*insert_point) (enum raw_bkpt_type type, CORE_ADDR addr,
84 		       int size, struct raw_breakpoint *bp);
85   int (*remove_point) (enum raw_bkpt_type type, CORE_ADDR addr,
86 		       int size, struct raw_breakpoint *bp);
87   int (*stopped_by_watchpoint) (void);
88   CORE_ADDR (*stopped_data_address) (void);
89 };
90 
91 extern struct win32_target_ops the_low_target;
92 
93 /* Target ops definitions for a Win32 target.  */
94 
95 class win32_process_target : public process_stratum_target
96 {
97 public:
98 
99   int create_inferior (const char *program,
100 		       const std::vector<char *> &program_args) override;
101 
102   int attach (unsigned long pid) override;
103 
104   int kill (process_info *proc) override;
105 
106   int detach (process_info *proc) override;
107 
108   void mourn (process_info *proc) override;
109 
110   void join (int pid) override;
111 
112   bool thread_alive (ptid_t pid) override;
113 
114   void resume (thread_resume *resume_info, size_t n) override;
115 
116   ptid_t wait (ptid_t ptid, target_waitstatus *status,
117 	       target_wait_flags options) override;
118 
119   void fetch_registers (regcache *regcache, int regno) override;
120 
121   void store_registers (regcache *regcache, int regno) override;
122 
123   int read_memory (CORE_ADDR memaddr, unsigned char *myaddr,
124 		   int len) override;
125 
126   int write_memory (CORE_ADDR memaddr, const unsigned char *myaddr,
127 		    int len) override;
128 
129   void request_interrupt () override;
130 
131   bool supports_z_point_type (char z_type) override;
132 
133   int insert_point (enum raw_bkpt_type type, CORE_ADDR addr,
134 		    int size, raw_breakpoint *bp) override;
135 
136   int remove_point (enum raw_bkpt_type type, CORE_ADDR addr,
137 		    int size, raw_breakpoint *bp) override;
138 
139   bool supports_hardware_single_step () override;
140 
141   bool stopped_by_watchpoint () override;
142 
143   CORE_ADDR stopped_data_address () override;
144 
145   bool supports_qxfer_siginfo () override;
146 
147   int qxfer_siginfo (const char *annex, unsigned char *readbuf,
148 		     unsigned const char *writebuf,
149 		     CORE_ADDR offset, int len) override;
150 
151   bool supports_get_tib_address () override;
152 
153   int get_tib_address (ptid_t ptid, CORE_ADDR *addr) override;
154 
155   const gdb_byte *sw_breakpoint_from_kind (int kind, int *size) override;
156 
157   CORE_ADDR read_pc (regcache *regcache) override;
158 
159   void write_pc (regcache *regcache, CORE_ADDR pc) override;
160 
161   bool stopped_by_sw_breakpoint () override;
162 
163   bool supports_stopped_by_sw_breakpoint () override;
164 };
165 
166 /* Retrieve the context for this thread, if not already retrieved.  */
167 extern void win32_require_context (windows_nat::windows_thread_info *th);
168 
169 /* Map the Windows error number in ERROR to a locale-dependent error
170    message string and return a pointer to it.  Typically, the values
171    for ERROR come from GetLastError.
172 
173    The string pointed to shall not be modified by the application,
174    but may be overwritten by a subsequent call to strwinerror
175 
176    The strwinerror function does not change the current setting
177    of GetLastError.  */
178 extern char * strwinerror (DWORD error);
179 
180 #endif /* GDBSERVER_WIN32_LOW_H */
181