a8048242860c7c1d6d588f7927dd2f23cb2b0cfb
[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
981 for (i = 0; i < TYPE_NFIELDS (type); ++i)
982 {
983 struct type *variant_type = TYPE_FIELD_TYPE (type, i);
984 const char *name
985 = rust_last_path_segment (TYPE_NAME (variant_type));
986
987 fprintfi_filtered (level + 2, stream, "%s", name);
988
989 if (TYPE_NFIELDS (variant_type) > skip_to)
990 {
991 int first = 1;
992 bool is_tuple = rust_tuple_variant_type_p (variant_type);
993 int j;
994
995 fputs_filtered (is_tuple ? "(" : "{", stream);
996 for (j = skip_to; j < TYPE_NFIELDS (variant_type); j++)
997 {
998 if (first)
999 first = 0;
1000 else
1001 fputs_filtered (", ", stream);
1002
1003 if (!is_tuple)
1004 fprintf_filtered (stream, "%s: ",
1005 TYPE_FIELD_NAME (variant_type, j));
1006
1007 rust_print_type (TYPE_FIELD_TYPE (variant_type, j), NULL,
1008 stream, show - 1, level + 2,
1009 flags);
1010 }
1011 fputs_filtered (is_tuple ? ")" : "}", stream);
1012 }
1013
1014 fputs_filtered (",\n", stream);
1015 }
1016
1017 fputs_filtered ("}", stream);
1018 }
1019 break;
1020
1021 default:
1022 c_printer:
1023 c_print_type (type, varstring, stream, show, level, flags);
1024 }
1025 }
1026
1027 \f
1028
1029 /* Compute the alignment of the type T. */
1030
1031 static int
1032 rust_type_alignment (struct type *t)
1033 {
1034 t = check_typedef (t);
1035 switch (TYPE_CODE (t))
1036 {
1037 default:
1038 error (_("Could not compute alignment of type"));
1039
1040 case TYPE_CODE_PTR:
1041 case TYPE_CODE_ENUM:
1042 case TYPE_CODE_INT:
1043 case TYPE_CODE_FLT:
1044 case TYPE_CODE_REF:
1045 case TYPE_CODE_CHAR:
1046 case TYPE_CODE_BOOL:
1047 return TYPE_LENGTH (t);
1048
1049 case TYPE_CODE_ARRAY:
1050 case TYPE_CODE_COMPLEX:
1051 return rust_type_alignment (TYPE_TARGET_TYPE (t));
1052
1053 case TYPE_CODE_STRUCT:
1054 case TYPE_CODE_UNION:
1055 {
1056 int i;
1057 int align = 1;
1058
1059 for (i = 0; i < TYPE_NFIELDS (t); ++i)
1060 {
1061 int a = rust_type_alignment (TYPE_FIELD_TYPE (t, i));
1062 if (a > align)
1063 align = a;
1064 }
1065 return align;
1066 }
1067 }
1068 }
1069
1070 /* Like arch_composite_type, but uses TYPE to decide how to allocate
1071 -- either on an obstack or on a gdbarch. */
1072
1073 static struct type *
1074 rust_composite_type (struct type *original,
1075 const char *name,
1076 const char *field1, struct type *type1,
1077 const char *field2, struct type *type2)
1078 {
1079 struct type *result = alloc_type_copy (original);
1080 int i, nfields, bitpos;
1081
1082 nfields = 0;
1083 if (field1 != NULL)
1084 ++nfields;
1085 if (field2 != NULL)
1086 ++nfields;
1087
1088 TYPE_CODE (result) = TYPE_CODE_STRUCT;
1089 TYPE_NAME (result) = name;
1090 TYPE_TAG_NAME (result) = name;
1091
1092 TYPE_NFIELDS (result) = nfields;
1093 TYPE_FIELDS (result)
1094 = (struct field *) TYPE_ZALLOC (result, nfields * sizeof (struct field));
1095
1096 i = 0;
1097 bitpos = 0;
1098 if (field1 != NULL)
1099 {
1100 struct field *field = &TYPE_FIELD (result, i);
1101
1102 SET_FIELD_BITPOS (*field, bitpos);
1103 bitpos += TYPE_LENGTH (type1) * TARGET_CHAR_BIT;
1104
1105 FIELD_NAME (*field) = field1;
1106 FIELD_TYPE (*field) = type1;
1107 ++i;
1108 }
1109 if (field2 != NULL)
1110 {
1111 struct field *field = &TYPE_FIELD (result, i);
1112 int align = rust_type_alignment (type2);
1113
1114 if (align != 0)
1115 {
1116 int delta;
1117
1118 align *= TARGET_CHAR_BIT;
1119 delta = bitpos % align;
1120 if (delta != 0)
1121 bitpos += align - delta;
1122 }
1123 SET_FIELD_BITPOS (*field, bitpos);
1124
1125 FIELD_NAME (*field) = field2;
1126 FIELD_TYPE (*field) = type2;
1127 ++i;
1128 }
1129
1130 if (i > 0)
1131 TYPE_LENGTH (result)
1132 = (TYPE_FIELD_BITPOS (result, i - 1) / TARGET_CHAR_BIT +
1133 TYPE_LENGTH (TYPE_FIELD_TYPE (result, i - 1)));
1134 return result;
1135 }
1136
1137 /* See rust-lang.h. */
1138
1139 struct type *
1140 rust_slice_type (const char *name, struct type *elt_type,
1141 struct type *usize_type)
1142 {
1143 struct type *type;
1144
1145 elt_type = lookup_pointer_type (elt_type);
1146 type = rust_composite_type (elt_type, name,
1147 "data_ptr", elt_type,
1148 "length", usize_type);
1149
1150 return type;
1151 }
1152
1153 enum rust_primitive_types
1154 {
1155 rust_primitive_bool,
1156 rust_primitive_char,
1157 rust_primitive_i8,
1158 rust_primitive_u8,
1159 rust_primitive_i16,
1160 rust_primitive_u16,
1161 rust_primitive_i32,
1162 rust_primitive_u32,
1163 rust_primitive_i64,
1164 rust_primitive_u64,
1165 rust_primitive_isize,
1166 rust_primitive_usize,
1167 rust_primitive_f32,
1168 rust_primitive_f64,
1169 rust_primitive_unit,
1170 rust_primitive_str,
1171 nr_rust_primitive_types
1172 };
1173
1174 /* la_language_arch_info implementation for Rust. */
1175
1176 static void
1177 rust_language_arch_info (struct gdbarch *gdbarch,
1178 struct language_arch_info *lai)
1179 {
1180 const struct builtin_type *builtin = builtin_type (gdbarch);
1181 struct type *tem;
1182 struct type **types;
1183 unsigned int length;
1184
1185 types = GDBARCH_OBSTACK_CALLOC (gdbarch, nr_rust_primitive_types + 1,
1186 struct type *);
1187
1188 types[rust_primitive_bool] = arch_boolean_type (gdbarch, 8, 1, "bool");
1189 types[rust_primitive_char] = arch_character_type (gdbarch, 32, 1, "char");
1190 types[rust_primitive_i8] = arch_integer_type (gdbarch, 8, 0, "i8");
1191 types[rust_primitive_u8] = arch_integer_type (gdbarch, 8, 1, "u8");
1192 types[rust_primitive_i16] = arch_integer_type (gdbarch, 16, 0, "i16");
1193 types[rust_primitive_u16] = arch_integer_type (gdbarch, 16, 1, "u16");
1194 types[rust_primitive_i32] = arch_integer_type (gdbarch, 32, 0, "i32");
1195 types[rust_primitive_u32] = arch_integer_type (gdbarch, 32, 1, "u32");
1196 types[rust_primitive_i64] = arch_integer_type (gdbarch, 64, 0, "i64");
1197 types[rust_primitive_u64] = arch_integer_type (gdbarch, 64, 1, "u64");
1198
1199 length = 8 * TYPE_LENGTH (builtin->builtin_data_ptr);
1200 types[rust_primitive_isize] = arch_integer_type (gdbarch, length, 0, "isize");
1201 types[rust_primitive_usize] = arch_integer_type (gdbarch, length, 1, "usize");
1202
1203 types[rust_primitive_f32] = arch_float_type (gdbarch, 32, "f32",
1204 floatformats_ieee_single);
1205 types[rust_primitive_f64] = arch_float_type (gdbarch, 64, "f64",
1206 floatformats_ieee_double);
1207
1208 types[rust_primitive_unit] = arch_integer_type (gdbarch, 0, 1, "()");
1209
1210 tem = make_cv_type (1, 0, types[rust_primitive_u8], NULL);
1211 types[rust_primitive_str] = rust_slice_type ("&str", tem,
1212 types[rust_primitive_usize]);
1213
1214 lai->primitive_type_vector = types;
1215 lai->bool_type_default = types[rust_primitive_bool];
1216 lai->string_char_type = types[rust_primitive_u8];
1217 }
1218
1219 \f
1220
1221 /* A helper for rust_evaluate_subexp that handles OP_FUNCALL. */
1222
1223 static struct value *
1224 rust_evaluate_funcall (struct expression *exp, int *pos, enum noside noside)
1225 {
1226 int i;
1227 int num_args = exp->elts[*pos + 1].longconst;
1228 const char *method;
1229 struct value *function, *result, *arg0;
1230 struct type *type, *fn_type;
1231 const struct block *block;
1232 struct block_symbol sym;
1233
1234 /* For an ordinary function call we can simply defer to the
1235 generic implementation. */
1236 if (exp->elts[*pos + 3].opcode != STRUCTOP_STRUCT)
1237 return evaluate_subexp_standard (NULL, exp, pos, noside);
1238
1239 /* Skip over the OP_FUNCALL and the STRUCTOP_STRUCT. */
1240 *pos += 4;
1241 method = &exp->elts[*pos + 1].string;
1242 *pos += 3 + BYTES_TO_EXP_ELEM (exp->elts[*pos].longconst + 1);
1243
1244 /* Evaluate the argument to STRUCTOP_STRUCT, then find its
1245 type in order to look up the method. */
1246 arg0 = evaluate_subexp (NULL_TYPE, exp, pos, noside);
1247
1248 if (noside == EVAL_SKIP)
1249 {
1250 for (i = 0; i < num_args; ++i)
1251 evaluate_subexp (NULL_TYPE, exp, pos, noside);
1252 return arg0;
1253 }
1254
1255 std::vector<struct value *> args (num_args + 1);
1256 args[0] = arg0;
1257
1258 /* We don't yet implement real Deref semantics. */
1259 while (TYPE_CODE (value_type (args[0])) == TYPE_CODE_PTR)
1260 args[0] = value_ind (args[0]);
1261
1262 type = value_type (args[0]);
1263 if ((TYPE_CODE (type) != TYPE_CODE_STRUCT
1264 && TYPE_CODE (type) != TYPE_CODE_UNION
1265 && TYPE_CODE (type) != TYPE_CODE_ENUM)
1266 || rust_tuple_type_p (type))
1267 error (_("Method calls only supported on struct or enum types"));
1268 if (TYPE_TAG_NAME (type) == NULL)
1269 error (_("Method call on nameless type"));
1270
1271 std::string name = std::string (TYPE_TAG_NAME (type)) + "::" + method;
1272
1273 block = get_selected_block (0);
1274 sym = lookup_symbol (name.c_str (), block, VAR_DOMAIN, NULL);
1275 if (sym.symbol == NULL)
1276 error (_("Could not find function named '%s'"), name.c_str ());
1277
1278 fn_type = SYMBOL_TYPE (sym.symbol);
1279 if (TYPE_NFIELDS (fn_type) == 0)
1280 error (_("Function '%s' takes no arguments"), name.c_str ());
1281
1282 if (TYPE_CODE (TYPE_FIELD_TYPE (fn_type, 0)) == TYPE_CODE_PTR)
1283 args[0] = value_addr (args[0]);
1284
1285 function = address_of_variable (sym.symbol, block);
1286
1287 for (i = 0; i < num_args; ++i)
1288 args[i + 1] = evaluate_subexp (NULL_TYPE, exp, pos, noside);
1289
1290 if (noside == EVAL_AVOID_SIDE_EFFECTS)
1291 result = value_zero (TYPE_TARGET_TYPE (fn_type), not_lval);
1292 else
1293 result = call_function_by_hand (function, num_args + 1, args.data ());
1294 return result;
1295 }
1296
1297 /* A helper for rust_evaluate_subexp that handles OP_RANGE. */
1298
1299 static struct value *
1300 rust_range (struct expression *exp, int *pos, enum noside noside)
1301 {
1302 enum range_type kind;
1303 struct value *low = NULL, *high = NULL;
1304 struct value *addrval, *result;
1305 CORE_ADDR addr;
1306 struct type *range_type;
1307 struct type *index_type;
1308 struct type *temp_type;
1309 const char *name;
1310
1311 kind = (enum range_type) longest_to_int (exp->elts[*pos + 1].longconst);
1312 *pos += 3;
1313
1314 if (kind == HIGH_BOUND_DEFAULT || kind == NONE_BOUND_DEFAULT)
1315 low = evaluate_subexp (NULL_TYPE, exp, pos, noside);
1316 if (kind == LOW_BOUND_DEFAULT || kind == NONE_BOUND_DEFAULT)
1317 high = evaluate_subexp (NULL_TYPE, exp, pos, noside);
1318
1319 if (noside == EVAL_SKIP)
1320 return value_from_longest (builtin_type (exp->gdbarch)->builtin_int, 1);
1321
1322 if (low == NULL)
1323 {
1324 if (high == NULL)
1325 {
1326 index_type = NULL;
1327 name = "std::ops::RangeFull";
1328 }
1329 else
1330 {
1331 index_type = value_type (high);
1332 name = "std::ops::RangeTo";
1333 }
1334 }
1335 else
1336 {
1337 if (high == NULL)
1338 {
1339 index_type = value_type (low);
1340 name = "std::ops::RangeFrom";
1341 }
1342 else
1343 {
1344 if (!types_equal (value_type (low), value_type (high)))
1345 error (_("Range expression with different types"));
1346 index_type = value_type (low);
1347 name = "std::ops::Range";
1348 }
1349 }
1350
1351 /* If we don't have an index type, just allocate this on the
1352 arch. Here any type will do. */
1353 temp_type = (index_type == NULL
1354 ? language_bool_type (exp->language_defn, exp->gdbarch)
1355 : index_type);
1356 /* It would be nicer to cache the range type. */
1357 range_type = rust_composite_type (temp_type, name,
1358 low == NULL ? NULL : "start", index_type,
1359 high == NULL ? NULL : "end", index_type);
1360
1361 if (noside == EVAL_AVOID_SIDE_EFFECTS)
1362 return value_zero (range_type, lval_memory);
1363
1364 addrval = value_allocate_space_in_inferior (TYPE_LENGTH (range_type));
1365 addr = value_as_long (addrval);
1366 result = value_at_lazy (range_type, addr);
1367
1368 if (low != NULL)
1369 {
1370 struct value *start = value_struct_elt (&result, NULL, "start", NULL,
1371 "range");
1372
1373 value_assign (start, low);
1374 }
1375
1376 if (high != NULL)
1377 {
1378 struct value *end = value_struct_elt (&result, NULL, "end", NULL,
1379 "range");
1380
1381 value_assign (end, high);
1382 }
1383
1384 result = value_at_lazy (range_type, addr);
1385 return result;
1386 }
1387
1388 /* A helper function to compute the range and kind given a range
1389 value. TYPE is the type of the range value. RANGE is the range
1390 value. LOW, HIGH, and KIND are out parameters. The LOW and HIGH
1391 parameters might be filled in, or might not be, depending on the
1392 kind of range this is. KIND will always be set to the appropriate
1393 value describing the kind of range, and this can be used to
1394 determine whether LOW or HIGH are valid. */
1395
1396 static void
1397 rust_compute_range (struct type *type, struct value *range,
1398 LONGEST *low, LONGEST *high,
1399 enum range_type *kind)
1400 {
1401 int i;
1402
1403 *low = 0;
1404 *high = 0;
1405 *kind = BOTH_BOUND_DEFAULT;
1406
1407 if (TYPE_NFIELDS (type) == 0)
1408 return;
1409
1410 i = 0;
1411 if (strcmp (TYPE_FIELD_NAME (type, 0), "start") == 0)
1412 {
1413 *kind = HIGH_BOUND_DEFAULT;
1414 *low = value_as_long (value_field (range, 0));
1415 ++i;
1416 }
1417 if (TYPE_NFIELDS (type) > i
1418 && strcmp (TYPE_FIELD_NAME (type, i), "end") == 0)
1419 {
1420 *kind = (*kind == BOTH_BOUND_DEFAULT
1421 ? LOW_BOUND_DEFAULT : NONE_BOUND_DEFAULT);
1422 *high = value_as_long (value_field (range, i));
1423 }
1424 }
1425
1426 /* A helper for rust_evaluate_subexp that handles BINOP_SUBSCRIPT. */
1427
1428 static struct value *
1429 rust_subscript (struct expression *exp, int *pos, enum noside noside,
1430 int for_addr)
1431 {
1432 struct value *lhs, *rhs, *result;
1433 struct type *rhstype;
1434 LONGEST low, high_bound;
1435 /* Initialized to appease the compiler. */
1436 enum range_type kind = BOTH_BOUND_DEFAULT;
1437 LONGEST high = 0;
1438 int want_slice = 0;
1439
1440 ++*pos;
1441 lhs = evaluate_subexp (NULL_TYPE, exp, pos, noside);
1442 rhs = evaluate_subexp (NULL_TYPE, exp, pos, noside);
1443
1444 if (noside == EVAL_SKIP)
1445 return lhs;
1446
1447 rhstype = check_typedef (value_type (rhs));
1448 if (rust_range_type_p (rhstype))
1449 {
1450 if (!for_addr)
1451 error (_("Can't take slice of array without '&'"));
1452 rust_compute_range (rhstype, rhs, &low, &high, &kind);
1453 want_slice = 1;
1454 }
1455 else
1456 low = value_as_long (rhs);
1457
1458 if (noside == EVAL_AVOID_SIDE_EFFECTS)
1459 {
1460 struct type *type = check_typedef (value_type (lhs));
1461
1462 result = value_zero (TYPE_TARGET_TYPE (type), VALUE_LVAL (lhs));
1463 }
1464 else
1465 {
1466 LONGEST low_bound;
1467 struct value *base;
1468 struct type *type = check_typedef (value_type (lhs));
1469
1470 if (TYPE_CODE (type) == TYPE_CODE_ARRAY)
1471 {
1472 base = lhs;
1473 if (!get_array_bounds (type, &low_bound, &high_bound))
1474 error (_("Can't compute array bounds"));
1475 if (low_bound != 0)
1476 error (_("Found array with non-zero lower bound"));
1477 ++high_bound;
1478 }
1479 else if (rust_slice_type_p (type))
1480 {
1481 struct value *len;
1482
1483 base = value_struct_elt (&lhs, NULL, "data_ptr", NULL, "slice");
1484 len = value_struct_elt (&lhs, NULL, "length", NULL, "slice");
1485 low_bound = 0;
1486 high_bound = value_as_long (len);
1487 }
1488 else if (TYPE_CODE (type) == TYPE_CODE_PTR)
1489 {
1490 base = lhs;
1491 low_bound = 0;
1492 high_bound = LONGEST_MAX;
1493 }
1494 else
1495 error (_("Cannot subscript non-array type"));
1496
1497 if (want_slice
1498 && (kind == BOTH_BOUND_DEFAULT || kind == LOW_BOUND_DEFAULT))
1499 low = low_bound;
1500 if (low < 0)
1501 error (_("Index less than zero"));
1502 if (low > high_bound)
1503 error (_("Index greater than length"));
1504
1505 result = value_subscript (base, low);
1506 }
1507
1508 if (for_addr)
1509 {
1510 if (want_slice)
1511 {
1512 struct type *usize, *slice;
1513 CORE_ADDR addr;
1514 struct value *addrval, *tem;
1515
1516 if (kind == BOTH_BOUND_DEFAULT || kind == HIGH_BOUND_DEFAULT)
1517 high = high_bound;
1518 if (high < 0)
1519 error (_("High index less than zero"));
1520 if (low > high)
1521 error (_("Low index greater than high index"));
1522 if (high > high_bound)
1523 error (_("High index greater than length"));
1524
1525 usize = language_lookup_primitive_type (exp->language_defn,
1526 exp->gdbarch,
1527 "usize");
1528 slice = rust_slice_type ("&[*gdb*]", value_type (result),
1529 usize);
1530
1531 addrval = value_allocate_space_in_inferior (TYPE_LENGTH (slice));
1532 addr = value_as_long (addrval);
1533 tem = value_at_lazy (slice, addr);
1534
1535 value_assign (value_field (tem, 0), value_addr (result));
1536 value_assign (value_field (tem, 1),
1537 value_from_longest (usize, high - low));
1538
1539 result = value_at_lazy (slice, addr);
1540 }
1541 else
1542 result = value_addr (result);
1543 }
1544
1545 return result;
1546 }
1547
1548 /* evaluate_exp implementation for Rust. */
1549
1550 static struct value *
1551 rust_evaluate_subexp (struct type *expect_type, struct expression *exp,
1552 int *pos, enum noside noside)
1553 {
1554 struct value *result;
1555
1556 switch (exp->elts[*pos].opcode)
1557 {
1558 case UNOP_COMPLEMENT:
1559 {
1560 struct value *value;
1561
1562 ++*pos;
1563 value = evaluate_subexp (NULL_TYPE, exp, pos, noside);
1564 if (noside == EVAL_SKIP)
1565 {
1566 /* Preserving the type is enough. */
1567 return value;
1568 }
1569 if (TYPE_CODE (value_type (value)) == TYPE_CODE_BOOL)
1570 result = value_from_longest (value_type (value),
1571 value_logical_not (value));
1572 else
1573 result = value_complement (value);
1574 }
1575 break;
1576
1577 case BINOP_SUBSCRIPT:
1578 result = rust_subscript (exp, pos, noside, 0);
1579 break;
1580
1581 case OP_FUNCALL:
1582 result = rust_evaluate_funcall (exp, pos, noside);
1583 break;
1584
1585 case OP_AGGREGATE:
1586 {
1587 int pc = (*pos)++;
1588 struct type *type = exp->elts[pc + 1].type;
1589 int arglen = longest_to_int (exp->elts[pc + 2].longconst);
1590 int i;
1591 CORE_ADDR addr = 0;
1592 struct value *addrval = NULL;
1593
1594 *pos += 3;
1595
1596 if (noside == EVAL_NORMAL)
1597 {
1598 addrval = value_allocate_space_in_inferior (TYPE_LENGTH (type));
1599 addr = value_as_long (addrval);
1600 result = value_at_lazy (type, addr);
1601 }
1602
1603 if (arglen > 0 && exp->elts[*pos].opcode == OP_OTHERS)
1604 {
1605 struct value *init;
1606
1607 ++*pos;
1608 init = rust_evaluate_subexp (NULL, exp, pos, noside);
1609 if (noside == EVAL_NORMAL)
1610 {
1611 /* This isn't quite right but will do for the time
1612 being, seeing that we can't implement the Copy
1613 trait anyway. */
1614 value_assign (result, init);
1615 }
1616
1617 --arglen;
1618 }
1619
1620 gdb_assert (arglen % 2 == 0);
1621 for (i = 0; i < arglen; i += 2)
1622 {
1623 int len;
1624 const char *fieldname;
1625 struct value *value, *field;
1626
1627 gdb_assert (exp->elts[*pos].opcode == OP_NAME);
1628 ++*pos;
1629 len = longest_to_int (exp->elts[*pos].longconst);
1630 ++*pos;
1631 fieldname = &exp->elts[*pos].string;
1632 *pos += 2 + BYTES_TO_EXP_ELEM (len + 1);
1633
1634 value = rust_evaluate_subexp (NULL, exp, pos, noside);
1635 if (noside == EVAL_NORMAL)
1636 {
1637 field = value_struct_elt (&result, NULL, fieldname, NULL,
1638 "structure");
1639 value_assign (field, value);
1640 }
1641 }
1642
1643 if (noside == EVAL_SKIP)
1644 return value_from_longest (builtin_type (exp->gdbarch)->builtin_int,
1645 1);
1646 else if (noside == EVAL_AVOID_SIDE_EFFECTS)
1647 result = allocate_value (type);
1648 else
1649 result = value_at_lazy (type, addr);
1650 }
1651 break;
1652
1653 case OP_RUST_ARRAY:
1654 {
1655 int pc = (*pos)++;
1656 int copies;
1657 struct value *elt;
1658 struct value *ncopies;
1659
1660 elt = rust_evaluate_subexp (NULL, exp, pos, noside);
1661 ncopies = rust_evaluate_subexp (NULL, exp, pos, noside);
1662 copies = value_as_long (ncopies);
1663 if (copies < 0)
1664 error (_("Array with negative number of elements"));
1665
1666 if (noside == EVAL_NORMAL)
1667 {
1668 CORE_ADDR addr;
1669 int i;
1670 std::vector<struct value *> eltvec (copies);
1671
1672 for (i = 0; i < copies; ++i)
1673 eltvec[i] = elt;
1674 result = value_array (0, copies - 1, eltvec.data ());
1675 }
1676 else
1677 {
1678 struct type *arraytype
1679 = lookup_array_range_type (value_type (elt), 0, copies - 1);
1680 result = allocate_value (arraytype);
1681 }
1682 }
1683 break;
1684
1685 case STRUCTOP_ANONYMOUS:
1686 {
1687 /* Anonymous field access, i.e. foo.1. */
1688 struct value *lhs;
1689 int pc, field_number, nfields;
1690 struct type *type, *variant_type;
1691 struct disr_info disr;
1692
1693 pc = (*pos)++;
1694 field_number = longest_to_int (exp->elts[pc + 1].longconst);
1695 (*pos) += 2;
1696 lhs = evaluate_subexp (NULL_TYPE, exp, pos, noside);
1697
1698 type = value_type (lhs);
1699 /* Untagged unions can't have anonymous field access since
1700 they can only have named fields. */
1701 if (TYPE_CODE (type) == TYPE_CODE_UNION
1702 && !rust_union_is_untagged (type))
1703 {
1704 disr = rust_get_disr_info (type, value_contents (lhs),
1705 value_embedded_offset (lhs),
1706 value_address (lhs), lhs);
1707
1708 if (disr.is_encoded && disr.field_no == RUST_ENCODED_ENUM_HIDDEN)
1709 {
1710 variant_type = NULL;
1711 nfields = 0;
1712 }
1713 else
1714 {
1715 variant_type = TYPE_FIELD_TYPE (type, disr.field_no);
1716 nfields = TYPE_NFIELDS (variant_type);
1717 }
1718
1719 if (!disr.is_encoded)
1720 ++field_number;
1721
1722 if (field_number >= nfields || field_number < 0)
1723 error(_("Cannot access field %d of variant %s, \
1724 there are only %d fields"),
1725 disr.is_encoded ? field_number : field_number - 1,
1726 disr.name.c_str (),
1727 disr.is_encoded ? nfields : nfields - 1);
1728
1729 if (!(disr.is_encoded
1730 ? rust_tuple_struct_type_p (variant_type)
1731 : rust_tuple_variant_type_p (variant_type)))
1732 error(_("Variant %s is not a tuple variant"), disr.name.c_str ());
1733
1734 result = value_primitive_field (lhs, 0, field_number,
1735 variant_type);
1736 }
1737 else if (TYPE_CODE (type) == TYPE_CODE_STRUCT)
1738 {
1739 /* Tuples and tuple structs */
1740 nfields = TYPE_NFIELDS(type);
1741
1742 if (field_number >= nfields || field_number < 0)
1743 error(_("Cannot access field %d of %s, there are only %d fields"),
1744 field_number, TYPE_TAG_NAME (type), nfields);
1745
1746 /* Tuples are tuple structs too. */
1747 if (!rust_tuple_struct_type_p (type))
1748 error(_("Attempting to access anonymous field %d of %s, which is \
1749 not a tuple, tuple struct, or tuple-like variant"),
1750 field_number, TYPE_TAG_NAME (type));
1751
1752 result = value_primitive_field (lhs, 0, field_number, type);
1753 }
1754 else
1755 error(_("Anonymous field access is only allowed on tuples, \
1756 tuple structs, and tuple-like enum variants"));
1757 }
1758 break;
1759
1760 case STRUCTOP_STRUCT:
1761 {
1762 struct value* lhs;
1763 struct type *type;
1764 int tem, pc;
1765
1766 pc = (*pos)++;
1767 tem = longest_to_int (exp->elts[pc + 1].longconst);
1768 (*pos) += 3 + BYTES_TO_EXP_ELEM (tem + 1);
1769 lhs = evaluate_subexp (NULL_TYPE, exp, pos, noside);
1770
1771 type = value_type (lhs);
1772 if (TYPE_CODE (type) == TYPE_CODE_UNION
1773 && !rust_union_is_untagged (type))
1774 {
1775 int i, start;
1776 struct disr_info disr;
1777 struct type* variant_type;
1778 char* field_name;
1779
1780 field_name = &exp->elts[pc + 2].string;
1781
1782 disr = rust_get_disr_info (type, value_contents (lhs),
1783 value_embedded_offset (lhs),
1784 value_address (lhs), lhs);
1785
1786 if (disr.is_encoded && disr.field_no == RUST_ENCODED_ENUM_HIDDEN)
1787 error(_("Could not find field %s of struct variant %s"),
1788 field_name, disr.name.c_str ());
1789
1790 variant_type = TYPE_FIELD_TYPE (type, disr.field_no);
1791
1792 if (variant_type == NULL
1793 || (disr.is_encoded
1794 ? rust_tuple_struct_type_p (variant_type)
1795 : rust_tuple_variant_type_p (variant_type)))
1796 error(_("Attempting to access named field %s of tuple variant %s, \
1797 which has only anonymous fields"),
1798 field_name, disr.name.c_str ());
1799
1800 start = disr.is_encoded ? 0 : 1;
1801 for (i = start; i < TYPE_NFIELDS (variant_type); i++)
1802 {
1803 if (strcmp (TYPE_FIELD_NAME (variant_type, i),
1804 field_name) == 0) {
1805 result = value_primitive_field (lhs, 0, i, variant_type);
1806 break;
1807 }
1808 }
1809
1810 if (i == TYPE_NFIELDS (variant_type))
1811 /* We didn't find it. */
1812 error(_("Could not find field %s of struct variant %s"),
1813 field_name, disr.name.c_str ());
1814 }
1815 else
1816 {
1817 /* Field access in structs and untagged unions works like C. */
1818 *pos = pc;
1819 result = evaluate_subexp_standard (expect_type, exp, pos, noside);
1820 }
1821 }
1822 break;
1823
1824 case OP_RANGE:
1825 result = rust_range (exp, pos, noside);
1826 break;
1827
1828 case UNOP_ADDR:
1829 /* We might have &array[range], in which case we need to make a
1830 slice. */
1831 if (exp->elts[*pos + 1].opcode == BINOP_SUBSCRIPT)
1832 {
1833 ++*pos;
1834 result = rust_subscript (exp, pos, noside, 1);
1835 break;
1836 }
1837 /* Fall through. */
1838 default:
1839 result = evaluate_subexp_standard (expect_type, exp, pos, noside);
1840 break;
1841 }
1842
1843 return result;
1844 }
1845
1846 /* operator_length implementation for Rust. */
1847
1848 static void
1849 rust_operator_length (const struct expression *exp, int pc, int *oplenp,
1850 int *argsp)
1851 {
1852 int oplen = 1;
1853 int args = 0;
1854
1855 switch (exp->elts[pc - 1].opcode)
1856 {
1857 case OP_AGGREGATE:
1858 /* We handle aggregate as a type and argument count. The first
1859 argument might be OP_OTHERS. After that the arguments
1860 alternate: first an OP_NAME, then an expression. */
1861 oplen = 4;
1862 args = longest_to_int (exp->elts[pc - 2].longconst);
1863 break;
1864
1865 case OP_OTHERS:
1866 oplen = 1;
1867 args = 1;
1868 break;
1869
1870 case STRUCTOP_ANONYMOUS:
1871 oplen = 3;
1872 args = 1;
1873 break;
1874
1875 case OP_RUST_ARRAY:
1876 oplen = 1;
1877 args = 2;
1878 break;
1879
1880 default:
1881 operator_length_standard (exp, pc, oplenp, argsp);
1882 return;
1883 }
1884
1885 *oplenp = oplen;
1886 *argsp = args;
1887 }
1888
1889 /* op_name implementation for Rust. */
1890
1891 static char *
1892 rust_op_name (enum exp_opcode opcode)
1893 {
1894 switch (opcode)
1895 {
1896 case OP_AGGREGATE:
1897 return "OP_AGGREGATE";
1898 case OP_OTHERS:
1899 return "OP_OTHERS";
1900 default:
1901 return op_name_standard (opcode);
1902 }
1903 }
1904
1905 /* dump_subexp_body implementation for Rust. */
1906
1907 static int
1908 rust_dump_subexp_body (struct expression *exp, struct ui_file *stream,
1909 int elt)
1910 {
1911 switch (exp->elts[elt].opcode)
1912 {
1913 case OP_AGGREGATE:
1914 {
1915 int length = longest_to_int (exp->elts[elt + 2].longconst);
1916 int i;
1917
1918 fprintf_filtered (stream, "Type @");
1919 gdb_print_host_address (exp->elts[elt + 1].type, stream);
1920 fprintf_filtered (stream, " (");
1921 type_print (exp->elts[elt + 1].type, NULL, stream, 0);
1922 fprintf_filtered (stream, "), length %d", length);
1923
1924 elt += 4;
1925 for (i = 0; i < length; ++i)
1926 elt = dump_subexp (exp, stream, elt);
1927 }
1928 break;
1929
1930 case OP_STRING:
1931 case OP_NAME:
1932 {
1933 LONGEST len = exp->elts[elt + 1].longconst;
1934
1935 fprintf_filtered (stream, "%s: %s",
1936 (exp->elts[elt].opcode == OP_STRING
1937 ? "string" : "name"),
1938 &exp->elts[elt + 2].string);
1939 elt += 4 + BYTES_TO_EXP_ELEM (len + 1);
1940 }
1941 break;
1942
1943 case OP_OTHERS:
1944 elt = dump_subexp (exp, stream, elt + 1);
1945 break;
1946
1947 case STRUCTOP_ANONYMOUS:
1948 {
1949 int field_number;
1950
1951 field_number = longest_to_int (exp->elts[elt].longconst);
1952
1953 fprintf_filtered (stream, "Field number: %d", field_number);
1954 elt = dump_subexp (exp, stream, elt + 2);
1955 }
1956 break;
1957
1958 case OP_RUST_ARRAY:
1959 break;
1960
1961 default:
1962 elt = dump_subexp_body_standard (exp, stream, elt);
1963 break;
1964 }
1965
1966 return elt;
1967 }
1968
1969 /* print_subexp implementation for Rust. */
1970
1971 static void
1972 rust_print_subexp (struct expression *exp, int *pos, struct ui_file *stream,
1973 enum precedence prec)
1974 {
1975 switch (exp->elts[*pos].opcode)
1976 {
1977 case OP_AGGREGATE:
1978 {
1979 int length = longest_to_int (exp->elts[*pos + 2].longconst);
1980 int i;
1981
1982 type_print (exp->elts[*pos + 1].type, "", stream, 0);
1983 fputs_filtered (" { ", stream);
1984
1985 *pos += 4;
1986 for (i = 0; i < length; ++i)
1987 {
1988 rust_print_subexp (exp, pos, stream, prec);
1989 fputs_filtered (", ", stream);
1990 }
1991 fputs_filtered (" }", stream);
1992 }
1993 break;
1994
1995 case OP_NAME:
1996 {
1997 LONGEST len = exp->elts[*pos + 1].longconst;
1998
1999 fputs_filtered (&exp->elts[*pos + 2].string, stream);
2000 *pos += 4 + BYTES_TO_EXP_ELEM (len + 1);
2001 }
2002 break;
2003
2004 case OP_OTHERS:
2005 {
2006 fputs_filtered ("<<others>> (", stream);
2007 ++*pos;
2008 rust_print_subexp (exp, pos, stream, prec);
2009 fputs_filtered (")", stream);
2010 }
2011 break;
2012
2013 case STRUCTOP_ANONYMOUS:
2014 {
2015 int tem = longest_to_int (exp->elts[*pos + 1].longconst);
2016
2017 (*pos) += 3;
2018 print_subexp (exp, pos, stream, PREC_SUFFIX);
2019 fprintf_filtered (stream, ".%d", tem);
2020 }
2021 return;
2022
2023 case OP_RUST_ARRAY:
2024 ++*pos;
2025 fprintf_filtered (stream, "[");
2026 rust_print_subexp (exp, pos, stream, prec);
2027 fprintf_filtered (stream, "; ");
2028 rust_print_subexp (exp, pos, stream, prec);
2029 fprintf_filtered (stream, "]");
2030 break;
2031
2032 default:
2033 print_subexp_standard (exp, pos, stream, prec);
2034 break;
2035 }
2036 }
2037
2038 /* operator_check implementation for Rust. */
2039
2040 static int
2041 rust_operator_check (struct expression *exp, int pos,
2042 int (*objfile_func) (struct objfile *objfile,
2043 void *data),
2044 void *data)
2045 {
2046 switch (exp->elts[pos].opcode)
2047 {
2048 case OP_AGGREGATE:
2049 {
2050 struct type *type = exp->elts[pos + 1].type;
2051 struct objfile *objfile = TYPE_OBJFILE (type);
2052
2053 if (objfile != NULL && (*objfile_func) (objfile, data))
2054 return 1;
2055 }
2056 break;
2057
2058 case OP_OTHERS:
2059 case OP_NAME:
2060 case OP_RUST_ARRAY:
2061 break;
2062
2063 default:
2064 return operator_check_standard (exp, pos, objfile_func, data);
2065 }
2066
2067 return 0;
2068 }
2069
2070 \f
2071
2072 /* Implementation of la_lookup_symbol_nonlocal for Rust. */
2073
2074 static struct block_symbol
2075 rust_lookup_symbol_nonlocal (const struct language_defn *langdef,
2076 const char *name,
2077 const struct block *block,
2078 const domain_enum domain)
2079 {
2080 struct block_symbol result = {NULL, NULL};
2081
2082 if (symbol_lookup_debug)
2083 {
2084 fprintf_unfiltered (gdb_stdlog,
2085 "rust_lookup_symbol_non_local"
2086 " (%s, %s (scope %s), %s)\n",
2087 name, host_address_to_string (block),
2088 block_scope (block), domain_name (domain));
2089 }
2090
2091 /* Look up bare names in the block's scope. */
2092 if (name[cp_find_first_component (name)] == '\0')
2093 {
2094 const char *scope = block_scope (block);
2095
2096 if (scope[0] != '\0')
2097 {
2098 std::string scopedname = std::string (scope) + "::" + name;
2099
2100 result = lookup_symbol_in_static_block (scopedname.c_str (), block,
2101 domain);
2102 if (result.symbol == NULL)
2103 result = lookup_global_symbol (scopedname.c_str (), block, domain);
2104 }
2105 }
2106 return result;
2107 }
2108
2109 \f
2110
2111 /* la_sniff_from_mangled_name for Rust. */
2112
2113 static int
2114 rust_sniff_from_mangled_name (const char *mangled, char **demangled)
2115 {
2116 *demangled = gdb_demangle (mangled, DMGL_PARAMS | DMGL_ANSI);
2117 return *demangled != NULL;
2118 }
2119
2120 \f
2121
2122 static const struct exp_descriptor exp_descriptor_rust =
2123 {
2124 rust_print_subexp,
2125 rust_operator_length,
2126 rust_operator_check,
2127 rust_op_name,
2128 rust_dump_subexp_body,
2129 rust_evaluate_subexp
2130 };
2131
2132 static const char *rust_extensions[] =
2133 {
2134 ".rs", NULL
2135 };
2136
2137 static const struct language_defn rust_language_defn =
2138 {
2139 "rust",
2140 "Rust",
2141 language_rust,
2142 range_check_on,
2143 case_sensitive_on,
2144 array_row_major,
2145 macro_expansion_no,
2146 rust_extensions,
2147 &exp_descriptor_rust,
2148 rust_parse,
2149 rustyyerror,
2150 null_post_parser,
2151 rust_printchar, /* Print a character constant */
2152 rust_printstr, /* Function to print string constant */
2153 rust_emitchar, /* Print a single char */
2154 rust_print_type, /* Print a type using appropriate syntax */
2155 rust_print_typedef, /* Print a typedef using appropriate syntax */
2156 rust_val_print, /* Print a value using appropriate syntax */
2157 c_value_print, /* Print a top-level value */
2158 default_read_var_value, /* la_read_var_value */
2159 NULL, /* Language specific skip_trampoline */
2160 NULL, /* name_of_this */
2161 rust_lookup_symbol_nonlocal, /* lookup_symbol_nonlocal */
2162 basic_lookup_transparent_type,/* lookup_transparent_type */
2163 gdb_demangle, /* Language specific symbol demangler */
2164 rust_sniff_from_mangled_name,
2165 NULL, /* Language specific
2166 class_name_from_physname */
2167 c_op_print_tab, /* expression operators for printing */
2168 1, /* c-style arrays */
2169 0, /* String lower bound */
2170 default_word_break_characters,
2171 default_make_symbol_completion_list,
2172 rust_language_arch_info,
2173 default_print_array_index,
2174 default_pass_by_reference,
2175 c_get_string,
2176 NULL, /* la_get_symbol_name_cmp */
2177 iterate_over_symbols,
2178 &default_varobj_ops,
2179 NULL,
2180 NULL,
2181 LANG_MAGIC
2182 };
2183
2184 void
2185 _initialize_rust_language (void)
2186 {
2187 add_language (&rust_language_defn);
2188 }
This page took 0.105533 seconds and 4 git commands to generate.