gdb/gdbserver/
[external/binutils.git] / gdb / gdbserver / server.h
1 /* Common definitions for remote server for GDB.
2    Copyright (C) 1993, 1995, 1997-2000, 2002-2012 Free Software
3    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 #ifndef SERVER_H
21 #define SERVER_H
22
23 #include "config.h"
24
25 #ifdef __MINGW32CE__
26 #include "wincecompat.h"
27 #endif
28
29 #include <stdarg.h>
30 #include <stdio.h>
31 #include <stdlib.h>
32 #ifdef HAVE_ERRNO_H
33 #include <errno.h>
34 #endif
35 #include <setjmp.h>
36
37 #ifdef HAVE_STRING_H
38 #include <string.h>
39 #endif
40
41 #ifdef HAVE_ALLOCA_H
42 #include <alloca.h>
43 #endif
44 /* On some systems such as MinGW, alloca is declared in malloc.h
45    (there is no alloca.h).  */
46 #if HAVE_MALLOC_H
47 #include <malloc.h>
48 #endif
49
50 #if !HAVE_DECL_STRERROR
51 #ifndef strerror
52 extern char *strerror (int);    /* X3.159-1989  4.11.6.2 */
53 #endif
54 #endif
55
56 #if !HAVE_DECL_PERROR
57 #ifndef perror
58 extern void perror (const char *);
59 #endif
60 #endif
61
62 #if !HAVE_DECL_VASPRINTF
63 extern int vasprintf(char **strp, const char *fmt, va_list ap);
64 #endif
65 #if !HAVE_DECL_VSNPRINTF
66 int vsnprintf(char *str, size_t size, const char *format, va_list ap);
67 #endif
68
69 #ifndef ATTR_NORETURN
70 #if defined(__GNUC__) && (__GNUC__ > 2 \
71                           || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
72 #define ATTR_NORETURN __attribute__ ((noreturn))
73 #else
74 #define ATTR_NORETURN           /* nothing */
75 #endif
76 #endif
77
78 #ifndef ATTR_FORMAT
79 #if defined(__GNUC__) && (__GNUC__ > 2 \
80                           || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
81 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
82 #else
83 #define ATTR_FORMAT(type, x, y) /* nothing */
84 #endif
85 #endif
86
87 #ifndef ATTR_MALLOC
88 #if defined(__GNUC__) && (__GNUC__ >= 3)
89 #define ATTR_MALLOC __attribute__ ((__malloc__))
90 #else
91 #define ATTR_MALLOC             /* nothing */
92 #endif
93 #endif
94
95 /* Define underscore macro, if not available, to be able to use it inside
96    code shared with gdb in common directory.  */
97 #ifndef _
98 #define _(String) (String)
99 #endif
100
101 #ifdef IN_PROCESS_AGENT
102 #  define PROG "ipa"
103 #else
104 #  define PROG "gdbserver"
105 #endif
106
107 /* A type used for binary buffers.  */
108 typedef unsigned char gdb_byte;
109
110 #include "ptid.h"
111 #include "buffer.h"
112 #include "xml-utils.h"
113 #include "gdb_locale.h"
114
115 /* FIXME: This should probably be autoconf'd for.  It's an integer type at
116    least the size of a (void *).  */
117 typedef long long CORE_ADDR;
118
119 typedef long long LONGEST;
120 typedef unsigned long long ULONGEST;
121
122 /* Generic information for tracking a list of ``inferiors'' - threads,
123    processes, etc.  */
124 struct inferior_list
125 {
126   struct inferior_list_entry *head;
127   struct inferior_list_entry *tail;
128 };
129 struct inferior_list_entry
130 {
131   ptid_t id;
132   struct inferior_list_entry *next;
133 };
134
135 struct thread_info;
136 struct process_info;
137 struct regcache;
138
139 #include "regcache.h"
140 #include "gdb/signals.h"
141 #include "gdb_signals.h"
142 #include "target.h"
143 #include "mem-break.h"
144 #include "gdbthread.h"
145
146 struct dll_info
147 {
148   struct inferior_list_entry entry;
149   char *name;
150   CORE_ADDR base_addr;
151 };
152
153 struct sym_cache;
154 struct breakpoint;
155 struct raw_breakpoint;
156 struct fast_tracepoint_jump;
157 struct process_info_private;
158
159 struct process_info
160 {
161   struct inferior_list_entry head;
162
163   /* Nonzero if this child process was attached rather than
164      spawned.  */
165   int attached;
166
167   /* True if GDB asked us to detach from this process, but we remained
168      attached anyway.  */
169   int gdb_detached;
170
171   /* The symbol cache.  */
172   struct sym_cache *symbol_cache;
173
174   /* The list of memory breakpoints.  */
175   struct breakpoint *breakpoints;
176
177   /* The list of raw memory breakpoints.  */
178   struct raw_breakpoint *raw_breakpoints;
179
180   /* The list of installed fast tracepoints.  */
181   struct fast_tracepoint_jump *fast_tracepoint_jumps;
182
183   /* Private target data.  */
184   struct process_info_private *private;
185 };
186
187 /* Return a pointer to the process that corresponds to the current
188    thread (current_inferior).  It is an error to call this if there is
189    no current thread selected.  */
190
191 struct process_info *current_process (void);
192 struct process_info *get_thread_process (struct thread_info *);
193
194 /* Target-specific functions */
195
196 void initialize_low ();
197
198 /* From inferiors.c.  */
199
200 extern struct inferior_list all_processes;
201 extern struct inferior_list all_dlls;
202 extern int dlls_changed;
203 extern void clear_dlls (void);
204
205 void add_inferior_to_list (struct inferior_list *list,
206                            struct inferior_list_entry *new_inferior);
207 void for_each_inferior (struct inferior_list *list,
208                         void (*action) (struct inferior_list_entry *));
209
210 extern struct thread_info *current_inferior;
211 void remove_inferior (struct inferior_list *list,
212                       struct inferior_list_entry *entry);
213
214 struct process_info *add_process (int pid, int attached);
215 void remove_process (struct process_info *process);
216 struct process_info *find_process_pid (int pid);
217 int have_started_inferiors_p (void);
218 int have_attached_inferiors_p (void);
219
220 ptid_t thread_id_to_gdb_id (ptid_t);
221 ptid_t thread_to_gdb_id (struct thread_info *);
222 ptid_t gdb_id_to_thread_id (ptid_t);
223
224 void clear_inferiors (void);
225 struct inferior_list_entry *find_inferior
226      (struct inferior_list *,
227       int (*func) (struct inferior_list_entry *,
228                    void *),
229       void *arg);
230 struct inferior_list_entry *find_inferior_id (struct inferior_list *list,
231                                               ptid_t id);
232 void *inferior_target_data (struct thread_info *);
233 void set_inferior_target_data (struct thread_info *, void *);
234 void *inferior_regcache_data (struct thread_info *);
235 void set_inferior_regcache_data (struct thread_info *, void *);
236
237 void loaded_dll (const char *name, CORE_ADDR base_addr);
238 void unloaded_dll (const char *name, CORE_ADDR base_addr);
239
240 /* Public variables in server.c */
241
242 extern ptid_t cont_thread;
243 extern ptid_t general_thread;
244
245 extern int server_waiting;
246 extern int debug_threads;
247 extern int debug_hw_points;
248 extern int pass_signals[];
249 extern int program_signals[];
250 extern int program_signals_p;
251
252 extern jmp_buf toplevel;
253
254 extern int disable_packet_vCont;
255 extern int disable_packet_Tthread;
256 extern int disable_packet_qC;
257 extern int disable_packet_qfThreadInfo;
258
259 extern int run_once;
260 extern int multi_process;
261 extern int non_stop;
262
263 extern int disable_randomization;
264
265 #if USE_WIN32API
266 #include <winsock2.h>
267 typedef SOCKET gdb_fildes_t;
268 #else
269 typedef int gdb_fildes_t;
270 #endif
271
272 /* Functions from event-loop.c.  */
273 typedef void *gdb_client_data;
274 typedef int (handler_func) (int, gdb_client_data);
275 typedef int (callback_handler_func) (gdb_client_data);
276
277 extern void delete_file_handler (gdb_fildes_t fd);
278 extern void add_file_handler (gdb_fildes_t fd, handler_func *proc,
279                               gdb_client_data client_data);
280 extern int append_callback_event (callback_handler_func *proc,
281                                    gdb_client_data client_data);
282 extern void delete_callback_event (int id);
283
284 extern void start_event_loop (void);
285
286 /* Functions from server.c.  */
287 extern int handle_serial_event (int err, gdb_client_data client_data);
288 extern int handle_target_event (int err, gdb_client_data client_data);
289
290 extern void push_event (ptid_t ptid, struct target_waitstatus *status);
291
292 /* Functions from hostio.c.  */
293 extern int handle_vFile (char *, int, int *);
294
295 /* Functions from hostio-errno.c.  */
296 extern void hostio_last_error_from_errno (char *own_buf);
297
298 /* From remote-utils.c */
299
300 extern int remote_debug;
301 extern int noack_mode;
302 extern int transport_is_reliable;
303
304 int gdb_connected (void);
305
306 #define STDIO_CONNECTION_NAME "stdio"
307 int remote_connection_is_stdio (void);
308
309 ptid_t read_ptid (char *buf, char **obuf);
310 char *write_ptid (char *buf, ptid_t ptid);
311
312 int putpkt (char *buf);
313 int putpkt_binary (char *buf, int len);
314 int putpkt_notif (char *buf);
315 int getpkt (char *buf);
316 void remote_prepare (char *name);
317 void remote_open (char *name);
318 void remote_close (void);
319 void write_ok (char *buf);
320 void write_enn (char *buf);
321 void initialize_async_io (void);
322 void enable_async_io (void);
323 void disable_async_io (void);
324 void check_remote_input_interrupt_request (void);
325 void convert_ascii_to_int (const char *from, unsigned char *to, int n);
326 void convert_int_to_ascii (const unsigned char *from, char *to, int n);
327 void new_thread_notify (int id);
328 void dead_thread_notify (int id);
329 void prepare_resume_reply (char *buf, ptid_t ptid,
330                            struct target_waitstatus *status);
331
332 const char *decode_address_to_semicolon (CORE_ADDR *addrp, const char *start);
333 void decode_address (CORE_ADDR *addrp, const char *start, int len);
334 void decode_m_packet (char *from, CORE_ADDR * mem_addr_ptr,
335                       unsigned int *len_ptr);
336 void decode_M_packet (char *from, CORE_ADDR * mem_addr_ptr,
337                       unsigned int *len_ptr, unsigned char **to_p);
338 int decode_X_packet (char *from, int packet_len, CORE_ADDR * mem_addr_ptr,
339                      unsigned int *len_ptr, unsigned char **to_p);
340 int decode_xfer_write (char *buf, int packet_len,
341                        CORE_ADDR *offset, unsigned int *len,
342                        unsigned char *data);
343 int decode_search_memory_packet (const char *buf, int packet_len,
344                                  CORE_ADDR *start_addrp,
345                                  CORE_ADDR *search_space_lenp,
346                                  gdb_byte *pattern,
347                                  unsigned int *pattern_lenp);
348
349 int unhexify (char *bin, const char *hex, int count);
350 int hexify (char *hex, const char *bin, int count);
351 int remote_escape_output (const gdb_byte *buffer, int len,
352                           gdb_byte *out_buf, int *out_len,
353                           int out_maxlen);
354 char *unpack_varlen_hex (char *buff,  ULONGEST *result);
355
356 void clear_symbol_cache (struct sym_cache **symcache_p);
357 int look_up_one_symbol (const char *name, CORE_ADDR *addrp, int may_ask_gdb);
358
359 int relocate_instruction (CORE_ADDR *to, CORE_ADDR oldloc);
360
361 void monitor_output (const char *msg);
362
363 /* Functions from utils.c */
364 #include "common-utils.h"
365
366 void *xmalloc (size_t) ATTR_MALLOC;
367 void *xrealloc (void *, size_t);
368 void *xcalloc (size_t, size_t) ATTR_MALLOC;
369 char *xstrdup (const char *) ATTR_MALLOC;
370 int xsnprintf (char *str, size_t size, const char *format, ...)
371   ATTR_FORMAT (printf, 3, 4);;
372 void freeargv (char **argv);
373 void perror_with_name (const char *string);
374 void error (const char *string,...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
375 void fatal (const char *string,...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
376 void warning (const char *string,...) ATTR_FORMAT (printf, 1, 2);
377 char *paddress (CORE_ADDR addr);
378 char *pulongest (ULONGEST u);
379 char *plongest (LONGEST l);
380 char *phex_nz (ULONGEST l, int sizeof_l);
381 char *pfildes (gdb_fildes_t fd);
382
383 #include "gdb_assert.h"
384
385 /* Maximum number of bytes to read/write at once.  The value here
386    is chosen to fill up a packet (the headers account for the 32).  */
387 #define MAXBUFBYTES(N) (((N)-32)/2)
388
389 /* Buffer sizes for transferring memory, registers, etc.   Set to a constant
390    value to accomodate multiple register formats.  This value must be at least
391    as large as the largest register set supported by gdbserver.  */
392 #define PBUFSIZ 16384
393
394 /* Functions from tracepoint.c */
395
396 /* Size for a small buffer to report problems from the in-process
397    agent back to GDBserver.  */
398 #define IPA_BUFSIZ 100
399
400 void initialize_tracepoint (void);
401
402 extern int tracing;
403 extern int disconnected_tracing;
404
405 void tracepoint_look_up_symbols (void);
406
407 void stop_tracing (void);
408
409 int handle_tracepoint_general_set (char *own_buf);
410 int handle_tracepoint_query (char *own_buf);
411
412 int tracepoint_finished_step (struct thread_info *tinfo, CORE_ADDR stop_pc);
413 int tracepoint_was_hit (struct thread_info *tinfo, CORE_ADDR stop_pc);
414
415 void release_while_stepping_state_list (struct thread_info *tinfo);
416
417 extern int current_traceframe;
418
419 int in_readonly_region (CORE_ADDR addr, ULONGEST length);
420 int traceframe_read_mem (int tfnum, CORE_ADDR addr,
421                          unsigned char *buf, ULONGEST length,
422                          ULONGEST *nbytes);
423 int fetch_traceframe_registers (int tfnum,
424                                 struct regcache *regcache,
425                                 int regnum);
426
427 int traceframe_read_sdata (int tfnum, ULONGEST offset,
428                            unsigned char *buf, ULONGEST length,
429                            ULONGEST *nbytes);
430
431 int traceframe_read_info (int tfnum, struct buffer *buffer);
432
433 /* If a thread is determined to be collecting a fast tracepoint, this
434    structure holds the collect status.  */
435
436 struct fast_tpoint_collect_status
437 {
438   /* The tracepoint that is presently being collected.  */
439   int tpoint_num;
440   CORE_ADDR tpoint_addr;
441
442   /* The address range in the jump pad of where the original
443      instruction the tracepoint jump was inserted was relocated
444      to.  */
445   CORE_ADDR adjusted_insn_addr;
446   CORE_ADDR adjusted_insn_addr_end;
447 };
448
449 int fast_tracepoint_collecting (CORE_ADDR thread_area,
450                                 CORE_ADDR stop_pc,
451                                 struct fast_tpoint_collect_status *status);
452 void force_unlock_trace_buffer (void);
453
454 int handle_tracepoint_bkpts (struct thread_info *tinfo, CORE_ADDR stop_pc);
455
456 #ifdef IN_PROCESS_AGENT
457 void initialize_low_tracepoint (void);
458 void supply_fast_tracepoint_registers (struct regcache *regcache,
459                                        const unsigned char *regs);
460 void supply_static_tracepoint_registers (struct regcache *regcache,
461                                          const unsigned char *regs,
462                                          CORE_ADDR pc);
463 void set_trampoline_buffer_space (CORE_ADDR begin, CORE_ADDR end,
464                                   char *errmsg);
465 #else
466 void stop_tracing (void);
467
468 int claim_trampoline_space (ULONGEST used, CORE_ADDR *trampoline);
469 int have_fast_tracepoint_trampoline_buffer (char *msgbuf);
470 void gdb_agent_about_to_close (int pid);
471 #endif
472
473 struct traceframe;
474
475 /* Do memory copies for bytecodes.  */
476 /* Do the recording of memory blocks for actions and bytecodes.  */
477
478 int agent_mem_read (struct traceframe *tframe,
479                     unsigned char *to, CORE_ADDR from,
480                     ULONGEST len);
481
482 LONGEST agent_get_trace_state_variable_value (int num);
483 void agent_set_trace_state_variable_value (int num, LONGEST val);
484
485 /* Record the value of a trace state variable.  */
486
487 int agent_tsv_read (struct traceframe *tframe, int n);
488 int agent_mem_read_string (struct traceframe *tframe,
489                            unsigned char *to,
490                            CORE_ADDR from,
491                            ULONGEST len);
492
493 /* Bytecode compilation function vector.  */
494
495 struct emit_ops
496 {
497   void (*emit_prologue) (void);
498   void (*emit_epilogue) (void);
499   void (*emit_add) (void);
500   void (*emit_sub) (void);
501   void (*emit_mul) (void);
502   void (*emit_lsh) (void);
503   void (*emit_rsh_signed) (void);
504   void (*emit_rsh_unsigned) (void);
505   void (*emit_ext) (int arg);
506   void (*emit_log_not) (void);
507   void (*emit_bit_and) (void);
508   void (*emit_bit_or) (void);
509   void (*emit_bit_xor) (void);
510   void (*emit_bit_not) (void);
511   void (*emit_equal) (void);
512   void (*emit_less_signed) (void);
513   void (*emit_less_unsigned) (void);
514   void (*emit_ref) (int size);
515   void (*emit_if_goto) (int *offset_p, int *size_p);
516   void (*emit_goto) (int *offset_p, int *size_p);
517   void (*write_goto_address) (CORE_ADDR from, CORE_ADDR to, int size);
518   void (*emit_const) (LONGEST num);
519   void (*emit_call) (CORE_ADDR fn);
520   void (*emit_reg) (int reg);
521   void (*emit_pop) (void);
522   void (*emit_stack_flush) (void);
523   void (*emit_zero_ext) (int arg);
524   void (*emit_swap) (void);
525   void (*emit_stack_adjust) (int n);
526
527   /* Emit code for a generic function that takes one fixed integer
528      argument and returns a 64-bit int (for instance, tsv getter).  */
529   void (*emit_int_call_1) (CORE_ADDR fn, int arg1);
530
531   /* Emit code for a generic function that takes one fixed integer
532      argument and a 64-bit int from the top of the stack, and returns
533      nothing (for instance, tsv setter).  */
534   void (*emit_void_call_2) (CORE_ADDR fn, int arg1);
535
536   /* Emit code specialized for common combinations of compare followed
537      by a goto.  */
538   void (*emit_eq_goto) (int *offset_p, int *size_p);
539   void (*emit_ne_goto) (int *offset_p, int *size_p);
540   void (*emit_lt_goto) (int *offset_p, int *size_p);
541   void (*emit_le_goto) (int *offset_p, int *size_p);
542   void (*emit_gt_goto) (int *offset_p, int *size_p);
543   void (*emit_ge_goto) (int *offset_p, int *size_p);
544 };
545
546 /* Returns the address of the get_raw_reg function in the IPA.  */
547 CORE_ADDR get_raw_reg_func_addr (void);
548 /* Returns the address of the get_trace_state_variable_value
549    function in the IPA.  */
550 CORE_ADDR get_get_tsv_func_addr (void);
551 /* Returns the address of the set_trace_state_variable_value
552    function in the IPA.  */
553 CORE_ADDR get_set_tsv_func_addr (void);
554
555 CORE_ADDR current_insn_ptr;
556 int emit_error;
557
558 /* Version information, from version.c.  */
559 extern const char version[];
560 extern const char host_name[];
561
562 #endif /* SERVER_H */