2 * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
4 * @APPLE_LICENSE_HEADER_START@
6 * The contents of this file constitute Original Code as defined in and
7 * are subject to the Apple Public Source License Version 1.1 (the
8 * "License"). You may not use this file except in compliance with the
9 * License. Please obtain a copy of the License at
10 * http://www.apple.com/publicsource and read it before using this file.
12 * This Original Code and all software distributed under the License are
13 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
14 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
15 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
17 * License for the specific language governing rights and limitations
20 * @APPLE_LICENSE_HEADER_END@
26 * Mach Operating System
27 * Copyright (c) 1991,1990 Carnegie Mellon University
28 * All Rights Reserved.
30 * Permission to use, copy, modify and distribute this software and its
31 * documentation is hereby granted, provided that both the copyright
32 * notice and this permission notice appear in all copies of the
33 * software, derivative works or modified versions, and any portions
34 * thereof, and that both notices appear in supporting documentation.
36 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
37 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
38 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
40 * Carnegie Mellon requests users of this software to return to
42 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
43 * School of Computer Science
44 * Carnegie Mellon University
45 * Pittsburgh PA 15213-3890
47 * any improvements or extensions that they make and grant Carnegie Mellon
48 * the rights to redistribute these changes.
53 * Author: David B. Golub, Carnegie Mellon University
57 * Symbol table routines for a.out format files.
59 #include <mach/mach_types.h>
60 #include <mach/boolean.h>
61 #include <mach/std_types.h>
62 #include <machine/db_machdep.h> /* data types */
64 #include <string.h> /* For strcpy(), strcmp() */
65 #include <ddb/db_aout.h>
66 #include <ddb/db_output.h> /* For db_printf() */
67 #include <ddb/db_sym.h>
71 #include <ddb/nlist.h> /* a.out symbol table */
74 #define private static
76 private int aout_db_order_symbols(char *, char *);
77 private int aout_db_compare_symbols(char *, char *);
78 private boolean_t
aout_db_is_filename(char *);
79 private boolean_t
aout_db_eq_name(struct nlist
*, char *, int);
82 * An a.out symbol table as loaded into the kernel debugger:
84 * symtab -> size of symbol entries, in bytes
85 * sp -> first symbol entry
87 * ep -> last symbol entry + 1
88 * strtab == start of string table
89 * size of string table in bytes,
95 * Find pointers to the start and end of the symbol entries,
96 * given a pointer to the start of the symbol table.
98 #define db_get_aout_symtab(symtab, sp, ep) \
99 (sp = (struct nlist *)(((vm_offset_t *)(symtab)) + 1), \
100 ep = (struct nlist *)((char *)sp + *((int *)(symtab))))
102 char *db_sorting_sym_end
;
105 aout_db_order_symbols(
109 struct nlist
*sym1
= (struct nlist
*) s1
;
110 struct nlist
*sym2
= (struct nlist
*) s2
;
112 if (sym1
->n_value
!= sym2
->n_value
)
113 return (sym1
->n_value
- sym2
->n_value
);
115 return (sym1
->n_un
.n_name
- sym2
->n_un
.n_name
);
120 aout_db_compare_symbols(
124 return (((struct nlist
*) sym1
)->n_value
-
125 ((struct nlist
*) sym2
)->n_value
);
128 int db_sorting_limit
= 50000;
132 char * symtab
, /* pointer to start of symbol table */
133 char * esymtab
, /* pointer to end of string table,
134 for checking - may be rounded up to
137 char * task_addr
) /* use for this task only */
139 struct nlist
*sym_start
, *sym_end
, *dbsym_start
, *dbsym_end
;
141 char *strtab
, *dbstrtab
;
143 char *estrtab
, *dbestrtab
;
144 unsigned long minsym
= ~0;
145 unsigned long maxsym
= 0;
148 extern boolean_t
getsymtab(char *,
149 vm_offset_t
*, int *,
150 vm_offset_t
*, vm_size_t
*);
154 if (!getsymtab(symtab
,
155 (vm_offset_t
*)&sym_start
, &nsyms
,
156 (vm_offset_t
*)&strtab
, (vm_size_t
*)&strlen
)) {
159 sym_end
= sym_start
+ nsyms
;
160 estrtab
= strtab
+ strlen
;
163 * We haven't actually started up VM yet, so we can just steal some pages to
164 * make a working copy of the symbols and strings
167 dbsym_start
= (struct nlist
*)pmap_steal_memory(((unsigned int)sym_end
- (unsigned int)sym_start
+ 4096) & -4096); /* Get space for symbols */
168 dbstrtab
= (char *)pmap_steal_memory(((unsigned int)estrtab
- (unsigned int)strtab
+ 4096) & -4096); /* Get space for strings */
170 bcopy((char *)sym_start
, (char *)dbsym_start
, (unsigned int)sym_end
- (unsigned int)sym_start
); /* Copy symbols */
171 bcopy(strtab
, dbstrtab
, (unsigned int)estrtab
- (unsigned int)strtab
); /* Copy strings */
173 dbsym_end
= dbsym_start
+ nsyms
;
174 dbestrtab
= dbstrtab
+ strlen
;
176 sorting
= ((dbsym_end
- dbsym_start
) < db_sorting_limit
);
178 for (sp
= dbsym_start
; sp
< dbsym_end
; sp
++) {
180 strx
= sp
->n_un
.n_strx
;
186 sp
->n_un
.n_name
= dbstrtab
+ strx
;
188 if (sp
->n_type
!= N_ABS
) {
189 if (sp
->n_value
> 0 && sp
->n_value
< minsym
)
190 minsym
= sp
->n_value
;
191 if (sp
->n_value
> maxsym
)
192 maxsym
= sp
->n_value
;
200 db_qsort((char *) dbsym_start
, dbsym_end
- dbsym_start
,
201 sizeof (struct nlist
), aout_db_order_symbols
);
206 if (db_add_symbol_table(SYMTAB_AOUT
,
216 /* Successfully added symbol table */
218 pmap_protect(kernel_pmap
,
219 (vm_offset_t
) dbsym_start
, (vm_offset_t
) dbsym_end
,
220 VM_PROT_READ
|VM_PROT_WRITE
);
221 pmap_protect(kernel_pmap
,
222 (vm_offset_t
) dbstrtab
, (vm_offset_t
) dbestrtab
,
223 VM_PROT_READ
|VM_PROT_WRITE
);
230 * This KLUDGE offsets the n_values of a copied symbol table
232 void db_clone_offsetXXX(char *, long);
234 db_clone_offsetXXX(char * symtab
, long offset
)
236 register struct nlist
*sym_start
, *sym_end
, *sp
;
238 db_get_aout_symtab((int *)symtab
, sym_start
, sym_end
);
240 for (sp
= sym_start
; sp
< sym_end
; sp
++)
241 if (sp
->n_type
!= N_ABS
)
242 sp
->n_value
+= offset
;
247 * check file name or not (check xxxx.x pattern)
250 aout_db_is_filename(char *name
)
263 * special name comparison routine with a name in the symbol table entry
271 register char *s1
, *s2
;
273 s1
= sp
->n_un
.n_name
;
275 #ifndef __NO_UNDERSCORES__
276 if (*s1
== '_' && *s2
&& *s2
!= '_')
278 #endif /* __NO_UNDERSCORES__ */
280 if (*s1
++ != *s2
++) {
282 * check .c .o file name comparison case
284 if (*s2
== 0 && sp
->n_un
.n_name
<= s1
- 2
285 && s1
[-2] == '.' && s1
[-1] == 'o')
293 * do special check for
295 * xxx.ttt for N_DATA and N_BSS
297 return(*s1
== 0 || (*s1
== ':' && sp
->n_type
== N_FUN
) ||
298 (*s1
== '.' && (sp
->n_type
== N_DATA
|| sp
->n_type
== N_BSS
)));
302 * search a symbol table with name and type
303 * fp(in,out): last found text file name symbol entry
305 private struct nlist
*
314 struct nlist
*file_sp
= *fp
;
315 struct nlist
*found_sp
= 0;
317 for ( ; sp
< ep
; sp
++) {
320 if (sp
->n_type
== N_TEXT
&& aout_db_is_filename(sp
->n_un
.n_name
))
323 if (sp
->n_type
== type
) {
324 /* dwm_debug: b26 name, mk6 added last param */
325 if (aout_db_eq_name(sp
, name
, 0))
328 if (sp
->n_type
== N_SO
)
332 if (sp
->n_type
& N_STAB
)
334 if (sp
->n_un
.n_name
&& aout_db_eq_name(sp
, name
, incomplete
)) {
336 * In case of qaulified search by a file,
337 * return it immediately with some check.
338 * Otherwise, search external one
341 if ((file_sp
== *fp
) || (sp
->n_type
& N_EXT
))
343 } else if ((sp
->n_type
& N_EXT
) ||
344 (incomplete
&& !aout_db_is_filename(sp
->n_un
.n_name
)))
354 * Print sorted possible completions for a symbol.
355 * Use n_other field to mark completion symbols in order
359 aout_db_qualified_print_completion(
367 struct nlist
*fp
= 0;
376 sp
= aout_db_search_name((struct nlist
*)stab
->start
,
377 (struct nlist
*)stab
->end
,
379 if (sp
== (struct nlist
*)0)
382 symlen
= strlen(sym
);
385 if (strncmp(cur
->n_un
.n_name
, sym
, symlen
) == 0)
390 cur
= aout_db_search_name(cur
+ 1, (struct nlist
*)stab
->end
,
401 if (strcmp(&cur
->n_un
.n_name
[cur
->n_other
- 1],
402 &new->n_un
.n_name
[new->n_other
- 1]) < 0)
409 if ((new->n_type
& N_EXT
) == 0) {
410 for (cur
= new - 1; cur
> (struct nlist
*)stab
->start
; cur
--) {
411 if (cur
->n_type
== N_SO
||
412 (stab
->sorted
&& cur
->n_value
< new->n_value
))
415 cur
->n_type
== N_SLINE
&&
416 cur
->n_value
== new->n_value
)
419 cur
->n_type
== N_FUN
&&
420 cur
->n_value
== new->n_value
)
424 if (cur
->n_type
== N_SO
)
425 fname
= cur
->n_un
.n_name
;
429 if (line
== 0 || func
== 0)
431 cur
< (struct nlist
*)stab
->end
; cur
++) {
432 if (cur
->n_type
== N_SO
||
433 (stab
->sorted
&& cur
->n_value
> new->n_value
))
436 cur
->n_type
== N_SLINE
&&
437 cur
->n_value
== new->n_value
) {
443 cur
->n_type
== N_FUN
&&
444 cur
->n_value
== new->n_value
) {
452 for (cur
= new - 1; cur
> (struct nlist
*)stab
->start
; cur
--) {
453 if (cur
->n_type
== N_SO
||
454 (stab
->sorted
&& cur
->n_value
< new->n_value
))
457 cur
->n_type
== N_FUN
&&
458 cur
->n_value
== new->n_value
)
463 cur
< (struct nlist
*)stab
->end
; cur
++) {
464 if (cur
->n_type
== N_SO
||
465 (stab
->sorted
&& cur
->n_value
> new->n_value
))
467 if (cur
->n_type
== N_FUN
&&
468 cur
->n_value
== new->n_value
) {
475 db_sym_print_completion(stab
, &new->n_un
.n_name
[new->n_other
- 1],
484 } else if (new == sp1
)
494 * search a (possibly incomplete) symbol with file, func and line qualification
497 aout_db_qualified_search(
506 register struct nlist
*sp
= (struct nlist
*)stab
->start
;
507 struct nlist
*ep
= (struct nlist
*)stab
->end
;
508 struct nlist
*fp
= 0;
509 struct nlist
*found_sp
;
510 unsigned long func_top
;
516 if (file
== 0 && sym
== 0)
519 if ((sp
= aout_db_search_name(sp
, ep
, file
, N_TEXT
, &fp
, 0)) == 0)
524 sp
= aout_db_search_name(sp
, ep
, sym
, (line
> 0)? N_FUN
: 0, &fp
,
525 (ret
== (db_sym_t
*)0));
531 if (strncmp(sp
->n_un
.n_name
, sym
, strlen(sym
)) == 0)
534 p
= &sp
->n_un
.n_name
[1];
536 if (*name
== (char *)0) {
540 for (i
= 0; i
< *len
; i
++)
541 if ((*name
)[i
] != p
[i
]) {
552 if (file
&& !aout_db_eq_name(fp
, file
, 0))
555 if (sp
->n_type
== N_FUN
) {
557 * qualfied by function name
558 * search backward because line number entries
559 * for the function are above it in this case.
561 func_top
= sp
->n_value
;
563 /* symbols with the same value may have been mixed up */
566 } while (sp
->n_value
== func_top
);
568 for (sp
--; sp
>= (struct nlist
*)stab
->start
; sp
--) {
569 if (sp
->n_type
!= N_SLINE
)
571 if (sp
->n_value
< func_top
)
573 if (sp
->n_desc
<= line
) {
574 if (found_sp
== 0 || found_sp
->n_desc
< sp
->n_desc
)
576 if (sp
->n_desc
== line
)
580 if (sp
->n_type
!= N_SLINE
|| sp
->n_value
< func_top
)
584 * qualified by only file name
585 * search forward in this case
589 /* symbols with the same value may have been mixed up */
590 func_top
= sp
->n_value
;
593 } while (sp
->n_value
== func_top
);
595 for (sp
++; sp
< ep
; sp
++) {
596 if (sp
->n_type
== N_TEXT
597 && aout_db_is_filename(sp
->n_un
.n_name
))
598 break; /* enter into another file */
599 if (sp
->n_type
== N_SOL
) {
600 in_file
= aout_db_eq_name(sp
, file
, 0);
603 if (!in_file
|| sp
->n_type
!= N_SLINE
)
605 if (sp
->n_desc
<= line
) {
606 if (found_sp
== 0 || found_sp
->n_desc
< sp
->n_desc
)
608 if (sp
->n_desc
== line
)
615 *ret
= (db_sym_t
) sp
;
620 * lookup symbol by name
627 return(db_sym_parse_and_lookup(aout_db_qualified_search
, stab
, symstr
));
631 * lookup (possibly incomplete) symbol by name
634 aout_db_lookup_incomplete(
641 return(db_sym_parse_and_lookup_incomplete(aout_db_qualified_search
,
642 stab
, symstr
, name
, len
, toadd
));
646 * Display possible completion for the symbol
649 aout_db_print_completion(stab
, symstr
)
654 return(db_sym_parse_and_print_completion(aout_db_qualified_print_completion
,
659 aout_db_search_symbol(
662 db_strategy_t strategy
,
663 db_expr_t
*diffp
) /* in/out */
665 db_expr_t diff
= *diffp
;
666 register struct nlist
*symp
= 0;
667 struct nlist
*sp
, *ep
, *cp
;
668 boolean_t first_pass
= FALSE
;
670 sp
= (struct nlist
*)symtab
->start
;
671 ep
= (struct nlist
*)symtab
->end
;
673 if (symtab
->sorted
) {
676 target
.n_value
= off
;
677 target
.n_un
.n_name
= (char *) 0;
678 target
.n_other
= (char) 0;
679 db_qsort_limit_search((char *) &target
, (char **) &sp
, (char **) &ep
,
680 sizeof (struct nlist
), aout_db_compare_symbols
);
685 for (cp
= ep
-1; cp
>= sp
; cp
--) {
686 if (cp
->n_un
.n_name
== 0)
688 if ((cp
->n_type
& N_STAB
) != 0)
690 if (strategy
== DB_STGY_XTRN
&& (cp
->n_type
& N_EXT
) == 0)
692 if (off
>= cp
->n_value
) {
693 if (off
- cp
->n_value
< diff
) {
694 diff
= off
- cp
->n_value
;
696 if (diff
== 0 && (cp
->n_type
& N_EXT
))
699 else if (off
- cp
->n_value
== diff
) {
702 else if ((symp
->n_type
& N_EXT
) == 0 &&
703 (cp
->n_type
& N_EXT
) != 0)
704 symp
= cp
; /* pick the external symbol */
711 sp
= (struct nlist
*) symtab
->start
;
719 return ((db_sym_t
)symp
);
723 * Return the name and value for a symbol.
726 aout_db_symbol_values(
731 register struct nlist
*sp
;
733 sp
= (struct nlist
*)sym
;
735 *namep
= sp
->n_un
.n_name
;
737 *valuep
= sp
->n_value
;
740 #define X_DB_MAX_DIFF 8 /* maximum allowable diff at the end of line */
741 extern int db_search_maxoff
; /* maximum acceptable offset */
744 * search symbol by value
747 aout_db_search_by_addr(
756 struct nlist
*sp
, *cp
;
757 register struct nlist
*line_sp
, *func_sp
, *file_sp
, *line_func
;
758 unsigned long func_diff
, line_diff
;
759 boolean_t found_line
= FALSE
;
760 struct nlist
*ep
= (struct nlist
*)stab
->end
;
761 boolean_t first_pass
= FALSE
;
765 * Added init of these two... not sure if it's correct, but
766 * can't be worse than random values.... -- jfriedl@omron.co.jp
768 func_diff
= line_diff
= /*HUGE*/0x0fffffff;
770 line_sp
= func_sp
= file_sp
= line_func
= 0;
775 sp
= (struct nlist
*)stab
->start
;
779 target
.n_value
= addr
;
780 target
.n_un
.n_name
= (char *) 0;
781 target
.n_other
= (char) 0;
782 db_qsort_limit_search((char *) &target
, (char **) &sp
,
783 (char **) &ep
, sizeof (struct nlist
),
784 aout_db_compare_symbols
);
788 for (cp
= sp
; cp
< ep
; cp
++) {
791 if (cp
->n_value
<= addr
) {
792 if (line_sp
== 0 || line_diff
>= addr
- cp
->n_value
) {
796 line_diff
= addr
- cp
->n_value
;
799 if (cp
->n_value
>= addr
&& line_sp
)
803 if ((found_line
|| (line_sp
&& line_diff
< X_DB_MAX_DIFF
))
808 if (cp
->n_value
> addr
)
810 if (file_sp
== 0 || file_sp
->n_value
<= cp
->n_value
)
814 if (aout_db_is_filename(cp
->n_un
.n_name
)) {
815 if (cp
->n_value
> addr
)
817 if (file_sp
== 0 || file_sp
->n_value
<= cp
->n_value
)
819 } else if (cp
->n_value
<= addr
&&
820 (func_sp
== 0 || func_diff
> addr
- cp
->n_value
)) {
822 func_diff
= addr
- cp
->n_value
;
826 if (cp
->n_value
<= addr
&&
827 (func_sp
== 0 || func_diff
>= addr
- cp
->n_value
)) {
829 func_diff
= addr
- cp
->n_value
;
830 if (func_diff
== 0 && file_sp
&& func_sp
&& line_sp
== 0)
835 if ((cp
->n_value
> addr
) &&
836 (cp
->n_value
- addr
> db_search_maxoff
))
843 if (first_pass
&& (!file_sp
|| !line_sp
|| !func_sp
)) {
846 sp
= (struct nlist
*)stab
->start
;
847 for (; cp
>= sp
; cp
--) {
854 if ((found_line
|| (line_sp
&& line_diff
< X_DB_MAX_DIFF
))
863 if (aout_db_is_filename(cp
->n_un
.n_name
)) {
866 } else if (func_sp
== 0) {
868 func_diff
= addr
- cp
->n_value
;
874 func_diff
= addr
- cp
->n_value
;
875 if (func_diff
== 0 && file_sp
&& func_sp
880 if (line_sp
&& file_sp
&&
881 addr
- cp
->n_value
> db_search_maxoff
)
890 * XXX - barbou@gr.osf.org
891 * I don't know if that code is useful to something, but it makes the -gline
892 * option of gcc useless.
895 if (line_func
== 0 || func_sp
== 0
896 || line_func
->n_value
!= func_sp
->n_value
)
900 if (line_sp
&& !found_line
) {
906 *diff
= addr
- file_sp
->n_value
;
907 *file
= file_sp
->n_un
.n_name
;
910 *diff
= addr
- line_sp
->n_value
;
911 *line
= line_sp
->n_desc
;
914 *diff
= addr
- func_sp
->n_value
;
915 *func
= (func_sp
->n_un
.n_name
[0] == '_')?
916 func_sp
->n_un
.n_name
+ 1: func_sp
->n_un
.n_name
;
917 if (line_func
&& (line_func
->n_desc
& 0x4000))
918 *args
= line_func
->n_desc
& 0x3ff;
920 return((db_sym_t
) func_sp
);
924 * Find filename and lineno within, given the current pc.
939 found
= (aout_db_search_by_addr(stab
, (unsigned)pc
, file
, &func
, line
,
942 return(found
&& func
&& *file
);
946 * Initialization routine for a.out files.
951 extern struct mach_header _mh_execute_header
;
953 aout_db_sym_init((char *) &_mh_execute_header
,
954 (char *)0, "mach", (char *)0);
957 #endif /* DB_NO_AOUT */