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