1 /* Objective-C language support routines for GDB, the GNU debugger.
3 Copyright (C) 2002-2020 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_key<unsigned int> 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 (SYMBOL_TYPE (sym)->code () != 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, 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, NULL, stringValue[2]);
186 else if (lookup_minimal_symbol("istr", 0, 0).minsym)
188 function = find_function_in_inferior("istr", NULL);
189 nsstringValue = call_function_by_hand(function, NULL, stringValue[2]);
191 else if (lookup_minimal_symbol("+[NSString stringWithCString:]", 0, 0).minsym)
194 = find_function_in_inferior("+[NSString stringWithCString:]", NULL);
195 type = builtin_type (gdbarch)->builtin_long;
197 stringValue[0] = value_from_longest
198 (type, lookup_objc_class (gdbarch, "NSString"));
199 stringValue[1] = value_from_longest
200 (type, lookup_child_selector (gdbarch, "stringWithCString:"));
201 nsstringValue = call_function_by_hand(function, NULL, stringValue);
204 error (_("NSString: internal error -- no way to create new NSString"));
206 sym = lookup_struct_typedef("NSString", 0, 1);
208 sym = lookup_struct_typedef("NXString", 0, 1);
210 type = builtin_type (gdbarch)->builtin_data_ptr;
212 type = lookup_pointer_type(SYMBOL_TYPE (sym));
214 deprecated_set_value_type (nsstringValue, type);
215 return nsstringValue;
218 /* Objective-C name demangling. */
221 objc_demangle (const char *mangled, int options)
223 char *demangled, *cp;
225 if (mangled[0] == '_' &&
226 (mangled[1] == 'i' || mangled[1] == 'c') &&
229 cp = demangled = (char *) xmalloc (strlen (mangled) + 2);
231 if (mangled[1] == 'i')
232 *cp++ = '-'; /* for instance method */
234 *cp++ = '+'; /* for class method */
236 *cp++ = '['; /* opening left brace */
237 strcpy(cp, mangled+3); /* Tack on the rest of the mangled name. */
239 while (*cp && *cp == '_')
240 cp++; /* Skip any initial underbars in class
243 cp = strchr(cp, '_');
244 if (!cp) /* Find first non-initial underbar. */
246 xfree(demangled); /* not mangled name */
249 if (cp[1] == '_') /* Easy case: no category name. */
251 *cp++ = ' '; /* Replace two '_' with one ' '. */
252 strcpy(cp, mangled + (cp - demangled) + 2);
256 *cp++ = '('; /* Less easy case: category name. */
257 cp = strchr(cp, '_');
260 xfree(demangled); /* not mangled name */
264 *cp++ = ' '; /* Overwriting 1st char of method name... */
265 strcpy(cp, mangled + (cp - demangled)); /* Get it back. */
268 while (*cp && *cp == '_')
269 cp++; /* Skip any initial underbars in
274 *cp = ':'; /* Replace remaining '_' with ':'. */
276 *cp++ = ']'; /* closing right brace */
277 *cp++ = 0; /* string terminator */
281 return NULL; /* Not an objc mangled name. */
284 /* la_sniff_from_mangled_name for ObjC. */
287 objc_sniff_from_mangled_name (const char *mangled, char **demangled)
289 *demangled = objc_demangle (mangled, 0);
290 return *demangled != NULL;
293 /* Determine if we are currently in the Objective-C dispatch function.
294 If so, get the address of the method function that the dispatcher
295 would call and use that as the function to step into instead. Also
296 skip over the trampoline for the function (if any). This is better
297 for the user since they are only interested in stepping into the
298 method function anyway. */
300 objc_skip_trampoline (struct frame_info *frame, CORE_ADDR stop_pc)
302 struct gdbarch *gdbarch = get_frame_arch (frame);
303 CORE_ADDR real_stop_pc;
304 CORE_ADDR method_stop_pc;
306 real_stop_pc = gdbarch_skip_trampoline_code (gdbarch, frame, stop_pc);
308 if (real_stop_pc != 0)
309 find_objc_msgcall (real_stop_pc, &method_stop_pc);
311 find_objc_msgcall (stop_pc, &method_stop_pc);
315 real_stop_pc = gdbarch_skip_trampoline_code
316 (gdbarch, frame, method_stop_pc);
317 if (real_stop_pc == 0)
318 real_stop_pc = method_stop_pc;
325 /* Table mapping opcodes into strings for printing operators
326 and precedences of the operators. */
328 static const struct op_print objc_op_print_tab[] =
330 {",", BINOP_COMMA, PREC_COMMA, 0},
331 {"=", BINOP_ASSIGN, PREC_ASSIGN, 1},
332 {"||", BINOP_LOGICAL_OR, PREC_LOGICAL_OR, 0},
333 {"&&", BINOP_LOGICAL_AND, PREC_LOGICAL_AND, 0},
334 {"|", BINOP_BITWISE_IOR, PREC_BITWISE_IOR, 0},
335 {"^", BINOP_BITWISE_XOR, PREC_BITWISE_XOR, 0},
336 {"&", BINOP_BITWISE_AND, PREC_BITWISE_AND, 0},
337 {"==", BINOP_EQUAL, PREC_EQUAL, 0},
338 {"!=", BINOP_NOTEQUAL, PREC_EQUAL, 0},
339 {"<=", BINOP_LEQ, PREC_ORDER, 0},
340 {">=", BINOP_GEQ, PREC_ORDER, 0},
341 {">", BINOP_GTR, PREC_ORDER, 0},
342 {"<", BINOP_LESS, PREC_ORDER, 0},
343 {">>", BINOP_RSH, PREC_SHIFT, 0},
344 {"<<", BINOP_LSH, PREC_SHIFT, 0},
345 {"+", BINOP_ADD, PREC_ADD, 0},
346 {"-", BINOP_SUB, PREC_ADD, 0},
347 {"*", BINOP_MUL, PREC_MUL, 0},
348 {"/", BINOP_DIV, PREC_MUL, 0},
349 {"%", BINOP_REM, PREC_MUL, 0},
350 {"@", BINOP_REPEAT, PREC_REPEAT, 0},
351 {"-", UNOP_NEG, PREC_PREFIX, 0},
352 {"!", UNOP_LOGICAL_NOT, PREC_PREFIX, 0},
353 {"~", UNOP_COMPLEMENT, PREC_PREFIX, 0},
354 {"*", UNOP_IND, PREC_PREFIX, 0},
355 {"&", UNOP_ADDR, PREC_PREFIX, 0},
356 {"sizeof ", UNOP_SIZEOF, PREC_PREFIX, 0},
357 {"++", UNOP_PREINCREMENT, PREC_PREFIX, 0},
358 {"--", UNOP_PREDECREMENT, PREC_PREFIX, 0},
359 {NULL, OP_NULL, PREC_NULL, 0}
362 static const char *objc_extensions[] =
367 /* Constant data representing the Objective-C language. */
369 extern const struct language_data objc_language_data =
371 "objective-c", /* Language name */
379 &exp_descriptor_standard,
382 c_printchar, /* Print a character constant */
383 c_printstr, /* Function to print string constant */
385 c_print_type, /* Print a type using appropriate syntax */
386 c_print_typedef, /* Print a typedef using appropriate syntax */
387 c_value_print_inner, /* la_value_print_inner */
388 c_value_print, /* Print a top-level value */
389 objc_skip_trampoline, /* Language specific skip_trampoline */
390 "self", /* name_of_this */
391 false, /* la_store_sym_names_in_linkage_form_p */
392 basic_lookup_symbol_nonlocal, /* lookup_symbol_nonlocal */
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_watch_location_expression,
403 NULL, /* la_get_symbol_name_matcher */
404 default_search_name_hash,
408 "{...}" /* la_struct_too_deep_ellipsis */
411 /* Class representing the Objective-C language. */
413 class objc_language : public language_defn
417 : language_defn (language_objc, objc_language_data)
420 /* See language.h. */
421 void language_arch_info (struct gdbarch *gdbarch,
422 struct language_arch_info *lai) const override
424 c_language_arch_info (gdbarch, lai);
428 /* Single instance of the class representing the Objective-C language. */
430 static objc_language objc_language_defn;
434 * Following functions help construct Objective-C message calls.
437 struct selname /* For parsing Objective-C. */
439 struct selname *next;
444 static int msglist_len;
445 static struct selname *selname_chain;
446 static char *msglist_sel;
451 struct selname *newobj = XNEW (struct selname);
453 newobj->next = selname_chain;
454 newobj->msglist_len = msglist_len;
455 newobj->msglist_sel = msglist_sel;
457 msglist_sel = (char *)xmalloc(1);
459 selname_chain = newobj;
463 add_msglist(struct stoken *str, int addcolon)
469 if (str == 0) /* Unnamed arg, or... */
471 if (addcolon == 0) /* variable number of args. */
484 len = plen + strlen(msglist_sel) + 2;
485 s = (char *)xmalloc(len);
486 strcpy(s, msglist_sel);
501 end_msglist (struct parser_state *ps)
503 int val = msglist_len;
504 struct selname *sel = selname_chain;
505 char *p = msglist_sel;
508 selname_chain = sel->next;
509 msglist_len = sel->msglist_len;
510 msglist_sel = sel->msglist_sel;
511 selid = lookup_child_selector (ps->gdbarch (), p);
513 error (_("Can't find selector \"%s\""), p);
514 write_exp_elt_longcst (ps, selid);
516 write_exp_elt_longcst (ps, val); /* Number of args */
523 * Function: specialcmp (const char *a, const char *b)
525 * Special strcmp: treats ']' and ' ' as end-of-string.
526 * Used for qsorting lists of objc methods (either by class or selector).
530 specialcmp (const char *a, const char *b)
532 while (*a && *a != ' ' && *a != ']' && *b && *b != ' ' && *b != ']')
538 if (*a && *a != ' ' && *a != ']')
539 return 1; /* a is longer therefore greater. */
540 if (*b && *b != ' ' && *b != ']')
541 return -1; /* a is shorter therefore lesser. */
542 return 0; /* a and b are identical. */
546 * Function: compare_selectors (const void *, const void *)
548 * Comparison function for use with qsort. Arguments are symbols or
549 * msymbols Compares selector part of objc method name alphabetically.
553 compare_selectors (const void *a, const void *b)
555 const char *aname, *bname;
557 aname = (*(struct symbol **) a)->print_name ();
558 bname = (*(struct symbol **) b)->print_name ();
559 if (aname == NULL || bname == NULL)
560 error (_("internal: compare_selectors(1)"));
562 aname = strchr(aname, ' ');
563 bname = strchr(bname, ' ');
564 if (aname == NULL || bname == NULL)
565 error (_("internal: compare_selectors(2)"));
567 return specialcmp (aname+1, bname+1);
571 * Function: selectors_info (regexp, from_tty)
573 * Implements the "Info selectors" command. Takes an optional regexp
574 * arg. Lists all objective c selectors that match the regexp. Works
575 * by grepping thru all symbols for objective c methods. Output list
576 * is sorted and uniqued.
580 info_selectors_command (const char *regexp, int from_tty)
589 struct symbol **sym_arr;
593 strcpy(myregexp, ".*]"); /* Null input, match all objc methods. */
596 if (*regexp == '+' || *regexp == '-')
597 { /* User wants only class methods or only instance methods. */
598 plusminus = *regexp++;
599 while (*regexp == ' ' || *regexp == '\t')
603 strcpy(myregexp, ".*]");
606 /* Allow a few extra bytes because of the strcat below. */
607 if (sizeof (myregexp) < strlen (regexp) + 4)
608 error (_("Regexp is too long: %s"), regexp);
609 strcpy(myregexp, regexp);
610 if (myregexp[strlen(myregexp) - 1] == '$') /* end of selector */
611 myregexp[strlen(myregexp) - 1] = ']'; /* end of method name */
613 strcat(myregexp, ".*]");
619 val = re_comp (myregexp);
621 error (_("Invalid regexp (%s): %s"), val, regexp);
624 /* First time thru is JUST to get max length and count. */
625 for (objfile *objfile : current_program_space->objfiles ())
627 for (minimal_symbol *msymbol : objfile->msymbols ())
630 name = msymbol->natural_name ();
632 && (name[0] == '-' || name[0] == '+')
633 && name[1] == '[') /* Got a method name. */
635 /* Filter for class/instance methods. */
636 if (plusminus && name[0] != plusminus)
638 /* Find selector part. */
639 name = (char *) strchr (name+2, ' ');
642 complaint (_("Bad method name '%s'"),
643 msymbol->natural_name ());
646 if (regexp == NULL || re_exec(++name) != 0)
648 const char *mystart = name;
649 const char *myend = strchr (mystart, ']');
651 if (myend && (myend - mystart > maxlen))
652 maxlen = myend - mystart; /* Get longest selector. */
660 printf_filtered (_("Selectors matching \"%s\":\n\n"),
661 regexp ? regexp : "*");
663 sym_arr = XALLOCAVEC (struct symbol *, matches);
665 for (objfile *objfile : current_program_space->objfiles ())
667 for (minimal_symbol *msymbol : objfile->msymbols ())
670 name = msymbol->natural_name ();
672 (name[0] == '-' || name[0] == '+') &&
673 name[1] == '[') /* Got a method name. */
675 /* Filter for class/instance methods. */
676 if (plusminus && name[0] != plusminus)
678 /* Find selector part. */
679 name = (char *) strchr(name+2, ' ');
680 if (regexp == NULL || re_exec(++name) != 0)
681 sym_arr[matches++] = (struct symbol *) msymbol;
686 qsort (sym_arr, matches, sizeof (struct minimal_symbol *),
688 /* Prevent compare on first iteration. */
690 for (ix = 0; ix < matches; ix++) /* Now do the output. */
695 name = sym_arr[ix]->natural_name ();
696 name = strchr (name, ' ') + 1;
697 if (p[0] && specialcmp(name, p) == 0)
698 continue; /* Seen this one already (not unique). */
700 /* Copy selector part. */
701 while (*name && *name != ']')
704 /* Print in columns. */
705 puts_filtered_tabular(asel, maxlen + 1, 0);
710 printf_filtered (_("No selectors matching \"%s\"\n"),
711 regexp ? regexp : "*");
715 * Function: compare_classes (const void *, const void *)
717 * Comparison function for use with qsort. Arguments are symbols or
718 * msymbols Compares class part of objc method name alphabetically.
722 compare_classes (const void *a, const void *b)
724 const char *aname, *bname;
726 aname = (*(struct symbol **) a)->print_name ();
727 bname = (*(struct symbol **) b)->print_name ();
728 if (aname == NULL || bname == NULL)
729 error (_("internal: compare_classes(1)"));
731 return specialcmp (aname+1, bname+1);
735 * Function: classes_info(regexp, from_tty)
737 * Implements the "info classes" command for objective c classes.
738 * Lists all objective c classes that match the optional regexp.
739 * Works by grepping thru the list of objective c methods. List will
740 * be sorted and uniqued (since one class may have many methods).
741 * BUGS: will not list a class that has no methods.
745 info_classes_command (const char *regexp, int from_tty)
754 struct symbol **sym_arr;
757 strcpy(myregexp, ".* "); /* Null input: match all objc classes. */
760 /* Allow a few extra bytes because of the strcat below. */
761 if (sizeof (myregexp) < strlen (regexp) + 4)
762 error (_("Regexp is too long: %s"), regexp);
763 strcpy(myregexp, regexp);
764 if (myregexp[strlen(myregexp) - 1] == '$')
765 /* In the method name, the end of the class name is marked by ' '. */
766 myregexp[strlen(myregexp) - 1] = ' ';
768 strcat(myregexp, ".* ");
773 val = re_comp (myregexp);
775 error (_("Invalid regexp (%s): %s"), val, regexp);
778 /* First time thru is JUST to get max length and count. */
779 for (objfile *objfile : current_program_space->objfiles ())
781 for (minimal_symbol *msymbol : objfile->msymbols ())
784 name = msymbol->natural_name ();
786 (name[0] == '-' || name[0] == '+') &&
787 name[1] == '[') /* Got a method name. */
788 if (regexp == NULL || re_exec(name+2) != 0)
790 /* Compute length of classname part. */
791 const char *mystart = name + 2;
792 const char *myend = strchr (mystart, ' ');
794 if (myend && (myend - mystart > maxlen))
795 maxlen = myend - mystart;
802 printf_filtered (_("Classes matching \"%s\":\n\n"),
803 regexp ? regexp : "*");
804 sym_arr = XALLOCAVEC (struct symbol *, matches);
806 for (objfile *objfile : current_program_space->objfiles ())
808 for (minimal_symbol *msymbol : objfile->msymbols ())
811 name = msymbol->natural_name ();
813 (name[0] == '-' || name[0] == '+') &&
814 name[1] == '[') /* Got a method name. */
815 if (regexp == NULL || re_exec(name+2) != 0)
816 sym_arr[matches++] = (struct symbol *) msymbol;
820 qsort (sym_arr, matches, sizeof (struct minimal_symbol *),
822 /* Prevent compare on first iteration. */
824 for (ix = 0; ix < matches; ix++) /* Now do the output. */
829 name = sym_arr[ix]->natural_name ();
831 if (p[0] && specialcmp(name, p) == 0)
832 continue; /* Seen this one already (not unique). */
834 /* Copy class part of method name. */
835 while (*name && *name != ' ')
838 /* Print in columns. */
839 puts_filtered_tabular(aclass, maxlen + 1, 0);
844 printf_filtered (_("No classes matching \"%s\"\n"), regexp ? regexp : "*");
848 parse_selector (char *method, char **selector)
854 char *nselector = NULL;
856 gdb_assert (selector != NULL);
860 s1 = skip_spaces (s1);
866 s1 = skip_spaces (s1);
873 if (isalnum (*s2) || (*s2 == '_') || (*s2 == ':'))
875 else if (isspace (*s2))
877 else if ((*s2 == '\0') || (*s2 == '\''))
885 s2 = skip_spaces (s2);
890 s2 = skip_spaces (s2);
893 if (selector != NULL)
894 *selector = nselector;
900 parse_method (char *method, char *type, char **theclass,
901 char **category, char **selector)
909 char *ncategory = NULL;
910 char *nselector = NULL;
912 gdb_assert (type != NULL);
913 gdb_assert (theclass != NULL);
914 gdb_assert (category != NULL);
915 gdb_assert (selector != NULL);
919 s1 = skip_spaces (s1);
925 s1 = skip_spaces (s1);
927 if ((s1[0] == '+') || (s1[0] == '-'))
930 s1 = skip_spaces (s1);
937 while (isalnum (*s1) || (*s1 == '_'))
941 s2 = skip_spaces (s2);
946 s2 = skip_spaces (s2);
948 while (isalnum (*s2) || (*s2 == '_'))
953 /* Truncate the class name now that we're not using the open paren. */
961 if (isalnum (*s2) || (*s2 == '_') || (*s2 == ':'))
963 else if (isspace (*s2))
974 s2 = skip_spaces (s2);
980 s2 = skip_spaces (s2);
985 if (theclass != NULL)
987 if (category != NULL)
988 *category = ncategory;
989 if (selector != NULL)
990 *selector = nselector;
996 find_methods (char type, const char *theclass, const char *category,
997 const char *selector,
998 std::vector<const char *> *symbol_names)
1000 const char *symname = NULL;
1003 char *nclass = NULL;
1004 char *ncategory = NULL;
1005 char *nselector = NULL;
1007 static char *tmp = NULL;
1008 static unsigned int tmplen = 0;
1010 gdb_assert (symbol_names != NULL);
1012 for (objfile *objfile : current_program_space->objfiles ())
1014 unsigned int *objc_csym;
1016 /* The objfile_csym variable counts the number of ObjC methods
1017 that this objfile defines. We save that count as a private
1018 objfile data. If we have already determined that this objfile
1019 provides no ObjC methods, we can skip it entirely. */
1021 unsigned int objfile_csym = 0;
1023 objc_csym = objc_objfile_data.get (objfile);
1024 if (objc_csym != NULL && *objc_csym == 0)
1025 /* There are no ObjC symbols in this objfile. Skip it entirely. */
1028 for (minimal_symbol *msymbol : objfile->msymbols ())
1032 /* Check the symbol name first as this can be done entirely without
1033 sending any query to the target. */
1034 symname = msymbol->natural_name ();
1035 if (symname == NULL)
1038 if ((symname[0] != '-' && symname[0] != '+') || (symname[1] != '['))
1039 /* Not a method name. */
1044 /* Now that thinks are a bit sane, clean up the symname. */
1045 while ((strlen (symname) + 1) >= tmplen)
1047 tmplen = (tmplen == 0) ? 1024 : tmplen * 2;
1048 tmp = (char *) xrealloc (tmp, tmplen);
1050 strcpy (tmp, symname);
1052 if (parse_method (tmp, &ntype, &nclass,
1053 &ncategory, &nselector) == NULL)
1056 if ((type != '\0') && (ntype != type))
1059 if ((theclass != NULL)
1060 && ((nclass == NULL) || (strcmp (theclass, nclass) != 0)))
1063 if ((category != NULL) &&
1064 ((ncategory == NULL) || (strcmp (category, ncategory) != 0)))
1067 if ((selector != NULL) &&
1068 ((nselector == NULL) || (strcmp (selector, nselector) != 0)))
1071 symbol_names->push_back (symname);
1074 if (objc_csym == NULL)
1075 objc_csym = objc_objfile_data.emplace (objfile, objfile_csym);
1077 /* Count of ObjC methods in this objfile should be constant. */
1078 gdb_assert (*objc_csym == objfile_csym);
1082 /* Uniquify a vector of strings. */
1085 uniquify_strings (std::vector<const char *> *strings)
1087 if (strings->empty ())
1090 std::sort (strings->begin (), strings->end (), compare_cstrings);
1091 strings->erase (std::unique (strings->begin (), strings->end (), streq),
1096 * Function: find_imps (const char *selector, struct symbol **sym_arr)
1098 * Input: a string representing a selector
1099 * a pointer to an array of symbol pointers
1100 * possibly a pointer to a symbol found by the caller.
1102 * Output: number of methods that implement that selector. Side
1103 * effects: The array of symbol pointers is filled with matching syms.
1105 * By analogy with function "find_methods" (symtab.c), builds a list
1106 * of symbols matching the ambiguous input, so that "decode_line_2"
1107 * (symtab.c) can list them and ask the user to choose one or more.
1108 * In this case the matches are objective c methods
1109 * ("implementations") matching an objective c selector.
1111 * Note that it is possible for a normal (c-style) function to have
1112 * the same name as an objective c selector. To prevent the selector
1113 * from eclipsing the function, we allow the caller (decode_line_1) to
1114 * search for such a function first, and if it finds one, pass it in
1115 * to us. We will then integrate it into the list. We also search
1116 * for one here, among the minsyms.
1118 * NOTE: if NUM_DEBUGGABLE is non-zero, the sym_arr will be divided
1119 * into two parts: debuggable (struct symbol) syms, and
1120 * non_debuggable (struct minimal_symbol) syms. The debuggable
1121 * ones will come first, before NUM_DEBUGGABLE (which will thus
1122 * be the index of the first non-debuggable one).
1126 find_imps (const char *method, std::vector<const char *> *symbol_names)
1129 char *theclass = NULL;
1130 char *category = NULL;
1131 char *selector = NULL;
1136 int selector_case = 0;
1138 gdb_assert (symbol_names != NULL);
1140 buf = (char *) alloca (strlen (method) + 1);
1141 strcpy (buf, method);
1142 tmp = parse_method (buf, &type, &theclass, &category, &selector);
1146 strcpy (buf, method);
1147 tmp = parse_selector (buf, &selector);
1155 find_methods (type, theclass, category, selector, symbol_names);
1157 /* If we hit the "selector" case, and we found some methods, then
1158 add the selector itself as a symbol, if it exists. */
1159 if (selector_case && !symbol_names->empty ())
1161 struct symbol *sym = lookup_symbol (selector, NULL, VAR_DOMAIN,
1165 symbol_names->push_back (sym->natural_name ());
1168 struct bound_minimal_symbol msym
1169 = lookup_minimal_symbol (selector, 0, 0);
1171 if (msym.minsym != NULL)
1172 symbol_names->push_back (msym.minsym->natural_name ());
1176 uniquify_strings (symbol_names);
1178 return method + (tmp - buf);
1182 print_object_command (const char *args, int from_tty)
1184 struct value *object, *function, *description;
1185 CORE_ADDR string_addr, object_addr;
1189 if (!args || !*args)
1191 "The 'print-object' command requires an argument (an Objective-C object)");
1194 expression_up expr = parse_expression (args);
1197 object = evaluate_subexp (builtin_type (expr->gdbarch)->builtin_data_ptr,
1198 expr.get (), &pc, EVAL_NORMAL);
1201 /* Validate the address for sanity. */
1202 object_addr = value_as_long (object);
1203 read_memory (object_addr, &c, 1);
1205 function = find_function_in_inferior ("_NSPrintForDebugger", NULL);
1206 if (function == NULL)
1207 error (_("Unable to locate _NSPrintForDebugger in child process"));
1209 description = call_function_by_hand (function, NULL, object);
1211 string_addr = value_as_long (description);
1212 if (string_addr == 0)
1213 error (_("object returns null description"));
1215 read_memory (string_addr + i++, &c, 1);
1218 { /* Read and print characters up to EOS. */
1220 printf_filtered ("%c", c);
1221 read_memory (string_addr + i++, &c, 1);
1224 printf_filtered(_("<object returns empty description>"));
1225 printf_filtered ("\n");
1228 /* The data structure 'methcalls' is used to detect method calls (thru
1229 * ObjC runtime lib functions objc_msgSend, objc_msgSendSuper, etc.),
1230 * and ultimately find the method being called.
1233 struct objc_methcall {
1235 /* Return instance method to be called. */
1236 int (*stop_at) (CORE_ADDR, CORE_ADDR *);
1237 /* Start of pc range corresponding to method invocation. */
1239 /* End of pc range corresponding to method invocation. */
1243 static int resolve_msgsend (CORE_ADDR pc, CORE_ADDR *new_pc);
1244 static int resolve_msgsend_stret (CORE_ADDR pc, CORE_ADDR *new_pc);
1245 static int resolve_msgsend_super (CORE_ADDR pc, CORE_ADDR *new_pc);
1246 static int resolve_msgsend_super_stret (CORE_ADDR pc, CORE_ADDR *new_pc);
1248 static struct objc_methcall methcalls[] = {
1249 { "_objc_msgSend", resolve_msgsend, 0, 0},
1250 { "_objc_msgSend_stret", resolve_msgsend_stret, 0, 0},
1251 { "_objc_msgSendSuper", resolve_msgsend_super, 0, 0},
1252 { "_objc_msgSendSuper_stret", resolve_msgsend_super_stret, 0, 0},
1253 { "_objc_getClass", NULL, 0, 0},
1254 { "_objc_getMetaClass", NULL, 0, 0}
1257 #define nmethcalls (sizeof (methcalls) / sizeof (methcalls[0]))
1259 /* The following function, "find_objc_msgsend", fills in the data
1260 * structure "objc_msgs" by finding the addresses of each of the
1261 * (currently four) functions that it holds (of which objc_msgSend is
1262 * the first). This must be called each time symbols are loaded, in
1263 * case the functions have moved for some reason.
1267 find_objc_msgsend (void)
1271 for (i = 0; i < nmethcalls; i++)
1273 struct bound_minimal_symbol func;
1275 /* Try both with and without underscore. */
1276 func = lookup_bound_minimal_symbol (methcalls[i].name);
1277 if ((func.minsym == NULL) && (methcalls[i].name[0] == '_'))
1279 func = lookup_bound_minimal_symbol (methcalls[i].name + 1);
1281 if (func.minsym == NULL)
1283 methcalls[i].begin = 0;
1284 methcalls[i].end = 0;
1288 methcalls[i].begin = BMSYMBOL_VALUE_ADDRESS (func);
1289 methcalls[i].end = minimal_symbol_upper_bound (func);
1293 /* find_objc_msgcall (replaces pc_off_limits)
1295 * ALL that this function now does is to determine whether the input
1296 * address ("pc") is the address of one of the Objective-C message
1297 * dispatch functions (mainly objc_msgSend or objc_msgSendSuper), and
1298 * if so, it returns the address of the method that will be called.
1300 * The old function "pc_off_limits" used to do a lot of other things
1301 * in addition, such as detecting shared library jump stubs and
1302 * returning the address of the shlib function that would be called.
1303 * That functionality has been moved into the gdbarch_skip_trampoline_code and
1304 * IN_SOLIB_TRAMPOLINE macros, which are resolved in the target-
1305 * dependent modules.
1309 find_objc_msgcall_submethod (int (*f) (CORE_ADDR, CORE_ADDR *),
1315 if (f (pc, new_pc) == 0)
1318 catch (const gdb_exception &ex)
1320 exception_fprintf (gdb_stderr, ex,
1321 "Unable to determine target of "
1322 "Objective-C method call (ignoring):\n");
1329 find_objc_msgcall (CORE_ADDR pc, CORE_ADDR *new_pc)
1333 find_objc_msgsend ();
1339 for (i = 0; i < nmethcalls; i++)
1340 if ((pc >= methcalls[i].begin) && (pc < methcalls[i].end))
1342 if (methcalls[i].stop_at != NULL)
1343 return find_objc_msgcall_submethod (methcalls[i].stop_at,
1352 void _initialize_objc_language ();
1354 _initialize_objc_language ()
1356 add_info ("selectors", info_selectors_command,
1357 _("All Objective-C selectors, or those matching REGEXP."));
1358 add_info ("classes", info_classes_command,
1359 _("All Objective-C classes, or those matching REGEXP."));
1360 add_com ("print-object", class_vars, print_object_command,
1361 _("Ask an Objective-C object to print itself."));
1362 add_com_alias ("po", "print-object", class_vars, 1);
1366 read_objc_method (struct gdbarch *gdbarch, CORE_ADDR addr,
1367 struct objc_method *method)
1369 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1371 method->name = read_memory_unsigned_integer (addr + 0, 4, byte_order);
1372 method->types = read_memory_unsigned_integer (addr + 4, 4, byte_order);
1373 method->imp = read_memory_unsigned_integer (addr + 8, 4, byte_order);
1376 static unsigned long
1377 read_objc_methlist_nmethods (struct gdbarch *gdbarch, CORE_ADDR addr)
1379 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1381 return read_memory_unsigned_integer (addr + 4, 4, byte_order);
1385 read_objc_methlist_method (struct gdbarch *gdbarch, CORE_ADDR addr,
1386 unsigned long num, struct objc_method *method)
1388 gdb_assert (num < read_objc_methlist_nmethods (gdbarch, addr));
1389 read_objc_method (gdbarch, addr + 8 + (12 * num), method);
1393 read_objc_object (struct gdbarch *gdbarch, CORE_ADDR addr,
1394 struct objc_object *object)
1396 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1398 object->isa = read_memory_unsigned_integer (addr, 4, byte_order);
1402 read_objc_super (struct gdbarch *gdbarch, CORE_ADDR addr,
1403 struct objc_super *super)
1405 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1407 super->receiver = read_memory_unsigned_integer (addr, 4, byte_order);
1408 super->theclass = read_memory_unsigned_integer (addr + 4, 4, byte_order);
1412 read_objc_class (struct gdbarch *gdbarch, CORE_ADDR addr,
1413 struct objc_class *theclass)
1415 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1417 theclass->isa = read_memory_unsigned_integer (addr, 4, byte_order);
1418 theclass->super_class = read_memory_unsigned_integer (addr + 4, 4, byte_order);
1419 theclass->name = read_memory_unsigned_integer (addr + 8, 4, byte_order);
1420 theclass->version = read_memory_unsigned_integer (addr + 12, 4, byte_order);
1421 theclass->info = read_memory_unsigned_integer (addr + 16, 4, byte_order);
1422 theclass->instance_size = read_memory_unsigned_integer (addr + 18, 4,
1424 theclass->ivars = read_memory_unsigned_integer (addr + 24, 4, byte_order);
1425 theclass->methods = read_memory_unsigned_integer (addr + 28, 4, byte_order);
1426 theclass->cache = read_memory_unsigned_integer (addr + 32, 4, byte_order);
1427 theclass->protocols = read_memory_unsigned_integer (addr + 36, 4, byte_order);
1431 find_implementation_from_class (struct gdbarch *gdbarch,
1432 CORE_ADDR theclass, CORE_ADDR sel)
1434 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1435 CORE_ADDR subclass = theclass;
1437 while (subclass != 0)
1440 struct objc_class class_str;
1441 unsigned mlistnum = 0;
1443 read_objc_class (gdbarch, subclass, &class_str);
1448 unsigned long nmethods;
1451 mlist = read_memory_unsigned_integer (class_str.methods +
1457 nmethods = read_objc_methlist_nmethods (gdbarch, mlist);
1459 for (i = 0; i < nmethods; i++)
1461 struct objc_method meth_str;
1463 read_objc_methlist_method (gdbarch, mlist, i, &meth_str);
1465 if (meth_str.name == sel)
1466 /* FIXME: hppa arch was doing a pointer dereference
1467 here. There needs to be a better way to do that. */
1468 return meth_str.imp;
1472 subclass = class_str.super_class;
1479 find_implementation (struct gdbarch *gdbarch,
1480 CORE_ADDR object, CORE_ADDR sel)
1482 struct objc_object ostr;
1486 read_objc_object (gdbarch, object, &ostr);
1490 return find_implementation_from_class (gdbarch, ostr.isa, sel);
1494 resolve_msgsend (CORE_ADDR pc, CORE_ADDR *new_pc)
1496 struct frame_info *frame = get_current_frame ();
1497 struct gdbarch *gdbarch = get_frame_arch (frame);
1498 struct type *ptr_type = builtin_type (gdbarch)->builtin_func_ptr;
1504 object = gdbarch_fetch_pointer_argument (gdbarch, frame, 0, ptr_type);
1505 sel = gdbarch_fetch_pointer_argument (gdbarch, frame, 1, ptr_type);
1507 res = find_implementation (gdbarch, object, sel);
1516 resolve_msgsend_stret (CORE_ADDR pc, CORE_ADDR *new_pc)
1518 struct frame_info *frame = get_current_frame ();
1519 struct gdbarch *gdbarch = get_frame_arch (frame);
1520 struct type *ptr_type = builtin_type (gdbarch)->builtin_func_ptr;
1526 object = gdbarch_fetch_pointer_argument (gdbarch, frame, 1, ptr_type);
1527 sel = gdbarch_fetch_pointer_argument (gdbarch, frame, 2, ptr_type);
1529 res = find_implementation (gdbarch, object, sel);
1538 resolve_msgsend_super (CORE_ADDR pc, CORE_ADDR *new_pc)
1540 struct frame_info *frame = get_current_frame ();
1541 struct gdbarch *gdbarch = get_frame_arch (frame);
1542 struct type *ptr_type = builtin_type (gdbarch)->builtin_func_ptr;
1544 struct objc_super sstr;
1550 super = gdbarch_fetch_pointer_argument (gdbarch, frame, 0, ptr_type);
1551 sel = gdbarch_fetch_pointer_argument (gdbarch, frame, 1, ptr_type);
1553 read_objc_super (gdbarch, super, &sstr);
1554 if (sstr.theclass == 0)
1557 res = find_implementation_from_class (gdbarch, sstr.theclass, sel);
1566 resolve_msgsend_super_stret (CORE_ADDR pc, CORE_ADDR *new_pc)
1568 struct frame_info *frame = get_current_frame ();
1569 struct gdbarch *gdbarch = get_frame_arch (frame);
1570 struct type *ptr_type = builtin_type (gdbarch)->builtin_func_ptr;
1572 struct objc_super sstr;
1578 super = gdbarch_fetch_pointer_argument (gdbarch, frame, 1, ptr_type);
1579 sel = gdbarch_fetch_pointer_argument (gdbarch, frame, 2, ptr_type);
1581 read_objc_super (gdbarch, super, &sstr);
1582 if (sstr.theclass == 0)
1585 res = find_implementation_from_class (gdbarch, sstr.theclass, sel);