1 /* Go language support routines for GDB, the GNU debugger.
3 Copyright (C) 2012-2014 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_assert.h"
36 #include "gdb_obstack.h"
44 #include "parser-defs.h"
48 /* The main function in the main package. */
49 static const char GO_MAIN_MAIN[] = "main.main";
51 /* Function returning the special symbol name used by Go for the main
52 procedure in the main program if it is found in minimal symbol list.
53 This function tries to find minimal symbols so that it finds them even
54 if the program was compiled without debugging information. */
59 struct bound_minimal_symbol msym;
61 msym = lookup_minimal_symbol (GO_MAIN_MAIN, NULL, NULL);
62 if (msym.minsym != NULL)
65 /* No known entry procedure found, the main program is probably not Go. */
69 /* Return non-zero if TYPE is a gccgo string.
70 We assume CHECK_TYPEDEF has already been done. */
73 gccgo_string_p (struct type *type)
75 /* gccgo strings don't necessarily have a name we can use. */
77 if (TYPE_NFIELDS (type) == 2)
79 struct type *type0 = TYPE_FIELD_TYPE (type, 0);
80 struct type *type1 = TYPE_FIELD_TYPE (type, 1);
82 CHECK_TYPEDEF (type0);
83 CHECK_TYPEDEF (type1);
85 if (TYPE_CODE (type0) == TYPE_CODE_PTR
86 && strcmp (TYPE_FIELD_NAME (type, 0), "__data") == 0
87 && TYPE_CODE (type1) == TYPE_CODE_INT
88 && strcmp (TYPE_FIELD_NAME (type, 1), "__length") == 0)
90 struct type *target_type = TYPE_TARGET_TYPE (type0);
92 CHECK_TYPEDEF (target_type);
94 if (TYPE_CODE (target_type) == TYPE_CODE_INT
95 && TYPE_LENGTH (target_type) == 1
96 && strcmp (TYPE_NAME (target_type), "uint8") == 0)
104 /* Return non-zero if TYPE is a 6g string.
105 We assume CHECK_TYPEDEF has already been done. */
108 sixg_string_p (struct type *type)
110 if (TYPE_NFIELDS (type) == 2
111 && TYPE_TAG_NAME (type) != NULL
112 && strcmp (TYPE_TAG_NAME (type), "string") == 0)
118 /* Classify the kind of Go object that TYPE is.
119 TYPE is a TYPE_CODE_STRUCT, used to represent a Go object. */
122 go_classify_struct_type (struct type *type)
124 CHECK_TYPEDEF (type);
126 /* Recognize strings as they're useful to be able to print without
128 if (gccgo_string_p (type)
129 || sixg_string_p (type))
130 return GO_TYPE_STRING;
135 /* Subroutine of unpack_mangled_go_symbol to simplify it.
136 Given "[foo.]bar.baz", store "bar" in *PACKAGEP and "baz" in *OBJECTP.
137 We stomp on the last '.' to nul-terminate "bar".
138 The caller is responsible for memory management. */
141 unpack_package_and_object (char *buf,
142 const char **packagep, const char **objectp)
146 last_dot = strrchr (buf, '.');
147 gdb_assert (last_dot != NULL);
148 *objectp = last_dot + 1;
150 last_dot = strrchr (buf, '.');
151 if (last_dot != NULL)
152 *packagep = last_dot + 1;
157 /* Given a mangled Go symbol, find its package name, object name, and
158 method type (if present).
159 E.g., for "libgo_net.textproto.String.N33_libgo_net.textproto.ProtocolError"
160 *PACKAGEP = "textproto"
162 *METHOD_TYPE_PACKAGEP = "textproto"
163 *METHOD_TYPE_OBJECTP = "ProtocolError"
165 Space for the resulting strings is malloc'd in one buffer.
166 PACKAGEP,OBJECTP,METHOD_TYPE* will (typically) point into this buffer.
167 [There are a few exceptions, but the caller is still responsible for
168 freeing the resulting pointer.]
169 A pointer to this buffer is returned, or NULL if symbol isn't a
171 The caller is responsible for freeing the result.
173 *METHOD_TYPE_IS_POINTERP is set to a boolean indicating if
174 the method type is a pointer.
176 There may be value in returning the outer container,
177 i.e., "net" in the above example, but for now it's not needed.
178 Plus it's currently not straightforward to compute,
179 it comes from -fgo-prefix, and there's no algorithm to compute it.
181 If we ever need to unpack the method type, this routine should work
185 unpack_mangled_go_symbol (const char *mangled_name,
186 const char **packagep,
187 const char **objectp,
188 const char **method_type_packagep,
189 const char **method_type_objectp,
190 int *method_type_is_pointerp)
194 int len = strlen (mangled_name);
195 /* Pointer to last digit in "N<digit(s)>_". */
197 /* Pointer to "N" if valid "N<digit(s)>_" found. */
199 /* Pointer to the first '.'. */
201 /* Pointer to the last '.'. */
203 /* Non-zero if we saw a pointer indicator. */
206 *packagep = *objectp = NULL;
207 *method_type_packagep = *method_type_objectp = NULL;
208 *method_type_is_pointerp = 0;
210 /* main.init is mangled specially. */
211 if (strcmp (mangled_name, "__go_init_main") == 0)
213 char *package = xstrdup ("main");
220 /* main.main is mangled specially (missing prefix). */
221 if (strcmp (mangled_name, "main.main") == 0)
223 char *package = xstrdup ("main");
230 /* We may get passed, e.g., "main.T.Foo", which is *not* mangled.
231 Alas it looks exactly like "prefix.package.object."
232 To cope for now we only recognize the following prefixes:
235 libgo_.*: used by gccgo's runtime
237 Thus we don't support -fgo-prefix (except as used by the runtime). */
238 if (strncmp (mangled_name, "go.", 3) != 0
239 && strncmp (mangled_name, "libgo_", 6) != 0)
242 /* Quick check for whether a search may be fruitful. */
243 /* Ignore anything with @plt, etc. in it. */
244 if (strchr (mangled_name, '@') != NULL)
246 /* It must have at least two dots. */
247 first_dot = strchr (mangled_name, '.');
248 if (first_dot == NULL)
250 /* Treat "foo.bar" as unmangled. It can collide with lots of other
251 languages and it's not clear what the consequences are.
252 And except for main.main, all gccgo symbols are at least
253 prefix.package.object. */
254 last_dot = strrchr (mangled_name, '.');
255 if (last_dot == first_dot)
258 /* More quick checks. */
259 if (last_dot[1] == '\0' /* foo. */
260 || last_dot[-1] == '.') /* foo..bar */
263 /* At this point we've decided we have a mangled Go symbol. */
265 buf = xstrdup (mangled_name);
267 /* Search backwards looking for "N<digit(s)>". */
269 saw_digit = method_type = NULL;
273 int current = *(const unsigned char *) --p;
274 int current_is_digit = isdigit (current);
278 if (current_is_digit)
281 && ((p > buf && p[-1] == '.')
282 || (p > buf + 1 && p[-1] == 'p' && p[-2] == '.')))
284 if (atoi (p + 1) == strlen (saw_digit + 2))
290 gdb_assert (p[-1] == 'p');
297 /* Not what we're looking for, reset and keep looking. */
302 if (current_is_digit && p[1] == '_')
304 /* Possible start of method "this" [sic] type. */
310 if (method_type != NULL
311 /* Ensure not something like "..foo". */
312 && (method_type > buf && method_type[-1] != '.'))
314 unpack_package_and_object (saw_digit + 2,
315 method_type_packagep, method_type_objectp);
317 *method_type_is_pointerp = saw_pointer;
320 unpack_package_and_object (buf, packagep, objectp);
324 /* Implements the la_demangle language_defn routine for language Go.
326 N.B. This may get passed *any* symbol, including symbols from other
327 languages and including symbols that are already demangled.
328 Both of these situations are kinda unfortunate, but that's how things
331 N.B. This currently only supports gccgo's mangling.
333 N.B. gccgo's mangling needs, I think, changing.
334 This demangler can't work in all situations,
335 thus not too much effort is currently put into it. */
338 go_demangle (const char *mangled_name, int options)
340 struct obstack tempbuf;
343 const char *package_name;
344 const char *object_name;
345 const char *method_type_package_name;
346 const char *method_type_object_name;
347 int method_type_is_pointer;
349 if (mangled_name == NULL)
352 name_buf = unpack_mangled_go_symbol (mangled_name,
353 &package_name, &object_name,
354 &method_type_package_name,
355 &method_type_object_name,
356 &method_type_is_pointer);
357 if (name_buf == NULL)
360 obstack_init (&tempbuf);
362 /* Print methods as they appear in "method expressions". */
363 if (method_type_package_name != NULL)
365 /* FIXME: Seems like we should include package_name here somewhere. */
366 if (method_type_is_pointer)
367 obstack_grow_str (&tempbuf, "(*");
368 obstack_grow_str (&tempbuf, method_type_package_name);
369 obstack_grow_str (&tempbuf, ".");
370 obstack_grow_str (&tempbuf, method_type_object_name);
371 if (method_type_is_pointer)
372 obstack_grow_str (&tempbuf, ")");
373 obstack_grow_str (&tempbuf, ".");
374 obstack_grow_str (&tempbuf, object_name);
378 obstack_grow_str (&tempbuf, package_name);
379 obstack_grow_str (&tempbuf, ".");
380 obstack_grow_str (&tempbuf, object_name);
382 obstack_grow_str0 (&tempbuf, "");
384 result = xstrdup (obstack_finish (&tempbuf));
385 obstack_free (&tempbuf, NULL);
390 /* Given a Go symbol, return its package or NULL if unknown.
391 Space for the result is malloc'd, caller must free. */
394 go_symbol_package_name (const struct symbol *sym)
396 const char *mangled_name = SYMBOL_LINKAGE_NAME (sym);
397 const char *package_name;
398 const char *object_name;
399 const char *method_type_package_name;
400 const char *method_type_object_name;
401 int method_type_is_pointer;
405 gdb_assert (SYMBOL_LANGUAGE (sym) == language_go);
406 name_buf = unpack_mangled_go_symbol (mangled_name,
407 &package_name, &object_name,
408 &method_type_package_name,
409 &method_type_object_name,
410 &method_type_is_pointer);
411 /* Some Go symbols don't have mangled form we interpret (yet). */
412 if (name_buf == NULL)
414 result = xstrdup (package_name);
419 /* Return the package that BLOCK is in, or NULL if there isn't one.
420 Space for the result is malloc'd, caller must free. */
423 go_block_package_name (const struct block *block)
425 while (block != NULL)
427 struct symbol *function = BLOCK_FUNCTION (block);
429 if (function != NULL)
431 char *package_name = go_symbol_package_name (function);
433 if (package_name != NULL)
436 /* Stop looking if we find a function without a package name.
437 We're most likely outside of Go and thus the concept of the
438 "current" package is gone. */
442 block = BLOCK_SUPERBLOCK (block);
448 /* Table mapping opcodes into strings for printing operators
449 and precedences of the operators.
452 static const struct op_print go_op_print_tab[] =
454 {",", BINOP_COMMA, PREC_COMMA, 0},
455 {"=", BINOP_ASSIGN, PREC_ASSIGN, 1},
456 {"||", BINOP_LOGICAL_OR, PREC_LOGICAL_OR, 0},
457 {"&&", BINOP_LOGICAL_AND, PREC_LOGICAL_AND, 0},
458 {"|", BINOP_BITWISE_IOR, PREC_BITWISE_IOR, 0},
459 {"^", BINOP_BITWISE_XOR, PREC_BITWISE_XOR, 0},
460 {"&", BINOP_BITWISE_AND, PREC_BITWISE_AND, 0},
461 {"==", BINOP_EQUAL, PREC_EQUAL, 0},
462 {"!=", BINOP_NOTEQUAL, PREC_EQUAL, 0},
463 {"<=", BINOP_LEQ, PREC_ORDER, 0},
464 {">=", BINOP_GEQ, PREC_ORDER, 0},
465 {">", BINOP_GTR, PREC_ORDER, 0},
466 {"<", BINOP_LESS, PREC_ORDER, 0},
467 {">>", BINOP_RSH, PREC_SHIFT, 0},
468 {"<<", BINOP_LSH, PREC_SHIFT, 0},
469 {"+", BINOP_ADD, PREC_ADD, 0},
470 {"-", BINOP_SUB, PREC_ADD, 0},
471 {"*", BINOP_MUL, PREC_MUL, 0},
472 {"/", BINOP_DIV, PREC_MUL, 0},
473 {"%", BINOP_REM, PREC_MUL, 0},
474 {"@", BINOP_REPEAT, PREC_REPEAT, 0},
475 {"-", UNOP_NEG, PREC_PREFIX, 0},
476 {"!", UNOP_LOGICAL_NOT, PREC_PREFIX, 0},
477 {"^", UNOP_COMPLEMENT, PREC_PREFIX, 0},
478 {"*", UNOP_IND, PREC_PREFIX, 0},
479 {"&", UNOP_ADDR, PREC_PREFIX, 0},
480 {"unsafe.Sizeof ", UNOP_SIZEOF, PREC_PREFIX, 0},
481 {"++", UNOP_POSTINCREMENT, PREC_SUFFIX, 0},
482 {"--", UNOP_POSTDECREMENT, PREC_SUFFIX, 0},
486 enum go_primitive_types {
487 go_primitive_type_void,
488 go_primitive_type_char,
489 go_primitive_type_bool,
490 go_primitive_type_int,
491 go_primitive_type_uint,
492 go_primitive_type_uintptr,
493 go_primitive_type_int8,
494 go_primitive_type_int16,
495 go_primitive_type_int32,
496 go_primitive_type_int64,
497 go_primitive_type_uint8,
498 go_primitive_type_uint16,
499 go_primitive_type_uint32,
500 go_primitive_type_uint64,
501 go_primitive_type_float32,
502 go_primitive_type_float64,
503 go_primitive_type_complex64,
504 go_primitive_type_complex128,
505 nr_go_primitive_types
509 go_language_arch_info (struct gdbarch *gdbarch,
510 struct language_arch_info *lai)
512 const struct builtin_go_type *builtin = builtin_go_type (gdbarch);
514 lai->string_char_type = builtin->builtin_char;
516 lai->primitive_type_vector
517 = GDBARCH_OBSTACK_CALLOC (gdbarch, nr_go_primitive_types + 1,
520 lai->primitive_type_vector [go_primitive_type_void]
521 = builtin->builtin_void;
522 lai->primitive_type_vector [go_primitive_type_char]
523 = builtin->builtin_char;
524 lai->primitive_type_vector [go_primitive_type_bool]
525 = builtin->builtin_bool;
526 lai->primitive_type_vector [go_primitive_type_int]
527 = builtin->builtin_int;
528 lai->primitive_type_vector [go_primitive_type_uint]
529 = builtin->builtin_uint;
530 lai->primitive_type_vector [go_primitive_type_uintptr]
531 = builtin->builtin_uintptr;
532 lai->primitive_type_vector [go_primitive_type_int8]
533 = builtin->builtin_int8;
534 lai->primitive_type_vector [go_primitive_type_int16]
535 = builtin->builtin_int16;
536 lai->primitive_type_vector [go_primitive_type_int32]
537 = builtin->builtin_int32;
538 lai->primitive_type_vector [go_primitive_type_int64]
539 = builtin->builtin_int64;
540 lai->primitive_type_vector [go_primitive_type_uint8]
541 = builtin->builtin_uint8;
542 lai->primitive_type_vector [go_primitive_type_uint16]
543 = builtin->builtin_uint16;
544 lai->primitive_type_vector [go_primitive_type_uint32]
545 = builtin->builtin_uint32;
546 lai->primitive_type_vector [go_primitive_type_uint64]
547 = builtin->builtin_uint64;
548 lai->primitive_type_vector [go_primitive_type_float32]
549 = builtin->builtin_float32;
550 lai->primitive_type_vector [go_primitive_type_float64]
551 = builtin->builtin_float64;
552 lai->primitive_type_vector [go_primitive_type_complex64]
553 = builtin->builtin_complex64;
554 lai->primitive_type_vector [go_primitive_type_complex128]
555 = builtin->builtin_complex128;
557 lai->bool_type_symbol = "bool";
558 lai->bool_type_default = builtin->builtin_bool;
561 static const struct language_defn go_language_defn =
574 c_printchar, /* Print a character constant. */
575 c_printstr, /* Function to print string constant. */
576 c_emit_char, /* Print a single char. */
577 go_print_type, /* Print a type using appropriate syntax. */
578 c_print_typedef, /* Print a typedef using appropriate
580 go_val_print, /* Print a value using appropriate syntax. */
581 c_value_print, /* Print a top-level value. */
582 default_read_var_value, /* la_read_var_value */
583 NULL, /* Language specific skip_trampoline. */
584 NULL, /* name_of_this */
585 basic_lookup_symbol_nonlocal,
586 basic_lookup_transparent_type,
587 go_demangle, /* Language specific symbol demangler. */
588 NULL, /* Language specific
589 class_name_from_physname. */
590 go_op_print_tab, /* Expression operators for printing. */
591 1, /* C-style arrays. */
592 0, /* String lower bound. */
593 default_word_break_characters,
594 default_make_symbol_completion_list,
595 go_language_arch_info,
596 default_print_array_index,
597 default_pass_by_reference,
600 iterate_over_symbols,
606 build_go_types (struct gdbarch *gdbarch)
608 struct builtin_go_type *builtin_go_type
609 = GDBARCH_OBSTACK_ZALLOC (gdbarch, struct builtin_go_type);
611 builtin_go_type->builtin_void
612 = arch_type (gdbarch, TYPE_CODE_VOID, 1, "void");
613 builtin_go_type->builtin_char
614 = arch_character_type (gdbarch, 8, 1, "char");
615 builtin_go_type->builtin_bool
616 = arch_boolean_type (gdbarch, 8, 0, "bool");
617 builtin_go_type->builtin_int
618 = arch_integer_type (gdbarch, gdbarch_int_bit (gdbarch), 0, "int");
619 builtin_go_type->builtin_uint
620 = arch_integer_type (gdbarch, gdbarch_int_bit (gdbarch), 1, "uint");
621 builtin_go_type->builtin_uintptr
622 = arch_integer_type (gdbarch, gdbarch_ptr_bit (gdbarch), 1, "uintptr");
623 builtin_go_type->builtin_int8
624 = arch_integer_type (gdbarch, 8, 0, "int8");
625 builtin_go_type->builtin_int16
626 = arch_integer_type (gdbarch, 16, 0, "int16");
627 builtin_go_type->builtin_int32
628 = arch_integer_type (gdbarch, 32, 0, "int32");
629 builtin_go_type->builtin_int64
630 = arch_integer_type (gdbarch, 64, 0, "int64");
631 builtin_go_type->builtin_uint8
632 = arch_integer_type (gdbarch, 8, 1, "uint8");
633 builtin_go_type->builtin_uint16
634 = arch_integer_type (gdbarch, 16, 1, "uint16");
635 builtin_go_type->builtin_uint32
636 = arch_integer_type (gdbarch, 32, 1, "uint32");
637 builtin_go_type->builtin_uint64
638 = arch_integer_type (gdbarch, 64, 1, "uint64");
639 builtin_go_type->builtin_float32
640 = arch_float_type (gdbarch, 32, "float32", NULL);
641 builtin_go_type->builtin_float64
642 = arch_float_type (gdbarch, 64, "float64", NULL);
643 builtin_go_type->builtin_complex64
644 = arch_complex_type (gdbarch, "complex64",
645 builtin_go_type->builtin_float32);
646 builtin_go_type->builtin_complex128
647 = arch_complex_type (gdbarch, "complex128",
648 builtin_go_type->builtin_float64);
650 return builtin_go_type;
653 static struct gdbarch_data *go_type_data;
655 const struct builtin_go_type *
656 builtin_go_type (struct gdbarch *gdbarch)
658 return gdbarch_data (gdbarch, go_type_data);
661 extern initialize_file_ftype _initialize_go_language;
664 _initialize_go_language (void)
666 go_type_data = gdbarch_data_register_post_init (build_go_types);
668 add_language (&go_language_defn);