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 #include <stdarg.h>
  28 #include <stdio.h>
  29 #include <stdlib.h>
  30 #include <errno.h>
  31 #include <setjmp.h>
  32
  33 #ifdef HAVE_STRING_H
  34 #include <string.h>
  35 #endif
  36
  37 #if !HAVE_DECL_STRERROR
  38 #ifndef strerror
  39 extern char *strerror (int);    /* X3.159-1989  4.11.6.2 */
  40 #endif
  41 #endif
  42
  43 #ifndef ATTR_NORETURN
  44 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
  45 #define ATTR_NORETURN __attribute__ ((noreturn))
  46 #else
  47 #define ATTR_NORETURN           /* nothing */
  48 #endif
  49 #endif
  50
  51 #ifndef ATTR_FORMAT
  52 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
  53 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
  54 #else
  55 #define ATTR_FORMAT(type, x, y) /* nothing */
  56 #endif
  57 #endif
  58
  59 /* A type used for binary buffers.  */
  60 typedef unsigned char gdb_byte;
  61
  62 /* FIXME: This should probably be autoconf'd for.  It's an integer type at
  63    least the size of a (void *).  */
  64 typedef long long CORE_ADDR;
  65
  66 /* Generic information for tracking a list of ``inferiors'' - threads,
  67    processes, etc.  */
  68 struct inferior_list
  69 {
  70   struct inferior_list_entry *head;
  71   struct inferior_list_entry *tail;
  72 };
  73 struct inferior_list_entry
  74 {
  75   unsigned long id;
  76   struct inferior_list_entry *next;
  77 };
  78
  79 /* Opaque type for user-visible threads.  */
  80 struct thread_info;
  81
  82 #include "regcache.h"
  83 #include "gdb/signals.h"
  84
  85 #include "target.h"
  86 #include "mem-break.h"
  87
  88 /* Target-specific functions */
  89
  90 void initialize_low ();
  91
  92 /* From inferiors.c.  */
  93
  94 extern struct inferior_list all_threads;
  95 void add_inferior_to_list (struct inferior_list *list,
  96                            struct inferior_list_entry *new_inferior);
  97 void for_each_inferior (struct inferior_list *list,
  98                         void (*action) (struct inferior_list_entry *));
  99 extern struct thread_info *current_inferior;
 100 void remove_inferior (struct inferior_list *list,
 101                       struct inferior_list_entry *entry);
 102 void remove_thread (struct thread_info *thread);
 103 void add_thread (unsigned long thread_id, void *target_data, unsigned int);
 104 unsigned int thread_id_to_gdb_id (unsigned long);
 105 unsigned int thread_to_gdb_id (struct thread_info *);
 106 unsigned long gdb_id_to_thread_id (unsigned int);
 107 struct thread_info *gdb_id_to_thread (unsigned int);
 108 void clear_inferiors (void);
 109 struct inferior_list_entry *find_inferior
 110      (struct inferior_list *,
 111       int (*func) (struct inferior_list_entry *,
 112                    void *),
 113       void *arg);
 114 struct inferior_list_entry *find_inferior_id (struct inferior_list *list,
 115                                               unsigned long id);
 116 void *inferior_target_data (struct thread_info *);
 117 void set_inferior_target_data (struct thread_info *, void *);
 118 void *inferior_regcache_data (struct thread_info *);
 119 void set_inferior_regcache_data (struct thread_info *, void *);
 120 void change_inferior_id (struct inferior_list *list,
 121                          unsigned long new_id);
 122
 123 /* Public variables in server.c */
 124
 125 extern unsigned long cont_thread;
 126 extern unsigned long general_thread;
 127 extern unsigned long step_thread;
 128 extern unsigned long thread_from_wait;
 129 extern unsigned long old_thread_from_wait;
 130 extern int server_waiting;
 131 extern int pass_signals[];
 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 const char *decode_address_to_semicolon (CORE_ADDR *addrp, const char *start);
 157 void decode_address (CORE_ADDR *addrp, const char *start, int len);
 158 void decode_m_packet (char *from, CORE_ADDR * mem_addr_ptr,
 159                       unsigned int *len_ptr);
 160 void decode_M_packet (char *from, CORE_ADDR * mem_addr_ptr,
 161                       unsigned int *len_ptr, unsigned char *to);
 162 int decode_X_packet (char *from, int packet_len, CORE_ADDR * mem_addr_ptr,
 163                      unsigned int *len_ptr, unsigned char *to);
 164
 165 int unhexify (char *bin, const char *hex, int count);
 166 int hexify (char *hex, const char *bin, int count);
 167 int remote_escape_output (const gdb_byte *buffer, int len,
 168                           gdb_byte *out_buf, int *out_len,
 169                           int out_maxlen);
 170
 171 int look_up_one_symbol (const char *name, CORE_ADDR *addrp);
 172
 173 /* Functions from ``signals.c''.  */
 174 enum target_signal target_signal_from_host (int hostsig);
 175 int target_signal_to_host_p (enum target_signal oursig);
 176 int target_signal_to_host (enum target_signal oursig);
 177 char *target_signal_to_name (enum target_signal);
 178
 179 /* Functions from utils.c */
 180
 181 void perror_with_name (char *string);
 182 void error (const char *string,...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
 183 void fatal (const char *string,...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
 184 void warning (const char *string,...) ATTR_FORMAT (printf, 1, 2);
 185
 186 /* Functions from the register cache definition.  */
 187
 188 void init_registers (void);
 189
 190 /* Maximum number of bytes to read/write at once.  The value here
 191    is chosen to fill up a packet (the headers account for the 32).  */
 192 #define MAXBUFBYTES(N) (((N)-32)/2)
 193
 194 /* Buffer sizes for transferring memory, registers, etc.  Round up PBUFSIZ to
 195    hold all the registers, at least.  */
 196 #define PBUFSIZ ((registers_length () + 32 > 2000) \
 197                  ? (registers_length () + 32) \
 198                  : 2000)
 199
 200 /* Version information, from version.c.  */
 201 extern const char version[];
 202 extern const char host_name[];
 203
 204 #endif /* SERVER_H */