1 /* Objective-C language support routines for GDB, the GNU debugger.
3 Copyright (C) 2002-2016 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"
55 CORE_ADDR super_class
;
77 static const struct objfile_data
*objc_objfile_data
;
79 /* Lookup a structure type named "struct NAME", visible in lexical
80 block BLOCK. If NOERR is nonzero, return zero if NAME is not
84 lookup_struct_typedef (char *name
, const struct block
*block
, int noerr
)
88 sym
= lookup_symbol (name
, block
, STRUCT_DOMAIN
, 0).symbol
;
95 error (_("No struct type named %s."), name
);
97 if (TYPE_CODE (SYMBOL_TYPE (sym
)) != TYPE_CODE_STRUCT
)
102 error (_("This context has class, union or enum %s, not a struct."),
109 lookup_objc_class (struct gdbarch
*gdbarch
, char *classname
)
111 struct type
*char_type
= builtin_type (gdbarch
)->builtin_char
;
112 struct value
* function
, *classval
;
114 if (! target_has_execution
)
116 /* Can't call into inferior to lookup class. */
120 if (lookup_minimal_symbol("objc_lookUpClass", 0, 0).minsym
)
121 function
= find_function_in_inferior("objc_lookUpClass", NULL
);
122 else if (lookup_minimal_symbol ("objc_lookup_class", 0, 0).minsym
)
123 function
= find_function_in_inferior("objc_lookup_class", NULL
);
126 complaint (&symfile_complaints
,
127 _("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
,
138 lookup_child_selector (struct gdbarch
*gdbarch
, char *selname
)
140 struct type
*char_type
= builtin_type (gdbarch
)->builtin_char
;
141 struct value
* function
, *selstring
;
143 if (! target_has_execution
)
145 /* Can't call into inferior to lookup selector. */
149 if (lookup_minimal_symbol("sel_getUid", 0, 0).minsym
)
150 function
= find_function_in_inferior("sel_getUid", NULL
);
151 else if (lookup_minimal_symbol ("sel_get_any_uid", 0, 0).minsym
)
152 function
= find_function_in_inferior("sel_get_any_uid", NULL
);
155 complaint (&symfile_complaints
,
156 _("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
, 1, &selstring
));
167 value_nsstring (struct gdbarch
*gdbarch
, char *ptr
, int len
)
169 struct type
*char_type
= builtin_type (gdbarch
)->builtin_char
;
170 struct value
*stringValue
[3];
171 struct value
*function
, *nsstringValue
;
175 if (!target_has_execution
)
176 return 0; /* Can't call into inferior to create NSString. */
178 stringValue
[2] = value_string(ptr
, len
, char_type
);
179 stringValue
[2] = value_coerce_array(stringValue
[2]);
180 /* _NSNewStringFromCString replaces "istr" after Lantern2A. */
181 if (lookup_minimal_symbol("_NSNewStringFromCString", 0, 0).minsym
)
183 function
= find_function_in_inferior("_NSNewStringFromCString", NULL
);
184 nsstringValue
= call_function_by_hand(function
, 1, &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
, 1, &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
, 3, &stringValue
[0]);
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 /* Determine if we are currently in the Objective-C dispatch function.
285 If so, get the address of the method function that the dispatcher
286 would call and use that as the function to step into instead. Also
287 skip over the trampoline for the function (if any). This is better
288 for the user since they are only interested in stepping into the
289 method function anyway. */
291 objc_skip_trampoline (struct frame_info
*frame
, CORE_ADDR stop_pc
)
293 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
294 CORE_ADDR real_stop_pc
;
295 CORE_ADDR method_stop_pc
;
297 real_stop_pc
= gdbarch_skip_trampoline_code (gdbarch
, frame
, stop_pc
);
299 if (real_stop_pc
!= 0)
300 find_objc_msgcall (real_stop_pc
, &method_stop_pc
);
302 find_objc_msgcall (stop_pc
, &method_stop_pc
);
306 real_stop_pc
= gdbarch_skip_trampoline_code
307 (gdbarch
, frame
, method_stop_pc
);
308 if (real_stop_pc
== 0)
309 real_stop_pc
= method_stop_pc
;
316 /* Table mapping opcodes into strings for printing operators
317 and precedences of the operators. */
319 static const struct op_print objc_op_print_tab
[] =
321 {",", BINOP_COMMA
, PREC_COMMA
, 0},
322 {"=", BINOP_ASSIGN
, PREC_ASSIGN
, 1},
323 {"||", BINOP_LOGICAL_OR
, PREC_LOGICAL_OR
, 0},
324 {"&&", BINOP_LOGICAL_AND
, PREC_LOGICAL_AND
, 0},
325 {"|", BINOP_BITWISE_IOR
, PREC_BITWISE_IOR
, 0},
326 {"^", BINOP_BITWISE_XOR
, PREC_BITWISE_XOR
, 0},
327 {"&", BINOP_BITWISE_AND
, PREC_BITWISE_AND
, 0},
328 {"==", BINOP_EQUAL
, PREC_EQUAL
, 0},
329 {"!=", BINOP_NOTEQUAL
, PREC_EQUAL
, 0},
330 {"<=", BINOP_LEQ
, PREC_ORDER
, 0},
331 {">=", BINOP_GEQ
, PREC_ORDER
, 0},
332 {">", BINOP_GTR
, PREC_ORDER
, 0},
333 {"<", BINOP_LESS
, PREC_ORDER
, 0},
334 {">>", BINOP_RSH
, PREC_SHIFT
, 0},
335 {"<<", BINOP_LSH
, PREC_SHIFT
, 0},
336 {"+", BINOP_ADD
, PREC_ADD
, 0},
337 {"-", BINOP_SUB
, PREC_ADD
, 0},
338 {"*", BINOP_MUL
, PREC_MUL
, 0},
339 {"/", BINOP_DIV
, PREC_MUL
, 0},
340 {"%", BINOP_REM
, PREC_MUL
, 0},
341 {"@", BINOP_REPEAT
, PREC_REPEAT
, 0},
342 {"-", UNOP_NEG
, PREC_PREFIX
, 0},
343 {"!", UNOP_LOGICAL_NOT
, PREC_PREFIX
, 0},
344 {"~", UNOP_COMPLEMENT
, PREC_PREFIX
, 0},
345 {"*", UNOP_IND
, PREC_PREFIX
, 0},
346 {"&", UNOP_ADDR
, PREC_PREFIX
, 0},
347 {"sizeof ", UNOP_SIZEOF
, PREC_PREFIX
, 0},
348 {"++", UNOP_PREINCREMENT
, PREC_PREFIX
, 0},
349 {"--", UNOP_PREDECREMENT
, PREC_PREFIX
, 0},
350 {NULL
, OP_NULL
, PREC_NULL
, 0}
353 static const char *objc_extensions
[] =
358 const struct language_defn objc_language_defn
= {
359 "objective-c", /* Language name */
367 &exp_descriptor_standard
,
371 c_printchar
, /* Print a character constant */
372 c_printstr
, /* Function to print string constant */
374 c_print_type
, /* Print a type using appropriate syntax */
375 c_print_typedef
, /* Print a typedef using appropriate syntax */
376 c_val_print
, /* Print a value using appropriate syntax */
377 c_value_print
, /* Print a top-level value */
378 default_read_var_value
, /* la_read_var_value */
379 objc_skip_trampoline
, /* Language specific skip_trampoline */
380 "self", /* name_of_this */
381 basic_lookup_symbol_nonlocal
, /* lookup_symbol_nonlocal */
382 basic_lookup_transparent_type
,/* lookup_transparent_type */
383 objc_demangle
, /* Language specific symbol demangler */
384 NULL
, /* Language specific
385 class_name_from_physname */
386 objc_op_print_tab
, /* Expression operators for printing */
387 1, /* C-style arrays */
388 0, /* String lower bound */
389 default_word_break_characters
,
390 default_make_symbol_completion_list
,
391 c_language_arch_info
,
392 default_print_array_index
,
393 default_pass_by_reference
,
395 NULL
, /* la_get_symbol_name_cmp */
396 iterate_over_symbols
,
405 * Following functions help construct Objective-C message calls.
408 struct selname
/* For parsing Objective-C. */
410 struct selname
*next
;
415 static int msglist_len
;
416 static struct selname
*selname_chain
;
417 static char *msglist_sel
;
422 struct selname
*newobj
= XNEW (struct selname
);
424 newobj
->next
= selname_chain
;
425 newobj
->msglist_len
= msglist_len
;
426 newobj
->msglist_sel
= msglist_sel
;
428 msglist_sel
= (char *)xmalloc(1);
430 selname_chain
= newobj
;
434 add_msglist(struct stoken
*str
, int addcolon
)
440 if (str
== 0) /* Unnamed arg, or... */
442 if (addcolon
== 0) /* variable number of args. */
455 len
= plen
+ strlen(msglist_sel
) + 2;
456 s
= (char *)xmalloc(len
);
457 strcpy(s
, msglist_sel
);
472 end_msglist (struct parser_state
*ps
)
474 int val
= msglist_len
;
475 struct selname
*sel
= selname_chain
;
476 char *p
= msglist_sel
;
479 selname_chain
= sel
->next
;
480 msglist_len
= sel
->msglist_len
;
481 msglist_sel
= sel
->msglist_sel
;
482 selid
= lookup_child_selector (parse_gdbarch (ps
), p
);
484 error (_("Can't find selector \"%s\""), p
);
485 write_exp_elt_longcst (ps
, selid
);
487 write_exp_elt_longcst (ps
, val
); /* Number of args */
494 * Function: specialcmp (const char *a, const char *b)
496 * Special strcmp: treats ']' and ' ' as end-of-string.
497 * Used for qsorting lists of objc methods (either by class or selector).
501 specialcmp (const char *a
, const char *b
)
503 while (*a
&& *a
!= ' ' && *a
!= ']' && *b
&& *b
!= ' ' && *b
!= ']')
509 if (*a
&& *a
!= ' ' && *a
!= ']')
510 return 1; /* a is longer therefore greater. */
511 if (*b
&& *b
!= ' ' && *b
!= ']')
512 return -1; /* a is shorter therefore lesser. */
513 return 0; /* a and b are identical. */
517 * Function: compare_selectors (const void *, const void *)
519 * Comparison function for use with qsort. Arguments are symbols or
520 * msymbols Compares selector part of objc method name alphabetically.
524 compare_selectors (const void *a
, const void *b
)
526 const char *aname
, *bname
;
528 aname
= SYMBOL_PRINT_NAME (*(struct symbol
**) a
);
529 bname
= SYMBOL_PRINT_NAME (*(struct symbol
**) b
);
530 if (aname
== NULL
|| bname
== NULL
)
531 error (_("internal: compare_selectors(1)"));
533 aname
= strchr(aname
, ' ');
534 bname
= strchr(bname
, ' ');
535 if (aname
== NULL
|| bname
== NULL
)
536 error (_("internal: compare_selectors(2)"));
538 return specialcmp (aname
+1, bname
+1);
542 * Function: selectors_info (regexp, from_tty)
544 * Implements the "Info selectors" command. Takes an optional regexp
545 * arg. Lists all objective c selectors that match the regexp. Works
546 * by grepping thru all symbols for objective c methods. Output list
547 * is sorted and uniqued.
551 selectors_info (char *regexp
, int from_tty
)
553 struct objfile
*objfile
;
554 struct minimal_symbol
*msymbol
;
562 struct symbol
**sym_arr
;
566 strcpy(myregexp
, ".*]"); /* Null input, match all objc methods. */
569 if (*regexp
== '+' || *regexp
== '-')
570 { /* User wants only class methods or only instance methods. */
571 plusminus
= *regexp
++;
572 while (*regexp
== ' ' || *regexp
== '\t')
576 strcpy(myregexp
, ".*]");
579 /* Allow a few extra bytes because of the strcat below. */
580 if (sizeof (myregexp
) < strlen (regexp
) + 4)
581 error (_("Regexp is too long: %s"), regexp
);
582 strcpy(myregexp
, regexp
);
583 if (myregexp
[strlen(myregexp
) - 1] == '$') /* end of selector */
584 myregexp
[strlen(myregexp
) - 1] = ']'; /* end of method name */
586 strcat(myregexp
, ".*]");
592 val
= re_comp (myregexp
);
594 error (_("Invalid regexp (%s): %s"), val
, regexp
);
597 /* First time thru is JUST to get max length and count. */
598 ALL_MSYMBOLS (objfile
, msymbol
)
601 name
= MSYMBOL_NATURAL_NAME (msymbol
);
603 && (name
[0] == '-' || name
[0] == '+')
604 && name
[1] == '[') /* Got a method name. */
606 /* Filter for class/instance methods. */
607 if (plusminus
&& name
[0] != plusminus
)
609 /* Find selector part. */
610 name
= (char *) strchr (name
+2, ' ');
613 complaint (&symfile_complaints
,
614 _("Bad method name '%s'"),
615 MSYMBOL_NATURAL_NAME (msymbol
));
618 if (regexp
== NULL
|| re_exec(++name
) != 0)
620 const char *mystart
= name
;
621 const char *myend
= strchr (mystart
, ']');
623 if (myend
&& (myend
- mystart
> maxlen
))
624 maxlen
= myend
- mystart
; /* Get longest selector. */
631 printf_filtered (_("Selectors matching \"%s\":\n\n"),
632 regexp
? regexp
: "*");
634 sym_arr
= XALLOCAVEC (struct symbol
*, matches
);
636 ALL_MSYMBOLS (objfile
, msymbol
)
639 name
= MSYMBOL_NATURAL_NAME (msymbol
);
641 (name
[0] == '-' || name
[0] == '+') &&
642 name
[1] == '[') /* Got a method name. */
644 /* Filter for class/instance methods. */
645 if (plusminus
&& name
[0] != plusminus
)
647 /* Find selector part. */
648 name
= (char *) strchr(name
+2, ' ');
649 if (regexp
== NULL
|| re_exec(++name
) != 0)
650 sym_arr
[matches
++] = (struct symbol
*) msymbol
;
654 qsort (sym_arr
, matches
, sizeof (struct minimal_symbol
*),
656 /* Prevent compare on first iteration. */
658 for (ix
= 0; ix
< matches
; ix
++) /* Now do the output. */
663 name
= SYMBOL_NATURAL_NAME (sym_arr
[ix
]);
664 name
= strchr (name
, ' ') + 1;
665 if (p
[0] && specialcmp(name
, p
) == 0)
666 continue; /* Seen this one already (not unique). */
668 /* Copy selector part. */
669 while (*name
&& *name
!= ']')
672 /* Print in columns. */
673 puts_filtered_tabular(asel
, maxlen
+ 1, 0);
678 printf_filtered (_("No selectors matching \"%s\"\n"),
679 regexp
? regexp
: "*");
683 * Function: compare_classes (const void *, const void *)
685 * Comparison function for use with qsort. Arguments are symbols or
686 * msymbols Compares class part of objc method name alphabetically.
690 compare_classes (const void *a
, const void *b
)
692 const char *aname
, *bname
;
694 aname
= SYMBOL_PRINT_NAME (*(struct symbol
**) a
);
695 bname
= SYMBOL_PRINT_NAME (*(struct symbol
**) b
);
696 if (aname
== NULL
|| bname
== NULL
)
697 error (_("internal: compare_classes(1)"));
699 return specialcmp (aname
+1, bname
+1);
703 * Function: classes_info(regexp, from_tty)
705 * Implements the "info classes" command for objective c classes.
706 * Lists all objective c classes that match the optional regexp.
707 * Works by grepping thru the list of objective c methods. List will
708 * be sorted and uniqued (since one class may have many methods).
709 * BUGS: will not list a class that has no methods.
713 classes_info (char *regexp
, int from_tty
)
715 struct objfile
*objfile
;
716 struct minimal_symbol
*msymbol
;
724 struct symbol
**sym_arr
;
727 strcpy(myregexp
, ".* "); /* Null input: match all objc classes. */
730 /* Allow a few extra bytes because of the strcat below. */
731 if (sizeof (myregexp
) < strlen (regexp
) + 4)
732 error (_("Regexp is too long: %s"), regexp
);
733 strcpy(myregexp
, regexp
);
734 if (myregexp
[strlen(myregexp
) - 1] == '$')
735 /* In the method name, the end of the class name is marked by ' '. */
736 myregexp
[strlen(myregexp
) - 1] = ' ';
738 strcat(myregexp
, ".* ");
743 val
= re_comp (myregexp
);
745 error (_("Invalid regexp (%s): %s"), val
, regexp
);
748 /* First time thru is JUST to get max length and count. */
749 ALL_MSYMBOLS (objfile
, msymbol
)
752 name
= MSYMBOL_NATURAL_NAME (msymbol
);
754 (name
[0] == '-' || name
[0] == '+') &&
755 name
[1] == '[') /* Got a method name. */
756 if (regexp
== NULL
|| re_exec(name
+2) != 0)
758 /* Compute length of classname part. */
759 const char *mystart
= name
+ 2;
760 const char *myend
= strchr (mystart
, ' ');
762 if (myend
&& (myend
- mystart
> maxlen
))
763 maxlen
= myend
- mystart
;
769 printf_filtered (_("Classes matching \"%s\":\n\n"),
770 regexp
? regexp
: "*");
771 sym_arr
= XALLOCAVEC (struct symbol
*, matches
);
773 ALL_MSYMBOLS (objfile
, msymbol
)
776 name
= MSYMBOL_NATURAL_NAME (msymbol
);
778 (name
[0] == '-' || name
[0] == '+') &&
779 name
[1] == '[') /* Got a method name. */
780 if (regexp
== NULL
|| re_exec(name
+2) != 0)
781 sym_arr
[matches
++] = (struct symbol
*) msymbol
;
784 qsort (sym_arr
, matches
, sizeof (struct minimal_symbol
*),
786 /* Prevent compare on first iteration. */
788 for (ix
= 0; ix
< matches
; ix
++) /* Now do the output. */
793 name
= SYMBOL_NATURAL_NAME (sym_arr
[ix
]);
795 if (p
[0] && specialcmp(name
, p
) == 0)
796 continue; /* Seen this one already (not unique). */
798 /* Copy class part of method name. */
799 while (*name
&& *name
!= ' ')
802 /* Print in columns. */
803 puts_filtered_tabular(aclass
, maxlen
+ 1, 0);
808 printf_filtered (_("No classes matching \"%s\"\n"), regexp
? regexp
: "*");
812 parse_selector (char *method
, char **selector
)
818 char *nselector
= NULL
;
820 gdb_assert (selector
!= NULL
);
824 s1
= skip_spaces (s1
);
830 s1
= skip_spaces (s1
);
837 if (isalnum (*s2
) || (*s2
== '_') || (*s2
== ':'))
839 else if (isspace (*s2
))
841 else if ((*s2
== '\0') || (*s2
== '\''))
849 s2
= skip_spaces (s2
);
854 s2
= skip_spaces (s2
);
857 if (selector
!= NULL
)
858 *selector
= nselector
;
864 parse_method (char *method
, char *type
, char **theclass
,
865 char **category
, char **selector
)
873 char *ncategory
= NULL
;
874 char *nselector
= NULL
;
876 gdb_assert (type
!= NULL
);
877 gdb_assert (theclass
!= NULL
);
878 gdb_assert (category
!= NULL
);
879 gdb_assert (selector
!= NULL
);
883 s1
= skip_spaces (s1
);
889 s1
= skip_spaces (s1
);
891 if ((s1
[0] == '+') || (s1
[0] == '-'))
894 s1
= skip_spaces (s1
);
901 while (isalnum (*s1
) || (*s1
== '_'))
905 s2
= skip_spaces (s2
);
910 s2
= skip_spaces (s2
);
912 while (isalnum (*s2
) || (*s2
== '_'))
917 /* Truncate the class name now that we're not using the open paren. */
925 if (isalnum (*s2
) || (*s2
== '_') || (*s2
== ':'))
927 else if (isspace (*s2
))
938 s2
= skip_spaces (s2
);
944 s2
= skip_spaces (s2
);
949 if (theclass
!= NULL
)
951 if (category
!= NULL
)
952 *category
= ncategory
;
953 if (selector
!= NULL
)
954 *selector
= nselector
;
960 find_methods (char type
, const char *theclass
, const char *category
,
961 const char *selector
,
962 VEC (const_char_ptr
) **symbol_names
)
964 struct objfile
*objfile
= NULL
;
966 const char *symname
= NULL
;
970 char *ncategory
= NULL
;
971 char *nselector
= NULL
;
973 static char *tmp
= NULL
;
974 static unsigned int tmplen
= 0;
976 gdb_assert (symbol_names
!= NULL
);
978 ALL_OBJFILES (objfile
)
980 unsigned int *objc_csym
;
981 struct minimal_symbol
*msymbol
= NULL
;
983 /* The objfile_csym variable counts the number of ObjC methods
984 that this objfile defines. We save that count as a private
985 objfile data. If we have already determined that this objfile
986 provides no ObjC methods, we can skip it entirely. */
988 unsigned int objfile_csym
= 0;
990 objc_csym
= (unsigned int *) objfile_data (objfile
, objc_objfile_data
);
991 if (objc_csym
!= NULL
&& *objc_csym
== 0)
992 /* There are no ObjC symbols in this objfile. Skip it entirely. */
995 ALL_OBJFILE_MSYMBOLS (objfile
, msymbol
)
999 /* Check the symbol name first as this can be done entirely without
1000 sending any query to the target. */
1001 symname
= MSYMBOL_NATURAL_NAME (msymbol
);
1002 if (symname
== NULL
)
1005 if ((symname
[0] != '-' && symname
[0] != '+') || (symname
[1] != '['))
1006 /* Not a method name. */
1011 /* Now that thinks are a bit sane, clean up the symname. */
1012 while ((strlen (symname
) + 1) >= tmplen
)
1014 tmplen
= (tmplen
== 0) ? 1024 : tmplen
* 2;
1015 tmp
= (char *) xrealloc (tmp
, tmplen
);
1017 strcpy (tmp
, symname
);
1019 if (parse_method (tmp
, &ntype
, &nclass
,
1020 &ncategory
, &nselector
) == NULL
)
1023 if ((type
!= '\0') && (ntype
!= type
))
1026 if ((theclass
!= NULL
)
1027 && ((nclass
== NULL
) || (strcmp (theclass
, nclass
) != 0)))
1030 if ((category
!= NULL
) &&
1031 ((ncategory
== NULL
) || (strcmp (category
, ncategory
) != 0)))
1034 if ((selector
!= NULL
) &&
1035 ((nselector
== NULL
) || (strcmp (selector
, nselector
) != 0)))
1038 VEC_safe_push (const_char_ptr
, *symbol_names
, symname
);
1041 if (objc_csym
== NULL
)
1043 objc_csym
= XOBNEW (&objfile
->objfile_obstack
, unsigned int);
1044 *objc_csym
= objfile_csym
;
1045 set_objfile_data (objfile
, objc_objfile_data
, objc_csym
);
1048 /* Count of ObjC methods in this objfile should be constant. */
1049 gdb_assert (*objc_csym
== objfile_csym
);
1053 /* Uniquify a VEC of strings. */
1056 uniquify_strings (VEC (const_char_ptr
) **strings
)
1059 const char *elem
, *last
= NULL
;
1062 /* If the vector is empty, there's nothing to do. This explicit
1063 check is needed to avoid invoking qsort with NULL. */
1064 if (VEC_empty (const_char_ptr
, *strings
))
1067 qsort (VEC_address (const_char_ptr
, *strings
),
1068 VEC_length (const_char_ptr
, *strings
),
1069 sizeof (const_char_ptr
),
1072 for (ix
= 0; VEC_iterate (const_char_ptr
, *strings
, ix
, elem
); ++ix
)
1074 if (last
== NULL
|| strcmp (last
, elem
) != 0)
1077 VEC_replace (const_char_ptr
, *strings
, out
, elem
);
1082 VEC_truncate (const_char_ptr
, *strings
, out
);
1086 * Function: find_imps (const char *selector, struct symbol **sym_arr)
1088 * Input: a string representing a selector
1089 * a pointer to an array of symbol pointers
1090 * possibly a pointer to a symbol found by the caller.
1092 * Output: number of methods that implement that selector. Side
1093 * effects: The array of symbol pointers is filled with matching syms.
1095 * By analogy with function "find_methods" (symtab.c), builds a list
1096 * of symbols matching the ambiguous input, so that "decode_line_2"
1097 * (symtab.c) can list them and ask the user to choose one or more.
1098 * In this case the matches are objective c methods
1099 * ("implementations") matching an objective c selector.
1101 * Note that it is possible for a normal (c-style) function to have
1102 * the same name as an objective c selector. To prevent the selector
1103 * from eclipsing the function, we allow the caller (decode_line_1) to
1104 * search for such a function first, and if it finds one, pass it in
1105 * to us. We will then integrate it into the list. We also search
1106 * for one here, among the minsyms.
1108 * NOTE: if NUM_DEBUGGABLE is non-zero, the sym_arr will be divided
1109 * into two parts: debuggable (struct symbol) syms, and
1110 * non_debuggable (struct minimal_symbol) syms. The debuggable
1111 * ones will come first, before NUM_DEBUGGABLE (which will thus
1112 * be the index of the first non-debuggable one).
1116 find_imps (const char *method
, VEC (const_char_ptr
) **symbol_names
)
1119 char *theclass
= NULL
;
1120 char *category
= NULL
;
1121 char *selector
= NULL
;
1126 int selector_case
= 0;
1128 gdb_assert (symbol_names
!= NULL
);
1130 buf
= (char *) alloca (strlen (method
) + 1);
1131 strcpy (buf
, method
);
1132 tmp
= parse_method (buf
, &type
, &theclass
, &category
, &selector
);
1136 strcpy (buf
, method
);
1137 tmp
= parse_selector (buf
, &selector
);
1145 find_methods (type
, theclass
, category
, selector
, symbol_names
);
1147 /* If we hit the "selector" case, and we found some methods, then
1148 add the selector itself as a symbol, if it exists. */
1149 if (selector_case
&& !VEC_empty (const_char_ptr
, *symbol_names
))
1151 struct symbol
*sym
= lookup_symbol (selector
, NULL
, VAR_DOMAIN
,
1155 VEC_safe_push (const_char_ptr
, *symbol_names
,
1156 SYMBOL_NATURAL_NAME (sym
));
1159 struct bound_minimal_symbol msym
1160 = lookup_minimal_symbol (selector
, 0, 0);
1162 if (msym
.minsym
!= NULL
)
1163 VEC_safe_push (const_char_ptr
, *symbol_names
,
1164 MSYMBOL_NATURAL_NAME (msym
.minsym
));
1168 uniquify_strings (symbol_names
);
1170 return method
+ (tmp
- buf
);
1174 print_object_command (char *args
, int from_tty
)
1176 struct value
*object
, *function
, *description
;
1177 CORE_ADDR string_addr
, object_addr
;
1181 if (!args
|| !*args
)
1183 "The 'print-object' command requires an argument (an Objective-C object)");
1186 struct expression
*expr
= parse_expression (args
);
1187 struct cleanup
*old_chain
=
1188 make_cleanup (free_current_contents
, &expr
);
1191 object
= evaluate_subexp (builtin_type (expr
->gdbarch
)->builtin_data_ptr
,
1192 expr
, &pc
, EVAL_NORMAL
);
1193 do_cleanups (old_chain
);
1196 /* Validate the address for sanity. */
1197 object_addr
= value_as_long (object
);
1198 read_memory (object_addr
, &c
, 1);
1200 function
= find_function_in_inferior ("_NSPrintForDebugger", NULL
);
1201 if (function
== NULL
)
1202 error (_("Unable to locate _NSPrintForDebugger in child process"));
1204 description
= call_function_by_hand (function
, 1, &object
);
1206 string_addr
= value_as_long (description
);
1207 if (string_addr
== 0)
1208 error (_("object returns null description"));
1210 read_memory (string_addr
+ i
++, &c
, 1);
1213 { /* Read and print characters up to EOS. */
1215 printf_filtered ("%c", c
);
1216 read_memory (string_addr
+ i
++, &c
, 1);
1219 printf_filtered(_("<object returns empty description>"));
1220 printf_filtered ("\n");
1223 /* The data structure 'methcalls' is used to detect method calls (thru
1224 * ObjC runtime lib functions objc_msgSend, objc_msgSendSuper, etc.),
1225 * and ultimately find the method being called.
1228 struct objc_methcall
{
1230 /* Return instance method to be called. */
1231 int (*stop_at
) (CORE_ADDR
, CORE_ADDR
*);
1232 /* Start of pc range corresponding to method invocation. */
1234 /* End of pc range corresponding to method invocation. */
1238 static int resolve_msgsend (CORE_ADDR pc
, CORE_ADDR
*new_pc
);
1239 static int resolve_msgsend_stret (CORE_ADDR pc
, CORE_ADDR
*new_pc
);
1240 static int resolve_msgsend_super (CORE_ADDR pc
, CORE_ADDR
*new_pc
);
1241 static int resolve_msgsend_super_stret (CORE_ADDR pc
, CORE_ADDR
*new_pc
);
1243 static struct objc_methcall methcalls
[] = {
1244 { "_objc_msgSend", resolve_msgsend
, 0, 0},
1245 { "_objc_msgSend_stret", resolve_msgsend_stret
, 0, 0},
1246 { "_objc_msgSendSuper", resolve_msgsend_super
, 0, 0},
1247 { "_objc_msgSendSuper_stret", resolve_msgsend_super_stret
, 0, 0},
1248 { "_objc_getClass", NULL
, 0, 0},
1249 { "_objc_getMetaClass", NULL
, 0, 0}
1252 #define nmethcalls (sizeof (methcalls) / sizeof (methcalls[0]))
1254 /* The following function, "find_objc_msgsend", fills in the data
1255 * structure "objc_msgs" by finding the addresses of each of the
1256 * (currently four) functions that it holds (of which objc_msgSend is
1257 * the first). This must be called each time symbols are loaded, in
1258 * case the functions have moved for some reason.
1262 find_objc_msgsend (void)
1266 for (i
= 0; i
< nmethcalls
; i
++)
1268 struct bound_minimal_symbol func
;
1270 /* Try both with and without underscore. */
1271 func
= lookup_bound_minimal_symbol (methcalls
[i
].name
);
1272 if ((func
.minsym
== NULL
) && (methcalls
[i
].name
[0] == '_'))
1274 func
= lookup_bound_minimal_symbol (methcalls
[i
].name
+ 1);
1276 if (func
.minsym
== NULL
)
1278 methcalls
[i
].begin
= 0;
1279 methcalls
[i
].end
= 0;
1283 methcalls
[i
].begin
= BMSYMBOL_VALUE_ADDRESS (func
);
1284 methcalls
[i
].end
= minimal_symbol_upper_bound (func
);
1288 /* find_objc_msgcall (replaces pc_off_limits)
1290 * ALL that this function now does is to determine whether the input
1291 * address ("pc") is the address of one of the Objective-C message
1292 * dispatch functions (mainly objc_msgSend or objc_msgSendSuper), and
1293 * if so, it returns the address of the method that will be called.
1295 * The old function "pc_off_limits" used to do a lot of other things
1296 * in addition, such as detecting shared library jump stubs and
1297 * returning the address of the shlib function that would be called.
1298 * That functionality has been moved into the gdbarch_skip_trampoline_code and
1299 * IN_SOLIB_TRAMPOLINE macros, which are resolved in the target-
1300 * dependent modules.
1303 struct objc_submethod_helper_data
{
1304 int (*f
) (CORE_ADDR
, CORE_ADDR
*);
1310 find_objc_msgcall_submethod_helper (void * arg
)
1312 struct objc_submethod_helper_data
*s
=
1313 (struct objc_submethod_helper_data
*) arg
;
1315 if (s
->f (s
->pc
, s
->new_pc
) == 0)
1322 find_objc_msgcall_submethod (int (*f
) (CORE_ADDR
, CORE_ADDR
*),
1326 struct objc_submethod_helper_data s
;
1332 if (catch_errors (find_objc_msgcall_submethod_helper
,
1334 "Unable to determine target of "
1335 "Objective-C method call (ignoring):\n",
1336 RETURN_MASK_ALL
) == 0)
1343 find_objc_msgcall (CORE_ADDR pc
, CORE_ADDR
*new_pc
)
1347 find_objc_msgsend ();
1353 for (i
= 0; i
< nmethcalls
; i
++)
1354 if ((pc
>= methcalls
[i
].begin
) && (pc
< methcalls
[i
].end
))
1356 if (methcalls
[i
].stop_at
!= NULL
)
1357 return find_objc_msgcall_submethod (methcalls
[i
].stop_at
,
1366 /* -Wmissing-prototypes */
1367 extern initialize_file_ftype _initialize_objc_language
;
1370 _initialize_objc_language (void)
1372 add_language (&objc_language_defn
);
1373 add_info ("selectors", selectors_info
, /* INFO SELECTORS command. */
1374 _("All Objective-C selectors, or those matching REGEXP."));
1375 add_info ("classes", classes_info
, /* INFO CLASSES command. */
1376 _("All Objective-C classes, or those matching REGEXP."));
1377 add_com ("print-object", class_vars
, print_object_command
,
1378 _("Ask an Objective-C object to print itself."));
1379 add_com_alias ("po", "print-object", class_vars
, 1);
1383 read_objc_method (struct gdbarch
*gdbarch
, CORE_ADDR addr
,
1384 struct objc_method
*method
)
1386 enum bfd_endian byte_order
= gdbarch_byte_order (gdbarch
);
1388 method
->name
= read_memory_unsigned_integer (addr
+ 0, 4, byte_order
);
1389 method
->types
= read_memory_unsigned_integer (addr
+ 4, 4, byte_order
);
1390 method
->imp
= read_memory_unsigned_integer (addr
+ 8, 4, byte_order
);
1393 static unsigned long
1394 read_objc_methlist_nmethods (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
1396 enum bfd_endian byte_order
= gdbarch_byte_order (gdbarch
);
1398 return read_memory_unsigned_integer (addr
+ 4, 4, byte_order
);
1402 read_objc_methlist_method (struct gdbarch
*gdbarch
, CORE_ADDR addr
,
1403 unsigned long num
, struct objc_method
*method
)
1405 gdb_assert (num
< read_objc_methlist_nmethods (gdbarch
, addr
));
1406 read_objc_method (gdbarch
, addr
+ 8 + (12 * num
), method
);
1410 read_objc_object (struct gdbarch
*gdbarch
, CORE_ADDR addr
,
1411 struct objc_object
*object
)
1413 enum bfd_endian byte_order
= gdbarch_byte_order (gdbarch
);
1415 object
->isa
= read_memory_unsigned_integer (addr
, 4, byte_order
);
1419 read_objc_super (struct gdbarch
*gdbarch
, CORE_ADDR addr
,
1420 struct objc_super
*super
)
1422 enum bfd_endian byte_order
= gdbarch_byte_order (gdbarch
);
1424 super
->receiver
= read_memory_unsigned_integer (addr
, 4, byte_order
);
1425 super
->theclass
= read_memory_unsigned_integer (addr
+ 4, 4, byte_order
);
1429 read_objc_class (struct gdbarch
*gdbarch
, CORE_ADDR addr
,
1430 struct objc_class
*theclass
)
1432 enum bfd_endian byte_order
= gdbarch_byte_order (gdbarch
);
1434 theclass
->isa
= read_memory_unsigned_integer (addr
, 4, byte_order
);
1435 theclass
->super_class
= read_memory_unsigned_integer (addr
+ 4, 4, byte_order
);
1436 theclass
->name
= read_memory_unsigned_integer (addr
+ 8, 4, byte_order
);
1437 theclass
->version
= read_memory_unsigned_integer (addr
+ 12, 4, byte_order
);
1438 theclass
->info
= read_memory_unsigned_integer (addr
+ 16, 4, byte_order
);
1439 theclass
->instance_size
= read_memory_unsigned_integer (addr
+ 18, 4,
1441 theclass
->ivars
= read_memory_unsigned_integer (addr
+ 24, 4, byte_order
);
1442 theclass
->methods
= read_memory_unsigned_integer (addr
+ 28, 4, byte_order
);
1443 theclass
->cache
= read_memory_unsigned_integer (addr
+ 32, 4, byte_order
);
1444 theclass
->protocols
= read_memory_unsigned_integer (addr
+ 36, 4, byte_order
);
1448 find_implementation_from_class (struct gdbarch
*gdbarch
,
1449 CORE_ADDR theclass
, CORE_ADDR sel
)
1451 enum bfd_endian byte_order
= gdbarch_byte_order (gdbarch
);
1452 CORE_ADDR subclass
= theclass
;
1454 while (subclass
!= 0)
1457 struct objc_class class_str
;
1458 unsigned mlistnum
= 0;
1460 read_objc_class (gdbarch
, subclass
, &class_str
);
1465 unsigned long nmethods
;
1468 mlist
= read_memory_unsigned_integer (class_str
.methods
+
1474 nmethods
= read_objc_methlist_nmethods (gdbarch
, mlist
);
1476 for (i
= 0; i
< nmethods
; i
++)
1478 struct objc_method meth_str
;
1480 read_objc_methlist_method (gdbarch
, mlist
, i
, &meth_str
);
1482 if (meth_str
.name
== sel
)
1483 /* FIXME: hppa arch was doing a pointer dereference
1484 here. There needs to be a better way to do that. */
1485 return meth_str
.imp
;
1489 subclass
= class_str
.super_class
;
1496 find_implementation (struct gdbarch
*gdbarch
,
1497 CORE_ADDR object
, CORE_ADDR sel
)
1499 struct objc_object ostr
;
1503 read_objc_object (gdbarch
, object
, &ostr
);
1507 return find_implementation_from_class (gdbarch
, ostr
.isa
, sel
);
1511 resolve_msgsend (CORE_ADDR pc
, CORE_ADDR
*new_pc
)
1513 struct frame_info
*frame
= get_current_frame ();
1514 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
1515 struct type
*ptr_type
= builtin_type (gdbarch
)->builtin_func_ptr
;
1521 object
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 0, ptr_type
);
1522 sel
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 1, ptr_type
);
1524 res
= find_implementation (gdbarch
, object
, sel
);
1533 resolve_msgsend_stret (CORE_ADDR pc
, CORE_ADDR
*new_pc
)
1535 struct frame_info
*frame
= get_current_frame ();
1536 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
1537 struct type
*ptr_type
= builtin_type (gdbarch
)->builtin_func_ptr
;
1543 object
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 1, ptr_type
);
1544 sel
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 2, ptr_type
);
1546 res
= find_implementation (gdbarch
, object
, sel
);
1555 resolve_msgsend_super (CORE_ADDR pc
, CORE_ADDR
*new_pc
)
1557 struct frame_info
*frame
= get_current_frame ();
1558 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
1559 struct type
*ptr_type
= builtin_type (gdbarch
)->builtin_func_ptr
;
1561 struct objc_super sstr
;
1567 super
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 0, ptr_type
);
1568 sel
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 1, ptr_type
);
1570 read_objc_super (gdbarch
, super
, &sstr
);
1571 if (sstr
.theclass
== 0)
1574 res
= find_implementation_from_class (gdbarch
, sstr
.theclass
, sel
);
1583 resolve_msgsend_super_stret (CORE_ADDR pc
, CORE_ADDR
*new_pc
)
1585 struct frame_info
*frame
= get_current_frame ();
1586 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
1587 struct type
*ptr_type
= builtin_type (gdbarch
)->builtin_func_ptr
;
1589 struct objc_super sstr
;
1595 super
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 1, ptr_type
);
1596 sel
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 2, ptr_type
);
1598 read_objc_super (gdbarch
, super
, &sstr
);
1599 if (sstr
.theclass
== 0)
1602 res
= find_implementation_from_class (gdbarch
, sstr
.theclass
, sel
);
1610 /* Provide a prototype to silence -Wmissing-prototypes. */
1611 extern initialize_file_ftype _initialize_objc_lang
;
1614 _initialize_objc_lang (void)
1616 objc_objfile_data
= register_objfile_data ();