32b90b5bcc7922bcdf6c0317c805a9de7af441ef
[external/binutils.git] / gdb / gdbserver / server.h
1 /* Common definitions for remote server for GDB.
2    Copyright 1993, 1995, 1997, 1998, 1999, 2000, 2002
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., 59 Temple Place - Suite 330,
20    Boston, MA 02111-1307, 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 #ifndef ATTR_NORETURN
38 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
39 #define ATTR_NORETURN __attribute__ ((noreturn))
40 #else
41 #define ATTR_NORETURN           /* nothing */
42 #endif
43 #endif
44
45 #ifndef ATTR_FORMAT
46 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
47 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
48 #else
49 #define ATTR_FORMAT(type, x, y) /* nothing */
50 #endif
51 #endif
52
53 /* FIXME: This should probably be autoconf'd for.  It's an integer type at
54    least the size of a (void *).  */
55 typedef long long CORE_ADDR;
56
57 /* Opaque inferior process information.  */
58 struct inferior_info;
59
60 #include "regcache.h"
61 #include "gdb/signals.h"
62
63 #include "target.h"
64 #include "mem-break.h"
65
66 /* Target-specific functions */
67
68 void initialize_low ();
69
70 /* Target-specific variables */
71
72 extern char *registers;
73
74 /* From inferiors.c.  */
75
76 extern struct inferior_info *current_inferior;
77 extern int signal_pid;
78 void add_inferior (int pid);
79 void clear_inferiors (void);
80 void *inferior_target_data (struct inferior_info *);
81 void set_inferior_target_data (struct inferior_info *, void *);
82 void *inferior_regcache_data (struct inferior_info *);
83 void set_inferior_regcache_data (struct inferior_info *, void *);
84
85 /* Public variables in server.c */
86
87 extern int cont_thread;
88 extern int general_thread;
89 extern int thread_from_wait;
90 extern int old_thread_from_wait;
91
92 extern jmp_buf toplevel;
93
94 /* Functions from remote-utils.c */
95
96 int putpkt (char *buf);
97 int getpkt (char *buf);
98 void remote_open (char *name);
99 void remote_close (void);
100 void write_ok (char *buf);
101 void write_enn (char *buf);
102 void enable_async_io (void);
103 void disable_async_io (void);
104 void convert_ascii_to_int (char *from, char *to, int n);
105 void convert_int_to_ascii (char *from, char *to, int n);
106 void prepare_resume_reply (char *buf, char status, unsigned char sig);
107
108 void decode_m_packet (char *from, CORE_ADDR * mem_addr_ptr,
109                       unsigned int *len_ptr);
110 void decode_M_packet (char *from, CORE_ADDR * mem_addr_ptr,
111                       unsigned int *len_ptr, char *to);
112
113 int unhexify (char *bin, const char *hex, int count);
114 int hexify (char *hex, const char *bin, int count);
115
116 int look_up_one_symbol (const char *name, CORE_ADDR *addrp);
117
118 /* Functions from ``signals.c''.  */
119 enum target_signal target_signal_from_host (int hostsig);
120 int target_signal_to_host_p (enum target_signal oursig);
121 int target_signal_to_host (enum target_signal oursig);
122
123 /* Functions from utils.c */
124
125 void perror_with_name (char *string);
126 void error (const char *string,...) ATTR_NORETURN;
127 void fatal (const char *string,...) ATTR_NORETURN;
128 void warning (const char *string,...);
129
130 /* Functions from the register cache definition.  */
131
132 void init_registers (void);
133
134 /* Maximum number of bytes to read/write at once.  The value here
135    is chosen to fill up a packet (the headers account for the 32).  */
136 #define MAXBUFBYTES(N) (((N)-32)/2)
137
138 /* Buffer sizes for transferring memory, registers, etc.  Round up PBUFSIZ to
139    hold all the registers, at least.  */
140 #define PBUFSIZ ((registers_length () + 32 > 2000) \
141                  ? (registers_length () + 32) \
142                  : 2000)
143
144 #endif /* SERVER_H */