7521296faef70babbdddb5d2257ffcc02baccbf1
[external/binutils.git] / gdb / config / arc / tm-arc.h
1 /* Parameters for target machine ARC, for GDB, the GNU debugger.
2    Copyright 1995, 1996, 1998, 1999, 2000 Free Software Foundation, Inc.
3    Contributed by Cygnus Support.
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 #include "regcache.h"
23
24 /* Used by arc-tdep.c to set the default cpu type.  */
25 #define DEFAULT_ARC_CPU_TYPE "base"
26
27 /* Byte order is selectable.  */
28 #define TARGET_BYTE_ORDER_SELECTABLE
29
30 /* We have IEEE floating point, if we have any float at all.  */
31 #define IEEE_FLOAT (1)
32
33 /* Offset from address of function to start of its code.
34    Zero on most machines.  */
35 #define FUNCTION_START_OFFSET 0
36
37 /* Advance PC across any function entry prologue instructions
38    to reach some "real" code.  SKIP_PROLOGUE_FRAMELESS_P advances
39    the PC past some of the prologue, but stops as soon as it
40    knows that the function has a frame.  Its result is equal
41    to its input PC if the function is frameless, unequal otherwise.  */
42
43 #define SKIP_PROLOGUE(pc) (arc_skip_prologue (pc, 0))
44 #define SKIP_PROLOGUE_FRAMELESS_P(pc) (arc_skip_prologue (pc, 1))
45 extern CORE_ADDR arc_skip_prologue (CORE_ADDR, int);
46
47 /* Sequence of bytes for breakpoint instruction.
48    ??? The current value is "sr -1,[-1]" and is for the simulator only.
49    The simulator watches for this and does the right thing.
50    The hardware version will have to associate with each breakpoint
51    the sequence "flag 1; nop; nop; nop".  IE: The breakpoint insn will not
52    be a fixed set of bits but instead will be a branch to a semi-random
53    address.  Presumably this will be cleaned up for "second silicon".  */
54 #define BIG_BREAKPOINT { 0x12, 0x1f, 0xff, 0xff }
55 #define LITTLE_BREAKPOINT { 0xff, 0xff, 0x1f, 0x12 }
56
57 /* Given the exposed pipeline, there isn't any one correct value.
58    However, this value must be 4.  GDB can't handle any other value (other than
59    zero).  See for example infrun.c:
60    "prev_pc != stop_pc - DECR_PC_AFTER_BREAK"  */
61 /* FIXME */
62 #define DECR_PC_AFTER_BREAK 8
63
64 /* We don't have a reliable single step facility.
65    ??? We do have a cycle single step facility, but that won't work.  */
66 #define SOFTWARE_SINGLE_STEP_P() 1
67 extern void arc_software_single_step (enum target_signal, int);
68 #define SOFTWARE_SINGLE_STEP(sig,bp_p) arc_software_single_step (sig, bp_p)
69
70 /* FIXME: Need to set STEP_SKIPS_DELAY.  */
71
72 /* Given a pc value as defined by the hardware, return the real address.
73    Remember that on the ARC blink contains that status register which
74    includes PC + flags (so we have to mask out the flags).  */
75 #define ARC_PC_TO_REAL_ADDRESS(pc) (((pc) & 0xffffff) << 2)
76
77 /* Immediately after a function call, return the saved pc.
78    Can't always go through the frames for this because on some machines
79    the new frame is not set up until the new function
80    executes some instructions.  */
81
82 #define SAVED_PC_AFTER_CALL(frame) \
83   (ARC_PC_TO_REAL_ADDRESS (read_register (BLINK_REGNUM)))
84
85 /* Stack grows upward */
86
87 #define INNER_THAN(lhs,rhs) ((lhs) < (rhs))
88
89 /* Say how long (ordinary) registers are.  This is a piece of bogosity
90    used in push_word and a few other places; REGISTER_RAW_SIZE is the
91    real way to know how big a register is.  */
92 #define REGISTER_SIZE 4
93
94 /* Number of machine registers */
95 #define NUM_REGS 92
96
97 /* Initializer for an array of names of registers.
98    There should be NUM_REGS strings in this initializer.  */
99
100 #define REGISTER_NAMES \
101 { \
102     /*  0 */ "r0",  "r1",  "r2",  "r3",  "r4",  "r5",  "r6",  "r7", \
103     /*  8 */ "r8",  "r9",  "r10", "r11", "r12", "r13", "r14", "r15", \
104     /* 16 */ "r16", "r17", "r18", "r19", "r20", "r21", "r22", "r23", \
105     /* 24 */ "r24", "r25", "r26", "fp", "sp", "ilink1", "ilink2", "blink", \
106     /* 32 */ "r32", "r33", "r34", "r35", "r36", "r37", "r38", "r39", \
107     /* 40 */ "r40", "r41", "r42", "r43", "r44", "r45", "r46", "r47", \
108     /* 48 */ "r48", "r49", "r50", "r51", "r52", "r53", "r54", "r55", \
109     /* 56 */ "r56", "mlo", "mmid", "mhi", "lp_count", \
110     /* 61 */ "status", "sema", "lp_start", "lp_end", "identity", "debug", \
111     /* 67 */ "aux10", "aux11", "aux12", "aux13", "aux14", \
112     /* 72 */ "aux15", "aux16", "aux17", "aux18", "aux19", \
113     /* 77 */ "aux1a", "aux1b", "aux1c", "aux1d", "aux1e", \
114     /* 82 */ "aux1f", "aux20", "aux21", "aux22", \
115     /* 86 */ "aux30", "aux31", "aux32", "aux33", "aux40", \
116     /* 91 */ "pc" \
117 }
118
119 /* Register numbers of various important registers (used to index
120    into arrays of register names and register values).  */
121
122 #define R0_REGNUM   0           /* First local register           */
123 #define R59_REGNUM 59           /* Last local register            */
124 #define FP_REGNUM  27           /* Contains address of executing stack frame */
125 #define SP_REGNUM  28           /* stack pointer */
126 #define BLINK_REGNUM 31         /* link register */
127 #define STA_REGNUM 61           /* processor status word */
128 #define PC_REGNUM  91           /* instruction pointer */
129 #define AUX_BEG_REGNUM  61      /* aux reg begins */
130 #define AUX_END_REGNUM  90      /* aux reg ends, pc not real aux reg */
131
132 /* Fake registers used to mark immediate data.  */
133 #define SHIMM_FLAG_REGNUM 61
134 #define LIMM_REGNUM 62
135 #define SHIMM_REGNUM 63
136
137 #define AUX_REG_MAP \
138 { \
139    {  0,  1,  2,  3,  4,  5, \
140      16, -1, -1, -1, -1, \
141      -1, -1, -1, -1, -1, \
142      -1, -1, -1, -1, 30, \
143      -1, 32, 33, -1, \
144       48, 49, 50, 51, 64, \
145       0 \
146     }, \
147    {  0,  1,  2,  3,  4,  5, \
148      16, -1, -1, -1, -1, \
149      -1, -1, -1, -1, -1, \
150      -1, -1, -1, -1, 30, \
151      31, 32, 33, -1, \
152      -1, -1, -1, -1, -1, \
153       0 \
154     }, \
155    {  0,  1,  2,  3,  4,  5, \
156       16, 17, 18, 19, 20, \
157       21, 22, 23, 24, 25, \
158       26, 27, 28, 29, 30, \
159       31, 32, 33, 34, \
160      -1, -1, -1, -1, -1, \
161       0 \
162     } \
163 }
164
165 #define PFP_REGNUM R0_REGNUM    /* Previous frame pointer */
166
167 /* Total amount of space needed to store our copies of the machine's
168    register state, the array `registers'.  */
169 #define REGISTER_BYTES (NUM_REGS * 4)
170
171 /* Index within `registers' of the first byte of the space for register N.  */
172 #define REGISTER_BYTE(N) (4*(N))
173
174 /* Number of bytes of storage in the actual machine representation
175    for register N. */
176 #define REGISTER_RAW_SIZE(N) 4
177
178 /* Number of bytes of storage in the program's representation for register N. */
179 #define REGISTER_VIRTUAL_SIZE(N) 4
180
181 /* Largest value REGISTER_RAW_SIZE can have.  */
182 #define MAX_REGISTER_RAW_SIZE 4
183
184 /* Largest value REGISTER_VIRTUAL_SIZE can have.  */
185 #define MAX_REGISTER_VIRTUAL_SIZE 4
186
187 /* Return the GDB type object for the "standard" data type
188    of data in register N.  */
189 #define REGISTER_VIRTUAL_TYPE(N) (builtin_type_int)
190 \f
191
192 /* Macros for understanding function return values... */
193
194 /* Does the specified function use the "struct returning" convention
195    or the "value returning" convention?  The "value returning" convention
196    almost invariably returns the entire value in registers.  The
197    "struct returning" convention often returns the entire value in
198    memory, and passes a pointer (out of or into the function) saying
199    where the value (is or should go).
200
201    Since this sometimes depends on whether it was compiled with GCC,
202    this is also an argument.  This is used in call_function to build a
203    stack, and in value_being_returned to print return values.
204
205    On arc, a structure is always retunred with pointer in r0. */
206
207 #define USE_STRUCT_CONVENTION(gcc_p, type) 1
208
209 /* Extract from an array REGBUF containing the (raw) register state
210    a function return value of type TYPE, and copy that, in virtual format,
211    into VALBUF.  This is only called if USE_STRUCT_CONVENTION for this
212    type is 0.
213  */
214 #define EXTRACT_RETURN_VALUE(TYPE,REGBUF,VALBUF) \
215         memcpy(VALBUF, REGBUF+REGISTER_BYTE(R0_REGNUM), TYPE_LENGTH (TYPE))
216
217 /* If USE_STRUCT_CONVENTION produces a 1, 
218    extract from an array REGBUF containing the (raw) register state
219    the address in which a function should return its structure value,
220    as a CORE_ADDR (or an expression that can be used as one). */
221 #define EXTRACT_STRUCT_VALUE_ADDRESS(REGBUF) \
222    (error("Don't know where large structure is returned on arc"), 0)
223
224 /* Write into appropriate registers a function return value
225    of type TYPE, given in virtual format, for "value returning" functions.
226    For 'return' command:  not (yet) implemented for arc.  */
227 #define STORE_RETURN_VALUE(TYPE,VALBUF) \
228     error ("Returning values from functions is not implemented in arc gdb")
229
230 /* Store the address of the place in which to copy the structure the
231    subroutine will return.  This is called from call_function. */
232 #define STORE_STRUCT_RETURN(ADDR, SP) \
233     error ("Returning values from functions is not implemented in arc gdb")
234 \f
235
236 /* Describe the pointer in each stack frame to the previous stack frame
237    (its caller).  */
238
239 /* We cache information about saved registers in the frame structure,
240    to save us from having to re-scan function prologues every time
241    a register in a non-current frame is accessed.  */
242
243 #define EXTRA_FRAME_INFO \
244         struct frame_saved_regs *fsr; \
245         CORE_ADDR arg_pointer;
246
247 /* Zero the frame_saved_regs pointer when the frame is initialized,
248    so that FRAME_FIND_SAVED_REGS () will know to allocate and
249    initialize a frame_saved_regs struct the first time it is called.
250    Set the arg_pointer to -1, which is not valid; 0 and other values
251    indicate real, cached values.  */
252
253 #define INIT_EXTRA_FRAME_INFO(fromleaf, fi) \
254         ((fi)->fsr = 0, (fi)->arg_pointer = -1)
255
256 /* FRAME_CHAIN takes a frame's nominal address
257    and produces the frame's chain-pointer.
258    However, if FRAME_CHAIN_VALID returns zero,
259    it means the given frame is the outermost one and has no caller.  */
260 /* On the arc, we get the chain pointer by reading the PFP saved
261    on the stack. */
262 /* The PFP and RPC is in fp and fp+4.  */
263
264 #define FRAME_CHAIN(thisframe) \
265   (read_memory_integer (FRAME_FP (thisframe), 4))
266
267 /* FRAME_CHAIN_VALID returns zero if the given frame is the outermost one
268    and has no caller.  */
269 #define FRAME_CHAIN_VALID(chain, thisframe) nonnull_frame_chain_valid (chain, thisframe)
270
271 /* An expression that tells us whether the function invocation represented
272    by FI does not have a frame on the stack associated with it. */
273
274 #define FRAMELESS_FUNCTION_INVOCATION(FI) \
275      (((FI)->signal_handler_caller) ? 0 : frameless_look_for_prologue (FI))
276
277 /* Where is the PC for a specific frame.
278    A leaf function may never save blink, so we have to check for that here.  */
279
280 #define FRAME_SAVED_PC(frame) (arc_frame_saved_pc (frame))
281 struct frame_info;              /* in case frame.h not included yet */
282 CORE_ADDR arc_frame_saved_pc (struct frame_info *);
283
284 /* If the argument is on the stack, it will be here.
285    We cache this value in the frame info if we've already looked it up.  */
286 /* ??? Is the arg_pointer check necessary?  */
287
288 #define FRAME_ARGS_ADDRESS(fi) \
289   (((fi)->arg_pointer != -1) ? (fi)->arg_pointer : (fi)->frame)
290
291 /* This is the same except it should return 0 when
292    it does not really know where the args are, rather than guessing.
293    This value is not cached since it is only used infrequently.  */
294
295 #define FRAME_LOCALS_ADDRESS(fi)        ((fi)->frame)
296
297 /* Set NUMARGS to the number of args passed to a frame.
298    Can return -1, meaning no way to tell.  */
299
300 #define FRAME_NUM_ARGS(fi)      (-1)
301
302 /* Return number of bytes at start of arglist that are not really args.  */
303
304 #define FRAME_ARGS_SKIP 0
305
306 /* Produce the positions of the saved registers in a stack frame.  */
307
308 #define FRAME_FIND_SAVED_REGS(frame_info_addr, sr) \
309         frame_find_saved_regs (frame_info_addr, &sr)
310 extern void frame_find_saved_regs ();   /* See arc-tdep.c */
311 \f
312
313 /* Things needed for making calls to functions in the inferior process */
314 void arc_push_dummy_frame (void);
315 #define PUSH_DUMMY_FRAME \
316         arc_push_dummy_frame ()
317
318 /* Discard from the stack the innermost frame, restoring all registers.  */
319 void arc_pop_frame (void);
320 #define POP_FRAME \
321         arc_pop_frame ()
322
323 /* This sequence of words is the instructions  bl xxxx, flag 1 */
324 #define CALL_DUMMY { 0x28000000, 0x1fbe8001 }
325 #define CALL_DUMMY_LENGTH 8
326
327 /* Start execution at beginning of dummy */
328 #define CALL_DUMMY_START_OFFSET 0
329
330 /* Insert the specified number of args and function address
331    into a call sequence of the above form stored at 'dummyname'. */
332 #define FIX_CALL_DUMMY(dummyname, pc, fun, nargs, args, type, gcc_p) \
333 { \
334         int from, to, delta, loc; \
335         loc = (int)(read_register (SP_REGNUM) - CALL_DUMMY_LENGTH); \
336         from = loc + 4; \
337         to = (int)(fun); \
338         delta = (to - from) >> 2; \
339         *((char *)(dummyname) + 1) = (delta & 0x1); \
340         *((char *)(dummyname) + 2) = ((delta >> 1) & 0xff); \
341         *((char *)(dummyname) + 3) = ((delta >> 9) & 0xff); \
342         *((char *)(dummyname) + 4) = ((delta >> 17) & 0x7); \
343 }