Fix ptype of single-member Rust enums
[deliverable/binutils-gdb.git] / gdb / rust-lang.c
1 /* Rust language support routines for GDB, the GNU debugger.
2
3 Copyright (C) 2016-2017 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 3 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, see <http://www.gnu.org/licenses/>. */
19
20 #include "defs.h"
21
22 #include <ctype.h>
23
24 #include "block.h"
25 #include "c-lang.h"
26 #include "charset.h"
27 #include "cp-support.h"
28 #include "demangle.h"
29 #include "gdbarch.h"
30 #include "infcall.h"
31 #include "objfiles.h"
32 #include "rust-lang.h"
33 #include "valprint.h"
34 #include "varobj.h"
35 #include <string>
36 #include <vector>
37
38 extern initialize_file_ftype _initialize_rust_language;
39
40 /* Returns the last segment of a Rust path like foo::bar::baz. Will
41 not handle cases where the last segment contains generics. This
42 will return NULL if the last segment cannot be found. */
43
44 static const char *
45 rust_last_path_segment (const char * path)
46 {
47 const char *result = strrchr (path, ':');
48
49 if (result == NULL)
50 return NULL;
51 return result + 1;
52 }
53
54 /* See rust-lang.h. */
55
56 std::string
57 rust_crate_for_block (const struct block *block)
58 {
59 const char *scope = block_scope (block);
60
61 if (scope[0] == '\0')
62 return std::string ();
63
64 return std::string (scope, cp_find_first_component (scope));
65 }
66
67 /* Information about the discriminant/variant of an enum */
68
69 struct disr_info
70 {
71 /* Name of field. */
72 std::string name;
73 /* Field number in union. Negative on error. For an encoded enum,
74 the "hidden" member will always be field 1, and the "real" member
75 will always be field 0. */
76 int field_no;
77 /* True if this is an encoded enum that has a single "real" member
78 and a single "hidden" member. */
79 unsigned int is_encoded : 1;
80 };
81
82 /* The prefix of a specially-encoded enum. */
83
84 #define RUST_ENUM_PREFIX "RUST$ENCODED$ENUM$"
85
86 /* The number of the real field. */
87
88 #define RUST_ENCODED_ENUM_REAL 0
89
90 /* The number of the hidden field. */
91
92 #define RUST_ENCODED_ENUM_HIDDEN 1
93
94 /* Whether or not a TYPE_CODE_UNION value is an untagged union
95 as opposed to being a regular Rust enum. */
96 static bool
97 rust_union_is_untagged (struct type *type)
98 {
99 /* Unions must have at least one field. */
100 if (TYPE_NFIELDS (type) == 0)
101 return false;
102 /* If the first field is named, but the name has the rust enum prefix,
103 it is an enum. */
104 if (strncmp (TYPE_FIELD_NAME (type, 0), RUST_ENUM_PREFIX,
105 strlen (RUST_ENUM_PREFIX)) == 0)
106 return false;
107 /* Unions only have named fields. */
108 for (int i = 0; i < TYPE_NFIELDS (type); ++i)
109 {
110 if (strlen (TYPE_FIELD_NAME (type, i)) == 0)
111 return false;
112 }
113 return true;
114 }
115
116 /* Utility function to get discriminant info for a given value. */
117
118 static struct disr_info
119 rust_get_disr_info (struct type *type, const gdb_byte *valaddr,
120 int embedded_offset, CORE_ADDR address,
121 struct value *val)
122 {
123 int i;
124 struct disr_info ret;
125 struct type *disr_type;
126 struct value_print_options opts;
127 struct cleanup *cleanup;
128 const char *name_segment;
129
130 get_no_prettyformat_print_options (&opts);
131
132 ret.field_no = -1;
133 ret.is_encoded = 0;
134
135 if (TYPE_NFIELDS (type) == 0)
136 error (_("Encountered void enum value"));
137
138 /* If an enum has two values where one is empty and the other holds
139 a pointer that cannot be zero; then the Rust compiler optimizes
140 away the discriminant and instead uses a zero value in the
141 pointer field to indicate the empty variant. */
142 if (strncmp (TYPE_FIELD_NAME (type, 0), RUST_ENUM_PREFIX,
143 strlen (RUST_ENUM_PREFIX)) == 0)
144 {
145 char *tail, *token, *saveptr = NULL;
146 unsigned long fieldno;
147 struct type *member_type;
148 LONGEST value;
149
150 ret.is_encoded = 1;
151
152 if (TYPE_NFIELDS (type) != 1)
153 error (_("Only expected one field in %s type"), RUST_ENUM_PREFIX);
154
155 /* Optimized enums have only one field. */
156 member_type = TYPE_FIELD_TYPE (type, 0);
157
158 std::string name (TYPE_FIELD_NAME (type, 0));
159 tail = &name[0] + strlen (RUST_ENUM_PREFIX);
160
161 /* The location of the value that doubles as a discriminant is
162 stored in the name of the field, as
163 RUST$ENCODED$ENUM$<fieldno>$<fieldno>$...$<variantname>
164 where the fieldnos are the indices of the fields that should be
165 traversed in order to find the field (which may be several fields deep)
166 and the variantname is the name of the variant of the case when the
167 field is zero. */
168 for (token = strtok_r (tail, "$", &saveptr);
169 token != NULL;
170 token = strtok_r (NULL, "$", &saveptr))
171 {
172 if (sscanf (token, "%lu", &fieldno) != 1)
173 {
174 /* We have reached the enum name, which cannot start
175 with a digit. */
176 break;
177 }
178 if (fieldno >= TYPE_NFIELDS (member_type))
179 error (_("%s refers to field after end of member type"),
180 RUST_ENUM_PREFIX);
181
182 embedded_offset += TYPE_FIELD_BITPOS (member_type, fieldno) / 8;
183 member_type = TYPE_FIELD_TYPE (member_type, fieldno);
184 }
185
186 if (token == NULL)
187 error (_("Invalid form for %s"), RUST_ENUM_PREFIX);
188 value = unpack_long (member_type, valaddr + embedded_offset);
189
190 if (value == 0)
191 {
192 ret.field_no = RUST_ENCODED_ENUM_HIDDEN;
193 ret.name = std::string (TYPE_NAME (type)) + "::" + token;
194 }
195 else
196 {
197 ret.field_no = RUST_ENCODED_ENUM_REAL;
198 ret.name = (std::string (TYPE_NAME (type)) + "::"
199 + rust_last_path_segment (TYPE_NAME (TYPE_FIELD_TYPE (type, 0))));
200 }
201
202 return ret;
203 }
204
205 disr_type = TYPE_FIELD_TYPE (type, 0);
206
207 if (TYPE_NFIELDS (disr_type) == 0)
208 {
209 /* This is a bounds check and should never be hit unless Rust
210 has changed its debuginfo format. */
211 error (_("Could not find enum discriminant field"));
212 }
213 else if (TYPE_NFIELDS (type) == 1)
214 {
215 /* Sometimes univariant enums are encoded without a
216 discriminant. In that case, treating it as an encoded enum
217 with the first field being the actual type works. */
218 const char *field_name = TYPE_NAME (TYPE_FIELD_TYPE (type, 0));
219 const char *last = rust_last_path_segment (field_name);
220 ret.name = std::string (TYPE_NAME (type)) + "::" + last;
221 ret.field_no = RUST_ENCODED_ENUM_REAL;
222 ret.is_encoded = 1;
223 return ret;
224 }
225
226 if (strcmp (TYPE_FIELD_NAME (disr_type, 0), "RUST$ENUM$DISR") != 0)
227 error (_("Rust debug format has changed"));
228
229 string_file temp_file;
230 /* The first value of the first field (or any field)
231 is the discriminant value. */
232 c_val_print (TYPE_FIELD_TYPE (disr_type, 0),
233 (embedded_offset + TYPE_FIELD_BITPOS (type, 0) / 8
234 + TYPE_FIELD_BITPOS (disr_type, 0) / 8),
235 address, &temp_file,
236 0, val, &opts);
237
238 ret.name = std::move (temp_file.string ());
239 name_segment = rust_last_path_segment (ret.name.c_str ());
240 if (name_segment != NULL)
241 {
242 for (i = 0; i < TYPE_NFIELDS (type); ++i)
243 {
244 /* Sadly, the discriminant value paths do not match the type
245 field name paths ('core::option::Option::Some' vs
246 'core::option::Some'). However, enum variant names are
247 unique in the last path segment and the generics are not
248 part of this path, so we can just compare those. This is
249 hackish and would be better fixed by improving rustc's
250 metadata for enums. */
251 const char *field_type = TYPE_NAME (TYPE_FIELD_TYPE (type, i));
252
253 if (field_type != NULL
254 && strcmp (name_segment,
255 rust_last_path_segment (field_type)) == 0)
256 {
257 ret.field_no = i;
258 break;
259 }
260 }
261 }
262
263 if (ret.field_no == -1 && !ret.name.empty ())
264 {
265 /* Somehow the discriminant wasn't found. */
266 error (_("Could not find variant of %s with discriminant %s"),
267 TYPE_TAG_NAME (type), ret.name.c_str ());
268 }
269
270 return ret;
271 }
272
273 /* See rust-lang.h. */
274
275 bool
276 rust_tuple_type_p (struct type *type)
277 {
278 /* The current implementation is a bit of a hack, but there's
279 nothing else in the debuginfo to distinguish a tuple from a
280 struct. */
281 return (TYPE_CODE (type) == TYPE_CODE_STRUCT
282 && TYPE_TAG_NAME (type) != NULL
283 && TYPE_TAG_NAME (type)[0] == '(');
284 }
285
286
287 /* Return true if all non-static fields of a structlike type are in a
288 sequence like __0, __1, __2. OFFSET lets us skip fields. */
289
290 static bool
291 rust_underscore_fields (struct type *type, int offset)
292 {
293 int i, field_number;
294
295 field_number = 0;
296
297 if (TYPE_CODE (type) != TYPE_CODE_STRUCT)
298 return false;
299 for (i = 0; i < TYPE_NFIELDS (type); ++i)
300 {
301 if (!field_is_static (&TYPE_FIELD (type, i)))
302 {
303 if (offset > 0)
304 offset--;
305 else
306 {
307 char buf[20];
308
309 xsnprintf (buf, sizeof (buf), "__%d", field_number);
310 if (strcmp (buf, TYPE_FIELD_NAME (type, i)) != 0)
311 return false;
312 field_number++;
313 }
314 }
315 }
316 return true;
317 }
318
319 /* See rust-lang.h. */
320
321 bool
322 rust_tuple_struct_type_p (struct type *type)
323 {
324 /* This is just an approximation until DWARF can represent Rust more
325 precisely. We exclude zero-length structs because they may not
326 be tuple structs, and there's no way to tell. */
327 return TYPE_NFIELDS (type) > 0 && rust_underscore_fields (type, 0);
328 }
329
330 /* Return true if a variant TYPE is a tuple variant, false otherwise. */
331
332 static bool
333 rust_tuple_variant_type_p (struct type *type)
334 {
335 /* First field is discriminant */
336 return rust_underscore_fields (type, 1);
337 }
338
339 /* Return true if TYPE is a slice type, otherwise false. */
340
341 static bool
342 rust_slice_type_p (struct type *type)
343 {
344 return (TYPE_CODE (type) == TYPE_CODE_STRUCT
345 && TYPE_TAG_NAME (type) != NULL
346 && strncmp (TYPE_TAG_NAME (type), "&[", 2) == 0);
347 }
348
349 /* Return true if TYPE is a range type, otherwise false. */
350
351 static bool
352 rust_range_type_p (struct type *type)
353 {
354 int i;
355
356 if (TYPE_CODE (type) != TYPE_CODE_STRUCT
357 || TYPE_NFIELDS (type) > 2
358 || TYPE_TAG_NAME (type) == NULL
359 || strstr (TYPE_TAG_NAME (type), "::Range") == NULL)
360 return false;
361
362 if (TYPE_NFIELDS (type) == 0)
363 return true;
364
365 i = 0;
366 if (strcmp (TYPE_FIELD_NAME (type, 0), "start") == 0)
367 {
368 if (TYPE_NFIELDS (type) == 1)
369 return true;
370 i = 1;
371 }
372 else if (TYPE_NFIELDS (type) == 2)
373 {
374 /* First field had to be "start". */
375 return false;
376 }
377
378 return strcmp (TYPE_FIELD_NAME (type, i), "end") == 0;
379 }
380
381 /* Return true if TYPE seems to be the type "u8", otherwise false. */
382
383 static bool
384 rust_u8_type_p (struct type *type)
385 {
386 return (TYPE_CODE (type) == TYPE_CODE_INT
387 && TYPE_UNSIGNED (type)
388 && TYPE_LENGTH (type) == 1);
389 }
390
391 /* Return true if TYPE is a Rust character type. */
392
393 static bool
394 rust_chartype_p (struct type *type)
395 {
396 return (TYPE_CODE (type) == TYPE_CODE_CHAR
397 && TYPE_LENGTH (type) == 4
398 && TYPE_UNSIGNED (type));
399 }
400
401 \f
402
403 /* la_emitchar implementation for Rust. */
404
405 static void
406 rust_emitchar (int c, struct type *type, struct ui_file *stream, int quoter)
407 {
408 if (!rust_chartype_p (type))
409 generic_emit_char (c, type, stream, quoter,
410 target_charset (get_type_arch (type)));
411 else if (c == '\\' || c == quoter)
412 fprintf_filtered (stream, "\\%c", c);
413 else if (c == '\n')
414 fputs_filtered ("\\n", stream);
415 else if (c == '\r')
416 fputs_filtered ("\\r", stream);
417 else if (c == '\t')
418 fputs_filtered ("\\t", stream);
419 else if (c == '\0')
420 fputs_filtered ("\\0", stream);
421 else if (c >= 32 && c <= 127 && isprint (c))
422 fputc_filtered (c, stream);
423 else if (c <= 255)
424 fprintf_filtered (stream, "\\x%02x", c);
425 else
426 fprintf_filtered (stream, "\\u{%06x}", c);
427 }
428
429 /* la_printchar implementation for Rust. */
430
431 static void
432 rust_printchar (int c, struct type *type, struct ui_file *stream)
433 {
434 fputs_filtered ("'", stream);
435 LA_EMIT_CHAR (c, type, stream, '\'');
436 fputs_filtered ("'", stream);
437 }
438
439 /* la_printstr implementation for Rust. */
440
441 static void
442 rust_printstr (struct ui_file *stream, struct type *type,
443 const gdb_byte *string, unsigned int length,
444 const char *user_encoding, int force_ellipses,
445 const struct value_print_options *options)
446 {
447 /* Rust always uses UTF-8, but let the caller override this if need
448 be. */
449 const char *encoding = user_encoding;
450 if (user_encoding == NULL || !*user_encoding)
451 {
452 /* In Rust strings, characters are "u8". */
453 if (rust_u8_type_p (type))
454 encoding = "UTF-8";
455 else
456 {
457 /* This is probably some C string, so let's let C deal with
458 it. */
459 c_printstr (stream, type, string, length, user_encoding,
460 force_ellipses, options);
461 return;
462 }
463 }
464
465 /* This is not ideal as it doesn't use our character printer. */
466 generic_printstr (stream, type, string, length, encoding, force_ellipses,
467 '"', 0, options);
468 }
469
470 \f
471
472 /* rust_print_type branch for structs and untagged unions. */
473
474 static void
475 val_print_struct (struct type *type, int embedded_offset,
476 CORE_ADDR address, struct ui_file *stream,
477 int recurse, struct value *val,
478 const struct value_print_options *options)
479 {
480 int i;
481 int first_field;
482 bool is_tuple = rust_tuple_type_p (type);
483 bool is_tuple_struct = !is_tuple && rust_tuple_struct_type_p (type);
484 struct value_print_options opts;
485
486 if (!is_tuple)
487 {
488 if (TYPE_TAG_NAME (type) != NULL)
489 fprintf_filtered (stream, "%s", TYPE_TAG_NAME (type));
490
491 if (TYPE_NFIELDS (type) == 0)
492 return;
493
494 if (TYPE_TAG_NAME (type) != NULL)
495 fputs_filtered (" ", stream);
496 }
497
498 if (is_tuple || is_tuple_struct)
499 fputs_filtered ("(", stream);
500 else
501 fputs_filtered ("{", stream);
502
503 opts = *options;
504 opts.deref_ref = 0;
505
506 first_field = 1;
507 for (i = 0; i < TYPE_NFIELDS (type); ++i)
508 {
509 if (field_is_static (&TYPE_FIELD (type, i)))
510 continue;
511
512 if (!first_field)
513 fputs_filtered (",", stream);
514
515 if (options->prettyformat)
516 {
517 fputs_filtered ("\n", stream);
518 print_spaces_filtered (2 + 2 * recurse, stream);
519 }
520 else if (!first_field)
521 fputs_filtered (" ", stream);
522
523 first_field = 0;
524
525 if (!is_tuple && !is_tuple_struct)
526 {
527 fputs_filtered (TYPE_FIELD_NAME (type, i), stream);
528 fputs_filtered (": ", stream);
529 }
530
531 val_print (TYPE_FIELD_TYPE (type, i),
532 embedded_offset + TYPE_FIELD_BITPOS (type, i) / 8,
533 address,
534 stream, recurse + 1, val, &opts,
535 current_language);
536 }
537
538 if (options->prettyformat)
539 {
540 fputs_filtered ("\n", stream);
541 print_spaces_filtered (2 * recurse, stream);
542 }
543
544 if (is_tuple || is_tuple_struct)
545 fputs_filtered (")", stream);
546 else
547 fputs_filtered ("}", stream);
548 }
549
550 static const struct generic_val_print_decorations rust_decorations =
551 {
552 /* Complex isn't used in Rust, but we provide C-ish values just in
553 case. */
554 "",
555 " + ",
556 " * I",
557 "true",
558 "false",
559 "()",
560 "[",
561 "]"
562 };
563
564 /* la_val_print implementation for Rust. */
565
566 static void
567 rust_val_print (struct type *type, int embedded_offset,
568 CORE_ADDR address, struct ui_file *stream, int recurse,
569 struct value *val,
570 const struct value_print_options *options)
571 {
572 const gdb_byte *valaddr = value_contents_for_printing (val);
573
574 type = check_typedef (type);
575 switch (TYPE_CODE (type))
576 {
577 case TYPE_CODE_PTR:
578 {
579 LONGEST low_bound, high_bound;
580
581 if (TYPE_CODE (TYPE_TARGET_TYPE (type)) == TYPE_CODE_ARRAY
582 && rust_u8_type_p (TYPE_TARGET_TYPE (TYPE_TARGET_TYPE (type)))
583 && get_array_bounds (TYPE_TARGET_TYPE (type), &low_bound,
584 &high_bound)) {
585 /* We have a pointer to a byte string, so just print
586 that. */
587 struct type *elttype = check_typedef (TYPE_TARGET_TYPE (type));
588 CORE_ADDR addr;
589 struct gdbarch *arch = get_type_arch (type);
590 int unit_size = gdbarch_addressable_memory_unit_size (arch);
591
592 addr = unpack_pointer (type, valaddr + embedded_offset * unit_size);
593 if (options->addressprint)
594 {
595 fputs_filtered (paddress (arch, addr), stream);
596 fputs_filtered (" ", stream);
597 }
598
599 fputs_filtered ("b", stream);
600 val_print_string (TYPE_TARGET_TYPE (elttype), "ASCII", addr,
601 high_bound - low_bound + 1, stream,
602 options);
603 break;
604 }
605 }
606 /* Fall through. */
607
608 case TYPE_CODE_METHODPTR:
609 case TYPE_CODE_MEMBERPTR:
610 c_val_print (type, embedded_offset, address, stream,
611 recurse, val, options);
612 break;
613
614 case TYPE_CODE_INT:
615 /* Recognize the unit type. */
616 if (TYPE_UNSIGNED (type) && TYPE_LENGTH (type) == 0
617 && TYPE_NAME (type) != NULL && strcmp (TYPE_NAME (type), "()") == 0)
618 {
619 fputs_filtered ("()", stream);
620 break;
621 }
622 goto generic_print;
623
624 case TYPE_CODE_STRING:
625 {
626 struct gdbarch *arch = get_type_arch (type);
627 int unit_size = gdbarch_addressable_memory_unit_size (arch);
628 LONGEST low_bound, high_bound;
629
630 if (!get_array_bounds (type, &low_bound, &high_bound))
631 error (_("Could not determine the array bounds"));
632
633 /* If we see a plain TYPE_CODE_STRING, then we're printing a
634 byte string, hence the choice of "ASCII" as the
635 encoding. */
636 fputs_filtered ("b", stream);
637 rust_printstr (stream, TYPE_TARGET_TYPE (type),
638 valaddr + embedded_offset * unit_size,
639 high_bound - low_bound + 1, "ASCII", 0, options);
640 }
641 break;
642
643 case TYPE_CODE_ARRAY:
644 {
645 LONGEST low_bound, high_bound;
646
647 if (get_array_bounds (type, &low_bound, &high_bound)
648 && high_bound - low_bound + 1 == 0)
649 fputs_filtered ("[]", stream);
650 else
651 goto generic_print;
652 }
653 break;
654
655 case TYPE_CODE_UNION:
656 {
657 int j, nfields, first_field, is_tuple, start;
658 struct type *variant_type;
659 struct disr_info disr;
660 struct value_print_options opts;
661
662 /* Untagged unions are printed as if they are structs.
663 Since the field bit positions overlap in the debuginfo,
664 the code for printing a union is same as that for a struct,
665 the only difference is that the input type will have overlapping
666 fields. */
667 if (rust_union_is_untagged (type))
668 {
669 val_print_struct (type, embedded_offset, address, stream,
670 recurse, val, options);
671 break;
672 }
673
674 opts = *options;
675 opts.deref_ref = 0;
676
677 disr = rust_get_disr_info (type, valaddr, embedded_offset, address,
678 val);
679
680 if (disr.is_encoded && disr.field_no == RUST_ENCODED_ENUM_HIDDEN)
681 {
682 fprintf_filtered (stream, "%s", disr.name.c_str ());
683 break;
684 }
685
686 first_field = 1;
687 variant_type = TYPE_FIELD_TYPE (type, disr.field_no);
688 nfields = TYPE_NFIELDS (variant_type);
689
690 is_tuple = (disr.is_encoded
691 ? rust_tuple_struct_type_p (variant_type)
692 : rust_tuple_variant_type_p (variant_type));
693 start = disr.is_encoded ? 0 : 1;
694
695 if (nfields > start)
696 {
697 /* In case of a non-nullary variant, we output 'Foo(x,y,z)'. */
698 if (is_tuple)
699 fprintf_filtered (stream, "%s(", disr.name.c_str ());
700 else
701 {
702 /* struct variant. */
703 fprintf_filtered (stream, "%s{", disr.name.c_str ());
704 }
705 }
706 else
707 {
708 /* In case of a nullary variant like 'None', just output
709 the name. */
710 fprintf_filtered (stream, "%s", disr.name.c_str ());
711 break;
712 }
713
714 for (j = start; j < TYPE_NFIELDS (variant_type); j++)
715 {
716 if (!first_field)
717 fputs_filtered (", ", stream);
718 first_field = 0;
719
720 if (!is_tuple)
721 fprintf_filtered (stream, "%s: ",
722 TYPE_FIELD_NAME (variant_type, j));
723
724 val_print (TYPE_FIELD_TYPE (variant_type, j),
725 (embedded_offset
726 + TYPE_FIELD_BITPOS (type, disr.field_no) / 8
727 + TYPE_FIELD_BITPOS (variant_type, j) / 8),
728 address,
729 stream, recurse + 1, val, &opts,
730 current_language);
731 }
732
733 if (is_tuple)
734 fputs_filtered (")", stream);
735 else
736 fputs_filtered ("}", stream);
737 }
738 break;
739
740 case TYPE_CODE_STRUCT:
741 val_print_struct (type, embedded_offset, address, stream,
742 recurse, val, options);
743 break;
744
745 default:
746 generic_print:
747 /* Nothing special yet. */
748 generic_val_print (type, embedded_offset, address, stream,
749 recurse, val, options, &rust_decorations);
750 }
751 }
752
753 \f
754
755 static void
756 rust_print_type (struct type *type, const char *varstring,
757 struct ui_file *stream, int show, int level,
758 const struct type_print_options *flags);
759
760 /* Print a struct or union typedef. */
761 static void
762 rust_print_struct_def (struct type *type, const char *varstring,
763 struct ui_file *stream, int show, int level,
764 const struct type_print_options *flags)
765 {
766 bool is_tuple_struct;
767 int i;
768
769 /* Print a tuple type simply. */
770 if (rust_tuple_type_p (type))
771 {
772 fputs_filtered (TYPE_TAG_NAME (type), stream);
773 return;
774 }
775
776 /* If we see a base class, delegate to C. */
777 if (TYPE_N_BASECLASSES (type) > 0)
778 c_print_type (type, varstring, stream, show, level, flags);
779
780 /* This code path is also used by unions. */
781 if (TYPE_CODE (type) == TYPE_CODE_STRUCT)
782 fputs_filtered ("struct ", stream);
783 else
784 fputs_filtered ("union ", stream);
785
786 if (TYPE_TAG_NAME (type) != NULL)
787 fputs_filtered (TYPE_TAG_NAME (type), stream);
788
789 is_tuple_struct = rust_tuple_struct_type_p (type);
790
791 if (TYPE_NFIELDS (type) == 0 && !rust_tuple_type_p (type))
792 return;
793 fputs_filtered (is_tuple_struct ? " (\n" : " {\n", stream);
794
795 for (i = 0; i < TYPE_NFIELDS (type); ++i)
796 {
797 const char *name;
798
799 QUIT;
800 if (field_is_static (&TYPE_FIELD (type, i)))
801 continue;
802
803 /* We'd like to print "pub" here as needed, but rustc
804 doesn't emit the debuginfo, and our types don't have
805 cplus_struct_type attached. */
806
807 /* For a tuple struct we print the type but nothing
808 else. */
809 print_spaces_filtered (level + 2, stream);
810 if (!is_tuple_struct)
811 fprintf_filtered (stream, "%s: ", TYPE_FIELD_NAME (type, i));
812
813 rust_print_type (TYPE_FIELD_TYPE (type, i), NULL,
814 stream, show - 1, level + 2,
815 flags);
816 fputs_filtered (",\n", stream);
817 }
818
819 fprintfi_filtered (level, stream, is_tuple_struct ? ")" : "}");
820 }
821
822 /* la_print_typedef implementation for Rust. */
823
824 static void
825 rust_print_typedef (struct type *type,
826 struct symbol *new_symbol,
827 struct ui_file *stream)
828 {
829 type = check_typedef (type);
830 fprintf_filtered (stream, "type %s = ", SYMBOL_PRINT_NAME (new_symbol));
831 type_print (type, "", stream, 0);
832 fprintf_filtered (stream, ";\n");
833 }
834
835 /* la_print_type implementation for Rust. */
836
837 static void
838 rust_print_type (struct type *type, const char *varstring,
839 struct ui_file *stream, int show, int level,
840 const struct type_print_options *flags)
841 {
842 int i;
843
844 QUIT;
845 if (show <= 0
846 && TYPE_NAME (type) != NULL)
847 {
848 /* Rust calls the unit type "void" in its debuginfo,
849 but we don't want to print it as that. */
850 if (TYPE_CODE (type) == TYPE_CODE_VOID)
851 fputs_filtered ("()", stream);
852 else
853 fputs_filtered (TYPE_NAME (type), stream);
854 return;
855 }
856
857 type = check_typedef (type);
858 switch (TYPE_CODE (type))
859 {
860 case TYPE_CODE_VOID:
861 fputs_filtered ("()", stream);
862 break;
863
864 case TYPE_CODE_FUNC:
865 /* Delegate varargs to the C printer. */
866 if (TYPE_VARARGS (type))
867 goto c_printer;
868
869 fputs_filtered ("fn ", stream);
870 if (varstring != NULL)
871 fputs_filtered (varstring, stream);
872 fputs_filtered ("(", stream);
873 for (i = 0; i < TYPE_NFIELDS (type); ++i)
874 {
875 QUIT;
876 if (i > 0)
877 fputs_filtered (", ", stream);
878 rust_print_type (TYPE_FIELD_TYPE (type, i), "", stream, -1, 0,
879 flags);
880 }
881 fputs_filtered (")", stream);
882 /* If it returns unit, we can omit the return type. */
883 if (TYPE_CODE (TYPE_TARGET_TYPE (type)) != TYPE_CODE_VOID)
884 {
885 fputs_filtered (" -> ", stream);
886 rust_print_type (TYPE_TARGET_TYPE (type), "", stream, -1, 0, flags);
887 }
888 break;
889
890 case TYPE_CODE_ARRAY:
891 {
892 LONGEST low_bound, high_bound;
893
894 fputs_filtered ("[", stream);
895 rust_print_type (TYPE_TARGET_TYPE (type), NULL,
896 stream, show - 1, level, flags);
897 fputs_filtered ("; ", stream);
898
899 if (TYPE_HIGH_BOUND_KIND (TYPE_INDEX_TYPE (type)) == PROP_LOCEXPR
900 || TYPE_HIGH_BOUND_KIND (TYPE_INDEX_TYPE (type)) == PROP_LOCLIST)
901 fprintf_filtered (stream, "variable length");
902 else if (get_array_bounds (type, &low_bound, &high_bound))
903 fprintf_filtered (stream, "%s",
904 plongest (high_bound - low_bound + 1));
905 fputs_filtered ("]", stream);
906 }
907 break;
908
909 case TYPE_CODE_STRUCT:
910 rust_print_struct_def (type, varstring, stream, show, level, flags);
911 break;
912
913 case TYPE_CODE_ENUM:
914 {
915 int i, len = 0;
916
917 fputs_filtered ("enum ", stream);
918 if (TYPE_TAG_NAME (type) != NULL)
919 {
920 fputs_filtered (TYPE_TAG_NAME (type), stream);
921 fputs_filtered (" ", stream);
922 len = strlen (TYPE_TAG_NAME (type));
923 }
924 fputs_filtered ("{\n", stream);
925
926 for (i = 0; i < TYPE_NFIELDS (type); ++i)
927 {
928 const char *name = TYPE_FIELD_NAME (type, i);
929
930 QUIT;
931
932 if (len > 0
933 && strncmp (name, TYPE_TAG_NAME (type), len) == 0
934 && name[len] == ':'
935 && name[len + 1] == ':')
936 name += len + 2;
937 fprintfi_filtered (level + 2, stream, "%s,\n", name);
938 }
939
940 fputs_filtered ("}", stream);
941 }
942 break;
943
944 case TYPE_CODE_UNION:
945 {
946 /* ADT enums. */
947 int i, len = 0;
948 /* Skip the discriminant field. */
949 int skip_to = 1;
950
951 /* Unions and structs have the same syntax in Rust,
952 the only difference is that structs are declared with `struct`
953 and union with `union`. This difference is handled in the struct
954 printer. */
955 if (rust_union_is_untagged (type))
956 {
957 rust_print_struct_def (type, varstring, stream, show, level, flags);
958 break;
959 }
960
961 fputs_filtered ("enum ", stream);
962 if (TYPE_TAG_NAME (type) != NULL)
963 {
964 fputs_filtered (TYPE_TAG_NAME (type), stream);
965 fputs_filtered (" ", stream);
966 }
967 fputs_filtered ("{\n", stream);
968
969 if (strncmp (TYPE_FIELD_NAME (type, 0), RUST_ENUM_PREFIX,
970 strlen (RUST_ENUM_PREFIX)) == 0)
971 {
972 const char *zero_field = strrchr (TYPE_FIELD_NAME (type, 0), '$');
973 if (zero_field != NULL && strlen (zero_field) > 1)
974 {
975 fprintfi_filtered (level + 2, stream, "%s,\n", zero_field + 1);
976 /* There is no explicit discriminant field, skip nothing. */
977 skip_to = 0;
978 }
979 }
980 else if (TYPE_NFIELDS (type) == 1)
981 skip_to = 0;
982
983 for (i = 0; i < TYPE_NFIELDS (type); ++i)
984 {
985 struct type *variant_type = TYPE_FIELD_TYPE (type, i);
986 const char *name
987 = rust_last_path_segment (TYPE_NAME (variant_type));
988
989 fprintfi_filtered (level + 2, stream, "%s", name);
990
991 if (TYPE_NFIELDS (variant_type) > skip_to)
992 {
993 int first = 1;
994 bool is_tuple = (TYPE_NFIELDS (type) == 1
995 ? rust_tuple_struct_type_p (variant_type)
996 : rust_tuple_variant_type_p (variant_type));
997 int j;
998
999 fputs_filtered (is_tuple ? "(" : "{", stream);
1000 for (j = skip_to; j < TYPE_NFIELDS (variant_type); j++)
1001 {
1002 if (first)
1003 first = 0;
1004 else
1005 fputs_filtered (", ", stream);
1006
1007 if (!is_tuple)
1008 fprintf_filtered (stream, "%s: ",
1009 TYPE_FIELD_NAME (variant_type, j));
1010
1011 rust_print_type (TYPE_FIELD_TYPE (variant_type, j), NULL,
1012 stream, show - 1, level + 2,
1013 flags);
1014 }
1015 fputs_filtered (is_tuple ? ")" : "}", stream);
1016 }
1017
1018 fputs_filtered (",\n", stream);
1019 }
1020
1021 fputs_filtered ("}", stream);
1022 }
1023 break;
1024
1025 default:
1026 c_printer:
1027 c_print_type (type, varstring, stream, show, level, flags);
1028 }
1029 }
1030
1031 \f
1032
1033 /* Compute the alignment of the type T. */
1034
1035 static int
1036 rust_type_alignment (struct type *t)
1037 {
1038 t = check_typedef (t);
1039 switch (TYPE_CODE (t))
1040 {
1041 default:
1042 error (_("Could not compute alignment of type"));
1043
1044 case TYPE_CODE_PTR:
1045 case TYPE_CODE_ENUM:
1046 case TYPE_CODE_INT:
1047 case TYPE_CODE_FLT:
1048 case TYPE_CODE_REF:
1049 case TYPE_CODE_CHAR:
1050 case TYPE_CODE_BOOL:
1051 return TYPE_LENGTH (t);
1052
1053 case TYPE_CODE_ARRAY:
1054 case TYPE_CODE_COMPLEX:
1055 return rust_type_alignment (TYPE_TARGET_TYPE (t));
1056
1057 case TYPE_CODE_STRUCT:
1058 case TYPE_CODE_UNION:
1059 {
1060 int i;
1061 int align = 1;
1062
1063 for (i = 0; i < TYPE_NFIELDS (t); ++i)
1064 {
1065 int a = rust_type_alignment (TYPE_FIELD_TYPE (t, i));
1066 if (a > align)
1067 align = a;
1068 }
1069 return align;
1070 }
1071 }
1072 }
1073
1074 /* Like arch_composite_type, but uses TYPE to decide how to allocate
1075 -- either on an obstack or on a gdbarch. */
1076
1077 static struct type *
1078 rust_composite_type (struct type *original,
1079 const char *name,
1080 const char *field1, struct type *type1,
1081 const char *field2, struct type *type2)
1082 {
1083 struct type *result = alloc_type_copy (original);
1084 int i, nfields, bitpos;
1085
1086 nfields = 0;
1087 if (field1 != NULL)
1088 ++nfields;
1089 if (field2 != NULL)
1090 ++nfields;
1091
1092 TYPE_CODE (result) = TYPE_CODE_STRUCT;
1093 TYPE_NAME (result) = name;
1094 TYPE_TAG_NAME (result) = name;
1095
1096 TYPE_NFIELDS (result) = nfields;
1097 TYPE_FIELDS (result)
1098 = (struct field *) TYPE_ZALLOC (result, nfields * sizeof (struct field));
1099
1100 i = 0;
1101 bitpos = 0;
1102 if (field1 != NULL)
1103 {
1104 struct field *field = &TYPE_FIELD (result, i);
1105
1106 SET_FIELD_BITPOS (*field, bitpos);
1107 bitpos += TYPE_LENGTH (type1) * TARGET_CHAR_BIT;
1108
1109 FIELD_NAME (*field) = field1;
1110 FIELD_TYPE (*field) = type1;
1111 ++i;
1112 }
1113 if (field2 != NULL)
1114 {
1115 struct field *field = &TYPE_FIELD (result, i);
1116 int align = rust_type_alignment (type2);
1117
1118 if (align != 0)
1119 {
1120 int delta;
1121
1122 align *= TARGET_CHAR_BIT;
1123 delta = bitpos % align;
1124 if (delta != 0)
1125 bitpos += align - delta;
1126 }
1127 SET_FIELD_BITPOS (*field, bitpos);
1128
1129 FIELD_NAME (*field) = field2;
1130 FIELD_TYPE (*field) = type2;
1131 ++i;
1132 }
1133
1134 if (i > 0)
1135 TYPE_LENGTH (result)
1136 = (TYPE_FIELD_BITPOS (result, i - 1) / TARGET_CHAR_BIT +
1137 TYPE_LENGTH (TYPE_FIELD_TYPE (result, i - 1)));
1138 return result;
1139 }
1140
1141 /* See rust-lang.h. */
1142
1143 struct type *
1144 rust_slice_type (const char *name, struct type *elt_type,
1145 struct type *usize_type)
1146 {
1147 struct type *type;
1148
1149 elt_type = lookup_pointer_type (elt_type);
1150 type = rust_composite_type (elt_type, name,
1151 "data_ptr", elt_type,
1152 "length", usize_type);
1153
1154 return type;
1155 }
1156
1157 enum rust_primitive_types
1158 {
1159 rust_primitive_bool,
1160 rust_primitive_char,
1161 rust_primitive_i8,
1162 rust_primitive_u8,
1163 rust_primitive_i16,
1164 rust_primitive_u16,
1165 rust_primitive_i32,
1166 rust_primitive_u32,
1167 rust_primitive_i64,
1168 rust_primitive_u64,
1169 rust_primitive_isize,
1170 rust_primitive_usize,
1171 rust_primitive_f32,
1172 rust_primitive_f64,
1173 rust_primitive_unit,
1174 rust_primitive_str,
1175 nr_rust_primitive_types
1176 };
1177
1178 /* la_language_arch_info implementation for Rust. */
1179
1180 static void
1181 rust_language_arch_info (struct gdbarch *gdbarch,
1182 struct language_arch_info *lai)
1183 {
1184 const struct builtin_type *builtin = builtin_type (gdbarch);
1185 struct type *tem;
1186 struct type **types;
1187 unsigned int length;
1188
1189 types = GDBARCH_OBSTACK_CALLOC (gdbarch, nr_rust_primitive_types + 1,
1190 struct type *);
1191
1192 types[rust_primitive_bool] = arch_boolean_type (gdbarch, 8, 1, "bool");
1193 types[rust_primitive_char] = arch_character_type (gdbarch, 32, 1, "char");
1194 types[rust_primitive_i8] = arch_integer_type (gdbarch, 8, 0, "i8");
1195 types[rust_primitive_u8] = arch_integer_type (gdbarch, 8, 1, "u8");
1196 types[rust_primitive_i16] = arch_integer_type (gdbarch, 16, 0, "i16");
1197 types[rust_primitive_u16] = arch_integer_type (gdbarch, 16, 1, "u16");
1198 types[rust_primitive_i32] = arch_integer_type (gdbarch, 32, 0, "i32");
1199 types[rust_primitive_u32] = arch_integer_type (gdbarch, 32, 1, "u32");
1200 types[rust_primitive_i64] = arch_integer_type (gdbarch, 64, 0, "i64");
1201 types[rust_primitive_u64] = arch_integer_type (gdbarch, 64, 1, "u64");
1202
1203 length = 8 * TYPE_LENGTH (builtin->builtin_data_ptr);
1204 types[rust_primitive_isize] = arch_integer_type (gdbarch, length, 0, "isize");
1205 types[rust_primitive_usize] = arch_integer_type (gdbarch, length, 1, "usize");
1206
1207 types[rust_primitive_f32] = arch_float_type (gdbarch, 32, "f32",
1208 floatformats_ieee_single);
1209 types[rust_primitive_f64] = arch_float_type (gdbarch, 64, "f64",
1210 floatformats_ieee_double);
1211
1212 types[rust_primitive_unit] = arch_integer_type (gdbarch, 0, 1, "()");
1213
1214 tem = make_cv_type (1, 0, types[rust_primitive_u8], NULL);
1215 types[rust_primitive_str] = rust_slice_type ("&str", tem,
1216 types[rust_primitive_usize]);
1217
1218 lai->primitive_type_vector = types;
1219 lai->bool_type_default = types[rust_primitive_bool];
1220 lai->string_char_type = types[rust_primitive_u8];
1221 }
1222
1223 \f
1224
1225 /* A helper for rust_evaluate_subexp that handles OP_FUNCALL. */
1226
1227 static struct value *
1228 rust_evaluate_funcall (struct expression *exp, int *pos, enum noside noside)
1229 {
1230 int i;
1231 int num_args = exp->elts[*pos + 1].longconst;
1232 const char *method;
1233 struct value *function, *result, *arg0;
1234 struct type *type, *fn_type;
1235 const struct block *block;
1236 struct block_symbol sym;
1237
1238 /* For an ordinary function call we can simply defer to the
1239 generic implementation. */
1240 if (exp->elts[*pos + 3].opcode != STRUCTOP_STRUCT)
1241 return evaluate_subexp_standard (NULL, exp, pos, noside);
1242
1243 /* Skip over the OP_FUNCALL and the STRUCTOP_STRUCT. */
1244 *pos += 4;
1245 method = &exp->elts[*pos + 1].string;
1246 *pos += 3 + BYTES_TO_EXP_ELEM (exp->elts[*pos].longconst + 1);
1247
1248 /* Evaluate the argument to STRUCTOP_STRUCT, then find its
1249 type in order to look up the method. */
1250 arg0 = evaluate_subexp (NULL_TYPE, exp, pos, noside);
1251
1252 if (noside == EVAL_SKIP)
1253 {
1254 for (i = 0; i < num_args; ++i)
1255 evaluate_subexp (NULL_TYPE, exp, pos, noside);
1256 return arg0;
1257 }
1258
1259 std::vector<struct value *> args (num_args + 1);
1260 args[0] = arg0;
1261
1262 /* We don't yet implement real Deref semantics. */
1263 while (TYPE_CODE (value_type (args[0])) == TYPE_CODE_PTR)
1264 args[0] = value_ind (args[0]);
1265
1266 type = value_type (args[0]);
1267 if ((TYPE_CODE (type) != TYPE_CODE_STRUCT
1268 && TYPE_CODE (type) != TYPE_CODE_UNION
1269 && TYPE_CODE (type) != TYPE_CODE_ENUM)
1270 || rust_tuple_type_p (type))
1271 error (_("Method calls only supported on struct or enum types"));
1272 if (TYPE_TAG_NAME (type) == NULL)
1273 error (_("Method call on nameless type"));
1274
1275 std::string name = std::string (TYPE_TAG_NAME (type)) + "::" + method;
1276
1277 block = get_selected_block (0);
1278 sym = lookup_symbol (name.c_str (), block, VAR_DOMAIN, NULL);
1279 if (sym.symbol == NULL)
1280 error (_("Could not find function named '%s'"), name.c_str ());
1281
1282 fn_type = SYMBOL_TYPE (sym.symbol);
1283 if (TYPE_NFIELDS (fn_type) == 0)
1284 error (_("Function '%s' takes no arguments"), name.c_str ());
1285
1286 if (TYPE_CODE (TYPE_FIELD_TYPE (fn_type, 0)) == TYPE_CODE_PTR)
1287 args[0] = value_addr (args[0]);
1288
1289 function = address_of_variable (sym.symbol, block);
1290
1291 for (i = 0; i < num_args; ++i)
1292 args[i + 1] = evaluate_subexp (NULL_TYPE, exp, pos, noside);
1293
1294 if (noside == EVAL_AVOID_SIDE_EFFECTS)
1295 result = value_zero (TYPE_TARGET_TYPE (fn_type), not_lval);
1296 else
1297 result = call_function_by_hand (function, num_args + 1, args.data ());
1298 return result;
1299 }
1300
1301 /* A helper for rust_evaluate_subexp that handles OP_RANGE. */
1302
1303 static struct value *
1304 rust_range (struct expression *exp, int *pos, enum noside noside)
1305 {
1306 enum range_type kind;
1307 struct value *low = NULL, *high = NULL;
1308 struct value *addrval, *result;
1309 CORE_ADDR addr;
1310 struct type *range_type;
1311 struct type *index_type;
1312 struct type *temp_type;
1313 const char *name;
1314
1315 kind = (enum range_type) longest_to_int (exp->elts[*pos + 1].longconst);
1316 *pos += 3;
1317
1318 if (kind == HIGH_BOUND_DEFAULT || kind == NONE_BOUND_DEFAULT)
1319 low = evaluate_subexp (NULL_TYPE, exp, pos, noside);
1320 if (kind == LOW_BOUND_DEFAULT || kind == NONE_BOUND_DEFAULT)
1321 high = evaluate_subexp (NULL_TYPE, exp, pos, noside);
1322
1323 if (noside == EVAL_SKIP)
1324 return value_from_longest (builtin_type (exp->gdbarch)->builtin_int, 1);
1325
1326 if (low == NULL)
1327 {
1328 if (high == NULL)
1329 {
1330 index_type = NULL;
1331 name = "std::ops::RangeFull";
1332 }
1333 else
1334 {
1335 index_type = value_type (high);
1336 name = "std::ops::RangeTo";
1337 }
1338 }
1339 else
1340 {
1341 if (high == NULL)
1342 {
1343 index_type = value_type (low);
1344 name = "std::ops::RangeFrom";
1345 }
1346 else
1347 {
1348 if (!types_equal (value_type (low), value_type (high)))
1349 error (_("Range expression with different types"));
1350 index_type = value_type (low);
1351 name = "std::ops::Range";
1352 }
1353 }
1354
1355 /* If we don't have an index type, just allocate this on the
1356 arch. Here any type will do. */
1357 temp_type = (index_type == NULL
1358 ? language_bool_type (exp->language_defn, exp->gdbarch)
1359 : index_type);
1360 /* It would be nicer to cache the range type. */
1361 range_type = rust_composite_type (temp_type, name,
1362 low == NULL ? NULL : "start", index_type,
1363 high == NULL ? NULL : "end", index_type);
1364
1365 if (noside == EVAL_AVOID_SIDE_EFFECTS)
1366 return value_zero (range_type, lval_memory);
1367
1368 addrval = value_allocate_space_in_inferior (TYPE_LENGTH (range_type));
1369 addr = value_as_long (addrval);
1370 result = value_at_lazy (range_type, addr);
1371
1372 if (low != NULL)
1373 {
1374 struct value *start = value_struct_elt (&result, NULL, "start", NULL,
1375 "range");
1376
1377 value_assign (start, low);
1378 }
1379
1380 if (high != NULL)
1381 {
1382 struct value *end = value_struct_elt (&result, NULL, "end", NULL,
1383 "range");
1384
1385 value_assign (end, high);
1386 }
1387
1388 result = value_at_lazy (range_type, addr);
1389 return result;
1390 }
1391
1392 /* A helper function to compute the range and kind given a range
1393 value. TYPE is the type of the range value. RANGE is the range
1394 value. LOW, HIGH, and KIND are out parameters. The LOW and HIGH
1395 parameters might be filled in, or might not be, depending on the
1396 kind of range this is. KIND will always be set to the appropriate
1397 value describing the kind of range, and this can be used to
1398 determine whether LOW or HIGH are valid. */
1399
1400 static void
1401 rust_compute_range (struct type *type, struct value *range,
1402 LONGEST *low, LONGEST *high,
1403 enum range_type *kind)
1404 {
1405 int i;
1406
1407 *low = 0;
1408 *high = 0;
1409 *kind = BOTH_BOUND_DEFAULT;
1410
1411 if (TYPE_NFIELDS (type) == 0)
1412 return;
1413
1414 i = 0;
1415 if (strcmp (TYPE_FIELD_NAME (type, 0), "start") == 0)
1416 {
1417 *kind = HIGH_BOUND_DEFAULT;
1418 *low = value_as_long (value_field (range, 0));
1419 ++i;
1420 }
1421 if (TYPE_NFIELDS (type) > i
1422 && strcmp (TYPE_FIELD_NAME (type, i), "end") == 0)
1423 {
1424 *kind = (*kind == BOTH_BOUND_DEFAULT
1425 ? LOW_BOUND_DEFAULT : NONE_BOUND_DEFAULT);
1426 *high = value_as_long (value_field (range, i));
1427 }
1428 }
1429
1430 /* A helper for rust_evaluate_subexp that handles BINOP_SUBSCRIPT. */
1431
1432 static struct value *
1433 rust_subscript (struct expression *exp, int *pos, enum noside noside,
1434 int for_addr)
1435 {
1436 struct value *lhs, *rhs, *result;
1437 struct type *rhstype;
1438 LONGEST low, high_bound;
1439 /* Initialized to appease the compiler. */
1440 enum range_type kind = BOTH_BOUND_DEFAULT;
1441 LONGEST high = 0;
1442 int want_slice = 0;
1443
1444 ++*pos;
1445 lhs = evaluate_subexp (NULL_TYPE, exp, pos, noside);
1446 rhs = evaluate_subexp (NULL_TYPE, exp, pos, noside);
1447
1448 if (noside == EVAL_SKIP)
1449 return lhs;
1450
1451 rhstype = check_typedef (value_type (rhs));
1452 if (rust_range_type_p (rhstype))
1453 {
1454 if (!for_addr)
1455 error (_("Can't take slice of array without '&'"));
1456 rust_compute_range (rhstype, rhs, &low, &high, &kind);
1457 want_slice = 1;
1458 }
1459 else
1460 low = value_as_long (rhs);
1461
1462 if (noside == EVAL_AVOID_SIDE_EFFECTS)
1463 {
1464 struct type *type = check_typedef (value_type (lhs));
1465
1466 result = value_zero (TYPE_TARGET_TYPE (type), VALUE_LVAL (lhs));
1467 }
1468 else
1469 {
1470 LONGEST low_bound;
1471 struct value *base;
1472 struct type *type = check_typedef (value_type (lhs));
1473
1474 if (TYPE_CODE (type) == TYPE_CODE_ARRAY)
1475 {
1476 base = lhs;
1477 if (!get_array_bounds (type, &low_bound, &high_bound))
1478 error (_("Can't compute array bounds"));
1479 if (low_bound != 0)
1480 error (_("Found array with non-zero lower bound"));
1481 ++high_bound;
1482 }
1483 else if (rust_slice_type_p (type))
1484 {
1485 struct value *len;
1486
1487 base = value_struct_elt (&lhs, NULL, "data_ptr", NULL, "slice");
1488 len = value_struct_elt (&lhs, NULL, "length", NULL, "slice");
1489 low_bound = 0;
1490 high_bound = value_as_long (len);
1491 }
1492 else if (TYPE_CODE (type) == TYPE_CODE_PTR)
1493 {
1494 base = lhs;
1495 low_bound = 0;
1496 high_bound = LONGEST_MAX;
1497 }
1498 else
1499 error (_("Cannot subscript non-array type"));
1500
1501 if (want_slice
1502 && (kind == BOTH_BOUND_DEFAULT || kind == LOW_BOUND_DEFAULT))
1503 low = low_bound;
1504 if (low < 0)
1505 error (_("Index less than zero"));
1506 if (low > high_bound)
1507 error (_("Index greater than length"));
1508
1509 result = value_subscript (base, low);
1510 }
1511
1512 if (for_addr)
1513 {
1514 if (want_slice)
1515 {
1516 struct type *usize, *slice;
1517 CORE_ADDR addr;
1518 struct value *addrval, *tem;
1519
1520 if (kind == BOTH_BOUND_DEFAULT || kind == HIGH_BOUND_DEFAULT)
1521 high = high_bound;
1522 if (high < 0)
1523 error (_("High index less than zero"));
1524 if (low > high)
1525 error (_("Low index greater than high index"));
1526 if (high > high_bound)
1527 error (_("High index greater than length"));
1528
1529 usize = language_lookup_primitive_type (exp->language_defn,
1530 exp->gdbarch,
1531 "usize");
1532 slice = rust_slice_type ("&[*gdb*]", value_type (result),
1533 usize);
1534
1535 addrval = value_allocate_space_in_inferior (TYPE_LENGTH (slice));
1536 addr = value_as_long (addrval);
1537 tem = value_at_lazy (slice, addr);
1538
1539 value_assign (value_field (tem, 0), value_addr (result));
1540 value_assign (value_field (tem, 1),
1541 value_from_longest (usize, high - low));
1542
1543 result = value_at_lazy (slice, addr);
1544 }
1545 else
1546 result = value_addr (result);
1547 }
1548
1549 return result;
1550 }
1551
1552 /* evaluate_exp implementation for Rust. */
1553
1554 static struct value *
1555 rust_evaluate_subexp (struct type *expect_type, struct expression *exp,
1556 int *pos, enum noside noside)
1557 {
1558 struct value *result;
1559
1560 switch (exp->elts[*pos].opcode)
1561 {
1562 case UNOP_COMPLEMENT:
1563 {
1564 struct value *value;
1565
1566 ++*pos;
1567 value = evaluate_subexp (NULL_TYPE, exp, pos, noside);
1568 if (noside == EVAL_SKIP)
1569 {
1570 /* Preserving the type is enough. */
1571 return value;
1572 }
1573 if (TYPE_CODE (value_type (value)) == TYPE_CODE_BOOL)
1574 result = value_from_longest (value_type (value),
1575 value_logical_not (value));
1576 else
1577 result = value_complement (value);
1578 }
1579 break;
1580
1581 case BINOP_SUBSCRIPT:
1582 result = rust_subscript (exp, pos, noside, 0);
1583 break;
1584
1585 case OP_FUNCALL:
1586 result = rust_evaluate_funcall (exp, pos, noside);
1587 break;
1588
1589 case OP_AGGREGATE:
1590 {
1591 int pc = (*pos)++;
1592 struct type *type = exp->elts[pc + 1].type;
1593 int arglen = longest_to_int (exp->elts[pc + 2].longconst);
1594 int i;
1595 CORE_ADDR addr = 0;
1596 struct value *addrval = NULL;
1597
1598 *pos += 3;
1599
1600 if (noside == EVAL_NORMAL)
1601 {
1602 addrval = value_allocate_space_in_inferior (TYPE_LENGTH (type));
1603 addr = value_as_long (addrval);
1604 result = value_at_lazy (type, addr);
1605 }
1606
1607 if (arglen > 0 && exp->elts[*pos].opcode == OP_OTHERS)
1608 {
1609 struct value *init;
1610
1611 ++*pos;
1612 init = rust_evaluate_subexp (NULL, exp, pos, noside);
1613 if (noside == EVAL_NORMAL)
1614 {
1615 /* This isn't quite right but will do for the time
1616 being, seeing that we can't implement the Copy
1617 trait anyway. */
1618 value_assign (result, init);
1619 }
1620
1621 --arglen;
1622 }
1623
1624 gdb_assert (arglen % 2 == 0);
1625 for (i = 0; i < arglen; i += 2)
1626 {
1627 int len;
1628 const char *fieldname;
1629 struct value *value, *field;
1630
1631 gdb_assert (exp->elts[*pos].opcode == OP_NAME);
1632 ++*pos;
1633 len = longest_to_int (exp->elts[*pos].longconst);
1634 ++*pos;
1635 fieldname = &exp->elts[*pos].string;
1636 *pos += 2 + BYTES_TO_EXP_ELEM (len + 1);
1637
1638 value = rust_evaluate_subexp (NULL, exp, pos, noside);
1639 if (noside == EVAL_NORMAL)
1640 {
1641 field = value_struct_elt (&result, NULL, fieldname, NULL,
1642 "structure");
1643 value_assign (field, value);
1644 }
1645 }
1646
1647 if (noside == EVAL_SKIP)
1648 return value_from_longest (builtin_type (exp->gdbarch)->builtin_int,
1649 1);
1650 else if (noside == EVAL_AVOID_SIDE_EFFECTS)
1651 result = allocate_value (type);
1652 else
1653 result = value_at_lazy (type, addr);
1654 }
1655 break;
1656
1657 case OP_RUST_ARRAY:
1658 {
1659 int pc = (*pos)++;
1660 int copies;
1661 struct value *elt;
1662 struct value *ncopies;
1663
1664 elt = rust_evaluate_subexp (NULL, exp, pos, noside);
1665 ncopies = rust_evaluate_subexp (NULL, exp, pos, noside);
1666 copies = value_as_long (ncopies);
1667 if (copies < 0)
1668 error (_("Array with negative number of elements"));
1669
1670 if (noside == EVAL_NORMAL)
1671 {
1672 CORE_ADDR addr;
1673 int i;
1674 std::vector<struct value *> eltvec (copies);
1675
1676 for (i = 0; i < copies; ++i)
1677 eltvec[i] = elt;
1678 result = value_array (0, copies - 1, eltvec.data ());
1679 }
1680 else
1681 {
1682 struct type *arraytype
1683 = lookup_array_range_type (value_type (elt), 0, copies - 1);
1684 result = allocate_value (arraytype);
1685 }
1686 }
1687 break;
1688
1689 case STRUCTOP_ANONYMOUS:
1690 {
1691 /* Anonymous field access, i.e. foo.1. */
1692 struct value *lhs;
1693 int pc, field_number, nfields;
1694 struct type *type, *variant_type;
1695 struct disr_info disr;
1696
1697 pc = (*pos)++;
1698 field_number = longest_to_int (exp->elts[pc + 1].longconst);
1699 (*pos) += 2;
1700 lhs = evaluate_subexp (NULL_TYPE, exp, pos, noside);
1701
1702 type = value_type (lhs);
1703 /* Untagged unions can't have anonymous field access since
1704 they can only have named fields. */
1705 if (TYPE_CODE (type) == TYPE_CODE_UNION
1706 && !rust_union_is_untagged (type))
1707 {
1708 disr = rust_get_disr_info (type, value_contents (lhs),
1709 value_embedded_offset (lhs),
1710 value_address (lhs), lhs);
1711
1712 if (disr.is_encoded && disr.field_no == RUST_ENCODED_ENUM_HIDDEN)
1713 {
1714 variant_type = NULL;
1715 nfields = 0;
1716 }
1717 else
1718 {
1719 variant_type = TYPE_FIELD_TYPE (type, disr.field_no);
1720 nfields = TYPE_NFIELDS (variant_type);
1721 }
1722
1723 if (!disr.is_encoded)
1724 ++field_number;
1725
1726 if (field_number >= nfields || field_number < 0)
1727 error(_("Cannot access field %d of variant %s, \
1728 there are only %d fields"),
1729 disr.is_encoded ? field_number : field_number - 1,
1730 disr.name.c_str (),
1731 disr.is_encoded ? nfields : nfields - 1);
1732
1733 if (!(disr.is_encoded
1734 ? rust_tuple_struct_type_p (variant_type)
1735 : rust_tuple_variant_type_p (variant_type)))
1736 error(_("Variant %s is not a tuple variant"), disr.name.c_str ());
1737
1738 result = value_primitive_field (lhs, 0, field_number,
1739 variant_type);
1740 }
1741 else if (TYPE_CODE (type) == TYPE_CODE_STRUCT)
1742 {
1743 /* Tuples and tuple structs */
1744 nfields = TYPE_NFIELDS(type);
1745
1746 if (field_number >= nfields || field_number < 0)
1747 error(_("Cannot access field %d of %s, there are only %d fields"),
1748 field_number, TYPE_TAG_NAME (type), nfields);
1749
1750 /* Tuples are tuple structs too. */
1751 if (!rust_tuple_struct_type_p (type))
1752 error(_("Attempting to access anonymous field %d of %s, which is \
1753 not a tuple, tuple struct, or tuple-like variant"),
1754 field_number, TYPE_TAG_NAME (type));
1755
1756 result = value_primitive_field (lhs, 0, field_number, type);
1757 }
1758 else
1759 error(_("Anonymous field access is only allowed on tuples, \
1760 tuple structs, and tuple-like enum variants"));
1761 }
1762 break;
1763
1764 case STRUCTOP_STRUCT:
1765 {
1766 struct value* lhs;
1767 struct type *type;
1768 int tem, pc;
1769
1770 pc = (*pos)++;
1771 tem = longest_to_int (exp->elts[pc + 1].longconst);
1772 (*pos) += 3 + BYTES_TO_EXP_ELEM (tem + 1);
1773 lhs = evaluate_subexp (NULL_TYPE, exp, pos, noside);
1774
1775 type = value_type (lhs);
1776 if (TYPE_CODE (type) == TYPE_CODE_UNION
1777 && !rust_union_is_untagged (type))
1778 {
1779 int i, start;
1780 struct disr_info disr;
1781 struct type* variant_type;
1782 char* field_name;
1783
1784 field_name = &exp->elts[pc + 2].string;
1785
1786 disr = rust_get_disr_info (type, value_contents (lhs),
1787 value_embedded_offset (lhs),
1788 value_address (lhs), lhs);
1789
1790 if (disr.is_encoded && disr.field_no == RUST_ENCODED_ENUM_HIDDEN)
1791 error(_("Could not find field %s of struct variant %s"),
1792 field_name, disr.name.c_str ());
1793
1794 variant_type = TYPE_FIELD_TYPE (type, disr.field_no);
1795
1796 if (variant_type == NULL
1797 || (disr.is_encoded
1798 ? rust_tuple_struct_type_p (variant_type)
1799 : rust_tuple_variant_type_p (variant_type)))
1800 error(_("Attempting to access named field %s of tuple variant %s, \
1801 which has only anonymous fields"),
1802 field_name, disr.name.c_str ());
1803
1804 start = disr.is_encoded ? 0 : 1;
1805 for (i = start; i < TYPE_NFIELDS (variant_type); i++)
1806 {
1807 if (strcmp (TYPE_FIELD_NAME (variant_type, i),
1808 field_name) == 0) {
1809 result = value_primitive_field (lhs, 0, i, variant_type);
1810 break;
1811 }
1812 }
1813
1814 if (i == TYPE_NFIELDS (variant_type))
1815 /* We didn't find it. */
1816 error(_("Could not find field %s of struct variant %s"),
1817 field_name, disr.name.c_str ());
1818 }
1819 else
1820 {
1821 /* Field access in structs and untagged unions works like C. */
1822 *pos = pc;
1823 result = evaluate_subexp_standard (expect_type, exp, pos, noside);
1824 }
1825 }
1826 break;
1827
1828 case OP_RANGE:
1829 result = rust_range (exp, pos, noside);
1830 break;
1831
1832 case UNOP_ADDR:
1833 /* We might have &array[range], in which case we need to make a
1834 slice. */
1835 if (exp->elts[*pos + 1].opcode == BINOP_SUBSCRIPT)
1836 {
1837 ++*pos;
1838 result = rust_subscript (exp, pos, noside, 1);
1839 break;
1840 }
1841 /* Fall through. */
1842 default:
1843 result = evaluate_subexp_standard (expect_type, exp, pos, noside);
1844 break;
1845 }
1846
1847 return result;
1848 }
1849
1850 /* operator_length implementation for Rust. */
1851
1852 static void
1853 rust_operator_length (const struct expression *exp, int pc, int *oplenp,
1854 int *argsp)
1855 {
1856 int oplen = 1;
1857 int args = 0;
1858
1859 switch (exp->elts[pc - 1].opcode)
1860 {
1861 case OP_AGGREGATE:
1862 /* We handle aggregate as a type and argument count. The first
1863 argument might be OP_OTHERS. After that the arguments
1864 alternate: first an OP_NAME, then an expression. */
1865 oplen = 4;
1866 args = longest_to_int (exp->elts[pc - 2].longconst);
1867 break;
1868
1869 case OP_OTHERS:
1870 oplen = 1;
1871 args = 1;
1872 break;
1873
1874 case STRUCTOP_ANONYMOUS:
1875 oplen = 3;
1876 args = 1;
1877 break;
1878
1879 case OP_RUST_ARRAY:
1880 oplen = 1;
1881 args = 2;
1882 break;
1883
1884 default:
1885 operator_length_standard (exp, pc, oplenp, argsp);
1886 return;
1887 }
1888
1889 *oplenp = oplen;
1890 *argsp = args;
1891 }
1892
1893 /* op_name implementation for Rust. */
1894
1895 static char *
1896 rust_op_name (enum exp_opcode opcode)
1897 {
1898 switch (opcode)
1899 {
1900 case OP_AGGREGATE:
1901 return "OP_AGGREGATE";
1902 case OP_OTHERS:
1903 return "OP_OTHERS";
1904 default:
1905 return op_name_standard (opcode);
1906 }
1907 }
1908
1909 /* dump_subexp_body implementation for Rust. */
1910
1911 static int
1912 rust_dump_subexp_body (struct expression *exp, struct ui_file *stream,
1913 int elt)
1914 {
1915 switch (exp->elts[elt].opcode)
1916 {
1917 case OP_AGGREGATE:
1918 {
1919 int length = longest_to_int (exp->elts[elt + 2].longconst);
1920 int i;
1921
1922 fprintf_filtered (stream, "Type @");
1923 gdb_print_host_address (exp->elts[elt + 1].type, stream);
1924 fprintf_filtered (stream, " (");
1925 type_print (exp->elts[elt + 1].type, NULL, stream, 0);
1926 fprintf_filtered (stream, "), length %d", length);
1927
1928 elt += 4;
1929 for (i = 0; i < length; ++i)
1930 elt = dump_subexp (exp, stream, elt);
1931 }
1932 break;
1933
1934 case OP_STRING:
1935 case OP_NAME:
1936 {
1937 LONGEST len = exp->elts[elt + 1].longconst;
1938
1939 fprintf_filtered (stream, "%s: %s",
1940 (exp->elts[elt].opcode == OP_STRING
1941 ? "string" : "name"),
1942 &exp->elts[elt + 2].string);
1943 elt += 4 + BYTES_TO_EXP_ELEM (len + 1);
1944 }
1945 break;
1946
1947 case OP_OTHERS:
1948 elt = dump_subexp (exp, stream, elt + 1);
1949 break;
1950
1951 case STRUCTOP_ANONYMOUS:
1952 {
1953 int field_number;
1954
1955 field_number = longest_to_int (exp->elts[elt].longconst);
1956
1957 fprintf_filtered (stream, "Field number: %d", field_number);
1958 elt = dump_subexp (exp, stream, elt + 2);
1959 }
1960 break;
1961
1962 case OP_RUST_ARRAY:
1963 break;
1964
1965 default:
1966 elt = dump_subexp_body_standard (exp, stream, elt);
1967 break;
1968 }
1969
1970 return elt;
1971 }
1972
1973 /* print_subexp implementation for Rust. */
1974
1975 static void
1976 rust_print_subexp (struct expression *exp, int *pos, struct ui_file *stream,
1977 enum precedence prec)
1978 {
1979 switch (exp->elts[*pos].opcode)
1980 {
1981 case OP_AGGREGATE:
1982 {
1983 int length = longest_to_int (exp->elts[*pos + 2].longconst);
1984 int i;
1985
1986 type_print (exp->elts[*pos + 1].type, "", stream, 0);
1987 fputs_filtered (" { ", stream);
1988
1989 *pos += 4;
1990 for (i = 0; i < length; ++i)
1991 {
1992 rust_print_subexp (exp, pos, stream, prec);
1993 fputs_filtered (", ", stream);
1994 }
1995 fputs_filtered (" }", stream);
1996 }
1997 break;
1998
1999 case OP_NAME:
2000 {
2001 LONGEST len = exp->elts[*pos + 1].longconst;
2002
2003 fputs_filtered (&exp->elts[*pos + 2].string, stream);
2004 *pos += 4 + BYTES_TO_EXP_ELEM (len + 1);
2005 }
2006 break;
2007
2008 case OP_OTHERS:
2009 {
2010 fputs_filtered ("<<others>> (", stream);
2011 ++*pos;
2012 rust_print_subexp (exp, pos, stream, prec);
2013 fputs_filtered (")", stream);
2014 }
2015 break;
2016
2017 case STRUCTOP_ANONYMOUS:
2018 {
2019 int tem = longest_to_int (exp->elts[*pos + 1].longconst);
2020
2021 (*pos) += 3;
2022 print_subexp (exp, pos, stream, PREC_SUFFIX);
2023 fprintf_filtered (stream, ".%d", tem);
2024 }
2025 return;
2026
2027 case OP_RUST_ARRAY:
2028 ++*pos;
2029 fprintf_filtered (stream, "[");
2030 rust_print_subexp (exp, pos, stream, prec);
2031 fprintf_filtered (stream, "; ");
2032 rust_print_subexp (exp, pos, stream, prec);
2033 fprintf_filtered (stream, "]");
2034 break;
2035
2036 default:
2037 print_subexp_standard (exp, pos, stream, prec);
2038 break;
2039 }
2040 }
2041
2042 /* operator_check implementation for Rust. */
2043
2044 static int
2045 rust_operator_check (struct expression *exp, int pos,
2046 int (*objfile_func) (struct objfile *objfile,
2047 void *data),
2048 void *data)
2049 {
2050 switch (exp->elts[pos].opcode)
2051 {
2052 case OP_AGGREGATE:
2053 {
2054 struct type *type = exp->elts[pos + 1].type;
2055 struct objfile *objfile = TYPE_OBJFILE (type);
2056
2057 if (objfile != NULL && (*objfile_func) (objfile, data))
2058 return 1;
2059 }
2060 break;
2061
2062 case OP_OTHERS:
2063 case OP_NAME:
2064 case OP_RUST_ARRAY:
2065 break;
2066
2067 default:
2068 return operator_check_standard (exp, pos, objfile_func, data);
2069 }
2070
2071 return 0;
2072 }
2073
2074 \f
2075
2076 /* Implementation of la_lookup_symbol_nonlocal for Rust. */
2077
2078 static struct block_symbol
2079 rust_lookup_symbol_nonlocal (const struct language_defn *langdef,
2080 const char *name,
2081 const struct block *block,
2082 const domain_enum domain)
2083 {
2084 struct block_symbol result = {NULL, NULL};
2085
2086 if (symbol_lookup_debug)
2087 {
2088 fprintf_unfiltered (gdb_stdlog,
2089 "rust_lookup_symbol_non_local"
2090 " (%s, %s (scope %s), %s)\n",
2091 name, host_address_to_string (block),
2092 block_scope (block), domain_name (domain));
2093 }
2094
2095 /* Look up bare names in the block's scope. */
2096 if (name[cp_find_first_component (name)] == '\0')
2097 {
2098 const char *scope = block_scope (block);
2099
2100 if (scope[0] != '\0')
2101 {
2102 std::string scopedname = std::string (scope) + "::" + name;
2103
2104 result = lookup_symbol_in_static_block (scopedname.c_str (), block,
2105 domain);
2106 if (result.symbol == NULL)
2107 result = lookup_global_symbol (scopedname.c_str (), block, domain);
2108 }
2109 }
2110 return result;
2111 }
2112
2113 \f
2114
2115 /* la_sniff_from_mangled_name for Rust. */
2116
2117 static int
2118 rust_sniff_from_mangled_name (const char *mangled, char **demangled)
2119 {
2120 *demangled = gdb_demangle (mangled, DMGL_PARAMS | DMGL_ANSI);
2121 return *demangled != NULL;
2122 }
2123
2124 \f
2125
2126 static const struct exp_descriptor exp_descriptor_rust =
2127 {
2128 rust_print_subexp,
2129 rust_operator_length,
2130 rust_operator_check,
2131 rust_op_name,
2132 rust_dump_subexp_body,
2133 rust_evaluate_subexp
2134 };
2135
2136 static const char *rust_extensions[] =
2137 {
2138 ".rs", NULL
2139 };
2140
2141 static const struct language_defn rust_language_defn =
2142 {
2143 "rust",
2144 "Rust",
2145 language_rust,
2146 range_check_on,
2147 case_sensitive_on,
2148 array_row_major,
2149 macro_expansion_no,
2150 rust_extensions,
2151 &exp_descriptor_rust,
2152 rust_parse,
2153 rustyyerror,
2154 null_post_parser,
2155 rust_printchar, /* Print a character constant */
2156 rust_printstr, /* Function to print string constant */
2157 rust_emitchar, /* Print a single char */
2158 rust_print_type, /* Print a type using appropriate syntax */
2159 rust_print_typedef, /* Print a typedef using appropriate syntax */
2160 rust_val_print, /* Print a value using appropriate syntax */
2161 c_value_print, /* Print a top-level value */
2162 default_read_var_value, /* la_read_var_value */
2163 NULL, /* Language specific skip_trampoline */
2164 NULL, /* name_of_this */
2165 rust_lookup_symbol_nonlocal, /* lookup_symbol_nonlocal */
2166 basic_lookup_transparent_type,/* lookup_transparent_type */
2167 gdb_demangle, /* Language specific symbol demangler */
2168 rust_sniff_from_mangled_name,
2169 NULL, /* Language specific
2170 class_name_from_physname */
2171 c_op_print_tab, /* expression operators for printing */
2172 1, /* c-style arrays */
2173 0, /* String lower bound */
2174 default_word_break_characters,
2175 default_make_symbol_completion_list,
2176 rust_language_arch_info,
2177 default_print_array_index,
2178 default_pass_by_reference,
2179 c_get_string,
2180 NULL, /* la_get_symbol_name_cmp */
2181 iterate_over_symbols,
2182 &default_varobj_ops,
2183 NULL,
2184 NULL,
2185 LANG_MAGIC
2186 };
2187
2188 void
2189 _initialize_rust_language (void)
2190 {
2191 add_language (&rust_language_defn);
2192 }
This page took 0.074474 seconds and 5 git commands to generate.