2011-11-14 Stan Shebs <stan@codesourcery.com>
[external/binutils.git] / gdb / gdbserver / linux-low.h
1 /* Internal interfaces for the GNU/Linux specific target code for gdbserver.
2    Copyright (C) 2002, 2004, 2005, 2007, 2008, 2009, 2010, 2011
3    Free Software Foundation, Inc.
4
5    This file is part of GDB.
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
19
20 #ifdef HAVE_THREAD_DB_H
21 #include <thread_db.h>
22 #endif
23
24 #include "gdb_proc_service.h"
25
26 #ifdef HAVE_LINUX_REGSETS
27 typedef void (*regset_fill_func) (struct regcache *, void *);
28 typedef void (*regset_store_func) (struct regcache *, const void *);
29 enum regset_type {
30   GENERAL_REGS,
31   FP_REGS,
32   EXTENDED_REGS,
33 };
34
35 struct regset_info
36 {
37   int get_request, set_request;
38   /* If NT_TYPE isn't 0, it will be passed to ptrace as the 3rd
39      argument and the 4th argument should be "const struct iovec *".  */
40   int nt_type;
41   int size;
42   enum regset_type type;
43   regset_fill_func fill_function;
44   regset_store_func store_function;
45 };
46 extern struct regset_info target_regsets[];
47 #endif
48
49 struct siginfo;
50
51 struct process_info_private
52 {
53   /* Arch-specific additions.  */
54   struct arch_process_info *arch_private;
55
56   /* libthread_db-specific additions.  Not NULL if this process has loaded
57      thread_db, and it is active.  */
58   struct thread_db *thread_db;
59 };
60
61 struct lwp_info;
62
63 struct linux_target_ops
64 {
65   /* Architecture-specific setup.  */
66   void (*arch_setup) (void);
67
68   int num_regs;
69   int *regmap;
70   int (*cannot_fetch_register) (int);
71
72   /* Returns 0 if we can store the register, 1 if we can not
73      store the register, and 2 if failure to store the register
74      is acceptable.  */
75   int (*cannot_store_register) (int);
76   CORE_ADDR (*get_pc) (struct regcache *regcache);
77   void (*set_pc) (struct regcache *regcache, CORE_ADDR newpc);
78   const unsigned char *breakpoint;
79   int breakpoint_len;
80   CORE_ADDR (*breakpoint_reinsert_addr) (void);
81
82   int decr_pc_after_break;
83   int (*breakpoint_at) (CORE_ADDR pc);
84
85   /* Breakpoint and watchpoint related functions.  See target.h for
86      comments.  */
87   int (*insert_point) (char type, CORE_ADDR addr, int len);
88   int (*remove_point) (char type, CORE_ADDR addr, int len);
89   int (*stopped_by_watchpoint) (void);
90   CORE_ADDR (*stopped_data_address) (void);
91
92   /* Hooks to reformat register data for PEEKUSR/POKEUSR (in particular
93      for registers smaller than an xfer unit).  */
94   void (*collect_ptrace_register) (struct regcache *regcache,
95                                    int regno, char *buf);
96   void (*supply_ptrace_register) (struct regcache *regcache,
97                                   int regno, const char *buf);
98
99   /* Hook to convert from target format to ptrace format and back.
100      Returns true if any conversion was done; false otherwise.
101      If DIRECTION is 1, then copy from INF to NATIVE.
102      If DIRECTION is 0, copy from NATIVE to INF.  */
103   int (*siginfo_fixup) (struct siginfo *native, void *inf, int direction);
104
105   /* Hook to call when a new process is created or attached to.
106      If extra per-process architecture-specific data is needed,
107      allocate it here.  */
108   struct arch_process_info * (*new_process) (void);
109
110   /* Hook to call when a new thread is detected.
111      If extra per-thread architecture-specific data is needed,
112      allocate it here.  */
113   struct arch_lwp_info * (*new_thread) (void);
114
115   /* Hook to call prior to resuming a thread.  */
116   void (*prepare_to_resume) (struct lwp_info *);
117
118   /* Hook to support target specific qSupported.  */
119   void (*process_qsupported) (const char *);
120
121   /* Returns true if the low target supports tracepoints.  */
122   int (*supports_tracepoints) (void);
123
124   /* Fill ADDRP with the thread area address of LWPID.  Returns 0 on
125      success, -1 on failure.  */
126   int (*get_thread_area) (int lwpid, CORE_ADDR *addrp);
127
128   /* Install a fast tracepoint jump pad.  See target.h for
129      comments.  */
130   int (*install_fast_tracepoint_jump_pad) (CORE_ADDR tpoint, CORE_ADDR tpaddr,
131                                            CORE_ADDR collector,
132                                            CORE_ADDR lockaddr,
133                                            ULONGEST orig_size,
134                                            CORE_ADDR *jump_entry,
135                                            CORE_ADDR *trampoline,
136                                            ULONGEST *trampoline_size,
137                                            unsigned char *jjump_pad_insn,
138                                            ULONGEST *jjump_pad_insn_size,
139                                            CORE_ADDR *adjusted_insn_addr,
140                                            CORE_ADDR *adjusted_insn_addr_end,
141                                            char *err);
142
143   /* Return the bytecode operations vector for the current inferior.
144      Returns NULL if bytecode compilation is not supported.  */
145   struct emit_ops *(*emit_ops) (void);
146
147   /* Return the minimum length of an instruction that can be safely overwritten
148      for use as a fast tracepoint.  */
149   int (*get_min_fast_tracepoint_insn_len) (void);
150
151 };
152
153 extern struct linux_target_ops the_low_target;
154
155 #define ptid_of(proc) ((proc)->head.id)
156 #define pid_of(proc) ptid_get_pid ((proc)->head.id)
157 #define lwpid_of(proc) ptid_get_lwp ((proc)->head.id)
158
159 #define get_lwp(inf) ((struct lwp_info *)(inf))
160 #define get_thread_lwp(thr) (get_lwp (inferior_target_data (thr)))
161 #define get_lwp_thread(proc) ((struct thread_info *)                    \
162                               find_inferior_id (&all_threads,           \
163                                                 get_lwp (proc)->head.id))
164
165 struct lwp_info
166 {
167   struct inferior_list_entry head;
168
169   /* If this flag is set, the next SIGSTOP will be ignored (the
170      process will be immediately resumed).  This means that either we
171      sent the SIGSTOP to it ourselves and got some other pending event
172      (so the SIGSTOP is still pending), or that we stopped the
173      inferior implicitly via PTRACE_ATTACH and have not waited for it
174      yet.  */
175   int stop_expected;
176
177   /* When this is true, we shall not try to resume this thread, even
178      if last_resume_kind isn't resume_stop.  */
179   int suspended;
180
181   /* If this flag is set, the lwp is known to be stopped right now (stop
182      event already received in a wait()).  */
183   int stopped;
184
185   /* If this flag is set, the lwp is known to be dead already (exit
186      event already received in a wait(), and is cached in
187      status_pending).  */
188   int dead;
189
190   /* When stopped is set, the last wait status recorded for this lwp.  */
191   int last_status;
192
193   /* When stopped is set, this is where the lwp stopped, with
194      decr_pc_after_break already accounted for.  */
195   CORE_ADDR stop_pc;
196
197   /* If this flag is set, STATUS_PENDING is a waitstatus that has not yet
198      been reported.  */
199   int status_pending_p;
200   int status_pending;
201
202   /* STOPPED_BY_WATCHPOINT is non-zero if this LWP stopped with a data
203      watchpoint trap.  */
204   int stopped_by_watchpoint;
205
206   /* On architectures where it is possible to know the data address of
207      a triggered watchpoint, STOPPED_DATA_ADDRESS is non-zero, and
208      contains such data address.  Only valid if STOPPED_BY_WATCHPOINT
209      is true.  */
210   CORE_ADDR stopped_data_address;
211
212   /* If this is non-zero, it is a breakpoint to be reinserted at our next
213      stop (SIGTRAP stops only).  */
214   CORE_ADDR bp_reinsert;
215
216   /* If this flag is set, the last continue operation at the ptrace
217      level on this process was a single-step.  */
218   int stepping;
219
220   /* If this flag is set, we need to set the event request flags the
221      next time we see this LWP stop.  */
222   int must_set_ptrace_flags;
223
224   /* If this is non-zero, it points to a chain of signals which need to
225      be delivered to this process.  */
226   struct pending_signals *pending_signals;
227
228   /* A link used when resuming.  It is initialized from the resume request,
229      and then processed and cleared in linux_resume_one_lwp.  */
230   struct thread_resume *resume;
231
232   /* True if it is known that this lwp is presently collecting a fast
233      tracepoint (it is in the jump pad or in some code that will
234      return to the jump pad.  Normally, we won't care about this, but
235      we will if a signal arrives to this lwp while it is
236      collecting.  */
237   int collecting_fast_tracepoint;
238
239   /* If this is non-zero, it points to a chain of signals which need
240      to be reported to GDB.  These were deferred because the thread
241      was doing a fast tracepoint collect when they arrived.  */
242   struct pending_signals *pending_signals_to_report;
243
244   /* When collecting_fast_tracepoint is first found to be 1, we insert
245      a exit-jump-pad-quickly breakpoint.  This is it.  */
246   struct breakpoint *exit_jump_pad_bkpt;
247
248   /* True if the LWP was seen stop at an internal breakpoint and needs
249      stepping over later when it is resumed.  */
250   int need_step_over;
251
252   int thread_known;
253 #ifdef HAVE_THREAD_DB_H
254   /* The thread handle, used for e.g. TLS access.  Only valid if
255      THREAD_KNOWN is set.  */
256   td_thrhandle_t th;
257 #endif
258
259   /* Arch-specific additions.  */
260   struct arch_lwp_info *arch_private;
261 };
262
263 extern struct inferior_list all_lwps;
264
265 char *linux_child_pid_to_exec_file (int pid);
266 int elf_64_file_p (const char *file);
267
268 void linux_attach_lwp (unsigned long pid);
269 struct lwp_info *find_lwp_pid (ptid_t ptid);
270 void linux_stop_lwp (struct lwp_info *lwp);
271
272 /* From thread-db.c  */
273 int thread_db_init (int use_events);
274 void thread_db_detach (struct process_info *);
275 void thread_db_mourn (struct process_info *);
276 int thread_db_handle_monitor_command (char *);
277 int thread_db_get_tls_address (struct thread_info *thread, CORE_ADDR offset,
278                                CORE_ADDR load_module, CORE_ADDR *address);
279 int thread_db_look_up_one_symbol (const char *name, CORE_ADDR *addrp);