1 /* Go language support routines for GDB, the GNU debugger.
3 Copyright (C) 2012-2020 Free Software Foundation, Inc.
5 This file is part of GDB.
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.
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.
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/>. */
22 - printing of native types
25 - gccgo mangling needs redoing
26 It's too hard, for example, to know whether one is looking at a mangled
27 Go symbol or not, and their are ambiguities, e.g., the demangler may
28 get passed *any* symbol, including symbols from other languages
29 and including symbols that are already demangled.
30 One thought is to at least add an _G prefix.
31 - 6g mangling isn't supported yet
35 #include "gdb_obstack.h"
42 #include "parser-defs.h"
47 /* The main function in the main package. */
48 static const char GO_MAIN_MAIN
[] = "main.main";
50 /* Function returning the special symbol name used by Go for the main
51 procedure in the main program if it is found in minimal symbol list.
52 This function tries to find minimal symbols so that it finds them even
53 if the program was compiled without debugging information. */
58 struct bound_minimal_symbol msym
;
60 msym
= lookup_minimal_symbol (GO_MAIN_MAIN
, NULL
, NULL
);
61 if (msym
.minsym
!= NULL
)
64 /* No known entry procedure found, the main program is probably not Go. */
68 /* Return non-zero if TYPE is a gccgo string.
69 We assume CHECK_TYPEDEF has already been done. */
72 gccgo_string_p (struct type
*type
)
74 /* gccgo strings don't necessarily have a name we can use. */
76 if (type
->num_fields () == 2)
78 struct type
*type0
= type
->field (0).type ();
79 struct type
*type1
= type
->field (1).type ();
81 type0
= check_typedef (type0
);
82 type1
= check_typedef (type1
);
84 if (type0
->code () == TYPE_CODE_PTR
85 && strcmp (TYPE_FIELD_NAME (type
, 0), "__data") == 0
86 && type1
->code () == TYPE_CODE_INT
87 && strcmp (TYPE_FIELD_NAME (type
, 1), "__length") == 0)
89 struct type
*target_type
= TYPE_TARGET_TYPE (type0
);
91 target_type
= check_typedef (target_type
);
93 if (target_type
->code () == TYPE_CODE_INT
94 && TYPE_LENGTH (target_type
) == 1
95 && strcmp (target_type
->name (), "uint8") == 0)
103 /* Return non-zero if TYPE is a 6g string.
104 We assume CHECK_TYPEDEF has already been done. */
107 sixg_string_p (struct type
*type
)
109 if (type
->num_fields () == 2
110 && type
->name () != NULL
111 && strcmp (type
->name (), "string") == 0)
117 /* Classify the kind of Go object that TYPE is.
118 TYPE is a TYPE_CODE_STRUCT, used to represent a Go object. */
121 go_classify_struct_type (struct type
*type
)
123 type
= check_typedef (type
);
125 /* Recognize strings as they're useful to be able to print without
127 if (gccgo_string_p (type
)
128 || sixg_string_p (type
))
129 return GO_TYPE_STRING
;
134 /* Subroutine of unpack_mangled_go_symbol to simplify it.
135 Given "[foo.]bar.baz", store "bar" in *PACKAGEP and "baz" in *OBJECTP.
136 We stomp on the last '.' to nul-terminate "bar".
137 The caller is responsible for memory management. */
140 unpack_package_and_object (char *buf
,
141 const char **packagep
, const char **objectp
)
145 last_dot
= strrchr (buf
, '.');
146 gdb_assert (last_dot
!= NULL
);
147 *objectp
= last_dot
+ 1;
149 last_dot
= strrchr (buf
, '.');
150 if (last_dot
!= NULL
)
151 *packagep
= last_dot
+ 1;
156 /* Given a mangled Go symbol, find its package name, object name, and
157 method type (if present).
158 E.g., for "libgo_net.textproto.String.N33_libgo_net.textproto.ProtocolError"
159 *PACKAGEP = "textproto"
161 *METHOD_TYPE_PACKAGEP = "textproto"
162 *METHOD_TYPE_OBJECTP = "ProtocolError"
164 Space for the resulting strings is malloc'd in one buffer.
165 PACKAGEP,OBJECTP,METHOD_TYPE* will (typically) point into this buffer.
166 [There are a few exceptions, but the caller is still responsible for
167 freeing the resulting pointer.]
168 A pointer to this buffer is returned, or NULL if symbol isn't a
170 The caller is responsible for freeing the result.
172 *METHOD_TYPE_IS_POINTERP is set to a boolean indicating if
173 the method type is a pointer.
175 There may be value in returning the outer container,
176 i.e., "net" in the above example, but for now it's not needed.
177 Plus it's currently not straightforward to compute,
178 it comes from -fgo-prefix, and there's no algorithm to compute it.
180 If we ever need to unpack the method type, this routine should work
184 unpack_mangled_go_symbol (const char *mangled_name
,
185 const char **packagep
,
186 const char **objectp
,
187 const char **method_type_packagep
,
188 const char **method_type_objectp
,
189 int *method_type_is_pointerp
)
193 int len
= strlen (mangled_name
);
194 /* Pointer to last digit in "N<digit(s)>_". */
196 /* Pointer to "N" if valid "N<digit(s)>_" found. */
198 /* Pointer to the first '.'. */
199 const char *first_dot
;
200 /* Pointer to the last '.'. */
201 const char *last_dot
;
202 /* Non-zero if we saw a pointer indicator. */
205 *packagep
= *objectp
= NULL
;
206 *method_type_packagep
= *method_type_objectp
= NULL
;
207 *method_type_is_pointerp
= 0;
209 /* main.init is mangled specially. */
210 if (strcmp (mangled_name
, "__go_init_main") == 0)
212 char *package
= xstrdup ("main");
219 /* main.main is mangled specially (missing prefix). */
220 if (strcmp (mangled_name
, "main.main") == 0)
222 char *package
= xstrdup ("main");
229 /* We may get passed, e.g., "main.T.Foo", which is *not* mangled.
230 Alas it looks exactly like "prefix.package.object."
231 To cope for now we only recognize the following prefixes:
234 libgo_.*: used by gccgo's runtime
236 Thus we don't support -fgo-prefix (except as used by the runtime). */
237 if (!startswith (mangled_name
, "go.")
238 && !startswith (mangled_name
, "libgo_"))
241 /* Quick check for whether a search may be fruitful. */
242 /* Ignore anything with @plt, etc. in it. */
243 if (strchr (mangled_name
, '@') != NULL
)
245 /* It must have at least two dots. */
246 first_dot
= strchr (mangled_name
, '.');
247 if (first_dot
== NULL
)
249 /* Treat "foo.bar" as unmangled. It can collide with lots of other
250 languages and it's not clear what the consequences are.
251 And except for main.main, all gccgo symbols are at least
252 prefix.package.object. */
253 last_dot
= strrchr (mangled_name
, '.');
254 if (last_dot
== first_dot
)
257 /* More quick checks. */
258 if (last_dot
[1] == '\0' /* foo. */
259 || last_dot
[-1] == '.') /* foo..bar */
262 /* At this point we've decided we have a mangled Go symbol. */
264 buf
= xstrdup (mangled_name
);
266 /* Search backwards looking for "N<digit(s)>". */
268 saw_digit
= method_type
= NULL
;
272 int current
= *(const unsigned char *) --p
;
273 int current_is_digit
= isdigit (current
);
277 if (current_is_digit
)
280 && ((p
> buf
&& p
[-1] == '.')
281 || (p
> buf
+ 1 && p
[-1] == 'p' && p
[-2] == '.')))
283 if (atoi (p
+ 1) == strlen (saw_digit
+ 2))
289 gdb_assert (p
[-1] == 'p');
296 /* Not what we're looking for, reset and keep looking. */
301 if (current_is_digit
&& p
[1] == '_')
303 /* Possible start of method "this" [sic] type. */
309 if (method_type
!= NULL
310 /* Ensure not something like "..foo". */
311 && (method_type
> buf
&& method_type
[-1] != '.'))
313 unpack_package_and_object (saw_digit
+ 2,
314 method_type_packagep
, method_type_objectp
);
316 *method_type_is_pointerp
= saw_pointer
;
319 unpack_package_and_object (buf
, packagep
, objectp
);
323 /* Implements the la_demangle language_defn routine for language Go.
325 N.B. This may get passed *any* symbol, including symbols from other
326 languages and including symbols that are already demangled.
327 Both of these situations are kinda unfortunate, but that's how things
330 N.B. This currently only supports gccgo's mangling.
332 N.B. gccgo's mangling needs, I think, changing.
333 This demangler can't work in all situations,
334 thus not too much effort is currently put into it. */
337 go_demangle (const char *mangled_name
, int options
)
339 struct obstack tempbuf
;
342 const char *package_name
;
343 const char *object_name
;
344 const char *method_type_package_name
;
345 const char *method_type_object_name
;
346 int method_type_is_pointer
;
348 if (mangled_name
== NULL
)
351 name_buf
= unpack_mangled_go_symbol (mangled_name
,
352 &package_name
, &object_name
,
353 &method_type_package_name
,
354 &method_type_object_name
,
355 &method_type_is_pointer
);
356 if (name_buf
== NULL
)
359 obstack_init (&tempbuf
);
361 /* Print methods as they appear in "method expressions". */
362 if (method_type_package_name
!= NULL
)
364 /* FIXME: Seems like we should include package_name here somewhere. */
365 if (method_type_is_pointer
)
366 obstack_grow_str (&tempbuf
, "(*");
367 obstack_grow_str (&tempbuf
, method_type_package_name
);
368 obstack_grow_str (&tempbuf
, ".");
369 obstack_grow_str (&tempbuf
, method_type_object_name
);
370 if (method_type_is_pointer
)
371 obstack_grow_str (&tempbuf
, ")");
372 obstack_grow_str (&tempbuf
, ".");
373 obstack_grow_str (&tempbuf
, object_name
);
377 obstack_grow_str (&tempbuf
, package_name
);
378 obstack_grow_str (&tempbuf
, ".");
379 obstack_grow_str (&tempbuf
, object_name
);
381 obstack_grow_str0 (&tempbuf
, "");
383 result
= xstrdup ((const char *) obstack_finish (&tempbuf
));
384 obstack_free (&tempbuf
, NULL
);
389 /* Given a Go symbol, return its package or NULL if unknown.
390 Space for the result is malloc'd, caller must free. */
393 go_symbol_package_name (const struct symbol
*sym
)
395 const char *mangled_name
= sym
->linkage_name ();
396 const char *package_name
;
397 const char *object_name
;
398 const char *method_type_package_name
;
399 const char *method_type_object_name
;
400 int method_type_is_pointer
;
404 gdb_assert (sym
->language () == language_go
);
405 name_buf
= unpack_mangled_go_symbol (mangled_name
,
406 &package_name
, &object_name
,
407 &method_type_package_name
,
408 &method_type_object_name
,
409 &method_type_is_pointer
);
410 /* Some Go symbols don't have mangled form we interpret (yet). */
411 if (name_buf
== NULL
)
413 result
= xstrdup (package_name
);
418 /* Return the package that BLOCK is in, or NULL if there isn't one.
419 Space for the result is malloc'd, caller must free. */
422 go_block_package_name (const struct block
*block
)
424 while (block
!= NULL
)
426 struct symbol
*function
= BLOCK_FUNCTION (block
);
428 if (function
!= NULL
)
430 char *package_name
= go_symbol_package_name (function
);
432 if (package_name
!= NULL
)
435 /* Stop looking if we find a function without a package name.
436 We're most likely outside of Go and thus the concept of the
437 "current" package is gone. */
441 block
= BLOCK_SUPERBLOCK (block
);
447 /* Table mapping opcodes into strings for printing operators
448 and precedences of the operators.
451 static const struct op_print go_op_print_tab
[] =
453 {",", BINOP_COMMA
, PREC_COMMA
, 0},
454 {"=", BINOP_ASSIGN
, PREC_ASSIGN
, 1},
455 {"||", BINOP_LOGICAL_OR
, PREC_LOGICAL_OR
, 0},
456 {"&&", BINOP_LOGICAL_AND
, PREC_LOGICAL_AND
, 0},
457 {"|", BINOP_BITWISE_IOR
, PREC_BITWISE_IOR
, 0},
458 {"^", BINOP_BITWISE_XOR
, PREC_BITWISE_XOR
, 0},
459 {"&", BINOP_BITWISE_AND
, PREC_BITWISE_AND
, 0},
460 {"==", BINOP_EQUAL
, PREC_EQUAL
, 0},
461 {"!=", BINOP_NOTEQUAL
, PREC_EQUAL
, 0},
462 {"<=", BINOP_LEQ
, PREC_ORDER
, 0},
463 {">=", BINOP_GEQ
, PREC_ORDER
, 0},
464 {">", BINOP_GTR
, PREC_ORDER
, 0},
465 {"<", BINOP_LESS
, PREC_ORDER
, 0},
466 {">>", BINOP_RSH
, PREC_SHIFT
, 0},
467 {"<<", BINOP_LSH
, PREC_SHIFT
, 0},
468 {"+", BINOP_ADD
, PREC_ADD
, 0},
469 {"-", BINOP_SUB
, PREC_ADD
, 0},
470 {"*", BINOP_MUL
, PREC_MUL
, 0},
471 {"/", BINOP_DIV
, PREC_MUL
, 0},
472 {"%", BINOP_REM
, PREC_MUL
, 0},
473 {"@", BINOP_REPEAT
, PREC_REPEAT
, 0},
474 {"-", UNOP_NEG
, PREC_PREFIX
, 0},
475 {"!", UNOP_LOGICAL_NOT
, PREC_PREFIX
, 0},
476 {"^", UNOP_COMPLEMENT
, PREC_PREFIX
, 0},
477 {"*", UNOP_IND
, PREC_PREFIX
, 0},
478 {"&", UNOP_ADDR
, PREC_PREFIX
, 0},
479 {"unsafe.Sizeof ", UNOP_SIZEOF
, PREC_PREFIX
, 0},
480 {"++", UNOP_POSTINCREMENT
, PREC_SUFFIX
, 0},
481 {"--", UNOP_POSTDECREMENT
, PREC_SUFFIX
, 0},
482 {NULL
, OP_NULL
, PREC_SUFFIX
, 0}
485 enum go_primitive_types
{
486 go_primitive_type_void
,
487 go_primitive_type_char
,
488 go_primitive_type_bool
,
489 go_primitive_type_int
,
490 go_primitive_type_uint
,
491 go_primitive_type_uintptr
,
492 go_primitive_type_int8
,
493 go_primitive_type_int16
,
494 go_primitive_type_int32
,
495 go_primitive_type_int64
,
496 go_primitive_type_uint8
,
497 go_primitive_type_uint16
,
498 go_primitive_type_uint32
,
499 go_primitive_type_uint64
,
500 go_primitive_type_float32
,
501 go_primitive_type_float64
,
502 go_primitive_type_complex64
,
503 go_primitive_type_complex128
,
504 nr_go_primitive_types
507 /* Constant data that describes the Go language. */
509 extern const struct language_data go_language_data
=
514 go_op_print_tab
, /* Expression operators for printing. */
518 /* Class representing the Go language. */
520 class go_language
: public language_defn
524 : language_defn (language_go
, go_language_data
)
527 /* See language.h. */
529 const char *name () const override
532 /* See language.h. */
534 const char *natural_name () const override
537 /* See language.h. */
538 void language_arch_info (struct gdbarch
*gdbarch
,
539 struct language_arch_info
*lai
) const override
541 const struct builtin_go_type
*builtin
= builtin_go_type (gdbarch
);
543 lai
->string_char_type
= builtin
->builtin_char
;
545 lai
->primitive_type_vector
546 = GDBARCH_OBSTACK_CALLOC (gdbarch
, nr_go_primitive_types
+ 1,
549 lai
->primitive_type_vector
[go_primitive_type_void
]
550 = builtin
->builtin_void
;
551 lai
->primitive_type_vector
[go_primitive_type_char
]
552 = builtin
->builtin_char
;
553 lai
->primitive_type_vector
[go_primitive_type_bool
]
554 = builtin
->builtin_bool
;
555 lai
->primitive_type_vector
[go_primitive_type_int
]
556 = builtin
->builtin_int
;
557 lai
->primitive_type_vector
[go_primitive_type_uint
]
558 = builtin
->builtin_uint
;
559 lai
->primitive_type_vector
[go_primitive_type_uintptr
]
560 = builtin
->builtin_uintptr
;
561 lai
->primitive_type_vector
[go_primitive_type_int8
]
562 = builtin
->builtin_int8
;
563 lai
->primitive_type_vector
[go_primitive_type_int16
]
564 = builtin
->builtin_int16
;
565 lai
->primitive_type_vector
[go_primitive_type_int32
]
566 = builtin
->builtin_int32
;
567 lai
->primitive_type_vector
[go_primitive_type_int64
]
568 = builtin
->builtin_int64
;
569 lai
->primitive_type_vector
[go_primitive_type_uint8
]
570 = builtin
->builtin_uint8
;
571 lai
->primitive_type_vector
[go_primitive_type_uint16
]
572 = builtin
->builtin_uint16
;
573 lai
->primitive_type_vector
[go_primitive_type_uint32
]
574 = builtin
->builtin_uint32
;
575 lai
->primitive_type_vector
[go_primitive_type_uint64
]
576 = builtin
->builtin_uint64
;
577 lai
->primitive_type_vector
[go_primitive_type_float32
]
578 = builtin
->builtin_float32
;
579 lai
->primitive_type_vector
[go_primitive_type_float64
]
580 = builtin
->builtin_float64
;
581 lai
->primitive_type_vector
[go_primitive_type_complex64
]
582 = builtin
->builtin_complex64
;
583 lai
->primitive_type_vector
[go_primitive_type_complex128
]
584 = builtin
->builtin_complex128
;
586 lai
->bool_type_symbol
= "bool";
587 lai
->bool_type_default
= builtin
->builtin_bool
;
590 /* See language.h. */
591 bool sniff_from_mangled_name (const char *mangled
,
592 char **demangled
) const override
594 *demangled
= go_demangle (mangled
, 0);
595 return *demangled
!= NULL
;
598 /* See language.h. */
600 char *demangle (const char *mangled
, int options
) const override
602 return go_demangle (mangled
, options
);
605 /* See language.h. */
607 void print_type (struct type
*type
, const char *varstring
,
608 struct ui_file
*stream
, int show
, int level
,
609 const struct type_print_options
*flags
) const override
611 go_print_type (type
, varstring
, stream
, show
, level
, flags
);
614 /* See language.h. */
616 void value_print_inner
617 (struct value
*val
, struct ui_file
*stream
, int recurse
,
618 const struct value_print_options
*options
) const override
620 return go_value_print_inner (val
, stream
, recurse
, options
);
623 /* See language.h. */
625 int parser (struct parser_state
*ps
) const override
627 return go_parse (ps
);
630 /* See language.h. */
632 bool is_string_type_p (struct type
*type
) const override
634 type
= check_typedef (type
);
635 return (type
->code () == TYPE_CODE_STRUCT
636 && go_classify_struct_type (type
) == GO_TYPE_STRING
);
639 /* See language.h. */
641 bool store_sym_names_in_linkage_form_p () const override
645 /* Single instance of the Go language class. */
647 static go_language go_language_defn
;
650 build_go_types (struct gdbarch
*gdbarch
)
652 struct builtin_go_type
*builtin_go_type
653 = GDBARCH_OBSTACK_ZALLOC (gdbarch
, struct builtin_go_type
);
655 builtin_go_type
->builtin_void
656 = arch_type (gdbarch
, TYPE_CODE_VOID
, TARGET_CHAR_BIT
, "void");
657 builtin_go_type
->builtin_char
658 = arch_character_type (gdbarch
, 8, 1, "char");
659 builtin_go_type
->builtin_bool
660 = arch_boolean_type (gdbarch
, 8, 0, "bool");
661 builtin_go_type
->builtin_int
662 = arch_integer_type (gdbarch
, gdbarch_int_bit (gdbarch
), 0, "int");
663 builtin_go_type
->builtin_uint
664 = arch_integer_type (gdbarch
, gdbarch_int_bit (gdbarch
), 1, "uint");
665 builtin_go_type
->builtin_uintptr
666 = arch_integer_type (gdbarch
, gdbarch_ptr_bit (gdbarch
), 1, "uintptr");
667 builtin_go_type
->builtin_int8
668 = arch_integer_type (gdbarch
, 8, 0, "int8");
669 builtin_go_type
->builtin_int16
670 = arch_integer_type (gdbarch
, 16, 0, "int16");
671 builtin_go_type
->builtin_int32
672 = arch_integer_type (gdbarch
, 32, 0, "int32");
673 builtin_go_type
->builtin_int64
674 = arch_integer_type (gdbarch
, 64, 0, "int64");
675 builtin_go_type
->builtin_uint8
676 = arch_integer_type (gdbarch
, 8, 1, "uint8");
677 builtin_go_type
->builtin_uint16
678 = arch_integer_type (gdbarch
, 16, 1, "uint16");
679 builtin_go_type
->builtin_uint32
680 = arch_integer_type (gdbarch
, 32, 1, "uint32");
681 builtin_go_type
->builtin_uint64
682 = arch_integer_type (gdbarch
, 64, 1, "uint64");
683 builtin_go_type
->builtin_float32
684 = arch_float_type (gdbarch
, 32, "float32", floatformats_ieee_single
);
685 builtin_go_type
->builtin_float64
686 = arch_float_type (gdbarch
, 64, "float64", floatformats_ieee_double
);
687 builtin_go_type
->builtin_complex64
688 = init_complex_type ("complex64", builtin_go_type
->builtin_float32
);
689 builtin_go_type
->builtin_complex128
690 = init_complex_type ("complex128", builtin_go_type
->builtin_float64
);
692 return builtin_go_type
;
695 static struct gdbarch_data
*go_type_data
;
697 const struct builtin_go_type
*
698 builtin_go_type (struct gdbarch
*gdbarch
)
700 return (const struct builtin_go_type
*) gdbarch_data (gdbarch
, go_type_data
);
703 void _initialize_go_language ();
705 _initialize_go_language ()
707 go_type_data
= gdbarch_data_register_post_init (build_go_types
);