1 /* Objective-C language support routines for GDB, the GNU debugger.
3 Copyright (C) 2002-2018 Free Software Foundation, Inc.
5 Contributed by Apple Computer, Inc.
6 Written by Michael Snyder.
8 This file is part of GDB.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>. */
26 #include "expression.h"
27 #include "parser-defs.h"
31 #include "objc-lang.h"
32 #include "complaints.h"
36 #include "target.h" /* for target_has_execution */
40 #include "gdb_regex.h"
45 #include "cli/cli-utils.h"
56 CORE_ADDR super_class;
78 static const struct objfile_data *objc_objfile_data;
80 /* Lookup a structure type named "struct NAME", visible in lexical
81 block BLOCK. If NOERR is nonzero, return zero if NAME is not
85 lookup_struct_typedef (const char *name, const struct block *block, int noerr)
89 sym = lookup_symbol (name, block, STRUCT_DOMAIN, 0).symbol;
96 error (_("No struct type named %s."), name);
98 if (TYPE_CODE (SYMBOL_TYPE (sym)) != TYPE_CODE_STRUCT)
103 error (_("This context has class, union or enum %s, not a struct."),
110 lookup_objc_class (struct gdbarch *gdbarch, const char *classname)
112 struct type *char_type = builtin_type (gdbarch)->builtin_char;
113 struct value * function, *classval;
115 if (! target_has_execution)
117 /* Can't call into inferior to lookup class. */
121 if (lookup_minimal_symbol("objc_lookUpClass", 0, 0).minsym)
122 function = find_function_in_inferior("objc_lookUpClass", NULL);
123 else if (lookup_minimal_symbol ("objc_lookup_class", 0, 0).minsym)
124 function = find_function_in_inferior("objc_lookup_class", NULL);
127 complaint (_("no way to lookup Objective-C classes"));
131 classval = value_string (classname, strlen (classname) + 1, char_type);
132 classval = value_coerce_array (classval);
133 return (CORE_ADDR) value_as_long (call_function_by_hand (function,
139 lookup_child_selector (struct gdbarch *gdbarch, const char *selname)
141 struct type *char_type = builtin_type (gdbarch)->builtin_char;
142 struct value * function, *selstring;
144 if (! target_has_execution)
146 /* Can't call into inferior to lookup selector. */
150 if (lookup_minimal_symbol("sel_getUid", 0, 0).minsym)
151 function = find_function_in_inferior("sel_getUid", NULL);
152 else if (lookup_minimal_symbol ("sel_get_any_uid", 0, 0).minsym)
153 function = find_function_in_inferior("sel_get_any_uid", NULL);
156 complaint (_("no way to lookup Objective-C selectors"));
160 selstring = value_coerce_array (value_string (selname,
161 strlen (selname) + 1,
163 return value_as_long (call_function_by_hand (function, NULL, 1, &selstring));
167 value_nsstring (struct gdbarch *gdbarch, char *ptr, int len)
169 struct type *char_type = builtin_type (gdbarch)->builtin_char;
170 struct value *stringValue[3];
171 struct value *function, *nsstringValue;
175 if (!target_has_execution)
176 return 0; /* Can't call into inferior to create NSString. */
178 stringValue[2] = value_string(ptr, len, char_type);
179 stringValue[2] = value_coerce_array(stringValue[2]);
180 /* _NSNewStringFromCString replaces "istr" after Lantern2A. */
181 if (lookup_minimal_symbol("_NSNewStringFromCString", 0, 0).minsym)
183 function = find_function_in_inferior("_NSNewStringFromCString", NULL);
184 nsstringValue = call_function_by_hand(function,
185 NULL, 1, &stringValue[2]);
187 else if (lookup_minimal_symbol("istr", 0, 0).minsym)
189 function = find_function_in_inferior("istr", NULL);
190 nsstringValue = call_function_by_hand(function, NULL, 1, &stringValue[2]);
192 else if (lookup_minimal_symbol("+[NSString stringWithCString:]", 0, 0).minsym)
195 = find_function_in_inferior("+[NSString stringWithCString:]", NULL);
196 type = builtin_type (gdbarch)->builtin_long;
198 stringValue[0] = value_from_longest
199 (type, lookup_objc_class (gdbarch, "NSString"));
200 stringValue[1] = value_from_longest
201 (type, lookup_child_selector (gdbarch, "stringWithCString:"));
202 nsstringValue = call_function_by_hand(function, NULL, 3, &stringValue[0]);
205 error (_("NSString: internal error -- no way to create new NSString"));
207 sym = lookup_struct_typedef("NSString", 0, 1);
209 sym = lookup_struct_typedef("NXString", 0, 1);
211 type = builtin_type (gdbarch)->builtin_data_ptr;
213 type = lookup_pointer_type(SYMBOL_TYPE (sym));
215 deprecated_set_value_type (nsstringValue, type);
216 return nsstringValue;
219 /* Objective-C name demangling. */
222 objc_demangle (const char *mangled, int options)
224 char *demangled, *cp;
226 if (mangled[0] == '_' &&
227 (mangled[1] == 'i' || mangled[1] == 'c') &&
230 cp = demangled = (char *) xmalloc (strlen (mangled) + 2);
232 if (mangled[1] == 'i')
233 *cp++ = '-'; /* for instance method */
235 *cp++ = '+'; /* for class method */
237 *cp++ = '['; /* opening left brace */
238 strcpy(cp, mangled+3); /* Tack on the rest of the mangled name. */
240 while (*cp && *cp == '_')
241 cp++; /* Skip any initial underbars in class
244 cp = strchr(cp, '_');
245 if (!cp) /* Find first non-initial underbar. */
247 xfree(demangled); /* not mangled name */
250 if (cp[1] == '_') /* Easy case: no category name. */
252 *cp++ = ' '; /* Replace two '_' with one ' '. */
253 strcpy(cp, mangled + (cp - demangled) + 2);
257 *cp++ = '('; /* Less easy case: category name. */
258 cp = strchr(cp, '_');
261 xfree(demangled); /* not mangled name */
265 *cp++ = ' '; /* Overwriting 1st char of method name... */
266 strcpy(cp, mangled + (cp - demangled)); /* Get it back. */
269 while (*cp && *cp == '_')
270 cp++; /* Skip any initial underbars in
275 *cp = ':'; /* Replace remaining '_' with ':'. */
277 *cp++ = ']'; /* closing right brace */
278 *cp++ = 0; /* string terminator */
282 return NULL; /* Not an objc mangled name. */
285 /* la_sniff_from_mangled_name for ObjC. */
288 objc_sniff_from_mangled_name (const char *mangled, char **demangled)
290 *demangled = objc_demangle (mangled, 0);
291 return *demangled != NULL;
294 /* Determine if we are currently in the Objective-C dispatch function.
295 If so, get the address of the method function that the dispatcher
296 would call and use that as the function to step into instead. Also
297 skip over the trampoline for the function (if any). This is better
298 for the user since they are only interested in stepping into the
299 method function anyway. */
301 objc_skip_trampoline (struct frame_info *frame, CORE_ADDR stop_pc)
303 struct gdbarch *gdbarch = get_frame_arch (frame);
304 CORE_ADDR real_stop_pc;
305 CORE_ADDR method_stop_pc;
307 real_stop_pc = gdbarch_skip_trampoline_code (gdbarch, frame, stop_pc);
309 if (real_stop_pc != 0)
310 find_objc_msgcall (real_stop_pc, &method_stop_pc);
312 find_objc_msgcall (stop_pc, &method_stop_pc);
316 real_stop_pc = gdbarch_skip_trampoline_code
317 (gdbarch, frame, method_stop_pc);
318 if (real_stop_pc == 0)
319 real_stop_pc = method_stop_pc;
326 /* Table mapping opcodes into strings for printing operators
327 and precedences of the operators. */
329 static const struct op_print objc_op_print_tab[] =
331 {",", BINOP_COMMA, PREC_COMMA, 0},
332 {"=", BINOP_ASSIGN, PREC_ASSIGN, 1},
333 {"||", BINOP_LOGICAL_OR, PREC_LOGICAL_OR, 0},
334 {"&&", BINOP_LOGICAL_AND, PREC_LOGICAL_AND, 0},
335 {"|", BINOP_BITWISE_IOR, PREC_BITWISE_IOR, 0},
336 {"^", BINOP_BITWISE_XOR, PREC_BITWISE_XOR, 0},
337 {"&", BINOP_BITWISE_AND, PREC_BITWISE_AND, 0},
338 {"==", BINOP_EQUAL, PREC_EQUAL, 0},
339 {"!=", BINOP_NOTEQUAL, PREC_EQUAL, 0},
340 {"<=", BINOP_LEQ, PREC_ORDER, 0},
341 {">=", BINOP_GEQ, PREC_ORDER, 0},
342 {">", BINOP_GTR, PREC_ORDER, 0},
343 {"<", BINOP_LESS, PREC_ORDER, 0},
344 {">>", BINOP_RSH, PREC_SHIFT, 0},
345 {"<<", BINOP_LSH, PREC_SHIFT, 0},
346 {"+", BINOP_ADD, PREC_ADD, 0},
347 {"-", BINOP_SUB, PREC_ADD, 0},
348 {"*", BINOP_MUL, PREC_MUL, 0},
349 {"/", BINOP_DIV, PREC_MUL, 0},
350 {"%", BINOP_REM, PREC_MUL, 0},
351 {"@", BINOP_REPEAT, PREC_REPEAT, 0},
352 {"-", UNOP_NEG, PREC_PREFIX, 0},
353 {"!", UNOP_LOGICAL_NOT, PREC_PREFIX, 0},
354 {"~", UNOP_COMPLEMENT, PREC_PREFIX, 0},
355 {"*", UNOP_IND, PREC_PREFIX, 0},
356 {"&", UNOP_ADDR, PREC_PREFIX, 0},
357 {"sizeof ", UNOP_SIZEOF, PREC_PREFIX, 0},
358 {"++", UNOP_PREINCREMENT, PREC_PREFIX, 0},
359 {"--", UNOP_PREDECREMENT, PREC_PREFIX, 0},
360 {NULL, OP_NULL, PREC_NULL, 0}
363 static const char *objc_extensions[] =
368 extern const struct language_defn objc_language_defn = {
369 "objective-c", /* Language name */
377 &exp_descriptor_standard,
380 c_printchar, /* Print a character constant */
381 c_printstr, /* Function to print string constant */
383 c_print_type, /* Print a type using appropriate syntax */
384 c_print_typedef, /* Print a typedef using appropriate syntax */
385 c_val_print, /* Print a value using appropriate syntax */
386 c_value_print, /* Print a top-level value */
387 default_read_var_value, /* la_read_var_value */
388 objc_skip_trampoline, /* Language specific skip_trampoline */
389 "self", /* name_of_this */
390 false, /* la_store_sym_names_in_linkage_form_p */
391 basic_lookup_symbol_nonlocal, /* lookup_symbol_nonlocal */
392 basic_lookup_transparent_type,/* lookup_transparent_type */
393 objc_demangle, /* Language specific symbol demangler */
394 objc_sniff_from_mangled_name,
395 NULL, /* Language specific
396 class_name_from_physname */
397 objc_op_print_tab, /* Expression operators for printing */
398 1, /* C-style arrays */
399 0, /* String lower bound */
400 default_word_break_characters,
401 default_collect_symbol_completion_matches,
402 c_language_arch_info,
403 default_print_array_index,
404 default_pass_by_reference,
406 c_watch_location_expression,
407 NULL, /* la_get_symbol_name_matcher */
408 iterate_over_symbols,
409 default_search_name_hash,
418 * Following functions help construct Objective-C message calls.
421 struct selname /* For parsing Objective-C. */
423 struct selname *next;
428 static int msglist_len;
429 static struct selname *selname_chain;
430 static char *msglist_sel;
435 struct selname *newobj = XNEW (struct selname);
437 newobj->next = selname_chain;
438 newobj->msglist_len = msglist_len;
439 newobj->msglist_sel = msglist_sel;
441 msglist_sel = (char *)xmalloc(1);
443 selname_chain = newobj;
447 add_msglist(struct stoken *str, int addcolon)
453 if (str == 0) /* Unnamed arg, or... */
455 if (addcolon == 0) /* variable number of args. */
468 len = plen + strlen(msglist_sel) + 2;
469 s = (char *)xmalloc(len);
470 strcpy(s, msglist_sel);
485 end_msglist (struct parser_state *ps)
487 int val = msglist_len;
488 struct selname *sel = selname_chain;
489 char *p = msglist_sel;
492 selname_chain = sel->next;
493 msglist_len = sel->msglist_len;
494 msglist_sel = sel->msglist_sel;
495 selid = lookup_child_selector (parse_gdbarch (ps), p);
497 error (_("Can't find selector \"%s\""), p);
498 write_exp_elt_longcst (ps, selid);
500 write_exp_elt_longcst (ps, val); /* Number of args */
507 * Function: specialcmp (const char *a, const char *b)
509 * Special strcmp: treats ']' and ' ' as end-of-string.
510 * Used for qsorting lists of objc methods (either by class or selector).
514 specialcmp (const char *a, const char *b)
516 while (*a && *a != ' ' && *a != ']' && *b && *b != ' ' && *b != ']')
522 if (*a && *a != ' ' && *a != ']')
523 return 1; /* a is longer therefore greater. */
524 if (*b && *b != ' ' && *b != ']')
525 return -1; /* a is shorter therefore lesser. */
526 return 0; /* a and b are identical. */
530 * Function: compare_selectors (const void *, const void *)
532 * Comparison function for use with qsort. Arguments are symbols or
533 * msymbols Compares selector part of objc method name alphabetically.
537 compare_selectors (const void *a, const void *b)
539 const char *aname, *bname;
541 aname = SYMBOL_PRINT_NAME (*(struct symbol **) a);
542 bname = SYMBOL_PRINT_NAME (*(struct symbol **) b);
543 if (aname == NULL || bname == NULL)
544 error (_("internal: compare_selectors(1)"));
546 aname = strchr(aname, ' ');
547 bname = strchr(bname, ' ');
548 if (aname == NULL || bname == NULL)
549 error (_("internal: compare_selectors(2)"));
551 return specialcmp (aname+1, bname+1);
555 * Function: selectors_info (regexp, from_tty)
557 * Implements the "Info selectors" command. Takes an optional regexp
558 * arg. Lists all objective c selectors that match the regexp. Works
559 * by grepping thru all symbols for objective c methods. Output list
560 * is sorted and uniqued.
564 info_selectors_command (const char *regexp, int from_tty)
566 struct objfile *objfile;
567 struct minimal_symbol *msymbol;
575 struct symbol **sym_arr;
579 strcpy(myregexp, ".*]"); /* Null input, match all objc methods. */
582 if (*regexp == '+' || *regexp == '-')
583 { /* User wants only class methods or only instance methods. */
584 plusminus = *regexp++;
585 while (*regexp == ' ' || *regexp == '\t')
589 strcpy(myregexp, ".*]");
592 /* Allow a few extra bytes because of the strcat below. */
593 if (sizeof (myregexp) < strlen (regexp) + 4)
594 error (_("Regexp is too long: %s"), regexp);
595 strcpy(myregexp, regexp);
596 if (myregexp[strlen(myregexp) - 1] == '$') /* end of selector */
597 myregexp[strlen(myregexp) - 1] = ']'; /* end of method name */
599 strcat(myregexp, ".*]");
605 val = re_comp (myregexp);
607 error (_("Invalid regexp (%s): %s"), val, regexp);
610 /* First time thru is JUST to get max length and count. */
611 ALL_MSYMBOLS (objfile, msymbol)
614 name = MSYMBOL_NATURAL_NAME (msymbol);
616 && (name[0] == '-' || name[0] == '+')
617 && name[1] == '[') /* Got a method name. */
619 /* Filter for class/instance methods. */
620 if (plusminus && name[0] != plusminus)
622 /* Find selector part. */
623 name = (char *) strchr (name+2, ' ');
626 complaint (_("Bad method name '%s'"),
627 MSYMBOL_NATURAL_NAME (msymbol));
630 if (regexp == NULL || re_exec(++name) != 0)
632 const char *mystart = name;
633 const char *myend = strchr (mystart, ']');
635 if (myend && (myend - mystart > maxlen))
636 maxlen = myend - mystart; /* Get longest selector. */
643 printf_filtered (_("Selectors matching \"%s\":\n\n"),
644 regexp ? regexp : "*");
646 sym_arr = XALLOCAVEC (struct symbol *, matches);
648 ALL_MSYMBOLS (objfile, msymbol)
651 name = MSYMBOL_NATURAL_NAME (msymbol);
653 (name[0] == '-' || name[0] == '+') &&
654 name[1] == '[') /* Got a method name. */
656 /* Filter for class/instance methods. */
657 if (plusminus && name[0] != plusminus)
659 /* Find selector part. */
660 name = (char *) strchr(name+2, ' ');
661 if (regexp == NULL || re_exec(++name) != 0)
662 sym_arr[matches++] = (struct symbol *) msymbol;
666 qsort (sym_arr, matches, sizeof (struct minimal_symbol *),
668 /* Prevent compare on first iteration. */
670 for (ix = 0; ix < matches; ix++) /* Now do the output. */
675 name = SYMBOL_NATURAL_NAME (sym_arr[ix]);
676 name = strchr (name, ' ') + 1;
677 if (p[0] && specialcmp(name, p) == 0)
678 continue; /* Seen this one already (not unique). */
680 /* Copy selector part. */
681 while (*name && *name != ']')
684 /* Print in columns. */
685 puts_filtered_tabular(asel, maxlen + 1, 0);
690 printf_filtered (_("No selectors matching \"%s\"\n"),
691 regexp ? regexp : "*");
695 * Function: compare_classes (const void *, const void *)
697 * Comparison function for use with qsort. Arguments are symbols or
698 * msymbols Compares class part of objc method name alphabetically.
702 compare_classes (const void *a, const void *b)
704 const char *aname, *bname;
706 aname = SYMBOL_PRINT_NAME (*(struct symbol **) a);
707 bname = SYMBOL_PRINT_NAME (*(struct symbol **) b);
708 if (aname == NULL || bname == NULL)
709 error (_("internal: compare_classes(1)"));
711 return specialcmp (aname+1, bname+1);
715 * Function: classes_info(regexp, from_tty)
717 * Implements the "info classes" command for objective c classes.
718 * Lists all objective c classes that match the optional regexp.
719 * Works by grepping thru the list of objective c methods. List will
720 * be sorted and uniqued (since one class may have many methods).
721 * BUGS: will not list a class that has no methods.
725 info_classes_command (const char *regexp, int from_tty)
727 struct objfile *objfile;
728 struct minimal_symbol *msymbol;
736 struct symbol **sym_arr;
739 strcpy(myregexp, ".* "); /* Null input: match all objc classes. */
742 /* Allow a few extra bytes because of the strcat below. */
743 if (sizeof (myregexp) < strlen (regexp) + 4)
744 error (_("Regexp is too long: %s"), regexp);
745 strcpy(myregexp, regexp);
746 if (myregexp[strlen(myregexp) - 1] == '$')
747 /* In the method name, the end of the class name is marked by ' '. */
748 myregexp[strlen(myregexp) - 1] = ' ';
750 strcat(myregexp, ".* ");
755 val = re_comp (myregexp);
757 error (_("Invalid regexp (%s): %s"), val, regexp);
760 /* First time thru is JUST to get max length and count. */
761 ALL_MSYMBOLS (objfile, msymbol)
764 name = MSYMBOL_NATURAL_NAME (msymbol);
766 (name[0] == '-' || name[0] == '+') &&
767 name[1] == '[') /* Got a method name. */
768 if (regexp == NULL || re_exec(name+2) != 0)
770 /* Compute length of classname part. */
771 const char *mystart = name + 2;
772 const char *myend = strchr (mystart, ' ');
774 if (myend && (myend - mystart > maxlen))
775 maxlen = myend - mystart;
781 printf_filtered (_("Classes matching \"%s\":\n\n"),
782 regexp ? regexp : "*");
783 sym_arr = XALLOCAVEC (struct symbol *, matches);
785 ALL_MSYMBOLS (objfile, msymbol)
788 name = MSYMBOL_NATURAL_NAME (msymbol);
790 (name[0] == '-' || name[0] == '+') &&
791 name[1] == '[') /* Got a method name. */
792 if (regexp == NULL || re_exec(name+2) != 0)
793 sym_arr[matches++] = (struct symbol *) msymbol;
796 qsort (sym_arr, matches, sizeof (struct minimal_symbol *),
798 /* Prevent compare on first iteration. */
800 for (ix = 0; ix < matches; ix++) /* Now do the output. */
805 name = SYMBOL_NATURAL_NAME (sym_arr[ix]);
807 if (p[0] && specialcmp(name, p) == 0)
808 continue; /* Seen this one already (not unique). */
810 /* Copy class part of method name. */
811 while (*name && *name != ' ')
814 /* Print in columns. */
815 puts_filtered_tabular(aclass, maxlen + 1, 0);
820 printf_filtered (_("No classes matching \"%s\"\n"), regexp ? regexp : "*");
824 parse_selector (char *method, char **selector)
830 char *nselector = NULL;
832 gdb_assert (selector != NULL);
836 s1 = skip_spaces (s1);
842 s1 = skip_spaces (s1);
849 if (isalnum (*s2) || (*s2 == '_') || (*s2 == ':'))
851 else if (isspace (*s2))
853 else if ((*s2 == '\0') || (*s2 == '\''))
861 s2 = skip_spaces (s2);
866 s2 = skip_spaces (s2);
869 if (selector != NULL)
870 *selector = nselector;
876 parse_method (char *method, char *type, char **theclass,
877 char **category, char **selector)
885 char *ncategory = NULL;
886 char *nselector = NULL;
888 gdb_assert (type != NULL);
889 gdb_assert (theclass != NULL);
890 gdb_assert (category != NULL);
891 gdb_assert (selector != NULL);
895 s1 = skip_spaces (s1);
901 s1 = skip_spaces (s1);
903 if ((s1[0] == '+') || (s1[0] == '-'))
906 s1 = skip_spaces (s1);
913 while (isalnum (*s1) || (*s1 == '_'))
917 s2 = skip_spaces (s2);
922 s2 = skip_spaces (s2);
924 while (isalnum (*s2) || (*s2 == '_'))
929 /* Truncate the class name now that we're not using the open paren. */
937 if (isalnum (*s2) || (*s2 == '_') || (*s2 == ':'))
939 else if (isspace (*s2))
950 s2 = skip_spaces (s2);
956 s2 = skip_spaces (s2);
961 if (theclass != NULL)
963 if (category != NULL)
964 *category = ncategory;
965 if (selector != NULL)
966 *selector = nselector;
972 find_methods (char type, const char *theclass, const char *category,
973 const char *selector,
974 std::vector<const char *> *symbol_names)
976 struct objfile *objfile = NULL;
978 const char *symname = NULL;
982 char *ncategory = NULL;
983 char *nselector = NULL;
985 static char *tmp = NULL;
986 static unsigned int tmplen = 0;
988 gdb_assert (symbol_names != NULL);
990 ALL_OBJFILES (objfile)
992 unsigned int *objc_csym;
993 struct minimal_symbol *msymbol = NULL;
995 /* The objfile_csym variable counts the number of ObjC methods
996 that this objfile defines. We save that count as a private
997 objfile data. If we have already determined that this objfile
998 provides no ObjC methods, we can skip it entirely. */
1000 unsigned int objfile_csym = 0;
1002 objc_csym = (unsigned int *) objfile_data (objfile, objc_objfile_data);
1003 if (objc_csym != NULL && *objc_csym == 0)
1004 /* There are no ObjC symbols in this objfile. Skip it entirely. */
1007 ALL_OBJFILE_MSYMBOLS (objfile, msymbol)
1011 /* Check the symbol name first as this can be done entirely without
1012 sending any query to the target. */
1013 symname = MSYMBOL_NATURAL_NAME (msymbol);
1014 if (symname == NULL)
1017 if ((symname[0] != '-' && symname[0] != '+') || (symname[1] != '['))
1018 /* Not a method name. */
1023 /* Now that thinks are a bit sane, clean up the symname. */
1024 while ((strlen (symname) + 1) >= tmplen)
1026 tmplen = (tmplen == 0) ? 1024 : tmplen * 2;
1027 tmp = (char *) xrealloc (tmp, tmplen);
1029 strcpy (tmp, symname);
1031 if (parse_method (tmp, &ntype, &nclass,
1032 &ncategory, &nselector) == NULL)
1035 if ((type != '\0') && (ntype != type))
1038 if ((theclass != NULL)
1039 && ((nclass == NULL) || (strcmp (theclass, nclass) != 0)))
1042 if ((category != NULL) &&
1043 ((ncategory == NULL) || (strcmp (category, ncategory) != 0)))
1046 if ((selector != NULL) &&
1047 ((nselector == NULL) || (strcmp (selector, nselector) != 0)))
1050 symbol_names->push_back (symname);
1053 if (objc_csym == NULL)
1055 objc_csym = XOBNEW (&objfile->objfile_obstack, unsigned int);
1056 *objc_csym = objfile_csym;
1057 set_objfile_data (objfile, objc_objfile_data, objc_csym);
1060 /* Count of ObjC methods in this objfile should be constant. */
1061 gdb_assert (*objc_csym == objfile_csym);
1065 /* Uniquify a VEC of strings. */
1068 uniquify_strings (std::vector<const char *> *strings)
1070 if (strings->empty ())
1073 std::sort (strings->begin (), strings->end (), compare_cstrings);
1074 strings->erase (std::unique (strings->begin (), strings->end (), streq),
1079 * Function: find_imps (const char *selector, struct symbol **sym_arr)
1081 * Input: a string representing a selector
1082 * a pointer to an array of symbol pointers
1083 * possibly a pointer to a symbol found by the caller.
1085 * Output: number of methods that implement that selector. Side
1086 * effects: The array of symbol pointers is filled with matching syms.
1088 * By analogy with function "find_methods" (symtab.c), builds a list
1089 * of symbols matching the ambiguous input, so that "decode_line_2"
1090 * (symtab.c) can list them and ask the user to choose one or more.
1091 * In this case the matches are objective c methods
1092 * ("implementations") matching an objective c selector.
1094 * Note that it is possible for a normal (c-style) function to have
1095 * the same name as an objective c selector. To prevent the selector
1096 * from eclipsing the function, we allow the caller (decode_line_1) to
1097 * search for such a function first, and if it finds one, pass it in
1098 * to us. We will then integrate it into the list. We also search
1099 * for one here, among the minsyms.
1101 * NOTE: if NUM_DEBUGGABLE is non-zero, the sym_arr will be divided
1102 * into two parts: debuggable (struct symbol) syms, and
1103 * non_debuggable (struct minimal_symbol) syms. The debuggable
1104 * ones will come first, before NUM_DEBUGGABLE (which will thus
1105 * be the index of the first non-debuggable one).
1109 find_imps (const char *method, std::vector<const char *> *symbol_names)
1112 char *theclass = NULL;
1113 char *category = NULL;
1114 char *selector = NULL;
1119 int selector_case = 0;
1121 gdb_assert (symbol_names != NULL);
1123 buf = (char *) alloca (strlen (method) + 1);
1124 strcpy (buf, method);
1125 tmp = parse_method (buf, &type, &theclass, &category, &selector);
1129 strcpy (buf, method);
1130 tmp = parse_selector (buf, &selector);
1138 find_methods (type, theclass, category, selector, symbol_names);
1140 /* If we hit the "selector" case, and we found some methods, then
1141 add the selector itself as a symbol, if it exists. */
1142 if (selector_case && !symbol_names->empty ())
1144 struct symbol *sym = lookup_symbol (selector, NULL, VAR_DOMAIN,
1148 symbol_names->push_back (SYMBOL_NATURAL_NAME (sym));
1151 struct bound_minimal_symbol msym
1152 = lookup_minimal_symbol (selector, 0, 0);
1154 if (msym.minsym != NULL)
1155 symbol_names->push_back (MSYMBOL_NATURAL_NAME (msym.minsym));
1159 uniquify_strings (symbol_names);
1161 return method + (tmp - buf);
1165 print_object_command (const char *args, int from_tty)
1167 struct value *object, *function, *description;
1168 CORE_ADDR string_addr, object_addr;
1172 if (!args || !*args)
1174 "The 'print-object' command requires an argument (an Objective-C object)");
1177 expression_up expr = parse_expression (args);
1180 object = evaluate_subexp (builtin_type (expr->gdbarch)->builtin_data_ptr,
1181 expr.get (), &pc, EVAL_NORMAL);
1184 /* Validate the address for sanity. */
1185 object_addr = value_as_long (object);
1186 read_memory (object_addr, &c, 1);
1188 function = find_function_in_inferior ("_NSPrintForDebugger", NULL);
1189 if (function == NULL)
1190 error (_("Unable to locate _NSPrintForDebugger in child process"));
1192 description = call_function_by_hand (function, NULL, 1, &object);
1194 string_addr = value_as_long (description);
1195 if (string_addr == 0)
1196 error (_("object returns null description"));
1198 read_memory (string_addr + i++, &c, 1);
1201 { /* Read and print characters up to EOS. */
1203 printf_filtered ("%c", c);
1204 read_memory (string_addr + i++, &c, 1);
1207 printf_filtered(_("<object returns empty description>"));
1208 printf_filtered ("\n");
1211 /* The data structure 'methcalls' is used to detect method calls (thru
1212 * ObjC runtime lib functions objc_msgSend, objc_msgSendSuper, etc.),
1213 * and ultimately find the method being called.
1216 struct objc_methcall {
1218 /* Return instance method to be called. */
1219 int (*stop_at) (CORE_ADDR, CORE_ADDR *);
1220 /* Start of pc range corresponding to method invocation. */
1222 /* End of pc range corresponding to method invocation. */
1226 static int resolve_msgsend (CORE_ADDR pc, CORE_ADDR *new_pc);
1227 static int resolve_msgsend_stret (CORE_ADDR pc, CORE_ADDR *new_pc);
1228 static int resolve_msgsend_super (CORE_ADDR pc, CORE_ADDR *new_pc);
1229 static int resolve_msgsend_super_stret (CORE_ADDR pc, CORE_ADDR *new_pc);
1231 static struct objc_methcall methcalls[] = {
1232 { "_objc_msgSend", resolve_msgsend, 0, 0},
1233 { "_objc_msgSend_stret", resolve_msgsend_stret, 0, 0},
1234 { "_objc_msgSendSuper", resolve_msgsend_super, 0, 0},
1235 { "_objc_msgSendSuper_stret", resolve_msgsend_super_stret, 0, 0},
1236 { "_objc_getClass", NULL, 0, 0},
1237 { "_objc_getMetaClass", NULL, 0, 0}
1240 #define nmethcalls (sizeof (methcalls) / sizeof (methcalls[0]))
1242 /* The following function, "find_objc_msgsend", fills in the data
1243 * structure "objc_msgs" by finding the addresses of each of the
1244 * (currently four) functions that it holds (of which objc_msgSend is
1245 * the first). This must be called each time symbols are loaded, in
1246 * case the functions have moved for some reason.
1250 find_objc_msgsend (void)
1254 for (i = 0; i < nmethcalls; i++)
1256 struct bound_minimal_symbol func;
1258 /* Try both with and without underscore. */
1259 func = lookup_bound_minimal_symbol (methcalls[i].name);
1260 if ((func.minsym == NULL) && (methcalls[i].name[0] == '_'))
1262 func = lookup_bound_minimal_symbol (methcalls[i].name + 1);
1264 if (func.minsym == NULL)
1266 methcalls[i].begin = 0;
1267 methcalls[i].end = 0;
1271 methcalls[i].begin = BMSYMBOL_VALUE_ADDRESS (func);
1272 methcalls[i].end = minimal_symbol_upper_bound (func);
1276 /* find_objc_msgcall (replaces pc_off_limits)
1278 * ALL that this function now does is to determine whether the input
1279 * address ("pc") is the address of one of the Objective-C message
1280 * dispatch functions (mainly objc_msgSend or objc_msgSendSuper), and
1281 * if so, it returns the address of the method that will be called.
1283 * The old function "pc_off_limits" used to do a lot of other things
1284 * in addition, such as detecting shared library jump stubs and
1285 * returning the address of the shlib function that would be called.
1286 * That functionality has been moved into the gdbarch_skip_trampoline_code and
1287 * IN_SOLIB_TRAMPOLINE macros, which are resolved in the target-
1288 * dependent modules.
1292 find_objc_msgcall_submethod (int (*f) (CORE_ADDR, CORE_ADDR *),
1298 if (f (pc, new_pc) == 0)
1301 CATCH (ex, RETURN_MASK_ALL)
1303 exception_fprintf (gdb_stderr, ex,
1304 "Unable to determine target of "
1305 "Objective-C method call (ignoring):\n");
1313 find_objc_msgcall (CORE_ADDR pc, CORE_ADDR *new_pc)
1317 find_objc_msgsend ();
1323 for (i = 0; i < nmethcalls; i++)
1324 if ((pc >= methcalls[i].begin) && (pc < methcalls[i].end))
1326 if (methcalls[i].stop_at != NULL)
1327 return find_objc_msgcall_submethod (methcalls[i].stop_at,
1337 _initialize_objc_language (void)
1339 add_info ("selectors", info_selectors_command,
1340 _("All Objective-C selectors, or those matching REGEXP."));
1341 add_info ("classes", info_classes_command,
1342 _("All Objective-C classes, or those matching REGEXP."));
1343 add_com ("print-object", class_vars, print_object_command,
1344 _("Ask an Objective-C object to print itself."));
1345 add_com_alias ("po", "print-object", class_vars, 1);
1349 read_objc_method (struct gdbarch *gdbarch, CORE_ADDR addr,
1350 struct objc_method *method)
1352 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1354 method->name = read_memory_unsigned_integer (addr + 0, 4, byte_order);
1355 method->types = read_memory_unsigned_integer (addr + 4, 4, byte_order);
1356 method->imp = read_memory_unsigned_integer (addr + 8, 4, byte_order);
1359 static unsigned long
1360 read_objc_methlist_nmethods (struct gdbarch *gdbarch, CORE_ADDR addr)
1362 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1364 return read_memory_unsigned_integer (addr + 4, 4, byte_order);
1368 read_objc_methlist_method (struct gdbarch *gdbarch, CORE_ADDR addr,
1369 unsigned long num, struct objc_method *method)
1371 gdb_assert (num < read_objc_methlist_nmethods (gdbarch, addr));
1372 read_objc_method (gdbarch, addr + 8 + (12 * num), method);
1376 read_objc_object (struct gdbarch *gdbarch, CORE_ADDR addr,
1377 struct objc_object *object)
1379 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1381 object->isa = read_memory_unsigned_integer (addr, 4, byte_order);
1385 read_objc_super (struct gdbarch *gdbarch, CORE_ADDR addr,
1386 struct objc_super *super)
1388 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1390 super->receiver = read_memory_unsigned_integer (addr, 4, byte_order);
1391 super->theclass = read_memory_unsigned_integer (addr + 4, 4, byte_order);
1395 read_objc_class (struct gdbarch *gdbarch, CORE_ADDR addr,
1396 struct objc_class *theclass)
1398 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1400 theclass->isa = read_memory_unsigned_integer (addr, 4, byte_order);
1401 theclass->super_class = read_memory_unsigned_integer (addr + 4, 4, byte_order);
1402 theclass->name = read_memory_unsigned_integer (addr + 8, 4, byte_order);
1403 theclass->version = read_memory_unsigned_integer (addr + 12, 4, byte_order);
1404 theclass->info = read_memory_unsigned_integer (addr + 16, 4, byte_order);
1405 theclass->instance_size = read_memory_unsigned_integer (addr + 18, 4,
1407 theclass->ivars = read_memory_unsigned_integer (addr + 24, 4, byte_order);
1408 theclass->methods = read_memory_unsigned_integer (addr + 28, 4, byte_order);
1409 theclass->cache = read_memory_unsigned_integer (addr + 32, 4, byte_order);
1410 theclass->protocols = read_memory_unsigned_integer (addr + 36, 4, byte_order);
1414 find_implementation_from_class (struct gdbarch *gdbarch,
1415 CORE_ADDR theclass, CORE_ADDR sel)
1417 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1418 CORE_ADDR subclass = theclass;
1420 while (subclass != 0)
1423 struct objc_class class_str;
1424 unsigned mlistnum = 0;
1426 read_objc_class (gdbarch, subclass, &class_str);
1431 unsigned long nmethods;
1434 mlist = read_memory_unsigned_integer (class_str.methods +
1440 nmethods = read_objc_methlist_nmethods (gdbarch, mlist);
1442 for (i = 0; i < nmethods; i++)
1444 struct objc_method meth_str;
1446 read_objc_methlist_method (gdbarch, mlist, i, &meth_str);
1448 if (meth_str.name == sel)
1449 /* FIXME: hppa arch was doing a pointer dereference
1450 here. There needs to be a better way to do that. */
1451 return meth_str.imp;
1455 subclass = class_str.super_class;
1462 find_implementation (struct gdbarch *gdbarch,
1463 CORE_ADDR object, CORE_ADDR sel)
1465 struct objc_object ostr;
1469 read_objc_object (gdbarch, object, &ostr);
1473 return find_implementation_from_class (gdbarch, ostr.isa, sel);
1477 resolve_msgsend (CORE_ADDR pc, CORE_ADDR *new_pc)
1479 struct frame_info *frame = get_current_frame ();
1480 struct gdbarch *gdbarch = get_frame_arch (frame);
1481 struct type *ptr_type = builtin_type (gdbarch)->builtin_func_ptr;
1487 object = gdbarch_fetch_pointer_argument (gdbarch, frame, 0, ptr_type);
1488 sel = gdbarch_fetch_pointer_argument (gdbarch, frame, 1, ptr_type);
1490 res = find_implementation (gdbarch, object, sel);
1499 resolve_msgsend_stret (CORE_ADDR pc, CORE_ADDR *new_pc)
1501 struct frame_info *frame = get_current_frame ();
1502 struct gdbarch *gdbarch = get_frame_arch (frame);
1503 struct type *ptr_type = builtin_type (gdbarch)->builtin_func_ptr;
1509 object = gdbarch_fetch_pointer_argument (gdbarch, frame, 1, ptr_type);
1510 sel = gdbarch_fetch_pointer_argument (gdbarch, frame, 2, ptr_type);
1512 res = find_implementation (gdbarch, object, sel);
1521 resolve_msgsend_super (CORE_ADDR pc, CORE_ADDR *new_pc)
1523 struct frame_info *frame = get_current_frame ();
1524 struct gdbarch *gdbarch = get_frame_arch (frame);
1525 struct type *ptr_type = builtin_type (gdbarch)->builtin_func_ptr;
1527 struct objc_super sstr;
1533 super = gdbarch_fetch_pointer_argument (gdbarch, frame, 0, ptr_type);
1534 sel = gdbarch_fetch_pointer_argument (gdbarch, frame, 1, ptr_type);
1536 read_objc_super (gdbarch, super, &sstr);
1537 if (sstr.theclass == 0)
1540 res = find_implementation_from_class (gdbarch, sstr.theclass, sel);
1549 resolve_msgsend_super_stret (CORE_ADDR pc, CORE_ADDR *new_pc)
1551 struct frame_info *frame = get_current_frame ();
1552 struct gdbarch *gdbarch = get_frame_arch (frame);
1553 struct type *ptr_type = builtin_type (gdbarch)->builtin_func_ptr;
1555 struct objc_super sstr;
1561 super = gdbarch_fetch_pointer_argument (gdbarch, frame, 1, ptr_type);
1562 sel = gdbarch_fetch_pointer_argument (gdbarch, frame, 2, ptr_type);
1564 read_objc_super (gdbarch, super, &sstr);
1565 if (sstr.theclass == 0)
1568 res = find_implementation_from_class (gdbarch, sstr.theclass, sel);
1577 _initialize_objc_lang (void)
1579 objc_objfile_data = register_objfile_data ();