1 /* Objective-C language support routines for GDB, the GNU debugger.
3 Copyright (C) 2002-2014 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 "target.h" /* for target_has_execution */
41 #include "gdb_regex.h"
46 #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 (char *name, const struct block *block, int noerr)
89 sym = lookup_symbol (name, block, STRUCT_DOMAIN, 0);
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, 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 (&symfile_complaints,
128 _("no way to lookup Objective-C classes"));
132 classval = value_string (classname, strlen (classname) + 1, char_type);
133 classval = value_coerce_array (classval);
134 return (CORE_ADDR) value_as_long (call_function_by_hand (function,
139 lookup_child_selector (struct gdbarch *gdbarch, 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 (&symfile_complaints,
157 _("no way to lookup Objective-C selectors"));
161 selstring = value_coerce_array (value_string (selname,
162 strlen (selname) + 1,
164 return value_as_long (call_function_by_hand (function, 1, &selstring));
168 value_nsstring (struct gdbarch *gdbarch, char *ptr, int len)
170 struct type *char_type = builtin_type (gdbarch)->builtin_char;
171 struct value *stringValue[3];
172 struct value *function, *nsstringValue;
176 if (!target_has_execution)
177 return 0; /* Can't call into inferior to create NSString. */
179 stringValue[2] = value_string(ptr, len, char_type);
180 stringValue[2] = value_coerce_array(stringValue[2]);
181 /* _NSNewStringFromCString replaces "istr" after Lantern2A. */
182 if (lookup_minimal_symbol("_NSNewStringFromCString", 0, 0).minsym)
184 function = find_function_in_inferior("_NSNewStringFromCString", NULL);
185 nsstringValue = call_function_by_hand(function, 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, 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, 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 = 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 /* Determine if we are currently in the Objective-C dispatch function.
286 If so, get the address of the method function that the dispatcher
287 would call and use that as the function to step into instead. Also
288 skip over the trampoline for the function (if any). This is better
289 for the user since they are only interested in stepping into the
290 method function anyway. */
292 objc_skip_trampoline (struct frame_info *frame, CORE_ADDR stop_pc)
294 struct gdbarch *gdbarch = get_frame_arch (frame);
295 CORE_ADDR real_stop_pc;
296 CORE_ADDR method_stop_pc;
298 real_stop_pc = gdbarch_skip_trampoline_code (gdbarch, frame, stop_pc);
300 if (real_stop_pc != 0)
301 find_objc_msgcall (real_stop_pc, &method_stop_pc);
303 find_objc_msgcall (stop_pc, &method_stop_pc);
307 real_stop_pc = gdbarch_skip_trampoline_code
308 (gdbarch, frame, method_stop_pc);
309 if (real_stop_pc == 0)
310 real_stop_pc = method_stop_pc;
317 /* Table mapping opcodes into strings for printing operators
318 and precedences of the operators. */
320 static const struct op_print objc_op_print_tab[] =
322 {",", BINOP_COMMA, PREC_COMMA, 0},
323 {"=", BINOP_ASSIGN, PREC_ASSIGN, 1},
324 {"||", BINOP_LOGICAL_OR, PREC_LOGICAL_OR, 0},
325 {"&&", BINOP_LOGICAL_AND, PREC_LOGICAL_AND, 0},
326 {"|", BINOP_BITWISE_IOR, PREC_BITWISE_IOR, 0},
327 {"^", BINOP_BITWISE_XOR, PREC_BITWISE_XOR, 0},
328 {"&", BINOP_BITWISE_AND, PREC_BITWISE_AND, 0},
329 {"==", BINOP_EQUAL, PREC_EQUAL, 0},
330 {"!=", BINOP_NOTEQUAL, PREC_EQUAL, 0},
331 {"<=", BINOP_LEQ, PREC_ORDER, 0},
332 {">=", BINOP_GEQ, PREC_ORDER, 0},
333 {">", BINOP_GTR, PREC_ORDER, 0},
334 {"<", BINOP_LESS, PREC_ORDER, 0},
335 {">>", BINOP_RSH, PREC_SHIFT, 0},
336 {"<<", BINOP_LSH, PREC_SHIFT, 0},
337 {"+", BINOP_ADD, PREC_ADD, 0},
338 {"-", BINOP_SUB, PREC_ADD, 0},
339 {"*", BINOP_MUL, PREC_MUL, 0},
340 {"/", BINOP_DIV, PREC_MUL, 0},
341 {"%", BINOP_REM, PREC_MUL, 0},
342 {"@", BINOP_REPEAT, PREC_REPEAT, 0},
343 {"-", UNOP_NEG, PREC_PREFIX, 0},
344 {"!", UNOP_LOGICAL_NOT, PREC_PREFIX, 0},
345 {"~", UNOP_COMPLEMENT, PREC_PREFIX, 0},
346 {"*", UNOP_IND, PREC_PREFIX, 0},
347 {"&", UNOP_ADDR, PREC_PREFIX, 0},
348 {"sizeof ", UNOP_SIZEOF, PREC_PREFIX, 0},
349 {"++", UNOP_PREINCREMENT, PREC_PREFIX, 0},
350 {"--", UNOP_PREDECREMENT, PREC_PREFIX, 0},
351 {NULL, OP_NULL, PREC_NULL, 0}
354 const struct language_defn objc_language_defn = {
355 "objective-c", /* Language name */
362 &exp_descriptor_standard,
366 c_printchar, /* Print a character constant */
367 c_printstr, /* Function to print string constant */
369 c_print_type, /* Print a type using appropriate syntax */
370 c_print_typedef, /* Print a typedef using appropriate syntax */
371 c_val_print, /* Print a value using appropriate syntax */
372 c_value_print, /* Print a top-level value */
373 default_read_var_value, /* la_read_var_value */
374 objc_skip_trampoline, /* Language specific skip_trampoline */
375 "self", /* name_of_this */
376 basic_lookup_symbol_nonlocal, /* lookup_symbol_nonlocal */
377 basic_lookup_transparent_type,/* lookup_transparent_type */
378 objc_demangle, /* Language specific symbol demangler */
379 NULL, /* Language specific
380 class_name_from_physname */
381 objc_op_print_tab, /* Expression operators for printing */
382 1, /* C-style arrays */
383 0, /* String lower bound */
384 default_word_break_characters,
385 default_make_symbol_completion_list,
386 c_language_arch_info,
387 default_print_array_index,
388 default_pass_by_reference,
390 NULL, /* la_get_symbol_name_cmp */
391 iterate_over_symbols,
398 * Following functions help construct Objective-C message calls.
401 struct selname /* For parsing Objective-C. */
403 struct selname *next;
408 static int msglist_len;
409 static struct selname *selname_chain;
410 static char *msglist_sel;
415 struct selname *new =
416 (struct selname *) xmalloc (sizeof (struct selname));
418 new->next = selname_chain;
419 new->msglist_len = msglist_len;
420 new->msglist_sel = msglist_sel;
422 msglist_sel = (char *)xmalloc(1);
428 add_msglist(struct stoken *str, int addcolon)
434 if (str == 0) /* Unnamed arg, or... */
436 if (addcolon == 0) /* variable number of args. */
449 len = plen + strlen(msglist_sel) + 2;
450 s = (char *)xmalloc(len);
451 strcpy(s, msglist_sel);
466 end_msglist (struct parser_state *ps)
468 int val = msglist_len;
469 struct selname *sel = selname_chain;
470 char *p = msglist_sel;
473 selname_chain = sel->next;
474 msglist_len = sel->msglist_len;
475 msglist_sel = sel->msglist_sel;
476 selid = lookup_child_selector (parse_gdbarch (ps), p);
478 error (_("Can't find selector \"%s\""), p);
479 write_exp_elt_longcst (ps, selid);
481 write_exp_elt_longcst (ps, val); /* Number of args */
488 * Function: specialcmp (const char *a, const char *b)
490 * Special strcmp: treats ']' and ' ' as end-of-string.
491 * Used for qsorting lists of objc methods (either by class or selector).
495 specialcmp (const char *a, const char *b)
497 while (*a && *a != ' ' && *a != ']' && *b && *b != ' ' && *b != ']')
503 if (*a && *a != ' ' && *a != ']')
504 return 1; /* a is longer therefore greater. */
505 if (*b && *b != ' ' && *b != ']')
506 return -1; /* a is shorter therefore lesser. */
507 return 0; /* a and b are identical. */
511 * Function: compare_selectors (const void *, const void *)
513 * Comparison function for use with qsort. Arguments are symbols or
514 * msymbols Compares selector part of objc method name alphabetically.
518 compare_selectors (const void *a, const void *b)
520 const char *aname, *bname;
522 aname = SYMBOL_PRINT_NAME (*(struct symbol **) a);
523 bname = SYMBOL_PRINT_NAME (*(struct symbol **) b);
524 if (aname == NULL || bname == NULL)
525 error (_("internal: compare_selectors(1)"));
527 aname = strchr(aname, ' ');
528 bname = strchr(bname, ' ');
529 if (aname == NULL || bname == NULL)
530 error (_("internal: compare_selectors(2)"));
532 return specialcmp (aname+1, bname+1);
536 * Function: selectors_info (regexp, from_tty)
538 * Implements the "Info selectors" command. Takes an optional regexp
539 * arg. Lists all objective c selectors that match the regexp. Works
540 * by grepping thru all symbols for objective c methods. Output list
541 * is sorted and uniqued.
545 selectors_info (char *regexp, int from_tty)
547 struct objfile *objfile;
548 struct minimal_symbol *msymbol;
556 struct symbol **sym_arr;
560 strcpy(myregexp, ".*]"); /* Null input, match all objc methods. */
563 if (*regexp == '+' || *regexp == '-')
564 { /* User wants only class methods or only instance methods. */
565 plusminus = *regexp++;
566 while (*regexp == ' ' || *regexp == '\t')
570 strcpy(myregexp, ".*]");
573 /* Allow a few extra bytes because of the strcat below. */
574 if (sizeof (myregexp) < strlen (regexp) + 4)
575 error (_("Regexp is too long: %s"), regexp);
576 strcpy(myregexp, regexp);
577 if (myregexp[strlen(myregexp) - 1] == '$') /* end of selector */
578 myregexp[strlen(myregexp) - 1] = ']'; /* end of method name */
580 strcat(myregexp, ".*]");
586 val = re_comp (myregexp);
588 error (_("Invalid regexp (%s): %s"), val, regexp);
591 /* First time thru is JUST to get max length and count. */
592 ALL_MSYMBOLS (objfile, msymbol)
595 name = MSYMBOL_NATURAL_NAME (msymbol);
597 && (name[0] == '-' || name[0] == '+')
598 && name[1] == '[') /* Got a method name. */
600 /* Filter for class/instance methods. */
601 if (plusminus && name[0] != plusminus)
603 /* Find selector part. */
604 name = (char *) strchr (name+2, ' ');
607 complaint (&symfile_complaints,
608 _("Bad method name '%s'"),
609 MSYMBOL_NATURAL_NAME (msymbol));
612 if (regexp == NULL || re_exec(++name) != 0)
614 const char *mystart = name;
615 const char *myend = strchr (mystart, ']');
617 if (myend && (myend - mystart > maxlen))
618 maxlen = myend - mystart; /* Get longest selector. */
625 printf_filtered (_("Selectors matching \"%s\":\n\n"),
626 regexp ? regexp : "*");
628 sym_arr = alloca (matches * sizeof (struct symbol *));
630 ALL_MSYMBOLS (objfile, msymbol)
633 name = MSYMBOL_NATURAL_NAME (msymbol);
635 (name[0] == '-' || name[0] == '+') &&
636 name[1] == '[') /* Got a method name. */
638 /* Filter for class/instance methods. */
639 if (plusminus && name[0] != plusminus)
641 /* Find selector part. */
642 name = (char *) strchr(name+2, ' ');
643 if (regexp == NULL || re_exec(++name) != 0)
644 sym_arr[matches++] = (struct symbol *) msymbol;
648 qsort (sym_arr, matches, sizeof (struct minimal_symbol *),
650 /* Prevent compare on first iteration. */
652 for (ix = 0; ix < matches; ix++) /* Now do the output. */
657 name = SYMBOL_NATURAL_NAME (sym_arr[ix]);
658 name = strchr (name, ' ') + 1;
659 if (p[0] && specialcmp(name, p) == 0)
660 continue; /* Seen this one already (not unique). */
662 /* Copy selector part. */
663 while (*name && *name != ']')
666 /* Print in columns. */
667 puts_filtered_tabular(asel, maxlen + 1, 0);
672 printf_filtered (_("No selectors matching \"%s\"\n"),
673 regexp ? regexp : "*");
677 * Function: compare_classes (const void *, const void *)
679 * Comparison function for use with qsort. Arguments are symbols or
680 * msymbols Compares class part of objc method name alphabetically.
684 compare_classes (const void *a, const void *b)
686 const char *aname, *bname;
688 aname = SYMBOL_PRINT_NAME (*(struct symbol **) a);
689 bname = SYMBOL_PRINT_NAME (*(struct symbol **) b);
690 if (aname == NULL || bname == NULL)
691 error (_("internal: compare_classes(1)"));
693 return specialcmp (aname+1, bname+1);
697 * Function: classes_info(regexp, from_tty)
699 * Implements the "info classes" command for objective c classes.
700 * Lists all objective c classes that match the optional regexp.
701 * Works by grepping thru the list of objective c methods. List will
702 * be sorted and uniqued (since one class may have many methods).
703 * BUGS: will not list a class that has no methods.
707 classes_info (char *regexp, int from_tty)
709 struct objfile *objfile;
710 struct minimal_symbol *msymbol;
718 struct symbol **sym_arr;
721 strcpy(myregexp, ".* "); /* Null input: match all objc classes. */
724 /* Allow a few extra bytes because of the strcat below. */
725 if (sizeof (myregexp) < strlen (regexp) + 4)
726 error (_("Regexp is too long: %s"), regexp);
727 strcpy(myregexp, regexp);
728 if (myregexp[strlen(myregexp) - 1] == '$')
729 /* In the method name, the end of the class name is marked by ' '. */
730 myregexp[strlen(myregexp) - 1] = ' ';
732 strcat(myregexp, ".* ");
737 val = re_comp (myregexp);
739 error (_("Invalid regexp (%s): %s"), val, regexp);
742 /* First time thru is JUST to get max length and count. */
743 ALL_MSYMBOLS (objfile, msymbol)
746 name = MSYMBOL_NATURAL_NAME (msymbol);
748 (name[0] == '-' || name[0] == '+') &&
749 name[1] == '[') /* Got a method name. */
750 if (regexp == NULL || re_exec(name+2) != 0)
752 /* Compute length of classname part. */
753 const char *mystart = name + 2;
754 const char *myend = strchr (mystart, ' ');
756 if (myend && (myend - mystart > maxlen))
757 maxlen = myend - mystart;
763 printf_filtered (_("Classes matching \"%s\":\n\n"),
764 regexp ? regexp : "*");
765 sym_arr = alloca (matches * sizeof (struct symbol *));
767 ALL_MSYMBOLS (objfile, msymbol)
770 name = MSYMBOL_NATURAL_NAME (msymbol);
772 (name[0] == '-' || name[0] == '+') &&
773 name[1] == '[') /* Got a method name. */
774 if (regexp == NULL || re_exec(name+2) != 0)
775 sym_arr[matches++] = (struct symbol *) msymbol;
778 qsort (sym_arr, matches, sizeof (struct minimal_symbol *),
780 /* Prevent compare on first iteration. */
782 for (ix = 0; ix < matches; ix++) /* Now do the output. */
787 name = SYMBOL_NATURAL_NAME (sym_arr[ix]);
789 if (p[0] && specialcmp(name, p) == 0)
790 continue; /* Seen this one already (not unique). */
792 /* Copy class part of method name. */
793 while (*name && *name != ' ')
796 /* Print in columns. */
797 puts_filtered_tabular(aclass, maxlen + 1, 0);
802 printf_filtered (_("No classes matching \"%s\"\n"), regexp ? regexp : "*");
806 parse_selector (char *method, char **selector)
812 char *nselector = NULL;
814 gdb_assert (selector != NULL);
818 s1 = skip_spaces (s1);
824 s1 = skip_spaces (s1);
831 if (isalnum (*s2) || (*s2 == '_') || (*s2 == ':'))
833 else if (isspace (*s2))
835 else if ((*s2 == '\0') || (*s2 == '\''))
843 s2 = skip_spaces (s2);
848 s2 = skip_spaces (s2);
851 if (selector != NULL)
852 *selector = nselector;
858 parse_method (char *method, char *type, char **class,
859 char **category, char **selector)
867 char *ncategory = NULL;
868 char *nselector = NULL;
870 gdb_assert (type != NULL);
871 gdb_assert (class != NULL);
872 gdb_assert (category != NULL);
873 gdb_assert (selector != NULL);
877 s1 = skip_spaces (s1);
883 s1 = skip_spaces (s1);
885 if ((s1[0] == '+') || (s1[0] == '-'))
888 s1 = skip_spaces (s1);
895 while (isalnum (*s1) || (*s1 == '_'))
899 s2 = skip_spaces (s2);
904 s2 = skip_spaces (s2);
906 while (isalnum (*s2) || (*s2 == '_'))
911 /* Truncate the class name now that we're not using the open paren. */
919 if (isalnum (*s2) || (*s2 == '_') || (*s2 == ':'))
921 else if (isspace (*s2))
932 s2 = skip_spaces (s2);
938 s2 = skip_spaces (s2);
945 if (category != NULL)
946 *category = ncategory;
947 if (selector != NULL)
948 *selector = nselector;
954 find_methods (char type, const char *class, const char *category,
955 const char *selector,
956 VEC (const_char_ptr) **symbol_names)
958 struct objfile *objfile = NULL;
960 const char *symname = NULL;
964 char *ncategory = NULL;
965 char *nselector = NULL;
967 static char *tmp = NULL;
968 static unsigned int tmplen = 0;
970 gdb_assert (symbol_names != NULL);
972 ALL_OBJFILES (objfile)
974 unsigned int *objc_csym;
975 struct minimal_symbol *msymbol = NULL;
977 /* The objfile_csym variable counts the number of ObjC methods
978 that this objfile defines. We save that count as a private
979 objfile data. If we have already determined that this objfile
980 provides no ObjC methods, we can skip it entirely. */
982 unsigned int objfile_csym = 0;
984 objc_csym = objfile_data (objfile, objc_objfile_data);
985 if (objc_csym != NULL && *objc_csym == 0)
986 /* There are no ObjC symbols in this objfile. Skip it entirely. */
989 ALL_OBJFILE_MSYMBOLS (objfile, msymbol)
993 /* Check the symbol name first as this can be done entirely without
994 sending any query to the target. */
995 symname = MSYMBOL_NATURAL_NAME (msymbol);
999 if ((symname[0] != '-' && symname[0] != '+') || (symname[1] != '['))
1000 /* Not a method name. */
1005 /* Now that thinks are a bit sane, clean up the symname. */
1006 while ((strlen (symname) + 1) >= tmplen)
1008 tmplen = (tmplen == 0) ? 1024 : tmplen * 2;
1009 tmp = xrealloc (tmp, tmplen);
1011 strcpy (tmp, symname);
1013 if (parse_method (tmp, &ntype, &nclass,
1014 &ncategory, &nselector) == NULL)
1017 if ((type != '\0') && (ntype != type))
1021 && ((nclass == NULL) || (strcmp (class, nclass) != 0)))
1024 if ((category != NULL) &&
1025 ((ncategory == NULL) || (strcmp (category, ncategory) != 0)))
1028 if ((selector != NULL) &&
1029 ((nselector == NULL) || (strcmp (selector, nselector) != 0)))
1032 VEC_safe_push (const_char_ptr, *symbol_names, symname);
1035 if (objc_csym == NULL)
1037 objc_csym = obstack_alloc (&objfile->objfile_obstack,
1038 sizeof (*objc_csym));
1039 *objc_csym = objfile_csym;
1040 set_objfile_data (objfile, objc_objfile_data, objc_csym);
1043 /* Count of ObjC methods in this objfile should be constant. */
1044 gdb_assert (*objc_csym == objfile_csym);
1048 /* Uniquify a VEC of strings. */
1051 uniquify_strings (VEC (const_char_ptr) **strings)
1054 const char *elem, *last = NULL;
1057 /* If the vector is empty, there's nothing to do. This explicit
1058 check is needed to avoid invoking qsort with NULL. */
1059 if (VEC_empty (const_char_ptr, *strings))
1062 qsort (VEC_address (const_char_ptr, *strings),
1063 VEC_length (const_char_ptr, *strings),
1064 sizeof (const_char_ptr),
1067 for (ix = 0; VEC_iterate (const_char_ptr, *strings, ix, elem); ++ix)
1069 if (last == NULL || strcmp (last, elem) != 0)
1072 VEC_replace (const_char_ptr, *strings, out, elem);
1077 VEC_truncate (const_char_ptr, *strings, out);
1081 * Function: find_imps (const char *selector, struct symbol **sym_arr)
1083 * Input: a string representing a selector
1084 * a pointer to an array of symbol pointers
1085 * possibly a pointer to a symbol found by the caller.
1087 * Output: number of methods that implement that selector. Side
1088 * effects: The array of symbol pointers is filled with matching syms.
1090 * By analogy with function "find_methods" (symtab.c), builds a list
1091 * of symbols matching the ambiguous input, so that "decode_line_2"
1092 * (symtab.c) can list them and ask the user to choose one or more.
1093 * In this case the matches are objective c methods
1094 * ("implementations") matching an objective c selector.
1096 * Note that it is possible for a normal (c-style) function to have
1097 * the same name as an objective c selector. To prevent the selector
1098 * from eclipsing the function, we allow the caller (decode_line_1) to
1099 * search for such a function first, and if it finds one, pass it in
1100 * to us. We will then integrate it into the list. We also search
1101 * for one here, among the minsyms.
1103 * NOTE: if NUM_DEBUGGABLE is non-zero, the sym_arr will be divided
1104 * into two parts: debuggable (struct symbol) syms, and
1105 * non_debuggable (struct minimal_symbol) syms. The debuggable
1106 * ones will come first, before NUM_DEBUGGABLE (which will thus
1107 * be the index of the first non-debuggable one).
1111 find_imps (const char *method, VEC (const_char_ptr) **symbol_names)
1115 char *category = NULL;
1116 char *selector = NULL;
1121 int selector_case = 0;
1123 gdb_assert (symbol_names != NULL);
1125 buf = (char *) alloca (strlen (method) + 1);
1126 strcpy (buf, method);
1127 tmp = parse_method (buf, &type, &class, &category, &selector);
1131 strcpy (buf, method);
1132 tmp = parse_selector (buf, &selector);
1140 find_methods (type, class, category, selector, symbol_names);
1142 /* If we hit the "selector" case, and we found some methods, then
1143 add the selector itself as a symbol, if it exists. */
1144 if (selector_case && !VEC_empty (const_char_ptr, *symbol_names))
1146 struct symbol *sym = lookup_symbol (selector, NULL, VAR_DOMAIN, 0);
1149 VEC_safe_push (const_char_ptr, *symbol_names,
1150 SYMBOL_NATURAL_NAME (sym));
1153 struct bound_minimal_symbol msym
1154 = lookup_minimal_symbol (selector, 0, 0);
1156 if (msym.minsym != NULL)
1157 VEC_safe_push (const_char_ptr, *symbol_names,
1158 MSYMBOL_NATURAL_NAME (msym.minsym));
1162 uniquify_strings (symbol_names);
1164 return method + (tmp - buf);
1168 print_object_command (char *args, int from_tty)
1170 struct value *object, *function, *description;
1171 CORE_ADDR string_addr, object_addr;
1175 if (!args || !*args)
1177 "The 'print-object' command requires an argument (an Objective-C object)");
1180 struct expression *expr = parse_expression (args);
1181 struct cleanup *old_chain =
1182 make_cleanup (free_current_contents, &expr);
1185 object = evaluate_subexp (builtin_type (expr->gdbarch)->builtin_data_ptr,
1186 expr, &pc, EVAL_NORMAL);
1187 do_cleanups (old_chain);
1190 /* Validate the address for sanity. */
1191 object_addr = value_as_long (object);
1192 read_memory (object_addr, &c, 1);
1194 function = find_function_in_inferior ("_NSPrintForDebugger", NULL);
1195 if (function == NULL)
1196 error (_("Unable to locate _NSPrintForDebugger in child process"));
1198 description = call_function_by_hand (function, 1, &object);
1200 string_addr = value_as_long (description);
1201 if (string_addr == 0)
1202 error (_("object returns null description"));
1204 read_memory (string_addr + i++, &c, 1);
1207 { /* Read and print characters up to EOS. */
1209 printf_filtered ("%c", c);
1210 read_memory (string_addr + i++, &c, 1);
1213 printf_filtered(_("<object returns empty description>"));
1214 printf_filtered ("\n");
1217 /* The data structure 'methcalls' is used to detect method calls (thru
1218 * ObjC runtime lib functions objc_msgSend, objc_msgSendSuper, etc.),
1219 * and ultimately find the method being called.
1222 struct objc_methcall {
1224 /* Return instance method to be called. */
1225 int (*stop_at) (CORE_ADDR, CORE_ADDR *);
1226 /* Start of pc range corresponding to method invocation. */
1228 /* End of pc range corresponding to method invocation. */
1232 static int resolve_msgsend (CORE_ADDR pc, CORE_ADDR *new_pc);
1233 static int resolve_msgsend_stret (CORE_ADDR pc, CORE_ADDR *new_pc);
1234 static int resolve_msgsend_super (CORE_ADDR pc, CORE_ADDR *new_pc);
1235 static int resolve_msgsend_super_stret (CORE_ADDR pc, CORE_ADDR *new_pc);
1237 static struct objc_methcall methcalls[] = {
1238 { "_objc_msgSend", resolve_msgsend, 0, 0},
1239 { "_objc_msgSend_stret", resolve_msgsend_stret, 0, 0},
1240 { "_objc_msgSendSuper", resolve_msgsend_super, 0, 0},
1241 { "_objc_msgSendSuper_stret", resolve_msgsend_super_stret, 0, 0},
1242 { "_objc_getClass", NULL, 0, 0},
1243 { "_objc_getMetaClass", NULL, 0, 0}
1246 #define nmethcalls (sizeof (methcalls) / sizeof (methcalls[0]))
1248 /* The following function, "find_objc_msgsend", fills in the data
1249 * structure "objc_msgs" by finding the addresses of each of the
1250 * (currently four) functions that it holds (of which objc_msgSend is
1251 * the first). This must be called each time symbols are loaded, in
1252 * case the functions have moved for some reason.
1256 find_objc_msgsend (void)
1260 for (i = 0; i < nmethcalls; i++)
1262 struct bound_minimal_symbol func;
1264 /* Try both with and without underscore. */
1265 func = lookup_bound_minimal_symbol (methcalls[i].name);
1266 if ((func.minsym == NULL) && (methcalls[i].name[0] == '_'))
1268 func = lookup_bound_minimal_symbol (methcalls[i].name + 1);
1270 if (func.minsym == NULL)
1272 methcalls[i].begin = 0;
1273 methcalls[i].end = 0;
1277 methcalls[i].begin = BMSYMBOL_VALUE_ADDRESS (func);
1278 methcalls[i].end = minimal_symbol_upper_bound (func);
1282 /* find_objc_msgcall (replaces pc_off_limits)
1284 * ALL that this function now does is to determine whether the input
1285 * address ("pc") is the address of one of the Objective-C message
1286 * dispatch functions (mainly objc_msgSend or objc_msgSendSuper), and
1287 * if so, it returns the address of the method that will be called.
1289 * The old function "pc_off_limits" used to do a lot of other things
1290 * in addition, such as detecting shared library jump stubs and
1291 * returning the address of the shlib function that would be called.
1292 * That functionality has been moved into the gdbarch_skip_trampoline_code and
1293 * IN_SOLIB_TRAMPOLINE macros, which are resolved in the target-
1294 * dependent modules.
1297 struct objc_submethod_helper_data {
1298 int (*f) (CORE_ADDR, CORE_ADDR *);
1304 find_objc_msgcall_submethod_helper (void * arg)
1306 struct objc_submethod_helper_data *s =
1307 (struct objc_submethod_helper_data *) arg;
1309 if (s->f (s->pc, s->new_pc) == 0)
1316 find_objc_msgcall_submethod (int (*f) (CORE_ADDR, CORE_ADDR *),
1320 struct objc_submethod_helper_data s;
1326 if (catch_errors (find_objc_msgcall_submethod_helper,
1328 "Unable to determine target of "
1329 "Objective-C method call (ignoring):\n",
1330 RETURN_MASK_ALL) == 0)
1337 find_objc_msgcall (CORE_ADDR pc, CORE_ADDR *new_pc)
1341 find_objc_msgsend ();
1347 for (i = 0; i < nmethcalls; i++)
1348 if ((pc >= methcalls[i].begin) && (pc < methcalls[i].end))
1350 if (methcalls[i].stop_at != NULL)
1351 return find_objc_msgcall_submethod (methcalls[i].stop_at,
1360 /* -Wmissing-prototypes */
1361 extern initialize_file_ftype _initialize_objc_language;
1364 _initialize_objc_language (void)
1366 add_language (&objc_language_defn);
1367 add_info ("selectors", selectors_info, /* INFO SELECTORS command. */
1368 _("All Objective-C selectors, or those matching REGEXP."));
1369 add_info ("classes", classes_info, /* INFO CLASSES command. */
1370 _("All Objective-C classes, or those matching REGEXP."));
1371 add_com ("print-object", class_vars, print_object_command,
1372 _("Ask an Objective-C object to print itself."));
1373 add_com_alias ("po", "print-object", class_vars, 1);
1377 read_objc_method (struct gdbarch *gdbarch, CORE_ADDR addr,
1378 struct objc_method *method)
1380 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1382 method->name = read_memory_unsigned_integer (addr + 0, 4, byte_order);
1383 method->types = read_memory_unsigned_integer (addr + 4, 4, byte_order);
1384 method->imp = read_memory_unsigned_integer (addr + 8, 4, byte_order);
1387 static unsigned long
1388 read_objc_methlist_nmethods (struct gdbarch *gdbarch, CORE_ADDR addr)
1390 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1392 return read_memory_unsigned_integer (addr + 4, 4, byte_order);
1396 read_objc_methlist_method (struct gdbarch *gdbarch, CORE_ADDR addr,
1397 unsigned long num, struct objc_method *method)
1399 gdb_assert (num < read_objc_methlist_nmethods (gdbarch, addr));
1400 read_objc_method (gdbarch, addr + 8 + (12 * num), method);
1404 read_objc_object (struct gdbarch *gdbarch, CORE_ADDR addr,
1405 struct objc_object *object)
1407 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1409 object->isa = read_memory_unsigned_integer (addr, 4, byte_order);
1413 read_objc_super (struct gdbarch *gdbarch, CORE_ADDR addr,
1414 struct objc_super *super)
1416 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1418 super->receiver = read_memory_unsigned_integer (addr, 4, byte_order);
1419 super->class = read_memory_unsigned_integer (addr + 4, 4, byte_order);
1423 read_objc_class (struct gdbarch *gdbarch, CORE_ADDR addr,
1424 struct objc_class *class)
1426 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1428 class->isa = read_memory_unsigned_integer (addr, 4, byte_order);
1429 class->super_class = read_memory_unsigned_integer (addr + 4, 4, byte_order);
1430 class->name = read_memory_unsigned_integer (addr + 8, 4, byte_order);
1431 class->version = read_memory_unsigned_integer (addr + 12, 4, byte_order);
1432 class->info = read_memory_unsigned_integer (addr + 16, 4, byte_order);
1433 class->instance_size = read_memory_unsigned_integer (addr + 18, 4,
1435 class->ivars = read_memory_unsigned_integer (addr + 24, 4, byte_order);
1436 class->methods = read_memory_unsigned_integer (addr + 28, 4, byte_order);
1437 class->cache = read_memory_unsigned_integer (addr + 32, 4, byte_order);
1438 class->protocols = read_memory_unsigned_integer (addr + 36, 4, byte_order);
1442 find_implementation_from_class (struct gdbarch *gdbarch,
1443 CORE_ADDR class, CORE_ADDR sel)
1445 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1446 CORE_ADDR subclass = class;
1448 while (subclass != 0)
1451 struct objc_class class_str;
1452 unsigned mlistnum = 0;
1454 read_objc_class (gdbarch, subclass, &class_str);
1459 unsigned long nmethods;
1462 mlist = read_memory_unsigned_integer (class_str.methods +
1468 nmethods = read_objc_methlist_nmethods (gdbarch, mlist);
1470 for (i = 0; i < nmethods; i++)
1472 struct objc_method meth_str;
1474 read_objc_methlist_method (gdbarch, mlist, i, &meth_str);
1477 "checking method 0x%lx against selector 0x%lx\n",
1478 meth_str.name, sel);
1481 if (meth_str.name == sel)
1482 /* FIXME: hppa arch was doing a pointer dereference
1483 here. There needs to be a better way to do that. */
1484 return meth_str.imp;
1488 subclass = class_str.super_class;
1495 find_implementation (struct gdbarch *gdbarch,
1496 CORE_ADDR object, CORE_ADDR sel)
1498 struct objc_object ostr;
1502 read_objc_object (gdbarch, object, &ostr);
1506 return find_implementation_from_class (gdbarch, ostr.isa, sel);
1510 resolve_msgsend (CORE_ADDR pc, CORE_ADDR *new_pc)
1512 struct frame_info *frame = get_current_frame ();
1513 struct gdbarch *gdbarch = get_frame_arch (frame);
1514 struct type *ptr_type = builtin_type (gdbarch)->builtin_func_ptr;
1520 object = gdbarch_fetch_pointer_argument (gdbarch, frame, 0, ptr_type);
1521 sel = gdbarch_fetch_pointer_argument (gdbarch, frame, 1, ptr_type);
1523 res = find_implementation (gdbarch, object, sel);
1532 resolve_msgsend_stret (CORE_ADDR pc, CORE_ADDR *new_pc)
1534 struct frame_info *frame = get_current_frame ();
1535 struct gdbarch *gdbarch = get_frame_arch (frame);
1536 struct type *ptr_type = builtin_type (gdbarch)->builtin_func_ptr;
1542 object = gdbarch_fetch_pointer_argument (gdbarch, frame, 1, ptr_type);
1543 sel = gdbarch_fetch_pointer_argument (gdbarch, frame, 2, ptr_type);
1545 res = find_implementation (gdbarch, object, sel);
1554 resolve_msgsend_super (CORE_ADDR pc, CORE_ADDR *new_pc)
1556 struct frame_info *frame = get_current_frame ();
1557 struct gdbarch *gdbarch = get_frame_arch (frame);
1558 struct type *ptr_type = builtin_type (gdbarch)->builtin_func_ptr;
1560 struct objc_super sstr;
1566 super = gdbarch_fetch_pointer_argument (gdbarch, frame, 0, ptr_type);
1567 sel = gdbarch_fetch_pointer_argument (gdbarch, frame, 1, ptr_type);
1569 read_objc_super (gdbarch, super, &sstr);
1570 if (sstr.class == 0)
1573 res = find_implementation_from_class (gdbarch, sstr.class, sel);
1582 resolve_msgsend_super_stret (CORE_ADDR pc, CORE_ADDR *new_pc)
1584 struct frame_info *frame = get_current_frame ();
1585 struct gdbarch *gdbarch = get_frame_arch (frame);
1586 struct type *ptr_type = builtin_type (gdbarch)->builtin_func_ptr;
1588 struct objc_super sstr;
1594 super = gdbarch_fetch_pointer_argument (gdbarch, frame, 1, ptr_type);
1595 sel = gdbarch_fetch_pointer_argument (gdbarch, frame, 2, ptr_type);
1597 read_objc_super (gdbarch, super, &sstr);
1598 if (sstr.class == 0)
1601 res = find_implementation_from_class (gdbarch, sstr.class, sel);
1609 /* Provide a prototype to silence -Wmissing-prototypes. */
1610 extern initialize_file_ftype _initialize_objc_lang;
1613 _initialize_objc_lang (void)
1615 objc_objfile_data = register_objfile_data ();