1 /* Objective-C language support routines for GDB, the GNU debugger.
3 Copyright (C) 2002, 2003, 2004, 2005, 2007, 2008, 2009, 2010
4 Free Software Foundation, Inc.
6 Contributed by Apple Computer, Inc.
7 Written by Michael Snyder.
9 This file is part of GDB.
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 3 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program. If not, see <http://www.gnu.org/licenses/>. */
27 #include "expression.h"
28 #include "parser-defs.h"
31 #include "objc-lang.h"
32 #include "exceptions.h"
33 #include "complaints.h"
37 #include "gdb_string.h" /* for strchr */
38 #include "target.h" /* for target_has_execution */
42 #include "gdb_regex.h"
47 #include "gdb_assert.h"
57 CORE_ADDR super_class
;
79 static const struct objfile_data
*objc_objfile_data
;
81 /* Lookup a structure type named "struct NAME", visible in lexical
82 block BLOCK. If NOERR is nonzero, return zero if NAME is not
86 lookup_struct_typedef (char *name
, struct block
*block
, int noerr
)
90 sym
= lookup_symbol (name
, block
, STRUCT_DOMAIN
, 0);
97 error (_("No struct type named %s."), name
);
99 if (TYPE_CODE (SYMBOL_TYPE (sym
)) != TYPE_CODE_STRUCT
)
104 error (_("This context has class, union or enum %s, not a struct."),
111 lookup_objc_class (struct gdbarch
*gdbarch
, char *classname
)
113 struct type
*char_type
= builtin_type (gdbarch
)->builtin_char
;
114 struct value
* function
, *classval
;
116 if (! target_has_execution
)
118 /* Can't call into inferior to lookup class. */
122 if (lookup_minimal_symbol("objc_lookUpClass", 0, 0))
123 function
= find_function_in_inferior("objc_lookUpClass", NULL
);
124 else if (lookup_minimal_symbol ("objc_lookup_class", 0, 0))
125 function
= find_function_in_inferior("objc_lookup_class", NULL
);
128 complaint (&symfile_complaints
, _("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))
151 function
= find_function_in_inferior("sel_getUid", NULL
);
152 else if (lookup_minimal_symbol ("sel_get_any_uid", 0, 0))
153 function
= find_function_in_inferior("sel_get_any_uid", NULL
);
156 complaint (&symfile_complaints
, _("no way to lookup Objective-C selectors"));
160 selstring
= value_coerce_array (value_string (selname
,
161 strlen (selname
) + 1, char_type
));
162 return value_as_long (call_function_by_hand (function
, 1, &selstring
));
166 value_nsstring (struct gdbarch
*gdbarch
, char *ptr
, int len
)
168 struct type
*char_type
= builtin_type (gdbarch
)->builtin_char
;
169 struct value
*stringValue
[3];
170 struct value
*function
, *nsstringValue
;
174 if (!target_has_execution
)
175 return 0; /* Can't call into inferior to create NSString. */
177 stringValue
[2] = value_string(ptr
, len
, char_type
);
178 stringValue
[2] = value_coerce_array(stringValue
[2]);
179 /* _NSNewStringFromCString replaces "istr" after Lantern2A. */
180 if (lookup_minimal_symbol("_NSNewStringFromCString", 0, 0))
182 function
= find_function_in_inferior("_NSNewStringFromCString", NULL
);
183 nsstringValue
= call_function_by_hand(function
, 1, &stringValue
[2]);
185 else if (lookup_minimal_symbol("istr", 0, 0))
187 function
= find_function_in_inferior("istr", NULL
);
188 nsstringValue
= call_function_by_hand(function
, 1, &stringValue
[2]);
190 else if (lookup_minimal_symbol("+[NSString stringWithCString:]", 0, 0))
193 = find_function_in_inferior("+[NSString stringWithCString:]", NULL
);
194 type
= builtin_type (gdbarch
)->builtin_long
;
196 stringValue
[0] = value_from_longest
197 (type
, lookup_objc_class (gdbarch
, "NSString"));
198 stringValue
[1] = value_from_longest
199 (type
, lookup_child_selector (gdbarch
, "stringWithCString:"));
200 nsstringValue
= call_function_by_hand(function
, 3, &stringValue
[0]);
203 error (_("NSString: internal error -- no way to create new NSString"));
205 sym
= lookup_struct_typedef("NSString", 0, 1);
207 sym
= lookup_struct_typedef("NXString", 0, 1);
209 type
= builtin_type (gdbarch
)->builtin_data_ptr
;
211 type
= lookup_pointer_type(SYMBOL_TYPE (sym
));
213 deprecated_set_value_type (nsstringValue
, type
);
214 return nsstringValue
;
217 /* Objective-C name demangling. */
220 objc_demangle (const char *mangled
, int options
)
222 char *demangled
, *cp
;
224 if (mangled
[0] == '_' &&
225 (mangled
[1] == 'i' || mangled
[1] == 'c') &&
228 cp
= demangled
= xmalloc(strlen(mangled
) + 2);
230 if (mangled
[1] == 'i')
231 *cp
++ = '-'; /* for instance method */
233 *cp
++ = '+'; /* for class method */
235 *cp
++ = '['; /* opening left brace */
236 strcpy(cp
, mangled
+3); /* tack on the rest of the mangled name */
238 while (*cp
&& *cp
== '_')
239 cp
++; /* skip any initial underbars in class name */
241 cp
= strchr(cp
, '_');
242 if (!cp
) /* find first non-initial underbar */
244 xfree(demangled
); /* not mangled name */
247 if (cp
[1] == '_') /* easy case: no category name */
249 *cp
++ = ' '; /* replace two '_' with one ' ' */
250 strcpy(cp
, mangled
+ (cp
- demangled
) + 2);
254 *cp
++ = '('; /* less easy case: category name */
255 cp
= strchr(cp
, '_');
258 xfree(demangled
); /* not mangled name */
262 *cp
++ = ' '; /* overwriting 1st char of method name... */
263 strcpy(cp
, mangled
+ (cp
- demangled
)); /* get it back */
266 while (*cp
&& *cp
== '_')
267 cp
++; /* skip any initial underbars in method name */
271 *cp
= ':'; /* replace remaining '_' with ':' */
273 *cp
++ = ']'; /* closing right brace */
274 *cp
++ = 0; /* string terminator */
278 return NULL
; /* Not an objc mangled name. */
281 /* Print the character C on STREAM as part of the contents of a
282 literal string whose delimiter is QUOTER. Note that that format
283 for printing characters and strings is language specific. */
286 objc_emit_char (int c
, struct type
*type
, struct ui_file
*stream
, int quoter
)
288 c
&= 0xFF; /* Avoid sign bit follies. */
290 if (PRINT_LITERAL_FORM (c
))
292 if (c
== '\\' || c
== quoter
)
294 fputs_filtered ("\\", stream
);
296 fprintf_filtered (stream
, "%c", c
);
303 fputs_filtered ("\\n", stream
);
306 fputs_filtered ("\\b", stream
);
309 fputs_filtered ("\\t", stream
);
312 fputs_filtered ("\\f", stream
);
315 fputs_filtered ("\\r", stream
);
318 fputs_filtered ("\\e", stream
);
321 fputs_filtered ("\\a", stream
);
324 fprintf_filtered (stream
, "\\%.3o", (unsigned int) c
);
331 objc_printchar (int c
, struct type
*type
, struct ui_file
*stream
)
333 fputs_filtered ("'", stream
);
334 objc_emit_char (c
, type
, stream
, '\'');
335 fputs_filtered ("'", stream
);
338 /* Print the character string STRING, printing at most LENGTH
339 characters. Printing stops early if the number hits print_max;
340 repeat counts are printed as appropriate. Print ellipses at the
341 end if we had to stop before printing LENGTH characters, or if
345 objc_printstr (struct ui_file
*stream
, struct type
*type
,
346 const gdb_byte
*string
, unsigned int length
,
347 const char *encoding
, int force_ellipses
,
348 const struct value_print_options
*options
)
351 unsigned int things_printed
= 0;
355 /* If the string was not truncated due to `set print elements', and
356 the last byte of it is a null, we don't print that, in
357 traditional C style. */
358 if ((!force_ellipses
) && length
> 0 && string
[length
-1] == '\0')
363 fputs_filtered ("\"\"", stream
);
367 for (i
= 0; i
< length
&& things_printed
< options
->print_max
; ++i
)
369 /* Position of the character we are examining to see whether it
372 /* Number of repetitions we have detected so far. */
379 fputs_filtered (", ", stream
);
385 while (rep1
< length
&& string
[rep1
] == string
[i
])
391 if (reps
> options
->repeat_count_threshold
)
395 if (options
->inspect_it
)
396 fputs_filtered ("\\\", ", stream
);
398 fputs_filtered ("\", ", stream
);
401 objc_printchar (string
[i
], type
, stream
);
402 fprintf_filtered (stream
, " <repeats %u times>", reps
);
404 things_printed
+= options
->repeat_count_threshold
;
411 if (options
->inspect_it
)
412 fputs_filtered ("\\\"", stream
);
414 fputs_filtered ("\"", stream
);
417 objc_emit_char (string
[i
], type
, stream
, '"');
422 /* Terminate the quotes if necessary. */
425 if (options
->inspect_it
)
426 fputs_filtered ("\\\"", stream
);
428 fputs_filtered ("\"", stream
);
431 if (force_ellipses
|| i
< length
)
432 fputs_filtered ("...", stream
);
435 /* Determine if we are currently in the Objective-C dispatch function.
436 If so, get the address of the method function that the dispatcher
437 would call and use that as the function to step into instead. Also
438 skip over the trampoline for the function (if any). This is better
439 for the user since they are only interested in stepping into the
440 method function anyway. */
442 objc_skip_trampoline (struct frame_info
*frame
, CORE_ADDR stop_pc
)
444 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
445 CORE_ADDR real_stop_pc
;
446 CORE_ADDR method_stop_pc
;
448 real_stop_pc
= gdbarch_skip_trampoline_code (gdbarch
, frame
, stop_pc
);
450 if (real_stop_pc
!= 0)
451 find_objc_msgcall (real_stop_pc
, &method_stop_pc
);
453 find_objc_msgcall (stop_pc
, &method_stop_pc
);
457 real_stop_pc
= gdbarch_skip_trampoline_code
458 (gdbarch
, frame
, method_stop_pc
);
459 if (real_stop_pc
== 0)
460 real_stop_pc
= method_stop_pc
;
467 /* Table mapping opcodes into strings for printing operators
468 and precedences of the operators. */
470 static const struct op_print objc_op_print_tab
[] =
472 {",", BINOP_COMMA
, PREC_COMMA
, 0},
473 {"=", BINOP_ASSIGN
, PREC_ASSIGN
, 1},
474 {"||", BINOP_LOGICAL_OR
, PREC_LOGICAL_OR
, 0},
475 {"&&", BINOP_LOGICAL_AND
, PREC_LOGICAL_AND
, 0},
476 {"|", BINOP_BITWISE_IOR
, PREC_BITWISE_IOR
, 0},
477 {"^", BINOP_BITWISE_XOR
, PREC_BITWISE_XOR
, 0},
478 {"&", BINOP_BITWISE_AND
, PREC_BITWISE_AND
, 0},
479 {"==", BINOP_EQUAL
, PREC_EQUAL
, 0},
480 {"!=", BINOP_NOTEQUAL
, PREC_EQUAL
, 0},
481 {"<=", BINOP_LEQ
, PREC_ORDER
, 0},
482 {">=", BINOP_GEQ
, PREC_ORDER
, 0},
483 {">", BINOP_GTR
, PREC_ORDER
, 0},
484 {"<", BINOP_LESS
, PREC_ORDER
, 0},
485 {">>", BINOP_RSH
, PREC_SHIFT
, 0},
486 {"<<", BINOP_LSH
, PREC_SHIFT
, 0},
487 {"+", BINOP_ADD
, PREC_ADD
, 0},
488 {"-", BINOP_SUB
, PREC_ADD
, 0},
489 {"*", BINOP_MUL
, PREC_MUL
, 0},
490 {"/", BINOP_DIV
, PREC_MUL
, 0},
491 {"%", BINOP_REM
, PREC_MUL
, 0},
492 {"@", BINOP_REPEAT
, PREC_REPEAT
, 0},
493 {"-", UNOP_NEG
, PREC_PREFIX
, 0},
494 {"!", UNOP_LOGICAL_NOT
, PREC_PREFIX
, 0},
495 {"~", UNOP_COMPLEMENT
, PREC_PREFIX
, 0},
496 {"*", UNOP_IND
, PREC_PREFIX
, 0},
497 {"&", UNOP_ADDR
, PREC_PREFIX
, 0},
498 {"sizeof ", UNOP_SIZEOF
, PREC_PREFIX
, 0},
499 {"++", UNOP_PREINCREMENT
, PREC_PREFIX
, 0},
500 {"--", UNOP_PREDECREMENT
, PREC_PREFIX
, 0},
501 {NULL
, OP_NULL
, PREC_NULL
, 0}
504 const struct language_defn objc_language_defn
= {
505 "objective-c", /* Language name */
512 &exp_descriptor_standard
,
516 objc_printchar
, /* Print a character constant */
517 objc_printstr
, /* Function to print string constant */
519 c_print_type
, /* Print a type using appropriate syntax */
520 c_print_typedef
, /* Print a typedef using appropriate syntax */
521 c_val_print
, /* Print a value using appropriate syntax */
522 c_value_print
, /* Print a top-level value */
523 objc_skip_trampoline
, /* Language specific skip_trampoline */
524 "self", /* name_of_this */
525 basic_lookup_symbol_nonlocal
, /* lookup_symbol_nonlocal */
526 basic_lookup_transparent_type
,/* lookup_transparent_type */
527 objc_demangle
, /* Language specific symbol demangler */
528 NULL
, /* Language specific class_name_from_physname */
529 objc_op_print_tab
, /* Expression operators for printing */
530 1, /* C-style arrays */
531 0, /* String lower bound */
532 default_word_break_characters
,
533 default_make_symbol_completion_list
,
534 c_language_arch_info
,
535 default_print_array_index
,
536 default_pass_by_reference
,
543 * Following functions help construct Objective-C message calls
546 struct selname
/* For parsing Objective-C. */
548 struct selname
*next
;
553 static int msglist_len
;
554 static struct selname
*selname_chain
;
555 static char *msglist_sel
;
560 struct selname
*new =
561 (struct selname
*) xmalloc (sizeof (struct selname
));
563 new->next
= selname_chain
;
564 new->msglist_len
= msglist_len
;
565 new->msglist_sel
= msglist_sel
;
567 msglist_sel
= (char *)xmalloc(1);
573 add_msglist(struct stoken
*str
, int addcolon
)
578 if (str
== 0) /* Unnamed arg, or... */
580 if (addcolon
== 0) /* variable number of args. */
593 len
= plen
+ strlen(msglist_sel
) + 2;
594 s
= (char *)xmalloc(len
);
595 strcpy(s
, msglist_sel
);
612 int val
= msglist_len
;
613 struct selname
*sel
= selname_chain
;
614 char *p
= msglist_sel
;
617 selname_chain
= sel
->next
;
618 msglist_len
= sel
->msglist_len
;
619 msglist_sel
= sel
->msglist_sel
;
620 selid
= lookup_child_selector (parse_gdbarch
, p
);
622 error (_("Can't find selector \"%s\""), p
);
623 write_exp_elt_longcst (selid
);
625 write_exp_elt_longcst (val
); /* Number of args */
632 * Function: specialcmp (char *a, char *b)
634 * Special strcmp: treats ']' and ' ' as end-of-string.
635 * Used for qsorting lists of objc methods (either by class or selector).
639 specialcmp (char *a
, char *b
)
641 while (*a
&& *a
!= ' ' && *a
!= ']' && *b
&& *b
!= ' ' && *b
!= ']')
647 if (*a
&& *a
!= ' ' && *a
!= ']')
648 return 1; /* a is longer therefore greater */
649 if (*b
&& *b
!= ' ' && *b
!= ']')
650 return -1; /* a is shorter therefore lesser */
651 return 0; /* a and b are identical */
655 * Function: compare_selectors (const void *, const void *)
657 * Comparison function for use with qsort. Arguments are symbols or
658 * msymbols Compares selector part of objc method name alphabetically.
662 compare_selectors (const void *a
, const void *b
)
666 aname
= SYMBOL_PRINT_NAME (*(struct symbol
**) a
);
667 bname
= SYMBOL_PRINT_NAME (*(struct symbol
**) b
);
668 if (aname
== NULL
|| bname
== NULL
)
669 error (_("internal: compare_selectors(1)"));
671 aname
= strchr(aname
, ' ');
672 bname
= strchr(bname
, ' ');
673 if (aname
== NULL
|| bname
== NULL
)
674 error (_("internal: compare_selectors(2)"));
676 return specialcmp (aname
+1, bname
+1);
680 * Function: selectors_info (regexp, from_tty)
682 * Implements the "Info selectors" command. Takes an optional regexp
683 * arg. Lists all objective c selectors that match the regexp. Works
684 * by grepping thru all symbols for objective c methods. Output list
685 * is sorted and uniqued.
689 selectors_info (char *regexp
, int from_tty
)
691 struct objfile
*objfile
;
692 struct minimal_symbol
*msymbol
;
700 struct symbol
**sym_arr
;
704 strcpy(myregexp
, ".*]"); /* Null input, match all objc methods. */
707 if (*regexp
== '+' || *regexp
== '-')
708 { /* User wants only class methods or only instance methods. */
709 plusminus
= *regexp
++;
710 while (*regexp
== ' ' || *regexp
== '\t')
714 strcpy(myregexp
, ".*]");
717 strcpy(myregexp
, regexp
);
718 if (myregexp
[strlen(myregexp
) - 1] == '$') /* end of selector */
719 myregexp
[strlen(myregexp
) - 1] = ']'; /* end of method name */
721 strcat(myregexp
, ".*]");
727 val
= re_comp (myregexp
);
729 error (_("Invalid regexp (%s): %s"), val
, regexp
);
732 /* First time thru is JUST to get max length and count. */
733 ALL_MSYMBOLS (objfile
, msymbol
)
736 name
= SYMBOL_NATURAL_NAME (msymbol
);
738 (name
[0] == '-' || name
[0] == '+') &&
739 name
[1] == '[') /* Got a method name. */
741 /* Filter for class/instance methods. */
742 if (plusminus
&& name
[0] != plusminus
)
744 /* Find selector part. */
745 name
= (char *) strchr(name
+2, ' ');
746 if (regexp
== NULL
|| re_exec(++name
) != 0)
748 char *mystart
= name
;
749 char *myend
= (char *) strchr(mystart
, ']');
751 if (myend
&& (myend
- mystart
> maxlen
))
752 maxlen
= myend
- mystart
; /* Get longest selector. */
759 printf_filtered (_("Selectors matching \"%s\":\n\n"),
760 regexp
? regexp
: "*");
762 sym_arr
= alloca (matches
* sizeof (struct symbol
*));
764 ALL_MSYMBOLS (objfile
, msymbol
)
767 name
= SYMBOL_NATURAL_NAME (msymbol
);
769 (name
[0] == '-' || name
[0] == '+') &&
770 name
[1] == '[') /* Got a method name. */
772 /* Filter for class/instance methods. */
773 if (plusminus
&& name
[0] != plusminus
)
775 /* Find selector part. */
776 name
= (char *) strchr(name
+2, ' ');
777 if (regexp
== NULL
|| re_exec(++name
) != 0)
778 sym_arr
[matches
++] = (struct symbol
*) msymbol
;
782 qsort (sym_arr
, matches
, sizeof (struct minimal_symbol
*),
784 /* Prevent compare on first iteration. */
786 for (ix
= 0; ix
< matches
; ix
++) /* Now do the output. */
791 name
= SYMBOL_NATURAL_NAME (sym_arr
[ix
]);
792 name
= strchr (name
, ' ') + 1;
793 if (p
[0] && specialcmp(name
, p
) == 0)
794 continue; /* Seen this one already (not unique). */
796 /* Copy selector part. */
797 while (*name
&& *name
!= ']')
800 /* Print in columns. */
801 puts_filtered_tabular(asel
, maxlen
+ 1, 0);
806 printf_filtered (_("No selectors matching \"%s\"\n"), regexp
? regexp
: "*");
810 * Function: compare_classes (const void *, const void *)
812 * Comparison function for use with qsort. Arguments are symbols or
813 * msymbols Compares class part of objc method name alphabetically.
817 compare_classes (const void *a
, const void *b
)
821 aname
= SYMBOL_PRINT_NAME (*(struct symbol
**) a
);
822 bname
= SYMBOL_PRINT_NAME (*(struct symbol
**) b
);
823 if (aname
== NULL
|| bname
== NULL
)
824 error (_("internal: compare_classes(1)"));
826 return specialcmp (aname
+1, bname
+1);
830 * Function: classes_info(regexp, from_tty)
832 * Implements the "info classes" command for objective c classes.
833 * Lists all objective c classes that match the optional regexp.
834 * Works by grepping thru the list of objective c methods. List will
835 * be sorted and uniqued (since one class may have many methods).
836 * BUGS: will not list a class that has no methods.
840 classes_info (char *regexp
, int from_tty
)
842 struct objfile
*objfile
;
843 struct minimal_symbol
*msymbol
;
851 struct symbol
**sym_arr
;
854 strcpy(myregexp
, ".* "); /* Null input: match all objc classes. */
857 strcpy(myregexp
, regexp
);
858 if (myregexp
[strlen(myregexp
) - 1] == '$')
859 /* In the method name, the end of the class name is marked by ' '. */
860 myregexp
[strlen(myregexp
) - 1] = ' ';
862 strcat(myregexp
, ".* ");
867 val
= re_comp (myregexp
);
869 error (_("Invalid regexp (%s): %s"), val
, regexp
);
872 /* First time thru is JUST to get max length and count. */
873 ALL_MSYMBOLS (objfile
, msymbol
)
876 name
= SYMBOL_NATURAL_NAME (msymbol
);
878 (name
[0] == '-' || name
[0] == '+') &&
879 name
[1] == '[') /* Got a method name. */
880 if (regexp
== NULL
|| re_exec(name
+2) != 0)
882 /* Compute length of classname part. */
883 char *mystart
= name
+ 2;
884 char *myend
= (char *) strchr(mystart
, ' ');
886 if (myend
&& (myend
- mystart
> maxlen
))
887 maxlen
= myend
- mystart
;
893 printf_filtered (_("Classes matching \"%s\":\n\n"),
894 regexp
? regexp
: "*");
895 sym_arr
= alloca (matches
* sizeof (struct symbol
*));
897 ALL_MSYMBOLS (objfile
, msymbol
)
900 name
= SYMBOL_NATURAL_NAME (msymbol
);
902 (name
[0] == '-' || name
[0] == '+') &&
903 name
[1] == '[') /* Got a method name. */
904 if (regexp
== NULL
|| re_exec(name
+2) != 0)
905 sym_arr
[matches
++] = (struct symbol
*) msymbol
;
908 qsort (sym_arr
, matches
, sizeof (struct minimal_symbol
*),
910 /* Prevent compare on first iteration. */
912 for (ix
= 0; ix
< matches
; ix
++) /* Now do the output. */
917 name
= SYMBOL_NATURAL_NAME (sym_arr
[ix
]);
919 if (p
[0] && specialcmp(name
, p
) == 0)
920 continue; /* Seen this one already (not unique). */
922 /* Copy class part of method name. */
923 while (*name
&& *name
!= ' ')
926 /* Print in columns. */
927 puts_filtered_tabular(aclass
, maxlen
+ 1, 0);
932 printf_filtered (_("No classes matching \"%s\"\n"), regexp
? regexp
: "*");
936 * Function: find_imps (char *selector, struct symbol **sym_arr)
938 * Input: a string representing a selector
939 * a pointer to an array of symbol pointers
940 * possibly a pointer to a symbol found by the caller.
942 * Output: number of methods that implement that selector. Side
943 * effects: The array of symbol pointers is filled with matching syms.
945 * By analogy with function "find_methods" (symtab.c), builds a list
946 * of symbols matching the ambiguous input, so that "decode_line_2"
947 * (symtab.c) can list them and ask the user to choose one or more.
948 * In this case the matches are objective c methods
949 * ("implementations") matching an objective c selector.
951 * Note that it is possible for a normal (c-style) function to have
952 * the same name as an objective c selector. To prevent the selector
953 * from eclipsing the function, we allow the caller (decode_line_1) to
954 * search for such a function first, and if it finds one, pass it in
955 * to us. We will then integrate it into the list. We also search
956 * for one here, among the minsyms.
958 * NOTE: if NUM_DEBUGGABLE is non-zero, the sym_arr will be divided
959 * into two parts: debuggable (struct symbol) syms, and
960 * non_debuggable (struct minimal_symbol) syms. The debuggable
961 * ones will come first, before NUM_DEBUGGABLE (which will thus
962 * be the index of the first non-debuggable one).
966 * Function: total_number_of_imps (char *selector);
968 * Input: a string representing a selector
969 * Output: number of methods that implement that selector.
971 * By analogy with function "total_number_of_methods", this allows
972 * decode_line_1 (symtab.c) to detect if there are objective c methods
973 * matching the input, and to allocate an array of pointers to them
974 * which can be manipulated by "decode_line_2" (also in symtab.c).
978 parse_selector (char *method
, char **selector
)
984 char *nselector
= NULL
;
986 gdb_assert (selector
!= NULL
);
990 while (isspace (*s1
))
997 while (isspace (*s1
))
1005 if (isalnum (*s2
) || (*s2
== '_') || (*s2
== ':'))
1007 else if (isspace (*s2
))
1009 else if ((*s2
== '\0') || (*s2
== '\''))
1017 while (isspace (*s2
))
1023 while (isspace (*s2
))
1027 if (selector
!= NULL
)
1028 *selector
= nselector
;
1034 parse_method (char *method
, char *type
, char **class,
1035 char **category
, char **selector
)
1039 int found_quote
= 0;
1042 char *nclass
= NULL
;
1043 char *ncategory
= NULL
;
1044 char *nselector
= NULL
;
1046 gdb_assert (type
!= NULL
);
1047 gdb_assert (class != NULL
);
1048 gdb_assert (category
!= NULL
);
1049 gdb_assert (selector
!= NULL
);
1053 while (isspace (*s1
))
1060 while (isspace (*s1
))
1063 if ((s1
[0] == '+') || (s1
[0] == '-'))
1066 while (isspace (*s1
))
1074 while (isalnum (*s1
) || (*s1
== '_'))
1078 while (isspace (*s2
))
1084 while (isspace (*s2
))
1087 while (isalnum (*s2
) || (*s2
== '_'))
1092 /* Truncate the class name now that we're not using the open paren. */
1100 if (isalnum (*s2
) || (*s2
== '_') || (*s2
== ':'))
1102 else if (isspace (*s2
))
1104 else if (*s2
== ']')
1113 while (isspace (*s2
))
1120 while (isspace (*s2
))
1128 if (category
!= NULL
)
1129 *category
= ncategory
;
1130 if (selector
!= NULL
)
1131 *selector
= nselector
;
1137 find_methods (struct symtab
*symtab
, char type
,
1138 const char *class, const char *category
,
1139 const char *selector
, struct symbol
**syms
,
1140 unsigned int *nsym
, unsigned int *ndebug
)
1142 struct objfile
*objfile
= NULL
;
1143 struct minimal_symbol
*msymbol
= NULL
;
1144 struct block
*block
= NULL
;
1145 struct symbol
*sym
= NULL
;
1147 char *symname
= NULL
;
1150 char *nclass
= NULL
;
1151 char *ncategory
= NULL
;
1152 char *nselector
= NULL
;
1154 unsigned int csym
= 0;
1155 unsigned int cdebug
= 0;
1157 static char *tmp
= NULL
;
1158 static unsigned int tmplen
= 0;
1160 gdb_assert (nsym
!= NULL
);
1161 gdb_assert (ndebug
!= NULL
);
1164 block
= BLOCKVECTOR_BLOCK (BLOCKVECTOR (symtab
), STATIC_BLOCK
);
1166 ALL_OBJFILES (objfile
)
1168 unsigned int *objc_csym
;
1170 /* The objfile_csym variable counts the number of ObjC methods
1171 that this objfile defines. We save that count as a private
1172 objfile data. If we have already determined that this objfile
1173 provides no ObjC methods, we can skip it entirely. */
1175 unsigned int objfile_csym
= 0;
1177 objc_csym
= objfile_data (objfile
, objc_objfile_data
);
1178 if (objc_csym
!= NULL
&& *objc_csym
== 0)
1179 /* There are no ObjC symbols in this objfile. Skip it entirely. */
1182 ALL_OBJFILE_MSYMBOLS (objfile
, msymbol
)
1184 struct gdbarch
*gdbarch
= get_objfile_arch (objfile
);
1185 CORE_ADDR pc
= SYMBOL_VALUE_ADDRESS (msymbol
);
1189 /* Check the symbol name first as this can be done entirely without
1190 sending any query to the target. */
1191 symname
= SYMBOL_NATURAL_NAME (msymbol
);
1192 if (symname
== NULL
)
1195 if ((symname
[0] != '-' && symname
[0] != '+') || (symname
[1] != '['))
1196 /* Not a method name. */
1199 /* The minimal symbol might point to a function descriptor;
1200 resolve it to the actual code address instead. */
1201 pc
= gdbarch_convert_from_func_ptr_addr (gdbarch
, pc
,
1205 if (pc
< BLOCK_START (block
) || pc
>= BLOCK_END (block
))
1206 /* Not in the specified symtab. */
1209 /* Now that thinks are a bit sane, clean up the symname. */
1210 while ((strlen (symname
) + 1) >= tmplen
)
1212 tmplen
= (tmplen
== 0) ? 1024 : tmplen
* 2;
1213 tmp
= xrealloc (tmp
, tmplen
);
1215 strcpy (tmp
, symname
);
1217 if (parse_method (tmp
, &ntype
, &nclass
, &ncategory
, &nselector
) == NULL
)
1222 if ((type
!= '\0') && (ntype
!= type
))
1226 && ((nclass
== NULL
) || (strcmp (class, nclass
) != 0)))
1229 if ((category
!= NULL
) &&
1230 ((ncategory
== NULL
) || (strcmp (category
, ncategory
) != 0)))
1233 if ((selector
!= NULL
) &&
1234 ((nselector
== NULL
) || (strcmp (selector
, nselector
) != 0)))
1237 sym
= find_pc_function (pc
);
1240 const char *newsymname
= SYMBOL_NATURAL_NAME (sym
);
1242 if (strcmp (symname
, newsymname
) == 0)
1244 /* Found a high-level method sym: swap it into the
1245 lower part of sym_arr (below num_debuggable). */
1248 syms
[csym
] = syms
[cdebug
];
1257 "debugging symbol \"%s\" does not match minimal symbol (\"%s\"); ignoring",
1258 newsymname
, symname
);
1260 syms
[csym
] = (struct symbol
*) msymbol
;
1266 /* Found a non-debuggable method symbol. */
1268 syms
[csym
] = (struct symbol
*) msymbol
;
1272 if (objc_csym
== NULL
)
1274 objc_csym
= obstack_alloc (&objfile
->objfile_obstack
,
1275 sizeof (*objc_csym
));
1276 *objc_csym
= objfile_csym
;
1277 set_objfile_data (objfile
, objc_objfile_data
, objc_csym
);
1280 /* Count of ObjC methods in this objfile should be constant. */
1281 gdb_assert (*objc_csym
== objfile_csym
);
1290 char *find_imps (struct symtab
*symtab
, struct block
*block
,
1291 char *method
, struct symbol
**syms
,
1292 unsigned int *nsym
, unsigned int *ndebug
)
1296 char *category
= NULL
;
1297 char *selector
= NULL
;
1299 unsigned int csym
= 0;
1300 unsigned int cdebug
= 0;
1302 unsigned int ncsym
= 0;
1303 unsigned int ncdebug
= 0;
1308 gdb_assert (nsym
!= NULL
);
1309 gdb_assert (ndebug
!= NULL
);
1316 buf
= (char *) alloca (strlen (method
) + 1);
1317 strcpy (buf
, method
);
1318 tmp
= parse_method (buf
, &type
, &class, &category
, &selector
);
1322 struct symbol
*sym
= NULL
;
1323 struct minimal_symbol
*msym
= NULL
;
1325 strcpy (buf
, method
);
1326 tmp
= parse_selector (buf
, &selector
);
1331 sym
= lookup_symbol (selector
, block
, VAR_DOMAIN
, 0);
1341 msym
= lookup_minimal_symbol (selector
, 0, 0);
1346 syms
[csym
] = (struct symbol
*)msym
;
1352 find_methods (symtab
, type
, class, category
, selector
,
1353 syms
+ csym
, &ncsym
, &ncdebug
);
1355 find_methods (symtab
, type
, class, category
, selector
,
1356 NULL
, &ncsym
, &ncdebug
);
1358 /* If we didn't find any methods, just return. */
1359 if (ncsym
== 0 && ncdebug
== 0)
1362 /* Take debug symbols from the second batch of symbols and swap them
1363 * with debug symbols from the first batch. Repeat until either the
1364 * second section is out of debug symbols or the first section is
1365 * full of debug symbols. Either way we have all debug symbols
1366 * packed to the beginning of the buffer.
1371 while ((cdebug
< csym
) && (ncdebug
> 0))
1373 struct symbol
*s
= NULL
;
1374 /* First non-debugging symbol. */
1375 unsigned int i
= cdebug
;
1376 /* Last of second batch of debug symbols. */
1377 unsigned int j
= csym
+ ncdebug
- 1;
1383 /* We've moved a symbol from the second debug section to the
1399 return method
+ (tmp
- buf
);
1403 /* Sort debuggable symbols. */
1405 qsort (syms
, cdebug
, sizeof (struct minimal_symbol
*),
1408 /* Sort minimal_symbols. */
1409 if ((csym
- cdebug
) > 1)
1410 qsort (&syms
[cdebug
], csym
- cdebug
,
1411 sizeof (struct minimal_symbol
*), compare_classes
);
1413 /* Terminate the sym_arr list. */
1416 return method
+ (tmp
- buf
);
1420 print_object_command (char *args
, int from_tty
)
1422 struct value
*object
, *function
, *description
;
1423 CORE_ADDR string_addr
, object_addr
;
1427 if (!args
|| !*args
)
1429 "The 'print-object' command requires an argument (an Objective-C object)");
1432 struct expression
*expr
= parse_expression (args
);
1433 struct cleanup
*old_chain
=
1434 make_cleanup (free_current_contents
, &expr
);
1437 object
= evaluate_subexp (builtin_type (expr
->gdbarch
)->builtin_data_ptr
,
1438 expr
, &pc
, EVAL_NORMAL
);
1439 do_cleanups (old_chain
);
1442 /* Validate the address for sanity. */
1443 object_addr
= value_as_long (object
);
1444 read_memory (object_addr
, &c
, 1);
1446 function
= find_function_in_inferior ("_NSPrintForDebugger", NULL
);
1447 if (function
== NULL
)
1448 error (_("Unable to locate _NSPrintForDebugger in child process"));
1450 description
= call_function_by_hand (function
, 1, &object
);
1452 string_addr
= value_as_long (description
);
1453 if (string_addr
== 0)
1454 error (_("object returns null description"));
1456 read_memory (string_addr
+ i
++, &c
, 1);
1459 { /* Read and print characters up to EOS. */
1461 printf_filtered ("%c", c
);
1462 read_memory (string_addr
+ i
++, &c
, 1);
1465 printf_filtered(_("<object returns empty description>"));
1466 printf_filtered ("\n");
1469 /* The data structure 'methcalls' is used to detect method calls (thru
1470 * ObjC runtime lib functions objc_msgSend, objc_msgSendSuper, etc.),
1471 * and ultimately find the method being called.
1474 struct objc_methcall
{
1476 /* Return instance method to be called. */
1477 int (*stop_at
) (CORE_ADDR
, CORE_ADDR
*);
1478 /* Start of pc range corresponding to method invocation. */
1480 /* End of pc range corresponding to method invocation. */
1484 static int resolve_msgsend (CORE_ADDR pc
, CORE_ADDR
*new_pc
);
1485 static int resolve_msgsend_stret (CORE_ADDR pc
, CORE_ADDR
*new_pc
);
1486 static int resolve_msgsend_super (CORE_ADDR pc
, CORE_ADDR
*new_pc
);
1487 static int resolve_msgsend_super_stret (CORE_ADDR pc
, CORE_ADDR
*new_pc
);
1489 static struct objc_methcall methcalls
[] = {
1490 { "_objc_msgSend", resolve_msgsend
, 0, 0},
1491 { "_objc_msgSend_stret", resolve_msgsend_stret
, 0, 0},
1492 { "_objc_msgSendSuper", resolve_msgsend_super
, 0, 0},
1493 { "_objc_msgSendSuper_stret", resolve_msgsend_super_stret
, 0, 0},
1494 { "_objc_getClass", NULL
, 0, 0},
1495 { "_objc_getMetaClass", NULL
, 0, 0}
1498 #define nmethcalls (sizeof (methcalls) / sizeof (methcalls[0]))
1500 /* The following function, "find_objc_msgsend", fills in the data
1501 * structure "objc_msgs" by finding the addresses of each of the
1502 * (currently four) functions that it holds (of which objc_msgSend is
1503 * the first). This must be called each time symbols are loaded, in
1504 * case the functions have moved for some reason.
1508 find_objc_msgsend (void)
1512 for (i
= 0; i
< nmethcalls
; i
++)
1514 struct minimal_symbol
*func
;
1516 /* Try both with and without underscore. */
1517 func
= lookup_minimal_symbol (methcalls
[i
].name
, NULL
, NULL
);
1518 if ((func
== NULL
) && (methcalls
[i
].name
[0] == '_'))
1520 func
= lookup_minimal_symbol (methcalls
[i
].name
+ 1, NULL
, NULL
);
1524 methcalls
[i
].begin
= 0;
1525 methcalls
[i
].end
= 0;
1529 methcalls
[i
].begin
= SYMBOL_VALUE_ADDRESS (func
);
1531 methcalls
[i
].end
= SYMBOL_VALUE_ADDRESS (++func
);
1532 } while (methcalls
[i
].begin
== methcalls
[i
].end
);
1536 /* find_objc_msgcall (replaces pc_off_limits)
1538 * ALL that this function now does is to determine whether the input
1539 * address ("pc") is the address of one of the Objective-C message
1540 * dispatch functions (mainly objc_msgSend or objc_msgSendSuper), and
1541 * if so, it returns the address of the method that will be called.
1543 * The old function "pc_off_limits" used to do a lot of other things
1544 * in addition, such as detecting shared library jump stubs and
1545 * returning the address of the shlib function that would be called.
1546 * That functionality has been moved into the gdbarch_skip_trampoline_code and
1547 * IN_SOLIB_TRAMPOLINE macros, which are resolved in the target-
1548 * dependent modules.
1551 struct objc_submethod_helper_data
{
1552 int (*f
) (CORE_ADDR
, CORE_ADDR
*);
1558 find_objc_msgcall_submethod_helper (void * arg
)
1560 struct objc_submethod_helper_data
*s
=
1561 (struct objc_submethod_helper_data
*) arg
;
1563 if (s
->f (s
->pc
, s
->new_pc
) == 0)
1570 find_objc_msgcall_submethod (int (*f
) (CORE_ADDR
, CORE_ADDR
*),
1574 struct objc_submethod_helper_data s
;
1580 if (catch_errors (find_objc_msgcall_submethod_helper
,
1582 "Unable to determine target of Objective-C method call (ignoring):\n",
1583 RETURN_MASK_ALL
) == 0)
1590 find_objc_msgcall (CORE_ADDR pc
, CORE_ADDR
*new_pc
)
1594 find_objc_msgsend ();
1600 for (i
= 0; i
< nmethcalls
; i
++)
1601 if ((pc
>= methcalls
[i
].begin
) && (pc
< methcalls
[i
].end
))
1603 if (methcalls
[i
].stop_at
!= NULL
)
1604 return find_objc_msgcall_submethod (methcalls
[i
].stop_at
,
1613 extern initialize_file_ftype _initialize_objc_language
; /* -Wmissing-prototypes */
1616 _initialize_objc_language (void)
1618 add_language (&objc_language_defn
);
1619 add_info ("selectors", selectors_info
, /* INFO SELECTORS command. */
1620 _("All Objective-C selectors, or those matching REGEXP."));
1621 add_info ("classes", classes_info
, /* INFO CLASSES command. */
1622 _("All Objective-C classes, or those matching REGEXP."));
1623 add_com ("print-object", class_vars
, print_object_command
,
1624 _("Ask an Objective-C object to print itself."));
1625 add_com_alias ("po", "print-object", class_vars
, 1);
1629 read_objc_method (struct gdbarch
*gdbarch
, CORE_ADDR addr
,
1630 struct objc_method
*method
)
1632 enum bfd_endian byte_order
= gdbarch_byte_order (gdbarch
);
1634 method
->name
= read_memory_unsigned_integer (addr
+ 0, 4, byte_order
);
1635 method
->types
= read_memory_unsigned_integer (addr
+ 4, 4, byte_order
);
1636 method
->imp
= read_memory_unsigned_integer (addr
+ 8, 4, byte_order
);
1639 static unsigned long
1640 read_objc_methlist_nmethods (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
1642 enum bfd_endian byte_order
= gdbarch_byte_order (gdbarch
);
1644 return read_memory_unsigned_integer (addr
+ 4, 4, byte_order
);
1648 read_objc_methlist_method (struct gdbarch
*gdbarch
, CORE_ADDR addr
,
1649 unsigned long num
, struct objc_method
*method
)
1651 gdb_assert (num
< read_objc_methlist_nmethods (gdbarch
, addr
));
1652 read_objc_method (gdbarch
, addr
+ 8 + (12 * num
), method
);
1656 read_objc_object (struct gdbarch
*gdbarch
, CORE_ADDR addr
,
1657 struct objc_object
*object
)
1659 enum bfd_endian byte_order
= gdbarch_byte_order (gdbarch
);
1661 object
->isa
= read_memory_unsigned_integer (addr
, 4, byte_order
);
1665 read_objc_super (struct gdbarch
*gdbarch
, CORE_ADDR addr
,
1666 struct objc_super
*super
)
1668 enum bfd_endian byte_order
= gdbarch_byte_order (gdbarch
);
1670 super
->receiver
= read_memory_unsigned_integer (addr
, 4, byte_order
);
1671 super
->class = read_memory_unsigned_integer (addr
+ 4, 4, byte_order
);
1675 read_objc_class (struct gdbarch
*gdbarch
, CORE_ADDR addr
,
1676 struct objc_class
*class)
1678 enum bfd_endian byte_order
= gdbarch_byte_order (gdbarch
);
1680 class->isa
= read_memory_unsigned_integer (addr
, 4, byte_order
);
1681 class->super_class
= read_memory_unsigned_integer (addr
+ 4, 4, byte_order
);
1682 class->name
= read_memory_unsigned_integer (addr
+ 8, 4, byte_order
);
1683 class->version
= read_memory_unsigned_integer (addr
+ 12, 4, byte_order
);
1684 class->info
= read_memory_unsigned_integer (addr
+ 16, 4, byte_order
);
1685 class->instance_size
= read_memory_unsigned_integer (addr
+ 18, 4, byte_order
);
1686 class->ivars
= read_memory_unsigned_integer (addr
+ 24, 4, byte_order
);
1687 class->methods
= read_memory_unsigned_integer (addr
+ 28, 4, byte_order
);
1688 class->cache
= read_memory_unsigned_integer (addr
+ 32, 4, byte_order
);
1689 class->protocols
= read_memory_unsigned_integer (addr
+ 36, 4, byte_order
);
1693 find_implementation_from_class (struct gdbarch
*gdbarch
,
1694 CORE_ADDR
class, CORE_ADDR sel
)
1696 enum bfd_endian byte_order
= gdbarch_byte_order (gdbarch
);
1697 CORE_ADDR subclass
= class;
1699 while (subclass
!= 0)
1702 struct objc_class class_str
;
1703 unsigned mlistnum
= 0;
1705 read_objc_class (gdbarch
, subclass
, &class_str
);
1710 unsigned long nmethods
;
1713 mlist
= read_memory_unsigned_integer (class_str
.methods
+
1719 nmethods
= read_objc_methlist_nmethods (gdbarch
, mlist
);
1721 for (i
= 0; i
< nmethods
; i
++)
1723 struct objc_method meth_str
;
1725 read_objc_methlist_method (gdbarch
, mlist
, i
, &meth_str
);
1728 "checking method 0x%lx against selector 0x%lx\n",
1729 meth_str
.name
, sel
);
1732 if (meth_str
.name
== sel
)
1733 /* FIXME: hppa arch was doing a pointer dereference
1734 here. There needs to be a better way to do that. */
1735 return meth_str
.imp
;
1739 subclass
= class_str
.super_class
;
1746 find_implementation (struct gdbarch
*gdbarch
,
1747 CORE_ADDR object
, CORE_ADDR sel
)
1749 struct objc_object ostr
;
1753 read_objc_object (gdbarch
, object
, &ostr
);
1757 return find_implementation_from_class (gdbarch
, ostr
.isa
, sel
);
1761 resolve_msgsend (CORE_ADDR pc
, CORE_ADDR
*new_pc
)
1763 struct frame_info
*frame
= get_current_frame ();
1764 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
1765 struct type
*ptr_type
= builtin_type (gdbarch
)->builtin_func_ptr
;
1771 object
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 0, ptr_type
);
1772 sel
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 1, ptr_type
);
1774 res
= find_implementation (gdbarch
, object
, sel
);
1783 resolve_msgsend_stret (CORE_ADDR pc
, CORE_ADDR
*new_pc
)
1785 struct frame_info
*frame
= get_current_frame ();
1786 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
1787 struct type
*ptr_type
= builtin_type (gdbarch
)->builtin_func_ptr
;
1793 object
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 1, ptr_type
);
1794 sel
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 2, ptr_type
);
1796 res
= find_implementation (gdbarch
, object
, sel
);
1805 resolve_msgsend_super (CORE_ADDR pc
, CORE_ADDR
*new_pc
)
1807 struct frame_info
*frame
= get_current_frame ();
1808 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
1809 struct type
*ptr_type
= builtin_type (gdbarch
)->builtin_func_ptr
;
1811 struct objc_super sstr
;
1817 super
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 0, ptr_type
);
1818 sel
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 1, ptr_type
);
1820 read_objc_super (gdbarch
, super
, &sstr
);
1821 if (sstr
.class == 0)
1824 res
= find_implementation_from_class (gdbarch
, sstr
.class, sel
);
1833 resolve_msgsend_super_stret (CORE_ADDR pc
, CORE_ADDR
*new_pc
)
1835 struct frame_info
*frame
= get_current_frame ();
1836 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
1837 struct type
*ptr_type
= builtin_type (gdbarch
)->builtin_func_ptr
;
1839 struct objc_super sstr
;
1845 super
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 1, ptr_type
);
1846 sel
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 2, ptr_type
);
1848 read_objc_super (gdbarch
, super
, &sstr
);
1849 if (sstr
.class == 0)
1852 res
= find_implementation_from_class (gdbarch
, sstr
.class, sel
);
1861 _initialize_objc_lang (void)
1863 objc_objfile_data
= register_objfile_data ();