1 /* Objective-C language support routines for GDB, the GNU debugger.
3 Copyright (C) 2002-2013 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 "exceptions.h"
33 #include "complaints.h"
37 #include "gdb_string.h" /* for strchr */
38 #include "target.h" /* for target_has_execution */
42 #include "gdb_regex.h"
47 #include "gdb_assert.h"
48 #include "cli/cli-utils.h"
58 CORE_ADDR super_class;
80 static const struct objfile_data *objc_objfile_data;
82 /* Lookup a structure type named "struct NAME", visible in lexical
83 block BLOCK. If NOERR is nonzero, return zero if NAME is not
87 lookup_struct_typedef (char *name, const struct block *block, int noerr)
91 sym = lookup_symbol (name, block, STRUCT_DOMAIN, 0);
98 error (_("No struct type named %s."), name);
100 if (TYPE_CODE (SYMBOL_TYPE (sym)) != TYPE_CODE_STRUCT)
105 error (_("This context has class, union or enum %s, not a struct."),
112 lookup_objc_class (struct gdbarch *gdbarch, char *classname)
114 struct type *char_type = builtin_type (gdbarch)->builtin_char;
115 struct value * function, *classval;
117 if (! target_has_execution)
119 /* Can't call into inferior to lookup class. */
123 if (lookup_minimal_symbol("objc_lookUpClass", 0, 0))
124 function = find_function_in_inferior("objc_lookUpClass", NULL);
125 else if (lookup_minimal_symbol ("objc_lookup_class", 0, 0))
126 function = find_function_in_inferior("objc_lookup_class", NULL);
129 complaint (&symfile_complaints,
130 _("no way to lookup Objective-C classes"));
134 classval = value_string (classname, strlen (classname) + 1, char_type);
135 classval = value_coerce_array (classval);
136 return (CORE_ADDR) value_as_long (call_function_by_hand (function,
141 lookup_child_selector (struct gdbarch *gdbarch, char *selname)
143 struct type *char_type = builtin_type (gdbarch)->builtin_char;
144 struct value * function, *selstring;
146 if (! target_has_execution)
148 /* Can't call into inferior to lookup selector. */
152 if (lookup_minimal_symbol("sel_getUid", 0, 0))
153 function = find_function_in_inferior("sel_getUid", NULL);
154 else if (lookup_minimal_symbol ("sel_get_any_uid", 0, 0))
155 function = find_function_in_inferior("sel_get_any_uid", NULL);
158 complaint (&symfile_complaints,
159 _("no way to lookup Objective-C selectors"));
163 selstring = value_coerce_array (value_string (selname,
164 strlen (selname) + 1,
166 return value_as_long (call_function_by_hand (function, 1, &selstring));
170 value_nsstring (struct gdbarch *gdbarch, char *ptr, int len)
172 struct type *char_type = builtin_type (gdbarch)->builtin_char;
173 struct value *stringValue[3];
174 struct value *function, *nsstringValue;
178 if (!target_has_execution)
179 return 0; /* Can't call into inferior to create NSString. */
181 stringValue[2] = value_string(ptr, len, char_type);
182 stringValue[2] = value_coerce_array(stringValue[2]);
183 /* _NSNewStringFromCString replaces "istr" after Lantern2A. */
184 if (lookup_minimal_symbol("_NSNewStringFromCString", 0, 0))
186 function = find_function_in_inferior("_NSNewStringFromCString", NULL);
187 nsstringValue = call_function_by_hand(function, 1, &stringValue[2]);
189 else if (lookup_minimal_symbol("istr", 0, 0))
191 function = find_function_in_inferior("istr", NULL);
192 nsstringValue = call_function_by_hand(function, 1, &stringValue[2]);
194 else if (lookup_minimal_symbol("+[NSString stringWithCString:]", 0, 0))
197 = find_function_in_inferior("+[NSString stringWithCString:]", NULL);
198 type = builtin_type (gdbarch)->builtin_long;
200 stringValue[0] = value_from_longest
201 (type, lookup_objc_class (gdbarch, "NSString"));
202 stringValue[1] = value_from_longest
203 (type, lookup_child_selector (gdbarch, "stringWithCString:"));
204 nsstringValue = call_function_by_hand(function, 3, &stringValue[0]);
207 error (_("NSString: internal error -- no way to create new NSString"));
209 sym = lookup_struct_typedef("NSString", 0, 1);
211 sym = lookup_struct_typedef("NXString", 0, 1);
213 type = builtin_type (gdbarch)->builtin_data_ptr;
215 type = lookup_pointer_type(SYMBOL_TYPE (sym));
217 deprecated_set_value_type (nsstringValue, type);
218 return nsstringValue;
221 /* Objective-C name demangling. */
224 objc_demangle (const char *mangled, int options)
226 char *demangled, *cp;
228 if (mangled[0] == '_' &&
229 (mangled[1] == 'i' || mangled[1] == 'c') &&
232 cp = demangled = xmalloc(strlen(mangled) + 2);
234 if (mangled[1] == 'i')
235 *cp++ = '-'; /* for instance method */
237 *cp++ = '+'; /* for class method */
239 *cp++ = '['; /* opening left brace */
240 strcpy(cp, mangled+3); /* Tack on the rest of the mangled name. */
242 while (*cp && *cp == '_')
243 cp++; /* Skip any initial underbars in class
246 cp = strchr(cp, '_');
247 if (!cp) /* Find first non-initial underbar. */
249 xfree(demangled); /* not mangled name */
252 if (cp[1] == '_') /* Easy case: no category name. */
254 *cp++ = ' '; /* Replace two '_' with one ' '. */
255 strcpy(cp, mangled + (cp - demangled) + 2);
259 *cp++ = '('; /* Less easy case: category name. */
260 cp = strchr(cp, '_');
263 xfree(demangled); /* not mangled name */
267 *cp++ = ' '; /* Overwriting 1st char of method name... */
268 strcpy(cp, mangled + (cp - demangled)); /* Get it back. */
271 while (*cp && *cp == '_')
272 cp++; /* Skip any initial underbars in
277 *cp = ':'; /* Replace remaining '_' with ':'. */
279 *cp++ = ']'; /* closing right brace */
280 *cp++ = 0; /* string terminator */
284 return NULL; /* Not an objc mangled name. */
287 /* Determine if we are currently in the Objective-C dispatch function.
288 If so, get the address of the method function that the dispatcher
289 would call and use that as the function to step into instead. Also
290 skip over the trampoline for the function (if any). This is better
291 for the user since they are only interested in stepping into the
292 method function anyway. */
294 objc_skip_trampoline (struct frame_info *frame, CORE_ADDR stop_pc)
296 struct gdbarch *gdbarch = get_frame_arch (frame);
297 CORE_ADDR real_stop_pc;
298 CORE_ADDR method_stop_pc;
300 real_stop_pc = gdbarch_skip_trampoline_code (gdbarch, frame, stop_pc);
302 if (real_stop_pc != 0)
303 find_objc_msgcall (real_stop_pc, &method_stop_pc);
305 find_objc_msgcall (stop_pc, &method_stop_pc);
309 real_stop_pc = gdbarch_skip_trampoline_code
310 (gdbarch, frame, method_stop_pc);
311 if (real_stop_pc == 0)
312 real_stop_pc = method_stop_pc;
319 /* Table mapping opcodes into strings for printing operators
320 and precedences of the operators. */
322 static const struct op_print objc_op_print_tab[] =
324 {",", BINOP_COMMA, PREC_COMMA, 0},
325 {"=", BINOP_ASSIGN, PREC_ASSIGN, 1},
326 {"||", BINOP_LOGICAL_OR, PREC_LOGICAL_OR, 0},
327 {"&&", BINOP_LOGICAL_AND, PREC_LOGICAL_AND, 0},
328 {"|", BINOP_BITWISE_IOR, PREC_BITWISE_IOR, 0},
329 {"^", BINOP_BITWISE_XOR, PREC_BITWISE_XOR, 0},
330 {"&", BINOP_BITWISE_AND, PREC_BITWISE_AND, 0},
331 {"==", BINOP_EQUAL, PREC_EQUAL, 0},
332 {"!=", BINOP_NOTEQUAL, PREC_EQUAL, 0},
333 {"<=", BINOP_LEQ, PREC_ORDER, 0},
334 {">=", BINOP_GEQ, PREC_ORDER, 0},
335 {">", BINOP_GTR, PREC_ORDER, 0},
336 {"<", BINOP_LESS, PREC_ORDER, 0},
337 {">>", BINOP_RSH, PREC_SHIFT, 0},
338 {"<<", BINOP_LSH, PREC_SHIFT, 0},
339 {"+", BINOP_ADD, PREC_ADD, 0},
340 {"-", BINOP_SUB, PREC_ADD, 0},
341 {"*", BINOP_MUL, PREC_MUL, 0},
342 {"/", BINOP_DIV, PREC_MUL, 0},
343 {"%", BINOP_REM, PREC_MUL, 0},
344 {"@", BINOP_REPEAT, PREC_REPEAT, 0},
345 {"-", UNOP_NEG, PREC_PREFIX, 0},
346 {"!", UNOP_LOGICAL_NOT, PREC_PREFIX, 0},
347 {"~", UNOP_COMPLEMENT, PREC_PREFIX, 0},
348 {"*", UNOP_IND, PREC_PREFIX, 0},
349 {"&", UNOP_ADDR, PREC_PREFIX, 0},
350 {"sizeof ", UNOP_SIZEOF, PREC_PREFIX, 0},
351 {"++", UNOP_PREINCREMENT, PREC_PREFIX, 0},
352 {"--", UNOP_PREDECREMENT, PREC_PREFIX, 0},
353 {NULL, OP_NULL, PREC_NULL, 0}
356 const struct language_defn objc_language_defn = {
357 "objective-c", /* Language name */
363 &exp_descriptor_standard,
367 c_printchar, /* Print a character constant */
368 c_printstr, /* Function to print string constant */
370 c_print_type, /* Print a type using appropriate syntax */
371 c_print_typedef, /* Print a typedef using appropriate syntax */
372 c_val_print, /* Print a value using appropriate syntax */
373 c_value_print, /* Print a top-level value */
374 default_read_var_value, /* la_read_var_value */
375 objc_skip_trampoline, /* Language specific skip_trampoline */
376 "self", /* name_of_this */
377 basic_lookup_symbol_nonlocal, /* lookup_symbol_nonlocal */
378 basic_lookup_transparent_type,/* lookup_transparent_type */
379 objc_demangle, /* Language specific symbol demangler */
380 NULL, /* Language specific
381 class_name_from_physname */
382 objc_op_print_tab, /* Expression operators for printing */
383 1, /* C-style arrays */
384 0, /* String lower bound */
385 default_word_break_characters,
386 default_make_symbol_completion_list,
387 c_language_arch_info,
388 default_print_array_index,
389 default_pass_by_reference,
391 NULL, /* la_get_symbol_name_cmp */
392 iterate_over_symbols,
399 * Following functions help construct Objective-C message calls.
402 struct selname /* For parsing Objective-C. */
404 struct selname *next;
409 static int msglist_len;
410 static struct selname *selname_chain;
411 static char *msglist_sel;
416 struct selname *new =
417 (struct selname *) xmalloc (sizeof (struct selname));
419 new->next = selname_chain;
420 new->msglist_len = msglist_len;
421 new->msglist_sel = msglist_sel;
423 msglist_sel = (char *)xmalloc(1);
429 add_msglist(struct stoken *str, int addcolon)
435 if (str == 0) /* Unnamed arg, or... */
437 if (addcolon == 0) /* variable number of args. */
450 len = plen + strlen(msglist_sel) + 2;
451 s = (char *)xmalloc(len);
452 strcpy(s, msglist_sel);
469 int val = msglist_len;
470 struct selname *sel = selname_chain;
471 char *p = msglist_sel;
474 selname_chain = sel->next;
475 msglist_len = sel->msglist_len;
476 msglist_sel = sel->msglist_sel;
477 selid = lookup_child_selector (parse_gdbarch, p);
479 error (_("Can't find selector \"%s\""), p);
480 write_exp_elt_longcst (selid);
482 write_exp_elt_longcst (val); /* Number of args */
489 * Function: specialcmp (const char *a, const char *b)
491 * Special strcmp: treats ']' and ' ' as end-of-string.
492 * Used for qsorting lists of objc methods (either by class or selector).
496 specialcmp (const char *a, const char *b)
498 while (*a && *a != ' ' && *a != ']' && *b && *b != ' ' && *b != ']')
504 if (*a && *a != ' ' && *a != ']')
505 return 1; /* a is longer therefore greater. */
506 if (*b && *b != ' ' && *b != ']')
507 return -1; /* a is shorter therefore lesser. */
508 return 0; /* a and b are identical. */
512 * Function: compare_selectors (const void *, const void *)
514 * Comparison function for use with qsort. Arguments are symbols or
515 * msymbols Compares selector part of objc method name alphabetically.
519 compare_selectors (const void *a, const void *b)
521 const char *aname, *bname;
523 aname = SYMBOL_PRINT_NAME (*(struct symbol **) a);
524 bname = SYMBOL_PRINT_NAME (*(struct symbol **) b);
525 if (aname == NULL || bname == NULL)
526 error (_("internal: compare_selectors(1)"));
528 aname = strchr(aname, ' ');
529 bname = strchr(bname, ' ');
530 if (aname == NULL || bname == NULL)
531 error (_("internal: compare_selectors(2)"));
533 return specialcmp (aname+1, bname+1);
537 * Function: selectors_info (regexp, from_tty)
539 * Implements the "Info selectors" command. Takes an optional regexp
540 * arg. Lists all objective c selectors that match the regexp. Works
541 * by grepping thru all symbols for objective c methods. Output list
542 * is sorted and uniqued.
546 selectors_info (char *regexp, int from_tty)
548 struct objfile *objfile;
549 struct minimal_symbol *msymbol;
557 struct symbol **sym_arr;
561 strcpy(myregexp, ".*]"); /* Null input, match all objc methods. */
564 if (*regexp == '+' || *regexp == '-')
565 { /* User wants only class methods or only instance methods. */
566 plusminus = *regexp++;
567 while (*regexp == ' ' || *regexp == '\t')
571 strcpy(myregexp, ".*]");
574 /* Allow a few extra bytes because of the strcat below. */
575 if (sizeof (myregexp) < strlen (regexp) + 4)
576 error (_("Regexp is too long: %s"), regexp);
577 strcpy(myregexp, regexp);
578 if (myregexp[strlen(myregexp) - 1] == '$') /* end of selector */
579 myregexp[strlen(myregexp) - 1] = ']'; /* end of method name */
581 strcat(myregexp, ".*]");
587 val = re_comp (myregexp);
589 error (_("Invalid regexp (%s): %s"), val, regexp);
592 /* First time thru is JUST to get max length and count. */
593 ALL_MSYMBOLS (objfile, msymbol)
596 name = SYMBOL_NATURAL_NAME (msymbol);
598 && (name[0] == '-' || name[0] == '+')
599 && name[1] == '[') /* Got a method name. */
601 /* Filter for class/instance methods. */
602 if (plusminus && name[0] != plusminus)
604 /* Find selector part. */
605 name = (char *) strchr (name+2, ' ');
608 complaint (&symfile_complaints,
609 _("Bad method name '%s'"),
610 SYMBOL_NATURAL_NAME (msymbol));
613 if (regexp == NULL || re_exec(++name) != 0)
615 const char *mystart = name;
616 const char *myend = strchr (mystart, ']');
618 if (myend && (myend - mystart > maxlen))
619 maxlen = myend - mystart; /* Get longest selector. */
626 printf_filtered (_("Selectors matching \"%s\":\n\n"),
627 regexp ? regexp : "*");
629 sym_arr = alloca (matches * sizeof (struct symbol *));
631 ALL_MSYMBOLS (objfile, msymbol)
634 name = SYMBOL_NATURAL_NAME (msymbol);
636 (name[0] == '-' || name[0] == '+') &&
637 name[1] == '[') /* Got a method name. */
639 /* Filter for class/instance methods. */
640 if (plusminus && name[0] != plusminus)
642 /* Find selector part. */
643 name = (char *) strchr(name+2, ' ');
644 if (regexp == NULL || re_exec(++name) != 0)
645 sym_arr[matches++] = (struct symbol *) msymbol;
649 qsort (sym_arr, matches, sizeof (struct minimal_symbol *),
651 /* Prevent compare on first iteration. */
653 for (ix = 0; ix < matches; ix++) /* Now do the output. */
658 name = SYMBOL_NATURAL_NAME (sym_arr[ix]);
659 name = strchr (name, ' ') + 1;
660 if (p[0] && specialcmp(name, p) == 0)
661 continue; /* Seen this one already (not unique). */
663 /* Copy selector part. */
664 while (*name && *name != ']')
667 /* Print in columns. */
668 puts_filtered_tabular(asel, maxlen + 1, 0);
673 printf_filtered (_("No selectors matching \"%s\"\n"),
674 regexp ? regexp : "*");
678 * Function: compare_classes (const void *, const void *)
680 * Comparison function for use with qsort. Arguments are symbols or
681 * msymbols Compares class part of objc method name alphabetically.
685 compare_classes (const void *a, const void *b)
687 const char *aname, *bname;
689 aname = SYMBOL_PRINT_NAME (*(struct symbol **) a);
690 bname = SYMBOL_PRINT_NAME (*(struct symbol **) b);
691 if (aname == NULL || bname == NULL)
692 error (_("internal: compare_classes(1)"));
694 return specialcmp (aname+1, bname+1);
698 * Function: classes_info(regexp, from_tty)
700 * Implements the "info classes" command for objective c classes.
701 * Lists all objective c classes that match the optional regexp.
702 * Works by grepping thru the list of objective c methods. List will
703 * be sorted and uniqued (since one class may have many methods).
704 * BUGS: will not list a class that has no methods.
708 classes_info (char *regexp, int from_tty)
710 struct objfile *objfile;
711 struct minimal_symbol *msymbol;
719 struct symbol **sym_arr;
722 strcpy(myregexp, ".* "); /* Null input: match all objc classes. */
725 /* Allow a few extra bytes because of the strcat below. */
726 if (sizeof (myregexp) < strlen (regexp) + 4)
727 error (_("Regexp is too long: %s"), regexp);
728 strcpy(myregexp, regexp);
729 if (myregexp[strlen(myregexp) - 1] == '$')
730 /* In the method name, the end of the class name is marked by ' '. */
731 myregexp[strlen(myregexp) - 1] = ' ';
733 strcat(myregexp, ".* ");
738 val = re_comp (myregexp);
740 error (_("Invalid regexp (%s): %s"), val, regexp);
743 /* First time thru is JUST to get max length and count. */
744 ALL_MSYMBOLS (objfile, msymbol)
747 name = SYMBOL_NATURAL_NAME (msymbol);
749 (name[0] == '-' || name[0] == '+') &&
750 name[1] == '[') /* Got a method name. */
751 if (regexp == NULL || re_exec(name+2) != 0)
753 /* Compute length of classname part. */
754 const char *mystart = name + 2;
755 const char *myend = strchr (mystart, ' ');
757 if (myend && (myend - mystart > maxlen))
758 maxlen = myend - mystart;
764 printf_filtered (_("Classes matching \"%s\":\n\n"),
765 regexp ? regexp : "*");
766 sym_arr = alloca (matches * sizeof (struct symbol *));
768 ALL_MSYMBOLS (objfile, msymbol)
771 name = SYMBOL_NATURAL_NAME (msymbol);
773 (name[0] == '-' || name[0] == '+') &&
774 name[1] == '[') /* Got a method name. */
775 if (regexp == NULL || re_exec(name+2) != 0)
776 sym_arr[matches++] = (struct symbol *) msymbol;
779 qsort (sym_arr, matches, sizeof (struct minimal_symbol *),
781 /* Prevent compare on first iteration. */
783 for (ix = 0; ix < matches; ix++) /* Now do the output. */
788 name = SYMBOL_NATURAL_NAME (sym_arr[ix]);
790 if (p[0] && specialcmp(name, p) == 0)
791 continue; /* Seen this one already (not unique). */
793 /* Copy class part of method name. */
794 while (*name && *name != ' ')
797 /* Print in columns. */
798 puts_filtered_tabular(aclass, maxlen + 1, 0);
803 printf_filtered (_("No classes matching \"%s\"\n"), regexp ? regexp : "*");
807 parse_selector (char *method, char **selector)
813 char *nselector = NULL;
815 gdb_assert (selector != NULL);
819 s1 = skip_spaces (s1);
825 s1 = skip_spaces (s1);
832 if (isalnum (*s2) || (*s2 == '_') || (*s2 == ':'))
834 else if (isspace (*s2))
836 else if ((*s2 == '\0') || (*s2 == '\''))
844 s2 = skip_spaces (s2);
849 s2 = skip_spaces (s2);
852 if (selector != NULL)
853 *selector = nselector;
859 parse_method (char *method, char *type, char **class,
860 char **category, char **selector)
868 char *ncategory = NULL;
869 char *nselector = NULL;
871 gdb_assert (type != NULL);
872 gdb_assert (class != NULL);
873 gdb_assert (category != NULL);
874 gdb_assert (selector != NULL);
878 s1 = skip_spaces (s1);
884 s1 = skip_spaces (s1);
886 if ((s1[0] == '+') || (s1[0] == '-'))
889 s1 = skip_spaces (s1);
896 while (isalnum (*s1) || (*s1 == '_'))
900 s2 = skip_spaces (s2);
905 s2 = skip_spaces (s2);
907 while (isalnum (*s2) || (*s2 == '_'))
912 /* Truncate the class name now that we're not using the open paren. */
920 if (isalnum (*s2) || (*s2 == '_') || (*s2 == ':'))
922 else if (isspace (*s2))
933 s2 = skip_spaces (s2);
939 s2 = skip_spaces (s2);
946 if (category != NULL)
947 *category = ncategory;
948 if (selector != NULL)
949 *selector = nselector;
955 find_methods (char type, const char *class, const char *category,
956 const char *selector,
957 VEC (const_char_ptr) **symbol_names)
959 struct objfile *objfile = NULL;
961 const char *symname = NULL;
965 char *ncategory = NULL;
966 char *nselector = NULL;
968 static char *tmp = NULL;
969 static unsigned int tmplen = 0;
971 gdb_assert (symbol_names != NULL);
973 ALL_OBJFILES (objfile)
975 unsigned int *objc_csym;
976 struct minimal_symbol *msymbol = NULL;
978 /* The objfile_csym variable counts the number of ObjC methods
979 that this objfile defines. We save that count as a private
980 objfile data. If we have already determined that this objfile
981 provides no ObjC methods, we can skip it entirely. */
983 unsigned int objfile_csym = 0;
985 objc_csym = objfile_data (objfile, objc_objfile_data);
986 if (objc_csym != NULL && *objc_csym == 0)
987 /* There are no ObjC symbols in this objfile. Skip it entirely. */
990 ALL_OBJFILE_MSYMBOLS (objfile, msymbol)
994 /* Check the symbol name first as this can be done entirely without
995 sending any query to the target. */
996 symname = SYMBOL_NATURAL_NAME (msymbol);
1000 if ((symname[0] != '-' && symname[0] != '+') || (symname[1] != '['))
1001 /* Not a method name. */
1006 /* Now that thinks are a bit sane, clean up the symname. */
1007 while ((strlen (symname) + 1) >= tmplen)
1009 tmplen = (tmplen == 0) ? 1024 : tmplen * 2;
1010 tmp = xrealloc (tmp, tmplen);
1012 strcpy (tmp, symname);
1014 if (parse_method (tmp, &ntype, &nclass,
1015 &ncategory, &nselector) == NULL)
1018 if ((type != '\0') && (ntype != type))
1022 && ((nclass == NULL) || (strcmp (class, nclass) != 0)))
1025 if ((category != NULL) &&
1026 ((ncategory == NULL) || (strcmp (category, ncategory) != 0)))
1029 if ((selector != NULL) &&
1030 ((nselector == NULL) || (strcmp (selector, nselector) != 0)))
1033 VEC_safe_push (const_char_ptr, *symbol_names, symname);
1036 if (objc_csym == NULL)
1038 objc_csym = obstack_alloc (&objfile->objfile_obstack,
1039 sizeof (*objc_csym));
1040 *objc_csym = objfile_csym;
1041 set_objfile_data (objfile, objc_objfile_data, objc_csym);
1044 /* Count of ObjC methods in this objfile should be constant. */
1045 gdb_assert (*objc_csym == objfile_csym);
1049 /* Uniquify a VEC of strings. */
1052 uniquify_strings (VEC (const_char_ptr) **strings)
1055 const char *elem, *last = NULL;
1058 qsort (VEC_address (const_char_ptr, *strings),
1059 VEC_length (const_char_ptr, *strings),
1060 sizeof (const_char_ptr),
1063 for (ix = 0; VEC_iterate (const_char_ptr, *strings, ix, elem); ++ix)
1065 if (last == NULL || strcmp (last, elem) != 0)
1068 VEC_replace (const_char_ptr, *strings, out, elem);
1073 VEC_truncate (const_char_ptr, *strings, out);
1077 * Function: find_imps (const char *selector, struct symbol **sym_arr)
1079 * Input: a string representing a selector
1080 * a pointer to an array of symbol pointers
1081 * possibly a pointer to a symbol found by the caller.
1083 * Output: number of methods that implement that selector. Side
1084 * effects: The array of symbol pointers is filled with matching syms.
1086 * By analogy with function "find_methods" (symtab.c), builds a list
1087 * of symbols matching the ambiguous input, so that "decode_line_2"
1088 * (symtab.c) can list them and ask the user to choose one or more.
1089 * In this case the matches are objective c methods
1090 * ("implementations") matching an objective c selector.
1092 * Note that it is possible for a normal (c-style) function to have
1093 * the same name as an objective c selector. To prevent the selector
1094 * from eclipsing the function, we allow the caller (decode_line_1) to
1095 * search for such a function first, and if it finds one, pass it in
1096 * to us. We will then integrate it into the list. We also search
1097 * for one here, among the minsyms.
1099 * NOTE: if NUM_DEBUGGABLE is non-zero, the sym_arr will be divided
1100 * into two parts: debuggable (struct symbol) syms, and
1101 * non_debuggable (struct minimal_symbol) syms. The debuggable
1102 * ones will come first, before NUM_DEBUGGABLE (which will thus
1103 * be the index of the first non-debuggable one).
1107 find_imps (const char *method, VEC (const_char_ptr) **symbol_names)
1111 char *category = NULL;
1112 char *selector = NULL;
1117 int selector_case = 0;
1119 gdb_assert (symbol_names != NULL);
1121 buf = (char *) alloca (strlen (method) + 1);
1122 strcpy (buf, method);
1123 tmp = parse_method (buf, &type, &class, &category, &selector);
1127 strcpy (buf, method);
1128 tmp = parse_selector (buf, &selector);
1136 find_methods (type, class, category, selector, symbol_names);
1138 /* If we hit the "selector" case, and we found some methods, then
1139 add the selector itself as a symbol, if it exists. */
1140 if (selector_case && !VEC_empty (const_char_ptr, *symbol_names))
1142 struct symbol *sym = lookup_symbol (selector, NULL, VAR_DOMAIN, 0);
1145 VEC_safe_push (const_char_ptr, *symbol_names,
1146 SYMBOL_NATURAL_NAME (sym));
1149 struct minimal_symbol *msym = lookup_minimal_symbol (selector, 0, 0);
1152 VEC_safe_push (const_char_ptr, *symbol_names,
1153 SYMBOL_NATURAL_NAME (msym));
1157 uniquify_strings (symbol_names);
1159 return method + (tmp - buf);
1163 print_object_command (char *args, int from_tty)
1165 struct value *object, *function, *description;
1166 CORE_ADDR string_addr, object_addr;
1170 if (!args || !*args)
1172 "The 'print-object' command requires an argument (an Objective-C object)");
1175 struct expression *expr = parse_expression (args);
1176 struct cleanup *old_chain =
1177 make_cleanup (free_current_contents, &expr);
1180 object = evaluate_subexp (builtin_type (expr->gdbarch)->builtin_data_ptr,
1181 expr, &pc, EVAL_NORMAL);
1182 do_cleanups (old_chain);
1185 /* Validate the address for sanity. */
1186 object_addr = value_as_long (object);
1187 read_memory (object_addr, &c, 1);
1189 function = find_function_in_inferior ("_NSPrintForDebugger", NULL);
1190 if (function == NULL)
1191 error (_("Unable to locate _NSPrintForDebugger in child process"));
1193 description = call_function_by_hand (function, 1, &object);
1195 string_addr = value_as_long (description);
1196 if (string_addr == 0)
1197 error (_("object returns null description"));
1199 read_memory (string_addr + i++, &c, 1);
1202 { /* Read and print characters up to EOS. */
1204 printf_filtered ("%c", c);
1205 read_memory (string_addr + i++, &c, 1);
1208 printf_filtered(_("<object returns empty description>"));
1209 printf_filtered ("\n");
1212 /* The data structure 'methcalls' is used to detect method calls (thru
1213 * ObjC runtime lib functions objc_msgSend, objc_msgSendSuper, etc.),
1214 * and ultimately find the method being called.
1217 struct objc_methcall {
1219 /* Return instance method to be called. */
1220 int (*stop_at) (CORE_ADDR, CORE_ADDR *);
1221 /* Start of pc range corresponding to method invocation. */
1223 /* End of pc range corresponding to method invocation. */
1227 static int resolve_msgsend (CORE_ADDR pc, CORE_ADDR *new_pc);
1228 static int resolve_msgsend_stret (CORE_ADDR pc, CORE_ADDR *new_pc);
1229 static int resolve_msgsend_super (CORE_ADDR pc, CORE_ADDR *new_pc);
1230 static int resolve_msgsend_super_stret (CORE_ADDR pc, CORE_ADDR *new_pc);
1232 static struct objc_methcall methcalls[] = {
1233 { "_objc_msgSend", resolve_msgsend, 0, 0},
1234 { "_objc_msgSend_stret", resolve_msgsend_stret, 0, 0},
1235 { "_objc_msgSendSuper", resolve_msgsend_super, 0, 0},
1236 { "_objc_msgSendSuper_stret", resolve_msgsend_super_stret, 0, 0},
1237 { "_objc_getClass", NULL, 0, 0},
1238 { "_objc_getMetaClass", NULL, 0, 0}
1241 #define nmethcalls (sizeof (methcalls) / sizeof (methcalls[0]))
1243 /* The following function, "find_objc_msgsend", fills in the data
1244 * structure "objc_msgs" by finding the addresses of each of the
1245 * (currently four) functions that it holds (of which objc_msgSend is
1246 * the first). This must be called each time symbols are loaded, in
1247 * case the functions have moved for some reason.
1251 find_objc_msgsend (void)
1255 for (i = 0; i < nmethcalls; i++)
1257 struct minimal_symbol *func;
1259 /* Try both with and without underscore. */
1260 func = lookup_minimal_symbol (methcalls[i].name, NULL, NULL);
1261 if ((func == NULL) && (methcalls[i].name[0] == '_'))
1263 func = lookup_minimal_symbol (methcalls[i].name + 1, NULL, NULL);
1267 methcalls[i].begin = 0;
1268 methcalls[i].end = 0;
1272 methcalls[i].begin = SYMBOL_VALUE_ADDRESS (func);
1274 methcalls[i].end = SYMBOL_VALUE_ADDRESS (++func);
1275 } while (methcalls[i].begin == methcalls[i].end);
1279 /* find_objc_msgcall (replaces pc_off_limits)
1281 * ALL that this function now does is to determine whether the input
1282 * address ("pc") is the address of one of the Objective-C message
1283 * dispatch functions (mainly objc_msgSend or objc_msgSendSuper), and
1284 * if so, it returns the address of the method that will be called.
1286 * The old function "pc_off_limits" used to do a lot of other things
1287 * in addition, such as detecting shared library jump stubs and
1288 * returning the address of the shlib function that would be called.
1289 * That functionality has been moved into the gdbarch_skip_trampoline_code and
1290 * IN_SOLIB_TRAMPOLINE macros, which are resolved in the target-
1291 * dependent modules.
1294 struct objc_submethod_helper_data {
1295 int (*f) (CORE_ADDR, CORE_ADDR *);
1301 find_objc_msgcall_submethod_helper (void * arg)
1303 struct objc_submethod_helper_data *s =
1304 (struct objc_submethod_helper_data *) arg;
1306 if (s->f (s->pc, s->new_pc) == 0)
1313 find_objc_msgcall_submethod (int (*f) (CORE_ADDR, CORE_ADDR *),
1317 struct objc_submethod_helper_data s;
1323 if (catch_errors (find_objc_msgcall_submethod_helper,
1325 "Unable to determine target of "
1326 "Objective-C method call (ignoring):\n",
1327 RETURN_MASK_ALL) == 0)
1334 find_objc_msgcall (CORE_ADDR pc, CORE_ADDR *new_pc)
1338 find_objc_msgsend ();
1344 for (i = 0; i < nmethcalls; i++)
1345 if ((pc >= methcalls[i].begin) && (pc < methcalls[i].end))
1347 if (methcalls[i].stop_at != NULL)
1348 return find_objc_msgcall_submethod (methcalls[i].stop_at,
1357 /* -Wmissing-prototypes */
1358 extern initialize_file_ftype _initialize_objc_language;
1361 _initialize_objc_language (void)
1363 add_language (&objc_language_defn);
1364 add_info ("selectors", selectors_info, /* INFO SELECTORS command. */
1365 _("All Objective-C selectors, or those matching REGEXP."));
1366 add_info ("classes", classes_info, /* INFO CLASSES command. */
1367 _("All Objective-C classes, or those matching REGEXP."));
1368 add_com ("print-object", class_vars, print_object_command,
1369 _("Ask an Objective-C object to print itself."));
1370 add_com_alias ("po", "print-object", class_vars, 1);
1374 read_objc_method (struct gdbarch *gdbarch, CORE_ADDR addr,
1375 struct objc_method *method)
1377 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1379 method->name = read_memory_unsigned_integer (addr + 0, 4, byte_order);
1380 method->types = read_memory_unsigned_integer (addr + 4, 4, byte_order);
1381 method->imp = read_memory_unsigned_integer (addr + 8, 4, byte_order);
1384 static unsigned long
1385 read_objc_methlist_nmethods (struct gdbarch *gdbarch, CORE_ADDR addr)
1387 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1389 return read_memory_unsigned_integer (addr + 4, 4, byte_order);
1393 read_objc_methlist_method (struct gdbarch *gdbarch, CORE_ADDR addr,
1394 unsigned long num, struct objc_method *method)
1396 gdb_assert (num < read_objc_methlist_nmethods (gdbarch, addr));
1397 read_objc_method (gdbarch, addr + 8 + (12 * num), method);
1401 read_objc_object (struct gdbarch *gdbarch, CORE_ADDR addr,
1402 struct objc_object *object)
1404 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1406 object->isa = read_memory_unsigned_integer (addr, 4, byte_order);
1410 read_objc_super (struct gdbarch *gdbarch, CORE_ADDR addr,
1411 struct objc_super *super)
1413 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1415 super->receiver = read_memory_unsigned_integer (addr, 4, byte_order);
1416 super->class = read_memory_unsigned_integer (addr + 4, 4, byte_order);
1420 read_objc_class (struct gdbarch *gdbarch, CORE_ADDR addr,
1421 struct objc_class *class)
1423 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1425 class->isa = read_memory_unsigned_integer (addr, 4, byte_order);
1426 class->super_class = read_memory_unsigned_integer (addr + 4, 4, byte_order);
1427 class->name = read_memory_unsigned_integer (addr + 8, 4, byte_order);
1428 class->version = read_memory_unsigned_integer (addr + 12, 4, byte_order);
1429 class->info = read_memory_unsigned_integer (addr + 16, 4, byte_order);
1430 class->instance_size = read_memory_unsigned_integer (addr + 18, 4,
1432 class->ivars = read_memory_unsigned_integer (addr + 24, 4, byte_order);
1433 class->methods = read_memory_unsigned_integer (addr + 28, 4, byte_order);
1434 class->cache = read_memory_unsigned_integer (addr + 32, 4, byte_order);
1435 class->protocols = read_memory_unsigned_integer (addr + 36, 4, byte_order);
1439 find_implementation_from_class (struct gdbarch *gdbarch,
1440 CORE_ADDR class, CORE_ADDR sel)
1442 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1443 CORE_ADDR subclass = class;
1445 while (subclass != 0)
1448 struct objc_class class_str;
1449 unsigned mlistnum = 0;
1451 read_objc_class (gdbarch, subclass, &class_str);
1456 unsigned long nmethods;
1459 mlist = read_memory_unsigned_integer (class_str.methods +
1465 nmethods = read_objc_methlist_nmethods (gdbarch, mlist);
1467 for (i = 0; i < nmethods; i++)
1469 struct objc_method meth_str;
1471 read_objc_methlist_method (gdbarch, mlist, i, &meth_str);
1474 "checking method 0x%lx against selector 0x%lx\n",
1475 meth_str.name, sel);
1478 if (meth_str.name == sel)
1479 /* FIXME: hppa arch was doing a pointer dereference
1480 here. There needs to be a better way to do that. */
1481 return meth_str.imp;
1485 subclass = class_str.super_class;
1492 find_implementation (struct gdbarch *gdbarch,
1493 CORE_ADDR object, CORE_ADDR sel)
1495 struct objc_object ostr;
1499 read_objc_object (gdbarch, object, &ostr);
1503 return find_implementation_from_class (gdbarch, ostr.isa, sel);
1507 resolve_msgsend (CORE_ADDR pc, CORE_ADDR *new_pc)
1509 struct frame_info *frame = get_current_frame ();
1510 struct gdbarch *gdbarch = get_frame_arch (frame);
1511 struct type *ptr_type = builtin_type (gdbarch)->builtin_func_ptr;
1517 object = gdbarch_fetch_pointer_argument (gdbarch, frame, 0, ptr_type);
1518 sel = gdbarch_fetch_pointer_argument (gdbarch, frame, 1, ptr_type);
1520 res = find_implementation (gdbarch, object, sel);
1529 resolve_msgsend_stret (CORE_ADDR pc, CORE_ADDR *new_pc)
1531 struct frame_info *frame = get_current_frame ();
1532 struct gdbarch *gdbarch = get_frame_arch (frame);
1533 struct type *ptr_type = builtin_type (gdbarch)->builtin_func_ptr;
1539 object = gdbarch_fetch_pointer_argument (gdbarch, frame, 1, ptr_type);
1540 sel = gdbarch_fetch_pointer_argument (gdbarch, frame, 2, ptr_type);
1542 res = find_implementation (gdbarch, object, sel);
1551 resolve_msgsend_super (CORE_ADDR pc, CORE_ADDR *new_pc)
1553 struct frame_info *frame = get_current_frame ();
1554 struct gdbarch *gdbarch = get_frame_arch (frame);
1555 struct type *ptr_type = builtin_type (gdbarch)->builtin_func_ptr;
1557 struct objc_super sstr;
1563 super = gdbarch_fetch_pointer_argument (gdbarch, frame, 0, ptr_type);
1564 sel = gdbarch_fetch_pointer_argument (gdbarch, frame, 1, ptr_type);
1566 read_objc_super (gdbarch, super, &sstr);
1567 if (sstr.class == 0)
1570 res = find_implementation_from_class (gdbarch, sstr.class, sel);
1579 resolve_msgsend_super_stret (CORE_ADDR pc, CORE_ADDR *new_pc)
1581 struct frame_info *frame = get_current_frame ();
1582 struct gdbarch *gdbarch = get_frame_arch (frame);
1583 struct type *ptr_type = builtin_type (gdbarch)->builtin_func_ptr;
1585 struct objc_super sstr;
1591 super = gdbarch_fetch_pointer_argument (gdbarch, frame, 1, ptr_type);
1592 sel = gdbarch_fetch_pointer_argument (gdbarch, frame, 2, ptr_type);
1594 read_objc_super (gdbarch, super, &sstr);
1595 if (sstr.class == 0)
1598 res = find_implementation_from_class (gdbarch, sstr.class, sel);
1606 /* Provide a prototype to silence -Wmissing-prototypes. */
1607 extern initialize_file_ftype _initialize_objc_lang;
1610 _initialize_objc_lang (void)
1612 objc_objfile_data = register_objfile_data ();