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