1 /* Target operations for the remote server for GDB.
2    Copyright 2002, 2003, 2004
3    Free Software Foundation, Inc.
4 
5    Contributed by MontaVista Software.
6 
7    This file is part of GDB.
8 
9    This program is free software; you can redistribute it and/or modify
10    it under the terms of the GNU General Public License as published by
11    the Free Software Foundation; either version 2 of the License, or
12    (at your option) any later version.
13 
14    This program is distributed in the hope that it will be useful,
15    but WITHOUT ANY WARRANTY; without even the implied warranty of
16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17    GNU General Public License for more details.
18 
19    You should have received a copy of the GNU General Public License
20    along with this program; if not, write to the Free Software
21    Foundation, Inc., 59 Temple Place - Suite 330,
22    Boston, MA 02111-1307, USA.  */
23 
24 #ifndef TARGET_H
25 #define TARGET_H
26 
27 /* This structure describes how to resume a particular thread (or
28    all threads) based on the client's request.  If thread is -1, then
29    this entry applies to all threads.  These are generally passed around
30    as an array, and terminated by a thread == -1 entry.  */
31 
32 struct thread_resume
33 {
34   int thread;
35 
36   /* If non-zero, leave this thread stopped.  */
37   int leave_stopped;
38 
39   /* If non-zero, we want to single-step.  */
40   int step;
41 
42   /* If non-zero, send this signal when we resume.  */
43   int sig;
44 };
45 
46 struct target_ops
47 {
48   /* Start a new process.
49 
50      PROGRAM is a path to the program to execute.
51      ARGS is a standard NULL-terminated array of arguments,
52      to be passed to the inferior as ``argv''.
53 
54      Returns the new PID on success, -1 on failure.  Registers the new
55      process with the process list.  */
56 
57   int (*create_inferior) (char *program, char **args);
58 
59   /* Attach to a running process.
60 
61      PID is the process ID to attach to, specified by the user
62      or a higher layer.  */
63 
64   int (*attach) (int pid);
65 
66   /* Kill all inferiors.  */
67 
68   void (*kill) (void);
69 
70   /* Detach from all inferiors.  */
71 
72   void (*detach) (void);
73 
74   /* Return 1 iff the thread with process ID PID is alive.  */
75 
76   int (*thread_alive) (int pid);
77 
78   /* Resume the inferior process.  */
79 
80   void (*resume) (struct thread_resume *resume_info);
81 
82   /* Wait for the inferior process to change state.
83 
84      STATUSP will be filled in with a response code to send to GDB.
85 
86      Returns the signal which caused the process to stop.  */
87 
88   unsigned char (*wait) (char *status);
89 
90   /* Fetch registers from the inferior process.
91 
92      If REGNO is -1, fetch all registers; otherwise, fetch at least REGNO.  */
93 
94   void (*fetch_registers) (int regno);
95 
96   /* Store registers to the inferior process.
97 
98      If REGNO is -1, store all registers; otherwise, store at least REGNO.  */
99 
100   void (*store_registers) (int regno);
101 
102   /* Read memory from the inferior process.  This should generally be
103      called through read_inferior_memory, which handles breakpoint shadowing.
104 
105      Read LEN bytes at MEMADDR into a buffer at MYADDR.
106 
107      Returns 0 on success and errno on failure.  */
108 
109   int (*read_memory) (CORE_ADDR memaddr, char *myaddr, int len);
110 
111   /* Write memory to the inferior process.  This should generally be
112      called through write_inferior_memory, which handles breakpoint shadowing.
113 
114      Write LEN bytes from the buffer at MYADDR to MEMADDR.
115 
116      Returns 0 on success and errno on failure.  */
117 
118   int (*write_memory) (CORE_ADDR memaddr, const char *myaddr, int len);
119 
120   /* Query GDB for the values of any symbols we're interested in.
121      This function is called whenever we receive a "qSymbols::"
122      query, which corresponds to every time more symbols (might)
123      become available.  NULL if we aren't interested in any
124      symbols.  */
125 
126   void (*look_up_symbols) (void);
127 
128   /* Send a signal to the inferior process, however is appropriate.  */
129   void (*send_signal) (int);
130 
131   /* Read auxiliary vector data from the inferior process.
132 
133      Read LEN bytes at OFFSET into a buffer at MYADDR.  */
134 
135   int (*read_auxv) (CORE_ADDR offset, char *myaddr, unsigned int len);
136 };
137 
138 extern struct target_ops *the_target;
139 
140 void set_target_ops (struct target_ops *);
141 
142 #define create_inferior(program, args) \
143   (*the_target->create_inferior) (program, args)
144 
145 #define myattach(pid) \
146   (*the_target->attach) (pid)
147 
148 #define kill_inferior() \
149   (*the_target->kill) ()
150 
151 #define detach_inferior() \
152   (*the_target->detach) ()
153 
154 #define mythread_alive(pid) \
155   (*the_target->thread_alive) (pid)
156 
157 #define fetch_inferior_registers(regno) \
158   (*the_target->fetch_registers) (regno)
159 
160 #define store_inferior_registers(regno) \
161   (*the_target->store_registers) (regno)
162 
163 unsigned char mywait (char *statusp, int connected_wait);
164 
165 int read_inferior_memory (CORE_ADDR memaddr, char *myaddr, int len);
166 
167 int write_inferior_memory (CORE_ADDR memaddr, const char *myaddr, int len);
168 
169 void set_desired_inferior (int id);
170 
171 #endif /* TARGET_H */
172