mach-o: decode and display arm64 compact unwind entries.
[deliverable/binutils-gdb.git] / gdb / value.h
CommitLineData
c906108c 1/* Definitions for values of C expressions, for GDB.
dea7f9ba 2
32d0add0 3 Copyright (C) 1986-2015 Free Software Foundation, Inc.
c906108c 4
c5aa993b 5 This file is part of GDB.
c906108c 6
c5aa993b
JM
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
a9762ec7 9 the Free Software Foundation; either version 3 of the License, or
c5aa993b 10 (at your option) any later version.
c906108c 11
c5aa993b
JM
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.
c906108c 16
c5aa993b 17 You should have received a copy of the GNU General Public License
a9762ec7 18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
c906108c
SS
19
20#if !defined (VALUE_H)
21#define VALUE_H 1
22
dea7f9ba 23#include "doublest.h"
1df6926e 24#include "frame.h" /* For struct frame_id. */
dea7f9ba
MK
25
26struct block;
da3331ec 27struct expression;
dea7f9ba 28struct regcache;
da3331ec
AC
29struct symbol;
30struct type;
dea7f9ba 31struct ui_file;
d8ca156b 32struct language_defn;
79a45b7d 33struct value_print_options;
e81e7f5e 34struct xmethod_worker;
d16aafd8 35
9a0dc9e3
PA
36/* Values can be partially 'optimized out' and/or 'unavailable'.
37 These are distinct states and have different string representations
38 and related error strings.
39
40 'unavailable' has a specific meaning in this context. It means the
41 value exists in the program (at the machine level), but GDB has no
42 means to get to it. Such a value is normally printed as
43 <unavailable>. Examples of how to end up with an unavailable value
44 would be:
45
46 - We're inspecting a traceframe, and the memory or registers the
47 debug information says the value lives on haven't been collected.
48
49 - We're inspecting a core dump, the memory or registers the debug
50 information says the value lives aren't present in the dump
51 (that is, we have a partial/trimmed core dump, or we don't fully
52 understand/handle the core dump's format).
53
54 - We're doing live debugging, but the debug API has no means to
55 get at where the value lives in the machine, like e.g., ptrace
56 not having access to some register or register set.
57
58 - Any other similar scenario.
59
60 OTOH, "optimized out" is about what the compiler decided to generate
61 (or not generate). A chunk of a value that was optimized out does
62 not actually exist in the program. There's no way to get at it
63 short of compiling the program differently.
64
65 A register that has not been saved in a frame is likewise considered
66 optimized out, except not-saved registers have a different string
67 representation and related error strings. E.g., we'll print them as
68 <not-saved> instead of <optimized out>, as in:
69
70 (gdb) p/x $rax
71 $1 = <not saved>
72 (gdb) info registers rax
73 rax <not saved>
74
75 If the debug info describes a variable as being in such a register,
76 we'll still print the variable as <optimized out>. IOW, <not saved>
77 is reserved for inspecting registers at the machine level.
78
79 When comparing value contents, optimized out chunks, unavailable
80 chunks, and valid contents data are all considered different. See
81 value_contents_eq for more info.
82*/
83
dea7f9ba
MK
84/* The structure which defines the type of a value. It should never
85 be possible for a program lval value to survive over a call to the
86 inferior (i.e. to be put into the history list or an internal
87 variable). */
c906108c 88
91294c83 89struct value;
c906108c 90
17cf0ecd 91/* Values are stored in a chain, so that they can be deleted easily
a08702d6
TJB
92 over calls to the inferior. Values assigned to internal variables,
93 put into the value history or exposed to Python are taken off this
94 list. */
91294c83 95
17cf0ecd
AC
96struct value *value_next (struct value *);
97
91294c83
AC
98/* Type of the value. */
99
0e03807e 100extern struct type *value_type (const struct value *);
91294c83 101
e512cdbd
SM
102/* Return the gdbarch associated with the value. */
103
104extern struct gdbarch *get_value_arch (const struct value *value);
105
04624583
AC
106/* This is being used to change the type of an existing value, that
107 code should instead be creating a new value with the changed type
108 (but possibly shared content). */
91294c83 109
04624583
AC
110extern void deprecated_set_value_type (struct value *value,
111 struct type *type);
91294c83
AC
112
113/* Only used for bitfields; number of bits contained in them. */
114
0e03807e 115extern int value_bitsize (const struct value *);
9bbda503 116extern void set_value_bitsize (struct value *, int bit);
91294c83
AC
117
118/* Only used for bitfields; position of start of field. For
32c9a795
MD
119 gdbarch_bits_big_endian=0 targets, it is the position of the LSB. For
120 gdbarch_bits_big_endian=1 targets, it is the position of the MSB. */
91294c83 121
0e03807e 122extern int value_bitpos (const struct value *);
9bbda503 123extern void set_value_bitpos (struct value *, int bit);
f5cf64a7 124
4ea48cc1
DJ
125/* Only used for bitfields; the containing value. This allows a
126 single read from the target when displaying multiple
127 bitfields. */
128
129struct value *value_parent (struct value *);
53ba8333 130extern void set_value_parent (struct value *value, struct value *parent);
4ea48cc1 131
91294c83
AC
132/* Describes offset of a value within lval of a structure in bytes.
133 If lval == lval_memory, this is an offset to the address. If lval
134 == lval_register, this is a further offset from location.address
135 within the registers structure. Note also the member
136 embedded_offset below. */
137
0e03807e 138extern int value_offset (const struct value *);
f5cf64a7 139extern void set_value_offset (struct value *, int offset);
df407dfe 140
88e3b34b
AC
141/* The comment from "struct value" reads: ``Is it modifiable? Only
142 relevant if lval != not_lval.''. Shouldn't the value instead be
143 not_lval and be done with it? */
91294c83 144
88e3b34b 145extern int deprecated_value_modifiable (struct value *value);
88e3b34b 146
91294c83
AC
147/* If a value represents a C++ object, then the `type' field gives the
148 object's compile-time type. If the object actually belongs to some
149 class derived from `type', perhaps with other base classes and
150 additional members, then `type' is just a subobject of the real
151 thing, and the full object is probably larger than `type' would
152 suggest.
153
154 If `type' is a dynamic class (i.e. one with a vtable), then GDB can
155 actually determine the object's run-time type by looking at the
156 run-time type information in the vtable. When this information is
157 available, we may elect to read in the entire object, for several
158 reasons:
159
160 - When printing the value, the user would probably rather see the
161 full object, not just the limited portion apparent from the
162 compile-time type.
163
164 - If `type' has virtual base classes, then even printing `type'
165 alone may require reaching outside the `type' portion of the
166 object to wherever the virtual base class has been stored.
167
168 When we store the entire object, `enclosing_type' is the run-time
169 type -- the complete object -- and `embedded_offset' is the offset
170 of `type' within that larger type, in bytes. The value_contents()
171 macro takes `embedded_offset' into account, so most GDB code
172 continues to see the `type' portion of the value, just as the
173 inferior would.
174
175 If `type' is a pointer to an object, then `enclosing_type' is a
176 pointer to the object's run-time type, and `pointed_to_offset' is
177 the offset in bytes from the full object to the pointed-to object
178 -- that is, the value `embedded_offset' would have if we followed
179 the pointer and fetched the complete object. (I don't really see
180 the point. Why not just determine the run-time type when you
181 indirect, and avoid the special case? The contents don't matter
182 until you indirect anyway.)
183
184 If we're not doing anything fancy, `enclosing_type' is equal to
185 `type', and `embedded_offset' is zero, so everything works
186 normally. */
187
4754a64e 188extern struct type *value_enclosing_type (struct value *);
4dfea560
DE
189extern void set_value_enclosing_type (struct value *val,
190 struct type *new_type);
191
8264ba82
AG
192/* Returns value_type or value_enclosing_type depending on
193 value_print_options.objectprint.
194
195 If RESOLVE_SIMPLE_TYPES is 0 the enclosing type will be resolved
196 only for pointers and references, else it will be returned
197 for all the types (e.g. structures). This option is useful
198 to prevent retrieving enclosing type for the base classes fields.
199
200 REAL_TYPE_FOUND is used to inform whether the real type was found
201 (or just static type was used). The NULL may be passed if it is not
202 necessary. */
203
204extern struct type *value_actual_type (struct value *value,
205 int resolve_simple_types,
206 int *real_type_found);
207
91294c83
AC
208extern int value_pointed_to_offset (struct value *value);
209extern void set_value_pointed_to_offset (struct value *value, int val);
210extern int value_embedded_offset (struct value *value);
211extern void set_value_embedded_offset (struct value *value, int val);
212
5f5233d4
PA
213/* For lval_computed values, this structure holds functions used to
214 retrieve and set the value (or portions of the value).
215
216 For each function, 'V' is the 'this' pointer: an lval_funcs
217 function F may always assume that the V it receives is an
218 lval_computed value, and has F in the appropriate slot of its
219 lval_funcs structure. */
220
221struct lval_funcs
222{
223 /* Fill in VALUE's contents. This is used to "un-lazy" values. If
224 a problem arises in obtaining VALUE's bits, this function should
ac71a68c
JK
225 call 'error'. If it is NULL value_fetch_lazy on "un-lazy"
226 non-optimized-out value is an internal error. */
5f5233d4
PA
227 void (*read) (struct value *v);
228
229 /* Handle an assignment TOVAL = FROMVAL by writing the value of
230 FROMVAL to TOVAL's location. The contents of TOVAL have not yet
231 been updated. If a problem arises in doing so, this function
ac71a68c
JK
232 should call 'error'. If it is NULL such TOVAL assignment is an error as
233 TOVAL is not considered as an lvalue. */
5f5233d4
PA
234 void (*write) (struct value *toval, struct value *fromval);
235
8cf6f0b1
TT
236 /* If non-NULL, this is used to implement pointer indirection for
237 this value. This method may return NULL, in which case value_ind
238 will fall back to ordinary indirection. */
239 struct value *(*indirect) (struct value *value);
240
a471c594
JK
241 /* If non-NULL, this is used to implement reference resolving for
242 this value. This method may return NULL, in which case coerce_ref
243 will fall back to ordinary references resolving. */
244 struct value *(*coerce_ref) (const struct value *value);
245
8cf6f0b1
TT
246 /* If non-NULL, this is used to determine whether the indicated bits
247 of VALUE are a synthetic pointer. */
248 int (*check_synthetic_pointer) (const struct value *value,
249 int offset, int length);
250
5f5233d4
PA
251 /* Return a duplicate of VALUE's closure, for use in a new value.
252 This may simply return the same closure, if VALUE's is
253 reference-counted or statically allocated.
254
255 This may be NULL, in which case VALUE's closure is re-used in the
256 new value. */
0e03807e 257 void *(*copy_closure) (const struct value *v);
5f5233d4
PA
258
259 /* Drop VALUE's reference to its closure. Maybe this frees the
260 closure; maybe this decrements a reference count; maybe the
261 closure is statically allocated and this does nothing.
262
263 This may be NULL, in which case no action is taken to free
264 VALUE's closure. */
265 void (*free_closure) (struct value *v);
266};
267
268/* Create a computed lvalue, with type TYPE, function pointers FUNCS,
269 and closure CLOSURE. */
270
271extern struct value *allocate_computed_value (struct type *type,
c8f2448a
JK
272 const struct lval_funcs *funcs,
273 void *closure);
5f5233d4 274
a72c8f6a
JK
275/* Helper function to check the validity of some bits of a value.
276
277 If TYPE represents some aggregate type (e.g., a structure), return 1.
278
279 Otherwise, any of the bytes starting at OFFSET and extending for
280 TYPE_LENGTH(TYPE) bytes are invalid, print a message to STREAM and
281 return 0. The checking is done using FUNCS.
282
283 Otherwise, return 1. */
284
285extern int valprint_check_validity (struct ui_file *stream, struct type *type,
286 int embedded_offset,
287 const struct value *val);
288
a7035dbb
JK
289extern struct value *allocate_optimized_out_value (struct type *type);
290
5f5233d4
PA
291/* If VALUE is lval_computed, return its lval_funcs structure. */
292
a471c594 293extern const struct lval_funcs *value_computed_funcs (const struct value *);
5f5233d4
PA
294
295/* If VALUE is lval_computed, return its closure. The meaning of the
296 returned value depends on the functions VALUE uses. */
297
0e03807e 298extern void *value_computed_closure (const struct value *value);
5f5233d4 299
91294c83 300/* If zero, contents of this value are in the contents field. If
9214ee5f
DJ
301 nonzero, contents are in inferior. If the lval field is lval_memory,
302 the contents are in inferior memory at location.address plus offset.
303 The lval field may also be lval_register.
91294c83
AC
304
305 WARNING: This field is used by the code which handles watchpoints
306 (see breakpoint.c) to decide whether a particular value can be
307 watched by hardware watchpoints. If the lazy flag is set for some
308 member of a value chain, it is assumed that this member of the
309 chain doesn't need to be watched as part of watching the value
310 itself. This is how GDB avoids watching the entire struct or array
311 when the user wants to watch a single struct member or array
312 element. If you ever change the way lazy flag is set and reset, be
313 sure to consider this use as well! */
314
d69fe07e 315extern int value_lazy (struct value *);
dfa52d88 316extern void set_value_lazy (struct value *value, int val);
dea7f9ba 317
4e5d721f
DE
318extern int value_stack (struct value *);
319extern void set_value_stack (struct value *value, int val);
320
901461f8
PA
321/* Throw an error complaining that the value has been optimized
322 out. */
323
324extern void error_value_optimized_out (void);
325
0fd88904
AC
326/* value_contents() and value_contents_raw() both return the address
327 of the gdb buffer used to hold a copy of the contents of the lval.
328 value_contents() is used when the contents of the buffer are needed
dea7f9ba 329 -- it uses value_fetch_lazy() to load the buffer from the process
0fd88904
AC
330 being debugged if it hasn't already been loaded
331 (value_contents_writeable() is used when a writeable but fetched
332 buffer is required).. value_contents_raw() is used when data is
333 being stored into the buffer, or when it is certain that the
334 contents of the buffer are valid.
dea7f9ba 335
c906108c
SS
336 Note: The contents pointer is adjusted by the offset required to
337 get to the real subobject, if the value happens to represent
dea7f9ba 338 something embedded in a larger run-time object. */
c906108c 339
fc1a4b47 340extern gdb_byte *value_contents_raw (struct value *);
91294c83
AC
341
342/* Actual contents of the value. For use of this value; setting it
343 uses the stuff above. Not valid if lazy is nonzero. Target
344 byte-order. We force it to be aligned properly for any possible
345 value. Note that a value therefore extends beyond what is
346 declared here. */
347
fc1a4b47
AC
348extern const gdb_byte *value_contents (struct value *);
349extern gdb_byte *value_contents_writeable (struct value *);
c906108c
SS
350
351/* The ALL variants of the above two macros do not adjust the returned
dea7f9ba 352 pointer by the embedded_offset value. */
c5aa993b 353
fc1a4b47
AC
354extern gdb_byte *value_contents_all_raw (struct value *);
355extern const gdb_byte *value_contents_all (struct value *);
c5aa993b 356
0e03807e
TT
357/* Like value_contents_all, but does not require that the returned
358 bits be valid. This should only be used in situations where you
359 plan to check the validity manually. */
360extern const gdb_byte *value_contents_for_printing (struct value *value);
361
de4127a3
PA
362/* Like value_contents_for_printing, but accepts a constant value
363 pointer. Unlike value_contents_for_printing however, the pointed
364 value must _not_ be lazy. */
365extern const gdb_byte *
366 value_contents_for_printing_const (const struct value *value);
367
a844296a 368extern void value_fetch_lazy (struct value *val);
c906108c 369
91294c83 370/* If nonzero, this is the value of a variable which does not actually
eca07816
JB
371 exist in the program, at least partially. If the value is lazy,
372 this may fetch it now. */
feb13ab0 373extern int value_optimized_out (struct value *value);
c906108c 374
9a0dc9e3
PA
375/* Given a value, return true if any of the contents bits starting at
376 OFFSET and extending for LENGTH bits is optimized out, false
377 otherwise. */
378
379extern int value_bits_any_optimized_out (const struct value *value,
380 int bit_offset, int bit_length);
381
382/* Like value_optimized_out, but return true iff the whole value is
383 optimized out. */
384extern int value_entirely_optimized_out (struct value *value);
385
386/* Mark VALUE's content bytes starting at OFFSET and extending for
387 LENGTH bytes as optimized out. */
388
389extern void mark_value_bytes_optimized_out (struct value *value,
390 int offset, int length);
391
392/* Mark VALUE's content bits starting at OFFSET and extending for
393 LENGTH bits as optimized out. */
eca07816 394
9a0dc9e3
PA
395extern void mark_value_bits_optimized_out (struct value *value,
396 int offset, int length);
0e03807e 397
f372da99 398/* Set or return field indicating whether a variable is initialized or
581e13c1 399 not, based on debugging information supplied by the compiler.
f372da99
CT
400 1 = initialized; 0 = uninitialized. */
401extern int value_initialized (struct value *);
402extern void set_value_initialized (struct value *, int);
403
74bcbdf3
PA
404/* Set COMPONENT's location as appropriate for a component of WHOLE
405 --- regardless of what kind of lvalue WHOLE is. */
406extern void set_value_component_location (struct value *component,
0e03807e 407 const struct value *whole);
74bcbdf3 408
13bb5560
AC
409/* While the following fields are per- VALUE .CONTENT .PIECE (i.e., a
410 single value might have multiple LVALs), this hacked interface is
411 limited to just the first PIECE. Expect further change. */
91294c83
AC
412/* Type of value; either not an lval, or one of the various different
413 possible kinds of lval. */
13bb5560
AC
414extern enum lval_type *deprecated_value_lval_hack (struct value *);
415#define VALUE_LVAL(val) (*deprecated_value_lval_hack (val))
91294c83 416
a471c594
JK
417/* Like VALUE_LVAL, except the parameter can be const. */
418extern enum lval_type value_lval_const (const struct value *value);
419
42ae5230
TT
420/* If lval == lval_memory, return the address in the inferior. If
421 lval == lval_register, return the byte offset into the registers
422 structure. Otherwise, return 0. The returned address
423 includes the offset, if any. */
de4127a3 424extern CORE_ADDR value_address (const struct value *);
42ae5230
TT
425
426/* Like value_address, except the result does not include value's
427 offset. */
428extern CORE_ADDR value_raw_address (struct value *);
429
430/* Set the address of a value. */
431extern void set_value_address (struct value *, CORE_ADDR);
91294c83
AC
432
433/* Pointer to internal variable. */
13bb5560
AC
434extern struct internalvar **deprecated_value_internalvar_hack (struct value *);
435#define VALUE_INTERNALVAR(val) (*deprecated_value_internalvar_hack (val))
91294c83
AC
436
437/* Frame register value is relative to. This will be described in the
438 lval enum above as "lval_register". */
13bb5560
AC
439extern struct frame_id *deprecated_value_frame_id_hack (struct value *);
440#define VALUE_FRAME_ID(val) (*deprecated_value_frame_id_hack (val))
91294c83
AC
441
442/* Register number if the value is from a register. */
13bb5560
AC
443extern short *deprecated_value_regnum_hack (struct value *);
444#define VALUE_REGNUM(val) (*deprecated_value_regnum_hack (val))
445
a471c594
JK
446/* Return value after lval_funcs->coerce_ref (after check_typedef). Return
447 NULL if lval_funcs->coerce_ref is not applicable for whatever reason. */
448
449extern struct value *coerce_ref_if_computed (const struct value *arg);
450
dfcee124
AG
451/* Setup a new value type and enclosing value type for dereferenced value VALUE.
452 ENC_TYPE is the new enclosing type that should be set. ORIGINAL_TYPE and
453 ORIGINAL_VAL are the type and value of the original reference or pointer.
454
455 Note, that VALUE is modified by this function.
456
457 It is a common implementation for coerce_ref and value_ind. */
458
459extern struct value * readjust_indirect_value_type (struct value *value,
460 struct type *enc_type,
461 struct type *original_type,
462 struct value *original_val);
463
dea7f9ba 464/* Convert a REF to the object referenced. */
c906108c 465
994b9211 466extern struct value *coerce_ref (struct value *value);
c906108c
SS
467
468/* If ARG is an array, convert it to a pointer.
c906108c
SS
469 If ARG is a function, convert it to a function pointer.
470
471 References are dereferenced. */
472
994b9211 473extern struct value *coerce_array (struct value *value);
c906108c 474
8cf6f0b1
TT
475/* Given a value, determine whether the bits starting at OFFSET and
476 extending for LENGTH bits are a synthetic pointer. */
477
478extern int value_bits_synthetic_pointer (const struct value *value,
479 int offset, int length);
480
4e07d55f
PA
481/* Given a value, determine whether the contents bytes starting at
482 OFFSET and extending for LENGTH bytes are available. This returns
483 nonzero if all bytes in the given range are available, zero if any
484 byte is unavailable. */
485
486extern int value_bytes_available (const struct value *value,
487 int offset, int length);
488
bdf22206
AB
489/* Given a value, determine whether the contents bits starting at
490 OFFSET and extending for LENGTH bits are available. This returns
491 nonzero if all bits in the given range are available, zero if any
492 bit is unavailable. */
493
494extern int value_bits_available (const struct value *value,
495 int offset, int length);
496
ec0a52e1
PA
497/* Like value_bytes_available, but return false if any byte in the
498 whole object is unavailable. */
499extern int value_entirely_available (struct value *value);
500
6211c335
YQ
501/* Like value_entirely_available, but return false if any byte in the
502 whole object is available. */
503extern int value_entirely_unavailable (struct value *value);
504
4e07d55f
PA
505/* Mark VALUE's content bytes starting at OFFSET and extending for
506 LENGTH bytes as unavailable. */
507
508extern void mark_value_bytes_unavailable (struct value *value,
509 int offset, int length);
c8c1c22f 510
bdf22206
AB
511/* Mark VALUE's content bits starting at OFFSET and extending for
512 LENGTH bits as unavailable. */
513
514extern void mark_value_bits_unavailable (struct value *value,
515 int offset, int length);
516
c8c1c22f 517/* Compare LENGTH bytes of VAL1's contents starting at OFFSET1 with
cd24cfaa
PA
518 LENGTH bytes of VAL2's contents starting at OFFSET2.
519
520 Note that "contents" refers to the whole value's contents
521 (value_contents_all), without any embedded offset adjustment. For
522 example, to compare a complete object value with itself, including
523 its enclosing type chunk, you'd do:
524
525 int len = TYPE_LENGTH (check_typedef (value_enclosing_type (val)));
9a0dc9e3
PA
526 value_contents_eq (val, 0, val, 0, len);
527
528 Returns true iff the set of available/valid contents match.
529
530 Optimized-out contents are equal to optimized-out contents, and are
531 not equal to non-optimized-out contents.
cd24cfaa 532
9a0dc9e3
PA
533 Unavailable contente are equal to unavailable contents, and are not
534 equal to non-unavailable contents.
c8c1c22f 535
9a0dc9e3
PA
536 For example, if 'x's represent an unavailable byte, and 'V' and 'Z'
537 represent different available/valid bytes, in a value with length
538 16:
539
540 offset: 0 4 8 12 16
541 contents: xxxxVVVVxxxxVVZZ
c8c1c22f
PA
542
543 then:
544
9a0dc9e3
PA
545 value_contents_eq(val, 0, val, 8, 6) => 1
546 value_contents_eq(val, 0, val, 4, 4) => 0
547 value_contents_eq(val, 0, val, 8, 8) => 0
548 value_contents_eq(val, 4, val, 12, 2) => 1
549 value_contents_eq(val, 4, val, 12, 4) => 0
550 value_contents_eq(val, 3, val, 4, 4) => 0
551
552 If 'x's represent an unavailable byte, 'o' represents an optimized
553 out byte, in a value with length 8:
554
555 offset: 0 4 8
556 contents: xxxxoooo
557
558 then:
559
560 value_contents_eq(val, 0, val, 2, 2) => 1
561 value_contents_eq(val, 4, val, 6, 2) => 1
562 value_contents_eq(val, 0, val, 4, 4) => 0
563
564 We only know whether a value chunk is unavailable or optimized out
565 if we've tried to read it. As this routine is used by printing
566 routines, which may be printing values in the value history, long
567 after the inferior is gone, it works with const values. Therefore,
568 this routine must not be called with lazy values. */
569
570extern int value_contents_eq (const struct value *val1, int offset1,
571 const struct value *val2, int offset2,
572 int length);
4e07d55f 573
3ae385af
SM
574/* Read LENGTH addressable memory units starting at MEMADDR into BUFFER,
575 which is (or will be copied to) VAL's contents buffer offset by
e6ca34fc
PA
576 EMBEDDED_OFFSET (that is, to &VAL->contents[EMBEDDED_OFFSET]).
577 Marks value contents ranges as unavailable if the corresponding
578 memory is likewise unavailable. STACK indicates whether the memory
579 is known to be stack memory. */
580
424447ee 581extern void read_value_memory (struct value *val, int embedded_offset,
e6ca34fc
PA
582 int stack, CORE_ADDR memaddr,
583 gdb_byte *buffer, size_t length);
584
8954db33
AB
585/* Cast SCALAR_VALUE to the element type of VECTOR_TYPE, then replicate
586 into each element of a new vector value with VECTOR_TYPE. */
587
588struct value *value_vector_widen (struct value *scalar_value,
589 struct type *vector_type);
590
c906108c 591\f
c5aa993b 592
c906108c
SS
593#include "symtab.h"
594#include "gdbtypes.h"
595#include "expression.h"
596
c906108c
SS
597struct frame_info;
598struct fn_field;
c906108c 599
9cb709b6
TT
600extern int print_address_demangle (const struct value_print_options *,
601 struct gdbarch *, CORE_ADDR,
602 struct ui_file *, int);
c906108c 603
f23631e4 604extern LONGEST value_as_long (struct value *val);
f23631e4 605extern DOUBLEST value_as_double (struct value *val);
f23631e4 606extern CORE_ADDR value_as_address (struct value *val);
c906108c 607
fc1a4b47
AC
608extern LONGEST unpack_long (struct type *type, const gdb_byte *valaddr);
609extern DOUBLEST unpack_double (struct type *type, const gdb_byte *valaddr,
66140c26 610 int *invp);
fc1a4b47 611extern CORE_ADDR unpack_pointer (struct type *type, const gdb_byte *valaddr);
5467c6c8 612
8929e59d 613extern LONGEST unpack_field_as_long (struct type *type,
fc1a4b47 614 const gdb_byte *valaddr,
a14ed312 615 int fieldno);
5467c6c8
PA
616extern int unpack_value_field_as_long (struct type *type, const gdb_byte *valaddr,
617 int embedded_offset, int fieldno,
618 const struct value *val, LONGEST *result);
619
bb9d5f81
PP
620extern void unpack_value_bitfield (struct value *dest_val,
621 int bitpos, int bitsize,
622 const gdb_byte *valaddr, int embedded_offset,
623 const struct value *val);
624
5467c6c8
PA
625extern struct value *value_field_bitfield (struct type *type, int fieldno,
626 const gdb_byte *valaddr,
627 int embedded_offset,
628 const struct value *val);
c906108c 629
14d06750
DJ
630extern void pack_long (gdb_byte *buf, struct type *type, LONGEST num);
631
f23631e4 632extern struct value *value_from_longest (struct type *type, LONGEST num);
595939de 633extern struct value *value_from_ulongest (struct type *type, ULONGEST num);
f23631e4 634extern struct value *value_from_pointer (struct type *type, CORE_ADDR addr);
f23631e4 635extern struct value *value_from_double (struct type *type, DOUBLEST num);
4ef30785
TJB
636extern struct value *value_from_decfloat (struct type *type,
637 const gdb_byte *decbytes);
e799154c 638extern struct value *value_from_history_ref (const char *, const char **);
0f71a2f6 639
00a4c844
AC
640extern struct value *value_at (struct type *type, CORE_ADDR addr);
641extern struct value *value_at_lazy (struct type *type, CORE_ADDR addr);
c906108c 642
012370f6
TT
643extern struct value *value_from_contents_and_address_unresolved
644 (struct type *, const gdb_byte *, CORE_ADDR);
8acb6b92
TT
645extern struct value *value_from_contents_and_address (struct type *,
646 const gdb_byte *,
647 CORE_ADDR);
8a9b8146 648extern struct value *value_from_contents (struct type *, const gdb_byte *);
8acb6b92 649
2ed3c037
UW
650extern struct value *default_value_from_register (struct gdbarch *gdbarch,
651 struct type *type,
9acbedc0 652 int regnum,
2ed3c037 653 struct frame_id frame_id);
9acbedc0 654
b56d6f31
JB
655extern void read_frame_register_value (struct value *value,
656 struct frame_info *frame);
657
f23631e4
AC
658extern struct value *value_from_register (struct type *type, int regnum,
659 struct frame_info *frame);
c906108c 660
2ed3c037 661extern CORE_ADDR address_from_register (int regnum,
0b2b0195
UW
662 struct frame_info *frame);
663
9df2fbc4
PM
664extern struct value *value_of_variable (struct symbol *var,
665 const struct block *b);
c906108c 666
270140bd
TT
667extern struct value *address_of_variable (struct symbol *var,
668 const struct block *b);
61212c0f 669
89f5065b 670extern struct value *value_of_register (int regnum, struct frame_info *frame);
c906108c 671
9214ee5f
DJ
672struct value *value_of_register_lazy (struct frame_info *frame, int regnum);
673
a14ed312 674extern int symbol_read_needs_frame (struct symbol *);
c906108c 675
f23631e4 676extern struct value *read_var_value (struct symbol *var,
63e43d3a 677 const struct block *var_block,
f23631e4 678 struct frame_info *frame);
c906108c 679
a5ee536b 680extern struct value *default_read_var_value (struct symbol *var,
63e43d3a 681 const struct block *var_block,
a5ee536b
JB
682 struct frame_info *frame);
683
f23631e4 684extern struct value *allocate_value (struct type *type);
3e3d7139 685extern struct value *allocate_value_lazy (struct type *type);
39d37385
PA
686extern void value_contents_copy (struct value *dst, int dst_offset,
687 struct value *src, int src_offset,
688 int length);
689extern void value_contents_copy_raw (struct value *dst, int dst_offset,
690 struct value *src, int src_offset,
691 int length);
c906108c 692
f23631e4 693extern struct value *allocate_repeat_value (struct type *type, int count);
c906108c 694
f23631e4 695extern struct value *value_mark (void);
c906108c 696
f23631e4 697extern void value_free_to_mark (struct value *mark);
c906108c 698
63375b74 699extern struct value *value_cstring (char *ptr, ssize_t len,
3b7538c0 700 struct type *char_type);
63375b74 701extern struct value *value_string (char *ptr, ssize_t len,
3b7538c0 702 struct type *char_type);
c906108c 703
f23631e4 704extern struct value *value_array (int lowbound, int highbound,
89f5065b 705 struct value **elemvec);
c906108c 706
f23631e4 707extern struct value *value_concat (struct value *arg1, struct value *arg2);
c906108c 708
f23631e4
AC
709extern struct value *value_binop (struct value *arg1, struct value *arg2,
710 enum exp_opcode op);
c906108c 711
2497b498 712extern struct value *value_ptradd (struct value *arg1, LONGEST arg2);
89eef114
UW
713
714extern LONGEST value_ptrdiff (struct value *arg1, struct value *arg2);
c906108c 715
63092375
DJ
716extern int value_must_coerce_to_target (struct value *arg1);
717
718extern struct value *value_coerce_to_target (struct value *arg1);
719
f23631e4 720extern struct value *value_coerce_array (struct value *arg1);
c906108c 721
f23631e4 722extern struct value *value_coerce_function (struct value *arg1);
c906108c 723
f23631e4 724extern struct value *value_ind (struct value *arg1);
c906108c 725
f23631e4 726extern struct value *value_addr (struct value *arg1);
c906108c 727
fb933624
DJ
728extern struct value *value_ref (struct value *arg1);
729
89f5065b
AC
730extern struct value *value_assign (struct value *toval,
731 struct value *fromval);
c906108c 732
36e9969c
NS
733extern struct value *value_pos (struct value *arg1);
734
f23631e4 735extern struct value *value_neg (struct value *arg1);
c906108c 736
f23631e4 737extern struct value *value_complement (struct value *arg1);
c906108c 738
f23631e4
AC
739extern struct value *value_struct_elt (struct value **argp,
740 struct value **args,
714f19d5
TT
741 const char *name, int *static_memfuncp,
742 const char *err);
c906108c 743
b5b08fb4
SC
744extern struct value *value_struct_elt_bitpos (struct value **argp,
745 int bitpos,
746 struct type *field_type,
747 const char *err);
748
79c2c32d 749extern struct value *value_aggregate_elt (struct type *curtype,
c848d642 750 const char *name,
072bba3b 751 struct type *expect_type,
0d5de010
DJ
752 int want_address,
753 enum noside noside);
c906108c 754
f23631e4 755extern struct value *value_static_field (struct type *type, int fieldno);
c906108c 756
4c3376c8
SW
757enum oload_search_type { NON_METHOD, METHOD, BOTH };
758
da096638 759extern int find_overload_match (struct value **args, int nargs,
4c3376c8 760 const char *name,
28c64fc2 761 enum oload_search_type method,
7f8c9282 762 struct value **objp, struct symbol *fsym,
f23631e4 763 struct value **valp, struct symbol **symp,
e66d4446
SC
764 int *staticp, const int no_adl,
765 enum noside noside);
c906108c 766
f23631e4 767extern struct value *value_field (struct value *arg1, int fieldno);
c906108c 768
f23631e4
AC
769extern struct value *value_primitive_field (struct value *arg1, int offset,
770 int fieldno,
771 struct type *arg_type);
c906108c 772
c906108c 773
dfcee124
AG
774extern struct type *value_rtti_indirect_type (struct value *, int *, int *,
775 int *);
c906108c 776
f23631e4
AC
777extern struct value *value_full_object (struct value *, struct type *, int,
778 int, int);
c906108c 779
b1af9e97 780extern struct value *value_cast_pointers (struct type *, struct value *, int);
fb933624 781
f23631e4 782extern struct value *value_cast (struct type *type, struct value *arg2);
c906108c 783
4e8f195d
TT
784extern struct value *value_reinterpret_cast (struct type *type,
785 struct value *arg);
786
787extern struct value *value_dynamic_cast (struct type *type, struct value *arg);
788
f23631e4 789extern struct value *value_zero (struct type *type, enum lval_type lv);
c906108c 790
18a46dbe 791extern struct value *value_one (struct type *type);
301f0ecf 792
f23631e4 793extern struct value *value_repeat (struct value *arg1, int count);
c906108c 794
2497b498 795extern struct value *value_subscript (struct value *array, LONGEST index);
c906108c 796
afc05acb
UW
797extern struct value *value_bitstring_subscript (struct type *type,
798 struct value *bitstring,
2497b498 799 LONGEST index);
afc05acb 800
5fe830e4
AC
801extern struct value *register_value_being_returned (struct type *valtype,
802 struct regcache *retbuf);
c906108c 803
fbb06eb1 804extern int value_in (struct value *element, struct value *set);
c906108c 805
fc1a4b47 806extern int value_bit_index (struct type *type, const gdb_byte *addr,
c84141d6 807 int index);
c906108c 808
bbfdfe1c
DM
809extern enum return_value_convention
810struct_return_convention (struct gdbarch *gdbarch, struct value *function,
811 struct type *value_type);
812
d80b854b 813extern int using_struct_return (struct gdbarch *gdbarch,
6a3a010b 814 struct value *function,
c055b101 815 struct type *value_type);
c906108c 816
f23631e4 817extern struct value *evaluate_expression (struct expression *exp);
c906108c 818
f23631e4 819extern struct value *evaluate_type (struct expression *exp);
c906108c 820
4b27a620
JB
821extern struct value *evaluate_subexp (struct type *expect_type,
822 struct expression *exp,
823 int *pos, enum noside noside);
824
65d12d83
TT
825extern struct value *evaluate_subexpression_type (struct expression *exp,
826 int subexp);
827
0cf6dd15
TJB
828extern void fetch_subexp_value (struct expression *exp, int *pc,
829 struct value **valp, struct value **resultp,
3a1115a0
TT
830 struct value **val_chain,
831 int preserve_errors);
0cf6dd15 832
65d12d83
TT
833extern char *extract_field_op (struct expression *exp, int *subexp);
834
f23631e4
AC
835extern struct value *evaluate_subexp_with_coercion (struct expression *,
836 int *, enum noside);
c906108c 837
bbc13ae3 838extern struct value *parse_and_eval (const char *exp);
c906108c 839
bbc13ae3 840extern struct value *parse_to_comma_and_eval (const char **expp);
c906108c 841
a14ed312 842extern struct type *parse_and_eval_type (char *p, int length);
c906108c 843
bbc13ae3 844extern CORE_ADDR parse_and_eval_address (const char *exp);
c906108c 845
a1b8c4cc 846extern LONGEST parse_and_eval_long (const char *exp);
bb518678 847
4066e646
UW
848extern void unop_promote (const struct language_defn *language,
849 struct gdbarch *gdbarch,
850 struct value **arg1);
851
852extern void binop_promote (const struct language_defn *language,
853 struct gdbarch *gdbarch,
854 struct value **arg1, struct value **arg2);
855
f23631e4 856extern struct value *access_value_history (int num);
c906108c 857
78267919
UW
858extern struct value *value_of_internalvar (struct gdbarch *gdbarch,
859 struct internalvar *var);
c906108c 860
4fa62494
UW
861extern int get_internalvar_integer (struct internalvar *var, LONGEST *l);
862
f23631e4 863extern void set_internalvar (struct internalvar *var, struct value *val);
c906108c 864
4fa62494
UW
865extern void set_internalvar_integer (struct internalvar *var, LONGEST l);
866
78267919
UW
867extern void set_internalvar_string (struct internalvar *var,
868 const char *string);
869
4fa62494
UW
870extern void clear_internalvar (struct internalvar *var);
871
a14ed312
KB
872extern void set_internalvar_component (struct internalvar *var,
873 int offset,
874 int bitpos, int bitsize,
f23631e4 875 struct value *newvalue);
c906108c 876
bc3b79fd 877extern struct internalvar *lookup_only_internalvar (const char *name);
c4a3d09a 878
bc3b79fd 879extern struct internalvar *create_internalvar (const char *name);
c4a3d09a 880
d55637df
TT
881extern VEC (char_ptr) *complete_internalvar (const char *name);
882
22d2b532
SDJ
883/* An internalvar can be dynamically computed by supplying a vector of
884 function pointers to perform various operations. */
885
886struct internalvar_funcs
887{
888 /* Compute the value of the variable. The DATA argument passed to
889 the function is the same argument that was passed to
890 `create_internalvar_type_lazy'. */
891
892 struct value *(*make_value) (struct gdbarch *arch,
893 struct internalvar *var,
894 void *data);
895
896 /* Update the agent expression EXPR with bytecode to compute the
897 value. VALUE is the agent value we are updating. The DATA
898 argument passed to this function is the same argument that was
899 passed to `create_internalvar_type_lazy'. If this pointer is
900 NULL, then the internalvar cannot be compiled to an agent
901 expression. */
902
903 void (*compile_to_ax) (struct internalvar *var,
904 struct agent_expr *expr,
905 struct axs_value *value,
906 void *data);
907
908 /* If non-NULL, this is called to destroy DATA. The DATA argument
909 passed to this function is the same argument that was passed to
910 `create_internalvar_type_lazy'. */
911
912 void (*destroy) (void *data);
913};
914
73033f12
SDJ
915extern struct internalvar *create_internalvar_type_lazy (const char *name,
916 const struct internalvar_funcs *funcs,
917 void *data);
22d2b532
SDJ
918
919/* Compile an internal variable to an agent expression. VAR is the
920 variable to compile; EXPR and VALUE are the agent expression we are
921 updating. This will return 0 if there is no known way to compile
922 VAR, and 1 if VAR was successfully compiled. It may also throw an
923 exception on error. */
924
925extern int compile_internalvar_to_ax (struct internalvar *var,
926 struct agent_expr *expr,
927 struct axs_value *value);
4aa995e1 928
bc3b79fd 929extern struct internalvar *lookup_internalvar (const char *name);
c906108c 930
f23631e4 931extern int value_equal (struct value *arg1, struct value *arg2);
c906108c 932
218d2fc6
TJB
933extern int value_equal_contents (struct value *arg1, struct value *arg2);
934
f23631e4 935extern int value_less (struct value *arg1, struct value *arg2);
c906108c 936
f23631e4 937extern int value_logical_not (struct value *arg1);
c906108c
SS
938
939/* C++ */
940
85bc8cb7
JK
941extern struct value *value_of_this (const struct language_defn *lang);
942
943extern struct value *value_of_this_silent (const struct language_defn *lang);
c906108c 944
f23631e4
AC
945extern struct value *value_x_binop (struct value *arg1, struct value *arg2,
946 enum exp_opcode op,
947 enum exp_opcode otherop,
948 enum noside noside);
c906108c 949
f23631e4
AC
950extern struct value *value_x_unop (struct value *arg1, enum exp_opcode op,
951 enum noside noside);
c906108c 952
89f5065b 953extern struct value *value_fn_field (struct value **arg1p, struct fn_field *f,
f23631e4 954 int j, struct type *type, int offset);
c906108c 955
be636754
PA
956extern int binop_types_user_defined_p (enum exp_opcode op,
957 struct type *type1,
958 struct type *type2);
959
f23631e4
AC
960extern int binop_user_defined_p (enum exp_opcode op, struct value *arg1,
961 struct value *arg2);
c906108c 962
f23631e4 963extern int unop_user_defined_p (enum exp_opcode op, struct value *arg1);
c906108c 964
d8228535 965extern int destructor_name_p (const char *name, struct type *type);
c906108c 966
828d3400
DJ
967extern void value_incref (struct value *val);
968
3e3d7139 969extern void value_free (struct value *val);
c906108c 970
a14ed312 971extern void free_all_values (void);
c906108c 972
0cf6dd15
TJB
973extern void free_value_chain (struct value *v);
974
f23631e4 975extern void release_value (struct value *val);
c906108c 976
e848a8a5
TT
977extern void release_value_or_incref (struct value *val);
978
f23631e4 979extern int record_latest_value (struct value *val);
c906108c 980
50810684
UW
981extern void modify_field (struct type *type, gdb_byte *addr,
982 LONGEST fieldval, int bitpos, int bitsize);
c906108c 983
0d5cff50 984extern void type_print (struct type *type, const char *varstring,
89f5065b 985 struct ui_file *stream, int show);
c906108c 986
ae6a3a4c
TJB
987extern char *type_to_string (struct type *type);
988
fc1a4b47
AC
989extern gdb_byte *baseclass_addr (struct type *type, int index,
990 gdb_byte *valaddr,
8929e59d 991 struct value **valuep, int *errp);
c906108c 992
89f5065b 993extern void print_longest (struct ui_file *stream, int format,
d9fcf2fb 994 int use_local, LONGEST val);
c906108c 995
fc1a4b47 996extern void print_floating (const gdb_byte *valaddr, struct type *type,
89f5065b 997 struct ui_file *stream);
c906108c 998
7678ef8f
TJB
999extern void print_decimal_floating (const gdb_byte *valaddr, struct type *type,
1000 struct ui_file *stream);
1001
8e069a98
TT
1002extern void value_print (struct value *val, struct ui_file *stream,
1003 const struct value_print_options *options);
c906108c 1004
f23631e4
AC
1005extern void value_print_array_elements (struct value *val,
1006 struct ui_file *stream, int format,
2a998fc0 1007 enum val_prettyformat pretty);
c906108c 1008
f23631e4 1009extern struct value *value_release_to_mark (struct value *mark);
c906108c 1010
35c0084b
TT
1011extern void val_print (struct type *type, const gdb_byte *valaddr,
1012 int embedded_offset, CORE_ADDR address,
1013 struct ui_file *stream, int recurse,
1014 const struct value *val,
1015 const struct value_print_options *options,
1016 const struct language_defn *language);
c906108c 1017
a1f5dd1b
TT
1018extern void common_val_print (struct value *val,
1019 struct ui_file *stream, int recurse,
1020 const struct value_print_options *options,
1021 const struct language_defn *language);
806048c6 1022
09ca9e2e
TT
1023extern int val_print_string (struct type *elttype, const char *encoding,
1024 CORE_ADDR addr, int len,
79a45b7d
TT
1025 struct ui_file *stream,
1026 const struct value_print_options *options);
c906108c 1027
aad95b57
TT
1028extern void print_variable_and_value (const char *name,
1029 struct symbol *var,
1030 struct frame_info *frame,
1031 struct ui_file *stream,
1032 int indent);
c906108c 1033
89f5065b
AC
1034extern void typedef_print (struct type *type, struct symbol *news,
1035 struct ui_file *stream);
c906108c 1036
a14ed312 1037extern char *internalvar_name (struct internalvar *var);
c906108c 1038
ae5a43e0 1039extern void preserve_values (struct objfile *);
c906108c
SS
1040
1041/* From values.c */
1042
f23631e4 1043extern struct value *value_copy (struct value *);
c906108c 1044
c37f7098
KW
1045extern struct value *value_non_lval (struct value *);
1046
6c659fc2
SC
1047extern void value_force_lval (struct value *, CORE_ADDR);
1048
4c082a81
SC
1049extern struct value *make_cv_value (int, int, struct value *);
1050
4e7a5ef5
TT
1051extern void preserve_one_value (struct value *, struct objfile *, htab_t);
1052
c906108c
SS
1053/* From valops.c */
1054
f23631e4 1055extern struct value *varying_to_slice (struct value *);
c906108c 1056
f23631e4 1057extern struct value *value_slice (struct value *, int, int);
c906108c 1058
f23631e4
AC
1059extern struct value *value_literal_complex (struct value *, struct value *,
1060 struct type *);
c906108c 1061
3e3b026f
UW
1062extern struct value *find_function_in_inferior (const char *,
1063 struct objfile **);
c906108c 1064
f23631e4 1065extern struct value *value_allocate_space_in_inferior (int);
c906108c 1066
2497b498
UW
1067extern struct value *value_subscripted_rvalue (struct value *array,
1068 LONGEST index, int lowerbound);
bc3b79fd
TJB
1069
1070/* User function handler. */
1071
d452c4bc
UW
1072typedef struct value *(*internal_function_fn) (struct gdbarch *gdbarch,
1073 const struct language_defn *language,
1074 void *cookie,
bc3b79fd
TJB
1075 int argc,
1076 struct value **argv);
1077
1078void add_internal_function (const char *name, const char *doc,
1079 internal_function_fn handler,
1080 void *cookie);
1081
d452c4bc
UW
1082struct value *call_internal_function (struct gdbarch *gdbarch,
1083 const struct language_defn *language,
1084 struct value *function,
bc3b79fd
TJB
1085 int argc, struct value **argv);
1086
1087char *value_internal_function_name (struct value *);
1088
e81e7f5e
SC
1089extern struct value *value_of_xmethod (struct xmethod_worker *);
1090
2ce1cdbf
DE
1091extern struct type *result_type_of_xmethod (struct value *method,
1092 int argc, struct value **argv);
1093
1094extern struct value *call_xmethod (struct value *method,
1095 int argc, struct value **argv);
e81e7f5e 1096
c5aa993b 1097#endif /* !defined (VALUE_H) */
This page took 1.864363 seconds and 4 git commands to generate.