2011-01-07 Michael Snyder <msnyder@vmware.com>
[deliverable/binutils-gdb.git] / gdb / f-valprint.c
1 /* Support for printing Fortran values for GDB, the GNU debugger.
2
3 Copyright (C) 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2003, 2005, 2006,
4 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
5
6 Contributed by Motorola. Adapted from the C definitions by Farooq Butt
7 (fmbutt@engage.sps.mot.com), additionally worked over by Stan Shebs.
8
9 This file is part of GDB.
10
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 3 of the License, or
14 (at your option) any later version.
15
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
20
21 You should have received a copy of the GNU General Public License
22 along with this program. If not, see <http://www.gnu.org/licenses/>. */
23
24 #include "defs.h"
25 #include "gdb_string.h"
26 #include "symtab.h"
27 #include "gdbtypes.h"
28 #include "expression.h"
29 #include "value.h"
30 #include "valprint.h"
31 #include "language.h"
32 #include "f-lang.h"
33 #include "frame.h"
34 #include "gdbcore.h"
35 #include "command.h"
36 #include "block.h"
37
38 #if 0
39 static int there_is_a_visible_common_named (char *);
40 #endif
41
42 extern void _initialize_f_valprint (void);
43 static void info_common_command (char *, int);
44 static void list_all_visible_commons (char *);
45 static void f77_create_arrayprint_offset_tbl (struct type *,
46 struct ui_file *);
47 static void f77_get_dynamic_length_of_aggregate (struct type *);
48
49 int f77_array_offset_tbl[MAX_FORTRAN_DIMS + 1][2];
50
51 /* Array which holds offsets to be applied to get a row's elements
52 for a given array. Array also holds the size of each subarray. */
53
54 /* The following macro gives us the size of the nth dimension, Where
55 n is 1 based. */
56
57 #define F77_DIM_SIZE(n) (f77_array_offset_tbl[n][1])
58
59 /* The following gives us the offset for row n where n is 1-based. */
60
61 #define F77_DIM_OFFSET(n) (f77_array_offset_tbl[n][0])
62
63 int
64 f77_get_lowerbound (struct type *type)
65 {
66 if (TYPE_ARRAY_LOWER_BOUND_IS_UNDEFINED (type))
67 error (_("Lower bound may not be '*' in F77"));
68
69 return TYPE_ARRAY_LOWER_BOUND_VALUE (type);
70 }
71
72 int
73 f77_get_upperbound (struct type *type)
74 {
75 if (TYPE_ARRAY_UPPER_BOUND_IS_UNDEFINED (type))
76 {
77 /* We have an assumed size array on our hands. Assume that
78 upper_bound == lower_bound so that we show at least 1 element.
79 If the user wants to see more elements, let him manually ask for 'em
80 and we'll subscript the array and show him. */
81
82 return f77_get_lowerbound (type);
83 }
84
85 return TYPE_ARRAY_UPPER_BOUND_VALUE (type);
86 }
87
88 /* Obtain F77 adjustable array dimensions. */
89
90 static void
91 f77_get_dynamic_length_of_aggregate (struct type *type)
92 {
93 int upper_bound = -1;
94 int lower_bound = 1;
95
96 /* Recursively go all the way down into a possibly multi-dimensional
97 F77 array and get the bounds. For simple arrays, this is pretty
98 easy but when the bounds are dynamic, we must be very careful
99 to add up all the lengths correctly. Not doing this right
100 will lead to horrendous-looking arrays in parameter lists.
101
102 This function also works for strings which behave very
103 similarly to arrays. */
104
105 if (TYPE_CODE (TYPE_TARGET_TYPE (type)) == TYPE_CODE_ARRAY
106 || TYPE_CODE (TYPE_TARGET_TYPE (type)) == TYPE_CODE_STRING)
107 f77_get_dynamic_length_of_aggregate (TYPE_TARGET_TYPE (type));
108
109 /* Recursion ends here, start setting up lengths. */
110 lower_bound = f77_get_lowerbound (type);
111 upper_bound = f77_get_upperbound (type);
112
113 /* Patch in a valid length value. */
114
115 TYPE_LENGTH (type) =
116 (upper_bound - lower_bound + 1)
117 * TYPE_LENGTH (check_typedef (TYPE_TARGET_TYPE (type)));
118 }
119
120 /* Function that sets up the array offset,size table for the array
121 type "type". */
122
123 static void
124 f77_create_arrayprint_offset_tbl (struct type *type, struct ui_file *stream)
125 {
126 struct type *tmp_type;
127 int eltlen;
128 int ndimen = 1;
129 int upper, lower;
130
131 tmp_type = type;
132
133 while ((TYPE_CODE (tmp_type) == TYPE_CODE_ARRAY))
134 {
135 upper = f77_get_upperbound (tmp_type);
136 lower = f77_get_lowerbound (tmp_type);
137
138 F77_DIM_SIZE (ndimen) = upper - lower + 1;
139
140 tmp_type = TYPE_TARGET_TYPE (tmp_type);
141 ndimen++;
142 }
143
144 /* Now we multiply eltlen by all the offsets, so that later we
145 can print out array elements correctly. Up till now we
146 know an offset to apply to get the item but we also
147 have to know how much to add to get to the next item. */
148
149 ndimen--;
150 eltlen = TYPE_LENGTH (tmp_type);
151 F77_DIM_OFFSET (ndimen) = eltlen;
152 while (--ndimen > 0)
153 {
154 eltlen *= F77_DIM_SIZE (ndimen + 1);
155 F77_DIM_OFFSET (ndimen) = eltlen;
156 }
157 }
158
159
160
161 /* Actual function which prints out F77 arrays, Valaddr == address in
162 the superior. Address == the address in the inferior. */
163
164 static void
165 f77_print_array_1 (int nss, int ndimensions, struct type *type,
166 const gdb_byte *valaddr, CORE_ADDR address,
167 struct ui_file *stream, int recurse,
168 const struct value *val,
169 const struct value_print_options *options,
170 int *elts)
171 {
172 int i;
173
174 if (nss != ndimensions)
175 {
176 for (i = 0;
177 (i < F77_DIM_SIZE (nss) && (*elts) < options->print_max);
178 i++)
179 {
180 fprintf_filtered (stream, "( ");
181 f77_print_array_1 (nss + 1, ndimensions, TYPE_TARGET_TYPE (type),
182 valaddr + i * F77_DIM_OFFSET (nss),
183 address + i * F77_DIM_OFFSET (nss),
184 stream, recurse, val, options, elts);
185 fprintf_filtered (stream, ") ");
186 }
187 if (*elts >= options->print_max && i < F77_DIM_SIZE (nss))
188 fprintf_filtered (stream, "...");
189 }
190 else
191 {
192 for (i = 0; i < F77_DIM_SIZE (nss) && (*elts) < options->print_max;
193 i++, (*elts)++)
194 {
195 val_print (TYPE_TARGET_TYPE (type),
196 valaddr + i * F77_DIM_OFFSET (ndimensions),
197 0,
198 address + i * F77_DIM_OFFSET (ndimensions),
199 stream, recurse, val, options, current_language);
200
201 if (i != (F77_DIM_SIZE (nss) - 1))
202 fprintf_filtered (stream, ", ");
203
204 if ((*elts == options->print_max - 1)
205 && (i != (F77_DIM_SIZE (nss) - 1)))
206 fprintf_filtered (stream, "...");
207 }
208 }
209 }
210
211 /* This function gets called to print an F77 array, we set up some
212 stuff and then immediately call f77_print_array_1(). */
213
214 static void
215 f77_print_array (struct type *type, const gdb_byte *valaddr,
216 CORE_ADDR address, struct ui_file *stream,
217 int recurse,
218 const struct value *val,
219 const struct value_print_options *options)
220 {
221 int ndimensions;
222 int elts = 0;
223
224 ndimensions = calc_f77_array_dims (type);
225
226 if (ndimensions > MAX_FORTRAN_DIMS || ndimensions < 0)
227 error (_("\
228 Type node corrupt! F77 arrays cannot have %d subscripts (%d Max)"),
229 ndimensions, MAX_FORTRAN_DIMS);
230
231 /* Since F77 arrays are stored column-major, we set up an
232 offset table to get at the various row's elements. The
233 offset table contains entries for both offset and subarray size. */
234
235 f77_create_arrayprint_offset_tbl (type, stream);
236
237 f77_print_array_1 (1, ndimensions, type, valaddr, address, stream,
238 recurse, val, options, &elts);
239 }
240 \f
241
242 /* Print data of type TYPE located at VALADDR (within GDB), which came from
243 the inferior at address ADDRESS, onto stdio stream STREAM according to
244 OPTIONS. The data at VALADDR is in target byte order.
245
246 If the data are a string pointer, returns the number of string characters
247 printed. */
248
249 int
250 f_val_print (struct type *type, const gdb_byte *valaddr, int embedded_offset,
251 CORE_ADDR address, struct ui_file *stream, int recurse,
252 const struct value *original_value,
253 const struct value_print_options *options)
254 {
255 struct gdbarch *gdbarch = get_type_arch (type);
256 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
257 unsigned int i = 0; /* Number of characters printed. */
258 struct type *elttype;
259 LONGEST val;
260 CORE_ADDR addr;
261 int index;
262
263 CHECK_TYPEDEF (type);
264 switch (TYPE_CODE (type))
265 {
266 case TYPE_CODE_STRING:
267 f77_get_dynamic_length_of_aggregate (type);
268 LA_PRINT_STRING (stream, builtin_type (gdbarch)->builtin_char,
269 valaddr, TYPE_LENGTH (type), NULL, 0, options);
270 break;
271
272 case TYPE_CODE_ARRAY:
273 fprintf_filtered (stream, "(");
274 f77_print_array (type, valaddr, address, stream,
275 recurse, original_value, options);
276 fprintf_filtered (stream, ")");
277 break;
278
279 case TYPE_CODE_PTR:
280 if (options->format && options->format != 's')
281 {
282 print_scalar_formatted (valaddr, type, options, 0, stream);
283 break;
284 }
285 else
286 {
287 addr = unpack_pointer (type, valaddr);
288 elttype = check_typedef (TYPE_TARGET_TYPE (type));
289
290 if (TYPE_CODE (elttype) == TYPE_CODE_FUNC)
291 {
292 /* Try to print what function it points to. */
293 print_address_demangle (gdbarch, addr, stream, demangle);
294 /* Return value is irrelevant except for string pointers. */
295 return 0;
296 }
297
298 if (options->addressprint && options->format != 's')
299 fputs_filtered (paddress (gdbarch, addr), stream);
300
301 /* For a pointer to char or unsigned char, also print the string
302 pointed to, unless pointer is null. */
303 if (TYPE_LENGTH (elttype) == 1
304 && TYPE_CODE (elttype) == TYPE_CODE_INT
305 && (options->format == 0 || options->format == 's')
306 && addr != 0)
307 i = val_print_string (TYPE_TARGET_TYPE (type), NULL, addr, -1,
308 stream, options);
309
310 /* Return number of characters printed, including the terminating
311 '\0' if we reached the end. val_print_string takes care including
312 the terminating '\0' if necessary. */
313 return i;
314 }
315 break;
316
317 case TYPE_CODE_REF:
318 elttype = check_typedef (TYPE_TARGET_TYPE (type));
319 if (options->addressprint)
320 {
321 CORE_ADDR addr
322 = extract_typed_address (valaddr + embedded_offset, type);
323
324 fprintf_filtered (stream, "@");
325 fputs_filtered (paddress (gdbarch, addr), stream);
326 if (options->deref_ref)
327 fputs_filtered (": ", stream);
328 }
329 /* De-reference the reference. */
330 if (options->deref_ref)
331 {
332 if (TYPE_CODE (elttype) != TYPE_CODE_UNDEF)
333 {
334 struct value *deref_val =
335 value_at
336 (TYPE_TARGET_TYPE (type),
337 unpack_pointer (type, valaddr + embedded_offset));
338
339 common_val_print (deref_val, stream, recurse,
340 options, current_language);
341 }
342 else
343 fputs_filtered ("???", stream);
344 }
345 break;
346
347 case TYPE_CODE_FUNC:
348 if (options->format)
349 {
350 print_scalar_formatted (valaddr, type, options, 0, stream);
351 break;
352 }
353 /* FIXME, we should consider, at least for ANSI C language, eliminating
354 the distinction made between FUNCs and POINTERs to FUNCs. */
355 fprintf_filtered (stream, "{");
356 type_print (type, "", stream, -1);
357 fprintf_filtered (stream, "} ");
358 /* Try to print what function it points to, and its address. */
359 print_address_demangle (gdbarch, address, stream, demangle);
360 break;
361
362 case TYPE_CODE_INT:
363 if (options->format || options->output_format)
364 {
365 struct value_print_options opts = *options;
366
367 opts.format = (options->format ? options->format
368 : options->output_format);
369 print_scalar_formatted (valaddr, type, &opts, 0, stream);
370 }
371 else
372 {
373 val_print_type_code_int (type, valaddr, stream);
374 /* C and C++ has no single byte int type, char is used instead.
375 Since we don't know whether the value is really intended to
376 be used as an integer or a character, print the character
377 equivalent as well. */
378 if (TYPE_LENGTH (type) == 1)
379 {
380 fputs_filtered (" ", stream);
381 LA_PRINT_CHAR ((unsigned char) unpack_long (type, valaddr),
382 type, stream);
383 }
384 }
385 break;
386
387 case TYPE_CODE_FLAGS:
388 if (options->format)
389 print_scalar_formatted (valaddr, type, options, 0, stream);
390 else
391 val_print_type_code_flags (type, valaddr, stream);
392 break;
393
394 case TYPE_CODE_FLT:
395 if (options->format)
396 print_scalar_formatted (valaddr, type, options, 0, stream);
397 else
398 print_floating (valaddr, type, stream);
399 break;
400
401 case TYPE_CODE_VOID:
402 fprintf_filtered (stream, "VOID");
403 break;
404
405 case TYPE_CODE_ERROR:
406 fprintf_filtered (stream, "%s", TYPE_ERROR_NAME (type));
407 break;
408
409 case TYPE_CODE_RANGE:
410 /* FIXME, we should not ever have to print one of these yet. */
411 fprintf_filtered (stream, "<range type>");
412 break;
413
414 case TYPE_CODE_BOOL:
415 if (options->format || options->output_format)
416 {
417 struct value_print_options opts = *options;
418
419 opts.format = (options->format ? options->format
420 : options->output_format);
421 print_scalar_formatted (valaddr, type, &opts, 0, stream);
422 }
423 else
424 {
425 val = extract_unsigned_integer (valaddr,
426 TYPE_LENGTH (type), byte_order);
427 if (val == 0)
428 fprintf_filtered (stream, ".FALSE.");
429 else if (val == 1)
430 fprintf_filtered (stream, ".TRUE.");
431 else
432 /* Not a legitimate logical type, print as an integer. */
433 {
434 /* Bash the type code temporarily. */
435 TYPE_CODE (type) = TYPE_CODE_INT;
436 val_print (type, valaddr, 0, address, stream, recurse,
437 original_value, options, current_language);
438 /* Restore the type code so later uses work as intended. */
439 TYPE_CODE (type) = TYPE_CODE_BOOL;
440 }
441 }
442 break;
443
444 case TYPE_CODE_COMPLEX:
445 type = TYPE_TARGET_TYPE (type);
446 fputs_filtered ("(", stream);
447 print_floating (valaddr, type, stream);
448 fputs_filtered (",", stream);
449 print_floating (valaddr + TYPE_LENGTH (type), type, stream);
450 fputs_filtered (")", stream);
451 break;
452
453 case TYPE_CODE_UNDEF:
454 /* This happens (without TYPE_FLAG_STUB set) on systems which don't use
455 dbx xrefs (NO_DBX_XREFS in gcc) if a file has a "struct foo *bar"
456 and no complete type for struct foo in that file. */
457 fprintf_filtered (stream, "<incomplete type>");
458 break;
459
460 case TYPE_CODE_STRUCT:
461 case TYPE_CODE_UNION:
462 /* Starting from the Fortran 90 standard, Fortran supports derived
463 types. */
464 fprintf_filtered (stream, "( ");
465 for (index = 0; index < TYPE_NFIELDS (type); index++)
466 {
467 int offset = TYPE_FIELD_BITPOS (type, index) / 8;
468
469 val_print (TYPE_FIELD_TYPE (type, index), valaddr + offset,
470 embedded_offset, address, stream, recurse + 1,
471 original_value, options, current_language);
472 if (index != TYPE_NFIELDS (type) - 1)
473 fputs_filtered (", ", stream);
474 }
475 fprintf_filtered (stream, " )");
476 break;
477
478 default:
479 error (_("Invalid F77 type code %d in symbol table."), TYPE_CODE (type));
480 }
481 gdb_flush (stream);
482 return 0;
483 }
484
485 static void
486 list_all_visible_commons (char *funname)
487 {
488 SAVED_F77_COMMON_PTR tmp;
489
490 tmp = head_common_list;
491
492 printf_filtered (_("All COMMON blocks visible at this level:\n\n"));
493
494 while (tmp != NULL)
495 {
496 if (strcmp (tmp->owning_function, funname) == 0)
497 printf_filtered ("%s\n", tmp->name);
498
499 tmp = tmp->next;
500 }
501 }
502
503 /* This function is used to print out the values in a given COMMON
504 block. It will always use the most local common block of the
505 given name. */
506
507 static void
508 info_common_command (char *comname, int from_tty)
509 {
510 SAVED_F77_COMMON_PTR the_common;
511 COMMON_ENTRY_PTR entry;
512 struct frame_info *fi;
513 char *funname = 0;
514 struct symbol *func;
515
516 /* We have been told to display the contents of F77 COMMON
517 block supposedly visible in this function. Let us
518 first make sure that it is visible and if so, let
519 us display its contents. */
520
521 fi = get_selected_frame (_("No frame selected"));
522
523 /* The following is generally ripped off from stack.c's routine
524 print_frame_info(). */
525
526 func = find_pc_function (get_frame_pc (fi));
527 if (func)
528 {
529 /* In certain pathological cases, the symtabs give the wrong
530 function (when we are in the first function in a file which
531 is compiled without debugging symbols, the previous function
532 is compiled with debugging symbols, and the "foo.o" symbol
533 that is supposed to tell us where the file with debugging symbols
534 ends has been truncated by ar because it is longer than 15
535 characters).
536
537 So look in the minimal symbol tables as well, and if it comes
538 up with a larger address for the function use that instead.
539 I don't think this can ever cause any problems; there shouldn't
540 be any minimal symbols in the middle of a function.
541 FIXME: (Not necessarily true. What about text labels?) */
542
543 struct minimal_symbol *msymbol =
544 lookup_minimal_symbol_by_pc (get_frame_pc (fi));
545
546 if (msymbol != NULL
547 && (SYMBOL_VALUE_ADDRESS (msymbol)
548 > BLOCK_START (SYMBOL_BLOCK_VALUE (func))))
549 funname = SYMBOL_LINKAGE_NAME (msymbol);
550 else
551 funname = SYMBOL_LINKAGE_NAME (func);
552 }
553 else
554 {
555 struct minimal_symbol *msymbol =
556 lookup_minimal_symbol_by_pc (get_frame_pc (fi));
557
558 if (msymbol != NULL)
559 funname = SYMBOL_LINKAGE_NAME (msymbol);
560 else /* Got no 'funname', code below will fail. */
561 error (_("No function found for frame."));
562 }
563
564 /* If comname is NULL, we assume the user wishes to see the
565 which COMMON blocks are visible here and then return. */
566
567 if (comname == 0)
568 {
569 list_all_visible_commons (funname);
570 return;
571 }
572
573 the_common = find_common_for_function (comname, funname);
574
575 if (the_common)
576 {
577 if (strcmp (comname, BLANK_COMMON_NAME_LOCAL) == 0)
578 printf_filtered (_("Contents of blank COMMON block:\n"));
579 else
580 printf_filtered (_("Contents of F77 COMMON block '%s':\n"), comname);
581
582 printf_filtered ("\n");
583 entry = the_common->entries;
584
585 while (entry != NULL)
586 {
587 print_variable_and_value (NULL, entry->symbol, fi, gdb_stdout, 0);
588 entry = entry->next;
589 }
590 }
591 else
592 printf_filtered (_("Cannot locate the common block %s in function '%s'\n"),
593 comname, funname);
594 }
595
596 /* This function is used to determine whether there is a
597 F77 common block visible at the current scope called 'comname'. */
598
599 #if 0
600 static int
601 there_is_a_visible_common_named (char *comname)
602 {
603 SAVED_F77_COMMON_PTR the_common;
604 struct frame_info *fi;
605 char *funname = 0;
606 struct symbol *func;
607
608 if (comname == NULL)
609 error (_("Cannot deal with NULL common name!"));
610
611 fi = get_selected_frame (_("No frame selected"));
612
613 /* The following is generally ripped off from stack.c's routine
614 print_frame_info(). */
615
616 func = find_pc_function (fi->pc);
617 if (func)
618 {
619 /* In certain pathological cases, the symtabs give the wrong
620 function (when we are in the first function in a file which
621 is compiled without debugging symbols, the previous function
622 is compiled with debugging symbols, and the "foo.o" symbol
623 that is supposed to tell us where the file with debugging symbols
624 ends has been truncated by ar because it is longer than 15
625 characters).
626
627 So look in the minimal symbol tables as well, and if it comes
628 up with a larger address for the function use that instead.
629 I don't think this can ever cause any problems; there shouldn't
630 be any minimal symbols in the middle of a function.
631 FIXME: (Not necessarily true. What about text labels?) */
632
633 struct minimal_symbol *msymbol = lookup_minimal_symbol_by_pc (fi->pc);
634
635 if (msymbol != NULL
636 && (SYMBOL_VALUE_ADDRESS (msymbol)
637 > BLOCK_START (SYMBOL_BLOCK_VALUE (func))))
638 funname = SYMBOL_LINKAGE_NAME (msymbol);
639 else
640 funname = SYMBOL_LINKAGE_NAME (func);
641 }
642 else
643 {
644 struct minimal_symbol *msymbol =
645 lookup_minimal_symbol_by_pc (fi->pc);
646
647 if (msymbol != NULL)
648 funname = SYMBOL_LINKAGE_NAME (msymbol);
649 }
650
651 the_common = find_common_for_function (comname, funname);
652
653 return (the_common ? 1 : 0);
654 }
655 #endif
656
657 void
658 _initialize_f_valprint (void)
659 {
660 add_info ("common", info_common_command,
661 _("Print out the values contained in a Fortran COMMON block."));
662 if (xdb_commands)
663 add_com ("lc", class_info, info_common_command,
664 _("Print out the values contained in a Fortran COMMON block."));
665 }
This page took 0.07986 seconds and 5 git commands to generate.