1 /* Objective-C language support routines for GDB, the GNU debugger.
3 Copyright (C) 2002-2019 Free Software Foundation, Inc.
5 Contributed by Apple Computer, Inc.
6 Written by Michael Snyder.
8 This file is part of GDB.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>. */
26 #include "expression.h"
27 #include "parser-defs.h"
31 #include "objc-lang.h"
32 #include "complaints.h"
36 #include "target.h" /* for target_has_execution */
40 #include "gdb_regex.h"
45 #include "cli/cli-utils.h"
56 CORE_ADDR super_class
;
78 static const struct objfile_data
*objc_objfile_data
;
80 /* Lookup a structure type named "struct NAME", visible in lexical
81 block BLOCK. If NOERR is nonzero, return zero if NAME is not
85 lookup_struct_typedef (const char *name
, const struct block
*block
, int noerr
)
89 sym
= lookup_symbol (name
, block
, STRUCT_DOMAIN
, 0).symbol
;
96 error (_("No struct type named %s."), name
);
98 if (TYPE_CODE (SYMBOL_TYPE (sym
)) != TYPE_CODE_STRUCT
)
103 error (_("This context has class, union or enum %s, not a struct."),
110 lookup_objc_class (struct gdbarch
*gdbarch
, const char *classname
)
112 struct type
*char_type
= builtin_type (gdbarch
)->builtin_char
;
113 struct value
* function
, *classval
;
115 if (! target_has_execution
)
117 /* Can't call into inferior to lookup class. */
121 if (lookup_minimal_symbol("objc_lookUpClass", 0, 0).minsym
)
122 function
= find_function_in_inferior("objc_lookUpClass", NULL
);
123 else if (lookup_minimal_symbol ("objc_lookup_class", 0, 0).minsym
)
124 function
= find_function_in_inferior("objc_lookup_class", NULL
);
127 complaint (_("no way to lookup Objective-C classes"));
131 classval
= value_string (classname
, strlen (classname
) + 1, char_type
);
132 classval
= value_coerce_array (classval
);
133 return (CORE_ADDR
) value_as_long (call_function_by_hand (function
,
139 lookup_child_selector (struct gdbarch
*gdbarch
, const char *selname
)
141 struct type
*char_type
= builtin_type (gdbarch
)->builtin_char
;
142 struct value
* function
, *selstring
;
144 if (! target_has_execution
)
146 /* Can't call into inferior to lookup selector. */
150 if (lookup_minimal_symbol("sel_getUid", 0, 0).minsym
)
151 function
= find_function_in_inferior("sel_getUid", NULL
);
152 else if (lookup_minimal_symbol ("sel_get_any_uid", 0, 0).minsym
)
153 function
= find_function_in_inferior("sel_get_any_uid", NULL
);
156 complaint (_("no way to lookup Objective-C selectors"));
160 selstring
= value_coerce_array (value_string (selname
,
161 strlen (selname
) + 1,
163 return value_as_long (call_function_by_hand (function
, NULL
, selstring
));
167 value_nsstring (struct gdbarch
*gdbarch
, char *ptr
, int len
)
169 struct type
*char_type
= builtin_type (gdbarch
)->builtin_char
;
170 struct value
*stringValue
[3];
171 struct value
*function
, *nsstringValue
;
175 if (!target_has_execution
)
176 return 0; /* Can't call into inferior to create NSString. */
178 stringValue
[2] = value_string(ptr
, len
, char_type
);
179 stringValue
[2] = value_coerce_array(stringValue
[2]);
180 /* _NSNewStringFromCString replaces "istr" after Lantern2A. */
181 if (lookup_minimal_symbol("_NSNewStringFromCString", 0, 0).minsym
)
183 function
= find_function_in_inferior("_NSNewStringFromCString", NULL
);
184 nsstringValue
= call_function_by_hand(function
, NULL
, stringValue
[2]);
186 else if (lookup_minimal_symbol("istr", 0, 0).minsym
)
188 function
= find_function_in_inferior("istr", NULL
);
189 nsstringValue
= call_function_by_hand(function
, NULL
, stringValue
[2]);
191 else if (lookup_minimal_symbol("+[NSString stringWithCString:]", 0, 0).minsym
)
194 = find_function_in_inferior("+[NSString stringWithCString:]", NULL
);
195 type
= builtin_type (gdbarch
)->builtin_long
;
197 stringValue
[0] = value_from_longest
198 (type
, lookup_objc_class (gdbarch
, "NSString"));
199 stringValue
[1] = value_from_longest
200 (type
, lookup_child_selector (gdbarch
, "stringWithCString:"));
201 nsstringValue
= call_function_by_hand(function
, NULL
, stringValue
);
204 error (_("NSString: internal error -- no way to create new NSString"));
206 sym
= lookup_struct_typedef("NSString", 0, 1);
208 sym
= lookup_struct_typedef("NXString", 0, 1);
210 type
= builtin_type (gdbarch
)->builtin_data_ptr
;
212 type
= lookup_pointer_type(SYMBOL_TYPE (sym
));
214 deprecated_set_value_type (nsstringValue
, type
);
215 return nsstringValue
;
218 /* Objective-C name demangling. */
221 objc_demangle (const char *mangled
, int options
)
223 char *demangled
, *cp
;
225 if (mangled
[0] == '_' &&
226 (mangled
[1] == 'i' || mangled
[1] == 'c') &&
229 cp
= demangled
= (char *) xmalloc (strlen (mangled
) + 2);
231 if (mangled
[1] == 'i')
232 *cp
++ = '-'; /* for instance method */
234 *cp
++ = '+'; /* for class method */
236 *cp
++ = '['; /* opening left brace */
237 strcpy(cp
, mangled
+3); /* Tack on the rest of the mangled name. */
239 while (*cp
&& *cp
== '_')
240 cp
++; /* Skip any initial underbars in class
243 cp
= strchr(cp
, '_');
244 if (!cp
) /* Find first non-initial underbar. */
246 xfree(demangled
); /* not mangled name */
249 if (cp
[1] == '_') /* Easy case: no category name. */
251 *cp
++ = ' '; /* Replace two '_' with one ' '. */
252 strcpy(cp
, mangled
+ (cp
- demangled
) + 2);
256 *cp
++ = '('; /* Less easy case: category name. */
257 cp
= strchr(cp
, '_');
260 xfree(demangled
); /* not mangled name */
264 *cp
++ = ' '; /* Overwriting 1st char of method name... */
265 strcpy(cp
, mangled
+ (cp
- demangled
)); /* Get it back. */
268 while (*cp
&& *cp
== '_')
269 cp
++; /* Skip any initial underbars in
274 *cp
= ':'; /* Replace remaining '_' with ':'. */
276 *cp
++ = ']'; /* closing right brace */
277 *cp
++ = 0; /* string terminator */
281 return NULL
; /* Not an objc mangled name. */
284 /* la_sniff_from_mangled_name for ObjC. */
287 objc_sniff_from_mangled_name (const char *mangled
, char **demangled
)
289 *demangled
= objc_demangle (mangled
, 0);
290 return *demangled
!= NULL
;
293 /* Determine if we are currently in the Objective-C dispatch function.
294 If so, get the address of the method function that the dispatcher
295 would call and use that as the function to step into instead. Also
296 skip over the trampoline for the function (if any). This is better
297 for the user since they are only interested in stepping into the
298 method function anyway. */
300 objc_skip_trampoline (struct frame_info
*frame
, CORE_ADDR stop_pc
)
302 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
303 CORE_ADDR real_stop_pc
;
304 CORE_ADDR method_stop_pc
;
306 real_stop_pc
= gdbarch_skip_trampoline_code (gdbarch
, frame
, stop_pc
);
308 if (real_stop_pc
!= 0)
309 find_objc_msgcall (real_stop_pc
, &method_stop_pc
);
311 find_objc_msgcall (stop_pc
, &method_stop_pc
);
315 real_stop_pc
= gdbarch_skip_trampoline_code
316 (gdbarch
, frame
, method_stop_pc
);
317 if (real_stop_pc
== 0)
318 real_stop_pc
= method_stop_pc
;
325 /* Table mapping opcodes into strings for printing operators
326 and precedences of the operators. */
328 static const struct op_print objc_op_print_tab
[] =
330 {",", BINOP_COMMA
, PREC_COMMA
, 0},
331 {"=", BINOP_ASSIGN
, PREC_ASSIGN
, 1},
332 {"||", BINOP_LOGICAL_OR
, PREC_LOGICAL_OR
, 0},
333 {"&&", BINOP_LOGICAL_AND
, PREC_LOGICAL_AND
, 0},
334 {"|", BINOP_BITWISE_IOR
, PREC_BITWISE_IOR
, 0},
335 {"^", BINOP_BITWISE_XOR
, PREC_BITWISE_XOR
, 0},
336 {"&", BINOP_BITWISE_AND
, PREC_BITWISE_AND
, 0},
337 {"==", BINOP_EQUAL
, PREC_EQUAL
, 0},
338 {"!=", BINOP_NOTEQUAL
, PREC_EQUAL
, 0},
339 {"<=", BINOP_LEQ
, PREC_ORDER
, 0},
340 {">=", BINOP_GEQ
, PREC_ORDER
, 0},
341 {">", BINOP_GTR
, PREC_ORDER
, 0},
342 {"<", BINOP_LESS
, PREC_ORDER
, 0},
343 {">>", BINOP_RSH
, PREC_SHIFT
, 0},
344 {"<<", BINOP_LSH
, PREC_SHIFT
, 0},
345 {"+", BINOP_ADD
, PREC_ADD
, 0},
346 {"-", BINOP_SUB
, PREC_ADD
, 0},
347 {"*", BINOP_MUL
, PREC_MUL
, 0},
348 {"/", BINOP_DIV
, PREC_MUL
, 0},
349 {"%", BINOP_REM
, PREC_MUL
, 0},
350 {"@", BINOP_REPEAT
, PREC_REPEAT
, 0},
351 {"-", UNOP_NEG
, PREC_PREFIX
, 0},
352 {"!", UNOP_LOGICAL_NOT
, PREC_PREFIX
, 0},
353 {"~", UNOP_COMPLEMENT
, PREC_PREFIX
, 0},
354 {"*", UNOP_IND
, PREC_PREFIX
, 0},
355 {"&", UNOP_ADDR
, PREC_PREFIX
, 0},
356 {"sizeof ", UNOP_SIZEOF
, PREC_PREFIX
, 0},
357 {"++", UNOP_PREINCREMENT
, PREC_PREFIX
, 0},
358 {"--", UNOP_PREDECREMENT
, PREC_PREFIX
, 0},
359 {NULL
, OP_NULL
, PREC_NULL
, 0}
362 static const char *objc_extensions
[] =
367 extern const struct language_defn objc_language_defn
= {
368 "objective-c", /* Language name */
376 &exp_descriptor_standard
,
379 c_printchar
, /* Print a character constant */
380 c_printstr
, /* Function to print string constant */
382 c_print_type
, /* Print a type using appropriate syntax */
383 c_print_typedef
, /* Print a typedef using appropriate syntax */
384 c_val_print
, /* Print a value using appropriate syntax */
385 c_value_print
, /* Print a top-level value */
386 default_read_var_value
, /* la_read_var_value */
387 objc_skip_trampoline
, /* Language specific skip_trampoline */
388 "self", /* name_of_this */
389 false, /* la_store_sym_names_in_linkage_form_p */
390 basic_lookup_symbol_nonlocal
, /* lookup_symbol_nonlocal */
391 basic_lookup_transparent_type
,/* lookup_transparent_type */
392 objc_demangle
, /* Language specific symbol demangler */
393 objc_sniff_from_mangled_name
,
394 NULL
, /* Language specific
395 class_name_from_physname */
396 objc_op_print_tab
, /* Expression operators for printing */
397 1, /* C-style arrays */
398 0, /* String lower bound */
399 default_word_break_characters
,
400 default_collect_symbol_completion_matches
,
401 c_language_arch_info
,
402 default_print_array_index
,
403 default_pass_by_reference
,
405 c_watch_location_expression
,
406 NULL
, /* la_get_symbol_name_matcher */
407 iterate_over_symbols
,
408 default_search_name_hash
,
417 * Following functions help construct Objective-C message calls.
420 struct selname
/* For parsing Objective-C. */
422 struct selname
*next
;
427 static int msglist_len
;
428 static struct selname
*selname_chain
;
429 static char *msglist_sel
;
434 struct selname
*newobj
= XNEW (struct selname
);
436 newobj
->next
= selname_chain
;
437 newobj
->msglist_len
= msglist_len
;
438 newobj
->msglist_sel
= msglist_sel
;
440 msglist_sel
= (char *)xmalloc(1);
442 selname_chain
= newobj
;
446 add_msglist(struct stoken
*str
, int addcolon
)
452 if (str
== 0) /* Unnamed arg, or... */
454 if (addcolon
== 0) /* variable number of args. */
467 len
= plen
+ strlen(msglist_sel
) + 2;
468 s
= (char *)xmalloc(len
);
469 strcpy(s
, msglist_sel
);
484 end_msglist (struct parser_state
*ps
)
486 int val
= msglist_len
;
487 struct selname
*sel
= selname_chain
;
488 char *p
= msglist_sel
;
491 selname_chain
= sel
->next
;
492 msglist_len
= sel
->msglist_len
;
493 msglist_sel
= sel
->msglist_sel
;
494 selid
= lookup_child_selector (parse_gdbarch (ps
), p
);
496 error (_("Can't find selector \"%s\""), p
);
497 write_exp_elt_longcst (ps
, selid
);
499 write_exp_elt_longcst (ps
, val
); /* Number of args */
506 * Function: specialcmp (const char *a, const char *b)
508 * Special strcmp: treats ']' and ' ' as end-of-string.
509 * Used for qsorting lists of objc methods (either by class or selector).
513 specialcmp (const char *a
, const char *b
)
515 while (*a
&& *a
!= ' ' && *a
!= ']' && *b
&& *b
!= ' ' && *b
!= ']')
521 if (*a
&& *a
!= ' ' && *a
!= ']')
522 return 1; /* a is longer therefore greater. */
523 if (*b
&& *b
!= ' ' && *b
!= ']')
524 return -1; /* a is shorter therefore lesser. */
525 return 0; /* a and b are identical. */
529 * Function: compare_selectors (const void *, const void *)
531 * Comparison function for use with qsort. Arguments are symbols or
532 * msymbols Compares selector part of objc method name alphabetically.
536 compare_selectors (const void *a
, const void *b
)
538 const char *aname
, *bname
;
540 aname
= SYMBOL_PRINT_NAME (*(struct symbol
**) a
);
541 bname
= SYMBOL_PRINT_NAME (*(struct symbol
**) b
);
542 if (aname
== NULL
|| bname
== NULL
)
543 error (_("internal: compare_selectors(1)"));
545 aname
= strchr(aname
, ' ');
546 bname
= strchr(bname
, ' ');
547 if (aname
== NULL
|| bname
== NULL
)
548 error (_("internal: compare_selectors(2)"));
550 return specialcmp (aname
+1, bname
+1);
554 * Function: selectors_info (regexp, from_tty)
556 * Implements the "Info selectors" command. Takes an optional regexp
557 * arg. Lists all objective c selectors that match the regexp. Works
558 * by grepping thru all symbols for objective c methods. Output list
559 * is sorted and uniqued.
563 info_selectors_command (const char *regexp
, int from_tty
)
565 struct objfile
*objfile
;
566 struct minimal_symbol
*msymbol
;
574 struct symbol
**sym_arr
;
578 strcpy(myregexp
, ".*]"); /* Null input, match all objc methods. */
581 if (*regexp
== '+' || *regexp
== '-')
582 { /* User wants only class methods or only instance methods. */
583 plusminus
= *regexp
++;
584 while (*regexp
== ' ' || *regexp
== '\t')
588 strcpy(myregexp
, ".*]");
591 /* Allow a few extra bytes because of the strcat below. */
592 if (sizeof (myregexp
) < strlen (regexp
) + 4)
593 error (_("Regexp is too long: %s"), regexp
);
594 strcpy(myregexp
, regexp
);
595 if (myregexp
[strlen(myregexp
) - 1] == '$') /* end of selector */
596 myregexp
[strlen(myregexp
) - 1] = ']'; /* end of method name */
598 strcat(myregexp
, ".*]");
604 val
= re_comp (myregexp
);
606 error (_("Invalid regexp (%s): %s"), val
, regexp
);
609 /* First time thru is JUST to get max length and count. */
610 ALL_MSYMBOLS (objfile
, msymbol
)
613 name
= MSYMBOL_NATURAL_NAME (msymbol
);
615 && (name
[0] == '-' || name
[0] == '+')
616 && name
[1] == '[') /* Got a method name. */
618 /* Filter for class/instance methods. */
619 if (plusminus
&& name
[0] != plusminus
)
621 /* Find selector part. */
622 name
= (char *) strchr (name
+2, ' ');
625 complaint (_("Bad method name '%s'"),
626 MSYMBOL_NATURAL_NAME (msymbol
));
629 if (regexp
== NULL
|| re_exec(++name
) != 0)
631 const char *mystart
= name
;
632 const char *myend
= strchr (mystart
, ']');
634 if (myend
&& (myend
- mystart
> maxlen
))
635 maxlen
= myend
- mystart
; /* Get longest selector. */
642 printf_filtered (_("Selectors matching \"%s\":\n\n"),
643 regexp
? regexp
: "*");
645 sym_arr
= XALLOCAVEC (struct symbol
*, matches
);
647 ALL_MSYMBOLS (objfile
, msymbol
)
650 name
= MSYMBOL_NATURAL_NAME (msymbol
);
652 (name
[0] == '-' || name
[0] == '+') &&
653 name
[1] == '[') /* Got a method name. */
655 /* Filter for class/instance methods. */
656 if (plusminus
&& name
[0] != plusminus
)
658 /* Find selector part. */
659 name
= (char *) strchr(name
+2, ' ');
660 if (regexp
== NULL
|| re_exec(++name
) != 0)
661 sym_arr
[matches
++] = (struct symbol
*) msymbol
;
665 qsort (sym_arr
, matches
, sizeof (struct minimal_symbol
*),
667 /* Prevent compare on first iteration. */
669 for (ix
= 0; ix
< matches
; ix
++) /* Now do the output. */
674 name
= SYMBOL_NATURAL_NAME (sym_arr
[ix
]);
675 name
= strchr (name
, ' ') + 1;
676 if (p
[0] && specialcmp(name
, p
) == 0)
677 continue; /* Seen this one already (not unique). */
679 /* Copy selector part. */
680 while (*name
&& *name
!= ']')
683 /* Print in columns. */
684 puts_filtered_tabular(asel
, maxlen
+ 1, 0);
689 printf_filtered (_("No selectors matching \"%s\"\n"),
690 regexp
? regexp
: "*");
694 * Function: compare_classes (const void *, const void *)
696 * Comparison function for use with qsort. Arguments are symbols or
697 * msymbols Compares class part of objc method name alphabetically.
701 compare_classes (const void *a
, const void *b
)
703 const char *aname
, *bname
;
705 aname
= SYMBOL_PRINT_NAME (*(struct symbol
**) a
);
706 bname
= SYMBOL_PRINT_NAME (*(struct symbol
**) b
);
707 if (aname
== NULL
|| bname
== NULL
)
708 error (_("internal: compare_classes(1)"));
710 return specialcmp (aname
+1, bname
+1);
714 * Function: classes_info(regexp, from_tty)
716 * Implements the "info classes" command for objective c classes.
717 * Lists all objective c classes that match the optional regexp.
718 * Works by grepping thru the list of objective c methods. List will
719 * be sorted and uniqued (since one class may have many methods).
720 * BUGS: will not list a class that has no methods.
724 info_classes_command (const char *regexp
, int from_tty
)
726 struct objfile
*objfile
;
727 struct minimal_symbol
*msymbol
;
735 struct symbol
**sym_arr
;
738 strcpy(myregexp
, ".* "); /* Null input: match all objc classes. */
741 /* Allow a few extra bytes because of the strcat below. */
742 if (sizeof (myregexp
) < strlen (regexp
) + 4)
743 error (_("Regexp is too long: %s"), regexp
);
744 strcpy(myregexp
, regexp
);
745 if (myregexp
[strlen(myregexp
) - 1] == '$')
746 /* In the method name, the end of the class name is marked by ' '. */
747 myregexp
[strlen(myregexp
) - 1] = ' ';
749 strcat(myregexp
, ".* ");
754 val
= re_comp (myregexp
);
756 error (_("Invalid regexp (%s): %s"), val
, regexp
);
759 /* First time thru is JUST to get max length and count. */
760 ALL_MSYMBOLS (objfile
, msymbol
)
763 name
= MSYMBOL_NATURAL_NAME (msymbol
);
765 (name
[0] == '-' || name
[0] == '+') &&
766 name
[1] == '[') /* Got a method name. */
767 if (regexp
== NULL
|| re_exec(name
+2) != 0)
769 /* Compute length of classname part. */
770 const char *mystart
= name
+ 2;
771 const char *myend
= strchr (mystart
, ' ');
773 if (myend
&& (myend
- mystart
> maxlen
))
774 maxlen
= myend
- mystart
;
780 printf_filtered (_("Classes matching \"%s\":\n\n"),
781 regexp
? regexp
: "*");
782 sym_arr
= XALLOCAVEC (struct symbol
*, matches
);
784 ALL_MSYMBOLS (objfile
, msymbol
)
787 name
= MSYMBOL_NATURAL_NAME (msymbol
);
789 (name
[0] == '-' || name
[0] == '+') &&
790 name
[1] == '[') /* Got a method name. */
791 if (regexp
== NULL
|| re_exec(name
+2) != 0)
792 sym_arr
[matches
++] = (struct symbol
*) msymbol
;
795 qsort (sym_arr
, matches
, sizeof (struct minimal_symbol
*),
797 /* Prevent compare on first iteration. */
799 for (ix
= 0; ix
< matches
; ix
++) /* Now do the output. */
804 name
= SYMBOL_NATURAL_NAME (sym_arr
[ix
]);
806 if (p
[0] && specialcmp(name
, p
) == 0)
807 continue; /* Seen this one already (not unique). */
809 /* Copy class part of method name. */
810 while (*name
&& *name
!= ' ')
813 /* Print in columns. */
814 puts_filtered_tabular(aclass
, maxlen
+ 1, 0);
819 printf_filtered (_("No classes matching \"%s\"\n"), regexp
? regexp
: "*");
823 parse_selector (char *method
, char **selector
)
829 char *nselector
= NULL
;
831 gdb_assert (selector
!= NULL
);
835 s1
= skip_spaces (s1
);
841 s1
= skip_spaces (s1
);
848 if (isalnum (*s2
) || (*s2
== '_') || (*s2
== ':'))
850 else if (isspace (*s2
))
852 else if ((*s2
== '\0') || (*s2
== '\''))
860 s2
= skip_spaces (s2
);
865 s2
= skip_spaces (s2
);
868 if (selector
!= NULL
)
869 *selector
= nselector
;
875 parse_method (char *method
, char *type
, char **theclass
,
876 char **category
, char **selector
)
884 char *ncategory
= NULL
;
885 char *nselector
= NULL
;
887 gdb_assert (type
!= NULL
);
888 gdb_assert (theclass
!= NULL
);
889 gdb_assert (category
!= NULL
);
890 gdb_assert (selector
!= NULL
);
894 s1
= skip_spaces (s1
);
900 s1
= skip_spaces (s1
);
902 if ((s1
[0] == '+') || (s1
[0] == '-'))
905 s1
= skip_spaces (s1
);
912 while (isalnum (*s1
) || (*s1
== '_'))
916 s2
= skip_spaces (s2
);
921 s2
= skip_spaces (s2
);
923 while (isalnum (*s2
) || (*s2
== '_'))
928 /* Truncate the class name now that we're not using the open paren. */
936 if (isalnum (*s2
) || (*s2
== '_') || (*s2
== ':'))
938 else if (isspace (*s2
))
949 s2
= skip_spaces (s2
);
955 s2
= skip_spaces (s2
);
960 if (theclass
!= NULL
)
962 if (category
!= NULL
)
963 *category
= ncategory
;
964 if (selector
!= NULL
)
965 *selector
= nselector
;
971 find_methods (char type
, const char *theclass
, const char *category
,
972 const char *selector
,
973 std::vector
<const char *> *symbol_names
)
975 const char *symname
= NULL
;
979 char *ncategory
= NULL
;
980 char *nselector
= NULL
;
982 static char *tmp
= NULL
;
983 static unsigned int tmplen
= 0;
985 gdb_assert (symbol_names
!= NULL
);
987 for (objfile
*objfile
: all_objfiles (current_program_space
))
989 unsigned int *objc_csym
;
990 struct minimal_symbol
*msymbol
= NULL
;
992 /* The objfile_csym variable counts the number of ObjC methods
993 that this objfile defines. We save that count as a private
994 objfile data. If we have already determined that this objfile
995 provides no ObjC methods, we can skip it entirely. */
997 unsigned int objfile_csym
= 0;
999 objc_csym
= (unsigned int *) objfile_data (objfile
, objc_objfile_data
);
1000 if (objc_csym
!= NULL
&& *objc_csym
== 0)
1001 /* There are no ObjC symbols in this objfile. Skip it entirely. */
1004 ALL_OBJFILE_MSYMBOLS (objfile
, msymbol
)
1008 /* Check the symbol name first as this can be done entirely without
1009 sending any query to the target. */
1010 symname
= MSYMBOL_NATURAL_NAME (msymbol
);
1011 if (symname
== NULL
)
1014 if ((symname
[0] != '-' && symname
[0] != '+') || (symname
[1] != '['))
1015 /* Not a method name. */
1020 /* Now that thinks are a bit sane, clean up the symname. */
1021 while ((strlen (symname
) + 1) >= tmplen
)
1023 tmplen
= (tmplen
== 0) ? 1024 : tmplen
* 2;
1024 tmp
= (char *) xrealloc (tmp
, tmplen
);
1026 strcpy (tmp
, symname
);
1028 if (parse_method (tmp
, &ntype
, &nclass
,
1029 &ncategory
, &nselector
) == NULL
)
1032 if ((type
!= '\0') && (ntype
!= type
))
1035 if ((theclass
!= NULL
)
1036 && ((nclass
== NULL
) || (strcmp (theclass
, nclass
) != 0)))
1039 if ((category
!= NULL
) &&
1040 ((ncategory
== NULL
) || (strcmp (category
, ncategory
) != 0)))
1043 if ((selector
!= NULL
) &&
1044 ((nselector
== NULL
) || (strcmp (selector
, nselector
) != 0)))
1047 symbol_names
->push_back (symname
);
1050 if (objc_csym
== NULL
)
1052 objc_csym
= XOBNEW (&objfile
->objfile_obstack
, unsigned int);
1053 *objc_csym
= objfile_csym
;
1054 set_objfile_data (objfile
, objc_objfile_data
, objc_csym
);
1057 /* Count of ObjC methods in this objfile should be constant. */
1058 gdb_assert (*objc_csym
== objfile_csym
);
1062 /* Uniquify a VEC of strings. */
1065 uniquify_strings (std::vector
<const char *> *strings
)
1067 if (strings
->empty ())
1070 std::sort (strings
->begin (), strings
->end (), compare_cstrings
);
1071 strings
->erase (std::unique (strings
->begin (), strings
->end (), streq
),
1076 * Function: find_imps (const char *selector, struct symbol **sym_arr)
1078 * Input: a string representing a selector
1079 * a pointer to an array of symbol pointers
1080 * possibly a pointer to a symbol found by the caller.
1082 * Output: number of methods that implement that selector. Side
1083 * effects: The array of symbol pointers is filled with matching syms.
1085 * By analogy with function "find_methods" (symtab.c), builds a list
1086 * of symbols matching the ambiguous input, so that "decode_line_2"
1087 * (symtab.c) can list them and ask the user to choose one or more.
1088 * In this case the matches are objective c methods
1089 * ("implementations") matching an objective c selector.
1091 * Note that it is possible for a normal (c-style) function to have
1092 * the same name as an objective c selector. To prevent the selector
1093 * from eclipsing the function, we allow the caller (decode_line_1) to
1094 * search for such a function first, and if it finds one, pass it in
1095 * to us. We will then integrate it into the list. We also search
1096 * for one here, among the minsyms.
1098 * NOTE: if NUM_DEBUGGABLE is non-zero, the sym_arr will be divided
1099 * into two parts: debuggable (struct symbol) syms, and
1100 * non_debuggable (struct minimal_symbol) syms. The debuggable
1101 * ones will come first, before NUM_DEBUGGABLE (which will thus
1102 * be the index of the first non-debuggable one).
1106 find_imps (const char *method
, std::vector
<const char *> *symbol_names
)
1109 char *theclass
= NULL
;
1110 char *category
= NULL
;
1111 char *selector
= NULL
;
1116 int selector_case
= 0;
1118 gdb_assert (symbol_names
!= NULL
);
1120 buf
= (char *) alloca (strlen (method
) + 1);
1121 strcpy (buf
, method
);
1122 tmp
= parse_method (buf
, &type
, &theclass
, &category
, &selector
);
1126 strcpy (buf
, method
);
1127 tmp
= parse_selector (buf
, &selector
);
1135 find_methods (type
, theclass
, category
, selector
, symbol_names
);
1137 /* If we hit the "selector" case, and we found some methods, then
1138 add the selector itself as a symbol, if it exists. */
1139 if (selector_case
&& !symbol_names
->empty ())
1141 struct symbol
*sym
= lookup_symbol (selector
, NULL
, VAR_DOMAIN
,
1145 symbol_names
->push_back (SYMBOL_NATURAL_NAME (sym
));
1148 struct bound_minimal_symbol msym
1149 = lookup_minimal_symbol (selector
, 0, 0);
1151 if (msym
.minsym
!= NULL
)
1152 symbol_names
->push_back (MSYMBOL_NATURAL_NAME (msym
.minsym
));
1156 uniquify_strings (symbol_names
);
1158 return method
+ (tmp
- buf
);
1162 print_object_command (const char *args
, int from_tty
)
1164 struct value
*object
, *function
, *description
;
1165 CORE_ADDR string_addr
, object_addr
;
1169 if (!args
|| !*args
)
1171 "The 'print-object' command requires an argument (an Objective-C object)");
1174 expression_up expr
= parse_expression (args
);
1177 object
= evaluate_subexp (builtin_type (expr
->gdbarch
)->builtin_data_ptr
,
1178 expr
.get (), &pc
, EVAL_NORMAL
);
1181 /* Validate the address for sanity. */
1182 object_addr
= value_as_long (object
);
1183 read_memory (object_addr
, &c
, 1);
1185 function
= find_function_in_inferior ("_NSPrintForDebugger", NULL
);
1186 if (function
== NULL
)
1187 error (_("Unable to locate _NSPrintForDebugger in child process"));
1189 description
= call_function_by_hand (function
, NULL
, object
);
1191 string_addr
= value_as_long (description
);
1192 if (string_addr
== 0)
1193 error (_("object returns null description"));
1195 read_memory (string_addr
+ i
++, &c
, 1);
1198 { /* Read and print characters up to EOS. */
1200 printf_filtered ("%c", c
);
1201 read_memory (string_addr
+ i
++, &c
, 1);
1204 printf_filtered(_("<object returns empty description>"));
1205 printf_filtered ("\n");
1208 /* The data structure 'methcalls' is used to detect method calls (thru
1209 * ObjC runtime lib functions objc_msgSend, objc_msgSendSuper, etc.),
1210 * and ultimately find the method being called.
1213 struct objc_methcall
{
1215 /* Return instance method to be called. */
1216 int (*stop_at
) (CORE_ADDR
, CORE_ADDR
*);
1217 /* Start of pc range corresponding to method invocation. */
1219 /* End of pc range corresponding to method invocation. */
1223 static int resolve_msgsend (CORE_ADDR pc
, CORE_ADDR
*new_pc
);
1224 static int resolve_msgsend_stret (CORE_ADDR pc
, CORE_ADDR
*new_pc
);
1225 static int resolve_msgsend_super (CORE_ADDR pc
, CORE_ADDR
*new_pc
);
1226 static int resolve_msgsend_super_stret (CORE_ADDR pc
, CORE_ADDR
*new_pc
);
1228 static struct objc_methcall methcalls
[] = {
1229 { "_objc_msgSend", resolve_msgsend
, 0, 0},
1230 { "_objc_msgSend_stret", resolve_msgsend_stret
, 0, 0},
1231 { "_objc_msgSendSuper", resolve_msgsend_super
, 0, 0},
1232 { "_objc_msgSendSuper_stret", resolve_msgsend_super_stret
, 0, 0},
1233 { "_objc_getClass", NULL
, 0, 0},
1234 { "_objc_getMetaClass", NULL
, 0, 0}
1237 #define nmethcalls (sizeof (methcalls) / sizeof (methcalls[0]))
1239 /* The following function, "find_objc_msgsend", fills in the data
1240 * structure "objc_msgs" by finding the addresses of each of the
1241 * (currently four) functions that it holds (of which objc_msgSend is
1242 * the first). This must be called each time symbols are loaded, in
1243 * case the functions have moved for some reason.
1247 find_objc_msgsend (void)
1251 for (i
= 0; i
< nmethcalls
; i
++)
1253 struct bound_minimal_symbol func
;
1255 /* Try both with and without underscore. */
1256 func
= lookup_bound_minimal_symbol (methcalls
[i
].name
);
1257 if ((func
.minsym
== NULL
) && (methcalls
[i
].name
[0] == '_'))
1259 func
= lookup_bound_minimal_symbol (methcalls
[i
].name
+ 1);
1261 if (func
.minsym
== NULL
)
1263 methcalls
[i
].begin
= 0;
1264 methcalls
[i
].end
= 0;
1268 methcalls
[i
].begin
= BMSYMBOL_VALUE_ADDRESS (func
);
1269 methcalls
[i
].end
= minimal_symbol_upper_bound (func
);
1273 /* find_objc_msgcall (replaces pc_off_limits)
1275 * ALL that this function now does is to determine whether the input
1276 * address ("pc") is the address of one of the Objective-C message
1277 * dispatch functions (mainly objc_msgSend or objc_msgSendSuper), and
1278 * if so, it returns the address of the method that will be called.
1280 * The old function "pc_off_limits" used to do a lot of other things
1281 * in addition, such as detecting shared library jump stubs and
1282 * returning the address of the shlib function that would be called.
1283 * That functionality has been moved into the gdbarch_skip_trampoline_code and
1284 * IN_SOLIB_TRAMPOLINE macros, which are resolved in the target-
1285 * dependent modules.
1289 find_objc_msgcall_submethod (int (*f
) (CORE_ADDR
, CORE_ADDR
*),
1295 if (f (pc
, new_pc
) == 0)
1298 CATCH (ex
, RETURN_MASK_ALL
)
1300 exception_fprintf (gdb_stderr
, ex
,
1301 "Unable to determine target of "
1302 "Objective-C method call (ignoring):\n");
1310 find_objc_msgcall (CORE_ADDR pc
, CORE_ADDR
*new_pc
)
1314 find_objc_msgsend ();
1320 for (i
= 0; i
< nmethcalls
; i
++)
1321 if ((pc
>= methcalls
[i
].begin
) && (pc
< methcalls
[i
].end
))
1323 if (methcalls
[i
].stop_at
!= NULL
)
1324 return find_objc_msgcall_submethod (methcalls
[i
].stop_at
,
1334 _initialize_objc_language (void)
1336 add_info ("selectors", info_selectors_command
,
1337 _("All Objective-C selectors, or those matching REGEXP."));
1338 add_info ("classes", info_classes_command
,
1339 _("All Objective-C classes, or those matching REGEXP."));
1340 add_com ("print-object", class_vars
, print_object_command
,
1341 _("Ask an Objective-C object to print itself."));
1342 add_com_alias ("po", "print-object", class_vars
, 1);
1346 read_objc_method (struct gdbarch
*gdbarch
, CORE_ADDR addr
,
1347 struct objc_method
*method
)
1349 enum bfd_endian byte_order
= gdbarch_byte_order (gdbarch
);
1351 method
->name
= read_memory_unsigned_integer (addr
+ 0, 4, byte_order
);
1352 method
->types
= read_memory_unsigned_integer (addr
+ 4, 4, byte_order
);
1353 method
->imp
= read_memory_unsigned_integer (addr
+ 8, 4, byte_order
);
1356 static unsigned long
1357 read_objc_methlist_nmethods (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
1359 enum bfd_endian byte_order
= gdbarch_byte_order (gdbarch
);
1361 return read_memory_unsigned_integer (addr
+ 4, 4, byte_order
);
1365 read_objc_methlist_method (struct gdbarch
*gdbarch
, CORE_ADDR addr
,
1366 unsigned long num
, struct objc_method
*method
)
1368 gdb_assert (num
< read_objc_methlist_nmethods (gdbarch
, addr
));
1369 read_objc_method (gdbarch
, addr
+ 8 + (12 * num
), method
);
1373 read_objc_object (struct gdbarch
*gdbarch
, CORE_ADDR addr
,
1374 struct objc_object
*object
)
1376 enum bfd_endian byte_order
= gdbarch_byte_order (gdbarch
);
1378 object
->isa
= read_memory_unsigned_integer (addr
, 4, byte_order
);
1382 read_objc_super (struct gdbarch
*gdbarch
, CORE_ADDR addr
,
1383 struct objc_super
*super
)
1385 enum bfd_endian byte_order
= gdbarch_byte_order (gdbarch
);
1387 super
->receiver
= read_memory_unsigned_integer (addr
, 4, byte_order
);
1388 super
->theclass
= read_memory_unsigned_integer (addr
+ 4, 4, byte_order
);
1392 read_objc_class (struct gdbarch
*gdbarch
, CORE_ADDR addr
,
1393 struct objc_class
*theclass
)
1395 enum bfd_endian byte_order
= gdbarch_byte_order (gdbarch
);
1397 theclass
->isa
= read_memory_unsigned_integer (addr
, 4, byte_order
);
1398 theclass
->super_class
= read_memory_unsigned_integer (addr
+ 4, 4, byte_order
);
1399 theclass
->name
= read_memory_unsigned_integer (addr
+ 8, 4, byte_order
);
1400 theclass
->version
= read_memory_unsigned_integer (addr
+ 12, 4, byte_order
);
1401 theclass
->info
= read_memory_unsigned_integer (addr
+ 16, 4, byte_order
);
1402 theclass
->instance_size
= read_memory_unsigned_integer (addr
+ 18, 4,
1404 theclass
->ivars
= read_memory_unsigned_integer (addr
+ 24, 4, byte_order
);
1405 theclass
->methods
= read_memory_unsigned_integer (addr
+ 28, 4, byte_order
);
1406 theclass
->cache
= read_memory_unsigned_integer (addr
+ 32, 4, byte_order
);
1407 theclass
->protocols
= read_memory_unsigned_integer (addr
+ 36, 4, byte_order
);
1411 find_implementation_from_class (struct gdbarch
*gdbarch
,
1412 CORE_ADDR theclass
, CORE_ADDR sel
)
1414 enum bfd_endian byte_order
= gdbarch_byte_order (gdbarch
);
1415 CORE_ADDR subclass
= theclass
;
1417 while (subclass
!= 0)
1420 struct objc_class class_str
;
1421 unsigned mlistnum
= 0;
1423 read_objc_class (gdbarch
, subclass
, &class_str
);
1428 unsigned long nmethods
;
1431 mlist
= read_memory_unsigned_integer (class_str
.methods
+
1437 nmethods
= read_objc_methlist_nmethods (gdbarch
, mlist
);
1439 for (i
= 0; i
< nmethods
; i
++)
1441 struct objc_method meth_str
;
1443 read_objc_methlist_method (gdbarch
, mlist
, i
, &meth_str
);
1445 if (meth_str
.name
== sel
)
1446 /* FIXME: hppa arch was doing a pointer dereference
1447 here. There needs to be a better way to do that. */
1448 return meth_str
.imp
;
1452 subclass
= class_str
.super_class
;
1459 find_implementation (struct gdbarch
*gdbarch
,
1460 CORE_ADDR object
, CORE_ADDR sel
)
1462 struct objc_object ostr
;
1466 read_objc_object (gdbarch
, object
, &ostr
);
1470 return find_implementation_from_class (gdbarch
, ostr
.isa
, sel
);
1474 resolve_msgsend (CORE_ADDR pc
, CORE_ADDR
*new_pc
)
1476 struct frame_info
*frame
= get_current_frame ();
1477 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
1478 struct type
*ptr_type
= builtin_type (gdbarch
)->builtin_func_ptr
;
1484 object
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 0, ptr_type
);
1485 sel
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 1, ptr_type
);
1487 res
= find_implementation (gdbarch
, object
, sel
);
1496 resolve_msgsend_stret (CORE_ADDR pc
, CORE_ADDR
*new_pc
)
1498 struct frame_info
*frame
= get_current_frame ();
1499 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
1500 struct type
*ptr_type
= builtin_type (gdbarch
)->builtin_func_ptr
;
1506 object
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 1, ptr_type
);
1507 sel
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 2, ptr_type
);
1509 res
= find_implementation (gdbarch
, object
, sel
);
1518 resolve_msgsend_super (CORE_ADDR pc
, CORE_ADDR
*new_pc
)
1520 struct frame_info
*frame
= get_current_frame ();
1521 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
1522 struct type
*ptr_type
= builtin_type (gdbarch
)->builtin_func_ptr
;
1524 struct objc_super sstr
;
1530 super
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 0, ptr_type
);
1531 sel
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 1, ptr_type
);
1533 read_objc_super (gdbarch
, super
, &sstr
);
1534 if (sstr
.theclass
== 0)
1537 res
= find_implementation_from_class (gdbarch
, sstr
.theclass
, sel
);
1546 resolve_msgsend_super_stret (CORE_ADDR pc
, CORE_ADDR
*new_pc
)
1548 struct frame_info
*frame
= get_current_frame ();
1549 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
1550 struct type
*ptr_type
= builtin_type (gdbarch
)->builtin_func_ptr
;
1552 struct objc_super sstr
;
1558 super
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 1, ptr_type
);
1559 sel
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 2, ptr_type
);
1561 read_objc_super (gdbarch
, super
, &sstr
);
1562 if (sstr
.theclass
== 0)
1565 res
= find_implementation_from_class (gdbarch
, sstr
.theclass
, sel
);
1574 _initialize_objc_lang (void)
1576 objc_objfile_data
= register_objfile_data ();