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 /* FIXME: This should probably be autoconf'd for.  It's an integer type at
  61    least the size of a (void *).  */
  62 typedef long long CORE_ADDR;
  63
  64 /* Generic information for tracking a list of ``inferiors'' - threads,
  65    processes, etc.  */
  66 struct inferior_list
  67 {
  68   struct inferior_list_entry *head;
  69   struct inferior_list_entry *tail;
  70 };
  71 struct inferior_list_entry
  72 {
  73   unsigned long id;
  74   struct inferior_list_entry *next;
  75 };
  76
  77 /* Opaque type for user-visible threads.  */
  78 struct thread_info;
  79
  80 #include "regcache.h"
  81 #include "gdb/signals.h"
  82
  83 #include "target.h"
  84 #include "mem-break.h"
  85
  86 /* Target-specific functions */
  87
  88 void initialize_low ();
  89
  90 /* From inferiors.c.  */
  91
  92 extern struct inferior_list all_threads;
  93 void add_inferior_to_list (struct inferior_list *list,
  94                            struct inferior_list_entry *new_inferior);
  95 void for_each_inferior (struct inferior_list *list,
  96                         void (*action) (struct inferior_list_entry *));
  97 extern struct thread_info *current_inferior;
  98 void remove_inferior (struct inferior_list *list,
  99                       struct inferior_list_entry *entry);
 100 void remove_thread (struct thread_info *thread);
 101 void add_thread (unsigned long thread_id, void *target_data, unsigned int);
 102 unsigned int thread_id_to_gdb_id (unsigned long);
 103 unsigned int thread_to_gdb_id (struct thread_info *);
 104 unsigned long gdb_id_to_thread_id (unsigned int);
 105 void clear_inferiors (void);
 106 struct inferior_list_entry *find_inferior
 107      (struct inferior_list *,
 108       int (*func) (struct inferior_list_entry *,
 109                    void *),
 110       void *arg);
 111 struct inferior_list_entry *find_inferior_id (struct inferior_list *list,
 112                                               unsigned long id);
 113 void *inferior_target_data (struct thread_info *);
 114 void set_inferior_target_data (struct thread_info *, void *);
 115 void *inferior_regcache_data (struct thread_info *);
 116 void set_inferior_regcache_data (struct thread_info *, void *);
 117 void change_inferior_id (struct inferior_list *list,
 118                          unsigned long new_id);
 119
 120 /* Public variables in server.c */
 121
 122 extern unsigned long cont_thread;
 123 extern unsigned long general_thread;
 124 extern unsigned long step_thread;
 125 extern unsigned long thread_from_wait;
 126 extern unsigned long old_thread_from_wait;
 127 extern int server_waiting;
 128
 129 extern jmp_buf toplevel;
 130
 131 /* From remote-utils.c */
 132
 133 extern int all_symbols_looked_up;
 134
 135 int putpkt (char *buf);
 136 int getpkt (char *buf);
 137 void remote_open (char *name);
 138 void remote_close (void);
 139 void write_ok (char *buf);
 140 void write_enn (char *buf);
 141 void enable_async_io (void);
 142 void disable_async_io (void);
 143 void unblock_async_io (void);
 144 void block_async_io (void);
 145 void convert_ascii_to_int (char *from, unsigned char *to, int n);
 146 void convert_int_to_ascii (unsigned char *from, char *to, int n);
 147 void new_thread_notify (int id);
 148 void dead_thread_notify (int id);
 149 void prepare_resume_reply (char *buf, char status, unsigned char sig);
 150
 151 void decode_m_packet (char *from, CORE_ADDR * mem_addr_ptr,
 152                       unsigned int *len_ptr);
 153 void decode_M_packet (char *from, CORE_ADDR * mem_addr_ptr,
 154                       unsigned int *len_ptr, unsigned char *to);
 155
 156 int unhexify (char *bin, const char *hex, int count);
 157 int hexify (char *hex, const char *bin, int count);
 158
 159 int look_up_one_symbol (const char *name, CORE_ADDR *addrp);
 160
 161 /* Functions from ``signals.c''.  */
 162 enum target_signal target_signal_from_host (int hostsig);
 163 int target_signal_to_host_p (enum target_signal oursig);
 164 int target_signal_to_host (enum target_signal oursig);
 165
 166 /* Functions from utils.c */
 167
 168 void perror_with_name (char *string);
 169 void error (const char *string,...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
 170 void fatal (const char *string,...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
 171 void warning (const char *string,...) ATTR_FORMAT (printf, 1, 2);
 172
 173 /* Functions from the register cache definition.  */
 174
 175 void init_registers (void);
 176
 177 /* Maximum number of bytes to read/write at once.  The value here
 178    is chosen to fill up a packet (the headers account for the 32).  */
 179 #define MAXBUFBYTES(N) (((N)-32)/2)
 180
 181 /* Buffer sizes for transferring memory, registers, etc.  Round up PBUFSIZ to
 182    hold all the registers, at least.  */
 183 #define PBUFSIZ ((registers_length () + 32 > 2000) \
 184                  ? (registers_length () + 32) \
 185                  : 2000)
 186
 187 /* Version information, from version.c.  */
 188 extern const char version[];
 189 extern const char host_name[];
 190
 191 #endif /* SERVER_H */