gdb/gdbserver/server.h

   1 /* Common definitions for remote server for GDB.
   2    Copyright (C) 1993, 1995, 1997, 1998, 1999, 2000, 2002, 2003, 2004, 2005,
   3    2006, 2007, 2008 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 #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 #if !HAVE_DECL_STRERROR
  42 #ifndef strerror
  43 extern char *strerror (int);    /* X3.159-1989  4.11.6.2 */
  44 #endif
  45 #endif
  46
  47 #if !HAVE_DECL_PERROR
  48 #ifndef perror
  49 extern void perror (const char *);
  50 #endif
  51 #endif
  52
  53 #ifndef ATTR_NORETURN
  54 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
  55 #define ATTR_NORETURN __attribute__ ((noreturn))
  56 #else
  57 #define ATTR_NORETURN           /* nothing */
  58 #endif
  59 #endif
  60
  61 #ifndef ATTR_FORMAT
  62 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
  63 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
  64 #else
  65 #define ATTR_FORMAT(type, x, y) /* nothing */
  66 #endif
  67 #endif
  68
  69 /* A type used for binary buffers.  */
  70 typedef unsigned char gdb_byte;
  71
  72 /* FIXME: This should probably be autoconf'd for.  It's an integer type at
  73    least the size of a (void *).  */
  74 typedef long long CORE_ADDR;
  75
  76 /* Generic information for tracking a list of ``inferiors'' - threads,
  77    processes, etc.  */
  78 struct inferior_list
  79 {
  80   struct inferior_list_entry *head;
  81   struct inferior_list_entry *tail;
  82 };
  83 struct inferior_list_entry
  84 {
  85   unsigned long id;
  86   struct inferior_list_entry *next;
  87 };
  88
  89 /* Opaque type for user-visible threads.  */
  90 struct thread_info;
  91
  92 struct dll_info
  93 {
  94   struct inferior_list_entry entry;
  95   char *name;
  96   CORE_ADDR base_addr;
  97 };
  98
  99 #include "regcache.h"
 100 #include "gdb/signals.h"
 101
 102 #include "target.h"
 103 #include "mem-break.h"
 104
 105 /* Target-specific functions */
 106
 107 void initialize_low ();
 108
 109 /* From inferiors.c.  */
 110
 111 extern struct inferior_list all_threads;
 112 extern struct inferior_list all_dlls;
 113 extern int dlls_changed;
 114
 115 void add_inferior_to_list (struct inferior_list *list,
 116                            struct inferior_list_entry *new_inferior);
 117 void for_each_inferior (struct inferior_list *list,
 118                         void (*action) (struct inferior_list_entry *));
 119 extern struct thread_info *current_inferior;
 120 void remove_inferior (struct inferior_list *list,
 121                       struct inferior_list_entry *entry);
 122 void remove_thread (struct thread_info *thread);
 123 void add_thread (unsigned long thread_id, void *target_data, unsigned int);
 124 unsigned int thread_id_to_gdb_id (unsigned long);
 125 unsigned int thread_to_gdb_id (struct thread_info *);
 126 unsigned long gdb_id_to_thread_id (unsigned int);
 127 struct thread_info *gdb_id_to_thread (unsigned int);
 128 void clear_inferiors (void);
 129 struct inferior_list_entry *find_inferior
 130      (struct inferior_list *,
 131       int (*func) (struct inferior_list_entry *,
 132                    void *),
 133       void *arg);
 134 struct inferior_list_entry *find_inferior_id (struct inferior_list *list,
 135                                               unsigned long id);
 136 void *inferior_target_data (struct thread_info *);
 137 void set_inferior_target_data (struct thread_info *, void *);
 138 void *inferior_regcache_data (struct thread_info *);
 139 void set_inferior_regcache_data (struct thread_info *, void *);
 140 void add_pid_to_list (struct inferior_list *list, unsigned long pid);
 141 int pull_pid_from_list (struct inferior_list *list, unsigned long pid);
 142
 143 void loaded_dll (const char *name, CORE_ADDR base_addr);
 144 void unloaded_dll (const char *name, CORE_ADDR base_addr);
 145
 146 /* Public variables in server.c */
 147
 148 extern unsigned long cont_thread;
 149 extern unsigned long general_thread;
 150 extern unsigned long step_thread;
 151 extern unsigned long thread_from_wait;
 152 extern unsigned long old_thread_from_wait;
 153 extern int server_waiting;
 154 extern int debug_threads;
 155 extern int pass_signals[];
 156
 157 extern jmp_buf toplevel;
 158
 159 /* Functions from hostio.c.  */
 160 extern int handle_vFile (char *, int, int *);
 161
 162 /* Functions from hostio-errno.c.  */
 163 extern void hostio_last_error_from_errno (char *own_buf);
 164
 165 /* From remote-utils.c */
 166
 167 extern int remote_debug;
 168 extern int all_symbols_looked_up;
 169
 170 int putpkt (char *buf);
 171 int putpkt_binary (char *buf, int len);
 172 int getpkt (char *buf);
 173 void remote_open (char *name);
 174 void remote_close (void);
 175 void write_ok (char *buf);
 176 void write_enn (char *buf);
 177 void initialize_async_io (void);
 178 void enable_async_io (void);
 179 void disable_async_io (void);
 180 void check_remote_input_interrupt_request (void);
 181 void convert_ascii_to_int (char *from, unsigned char *to, int n);
 182 void convert_int_to_ascii (unsigned char *from, char *to, int n);
 183 void new_thread_notify (int id);
 184 void dead_thread_notify (int id);
 185 void prepare_resume_reply (char *buf, char status, unsigned char sig);
 186
 187 const char *decode_address_to_semicolon (CORE_ADDR *addrp, const char *start);
 188 void decode_address (CORE_ADDR *addrp, const char *start, int len);
 189 void decode_m_packet (char *from, CORE_ADDR * mem_addr_ptr,
 190                       unsigned int *len_ptr);
 191 void decode_M_packet (char *from, CORE_ADDR * mem_addr_ptr,
 192                       unsigned int *len_ptr, unsigned char *to);
 193 int decode_X_packet (char *from, int packet_len, CORE_ADDR * mem_addr_ptr,
 194                      unsigned int *len_ptr, unsigned char *to);
 195 int decode_xfer_write (char *buf, int packet_len, char **annex,
 196                        CORE_ADDR *offset, unsigned int *len,
 197                        unsigned char *data);
 198
 199 int unhexify (char *bin, const char *hex, int count);
 200 int hexify (char *hex, const char *bin, int count);
 201 int remote_escape_output (const gdb_byte *buffer, int len,
 202                           gdb_byte *out_buf, int *out_len,
 203                           int out_maxlen);
 204
 205 int look_up_one_symbol (const char *name, CORE_ADDR *addrp);
 206
 207 void monitor_output (const char *msg);
 208
 209 char *xml_escape_text (const char *text);
 210
 211 /* Functions from ``signals.c''.  */
 212 enum target_signal target_signal_from_host (int hostsig);
 213 int target_signal_to_host_p (enum target_signal oursig);
 214 int target_signal_to_host (enum target_signal oursig);
 215 char *target_signal_to_name (enum target_signal);
 216
 217 /* Functions from utils.c */
 218
 219 void perror_with_name (char *string);
 220 void error (const char *string,...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
 221 void fatal (const char *string,...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
 222 void warning (const char *string,...) ATTR_FORMAT (printf, 1, 2);
 223
 224 /* Functions from the register cache definition.  */
 225
 226 void init_registers (void);
 227
 228 /* Maximum number of bytes to read/write at once.  The value here
 229    is chosen to fill up a packet (the headers account for the 32).  */
 230 #define MAXBUFBYTES(N) (((N)-32)/2)
 231
 232 /* Buffer sizes for transferring memory, registers, etc.  Round up PBUFSIZ to
 233    hold all the registers, at least.  */
 234 #define PBUFSIZ ((registers_length () + 32 > 2000) \
 235                  ? (registers_length () + 32) \
 236                  : 2000)
 237
 238 /* Version information, from version.c.  */
 239 extern const char version[];
 240 extern const char host_name[];
 241
 242 #endif /* SERVER_H */