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