2 * Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
32 * Mach Operating System
33 * Copyright (c) 1991,1990 Carnegie Mellon University
34 * All Rights Reserved.
36 * Permission to use, copy, modify and distribute this software and its
37 * documentation is hereby granted, provided that both the copyright
38 * notice and this permission notice appear in all copies of the
39 * software, derivative works or modified versions, and any portions
40 * thereof, and that both notices appear in supporting documentation.
42 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
43 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
44 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
46 * Carnegie Mellon requests users of this software to return to
48 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
49 * School of Computer Science
50 * Carnegie Mellon University
51 * Pittsburgh PA 15213-3890
53 * any improvements or extensions that they make and grant Carnegie Mellon
54 * the rights to redistribute these changes.
59 * Author: David B. Golub, Carnegie Mellon University
63 * Symbol table routines for a.out format files.
65 #include <mach/mach_types.h>
66 #include <mach/boolean.h>
67 #include <mach/std_types.h>
68 #include <machine/db_machdep.h> /* data types */
70 #include <string.h> /* For strcpy(), strcmp() */
71 #include <ddb/db_aout.h>
72 #include <ddb/db_output.h> /* For db_printf() */
73 #include <ddb/db_sym.h>
77 #include <ddb/nlist.h> /* a.out symbol table */
80 #define private static
82 private int aout_db_order_symbols(char *, char *);
83 private int aout_db_compare_symbols(char *, char *);
84 private boolean_t
aout_db_is_filename(char *);
85 private boolean_t
aout_db_eq_name(struct nlist
*, char *, int);
88 * An a.out symbol table as loaded into the kernel debugger:
90 * symtab -> size of symbol entries, in bytes
91 * sp -> first symbol entry
93 * ep -> last symbol entry + 1
94 * strtab == start of string table
95 * size of string table in bytes,
101 * Find pointers to the start and end of the symbol entries,
102 * given a pointer to the start of the symbol table.
104 #define db_get_aout_symtab(symtab, sp, ep) \
105 (sp = (struct nlist *)(((vm_offset_t *)(symtab)) + 1), \
106 ep = (struct nlist *)((char *)sp + *((int *)(symtab))))
108 char *db_sorting_sym_end
;
111 aout_db_order_symbols(
115 struct nlist
*sym1
= (struct nlist
*) s1
;
116 struct nlist
*sym2
= (struct nlist
*) s2
;
118 if (sym1
->n_value
!= sym2
->n_value
)
119 return (sym1
->n_value
- sym2
->n_value
);
121 return (sym1
->n_un
.n_name
- sym2
->n_un
.n_name
);
126 aout_db_compare_symbols(
130 return (((struct nlist
*) sym1
)->n_value
-
131 ((struct nlist
*) sym2
)->n_value
);
134 int db_sorting_limit
= 50000;
136 extern boolean_t
getsymtab(char *, vm_offset_t
*, int *, vm_offset_t
*,
141 char * symtab
, /* pointer to start of symbol table */
142 __unused
char *esymtab
, /* pointer to end of string table,
143 for checking - may be rounded up to
146 char * task_addr
) /* use for this task only */
148 struct nlist
*sym_start
, *sym_end
, *dbsym_start
, *dbsym_end
;
150 char *strtab
, *dbstrtab
;
152 char *estrtab
, *dbestrtab
;
153 unsigned long minsym
= ~0;
154 unsigned long maxsym
= 0;
160 if (!getsymtab(symtab
,
161 (vm_offset_t
*)&sym_start
, &nsyms
,
162 (vm_offset_t
*)&strtab
, (vm_size_t
*)&db_strlen
)) {
165 sym_end
= sym_start
+ nsyms
;
166 estrtab
= strtab
+ db_strlen
;
169 * We haven't actually started up VM yet, so we can just steal some pages to
170 * make a working copy of the symbols and strings
173 dbsym_start
= (struct nlist
*)pmap_steal_memory(((unsigned int)sym_end
- (unsigned int)sym_start
+ 4096) & -4096); /* Get space for symbols */
174 dbstrtab
= (char *)pmap_steal_memory(((unsigned int)estrtab
- (unsigned int)strtab
+ 4096) & -4096); /* Get space for strings */
176 bcopy((char *)sym_start
, (char *)dbsym_start
, (unsigned int)sym_end
- (unsigned int)sym_start
); /* Copy symbols */
177 bcopy(strtab
, dbstrtab
, (unsigned int)estrtab
- (unsigned int)strtab
); /* Copy strings */
179 dbsym_end
= dbsym_start
+ nsyms
;
180 dbestrtab
= dbstrtab
+ db_strlen
;
182 sorting
= ((dbsym_end
- dbsym_start
) < db_sorting_limit
);
184 for (sp
= dbsym_start
; sp
< dbsym_end
; sp
++) {
186 strx
= sp
->n_un
.n_strx
;
188 if (strx
> db_strlen
) {
192 sp
->n_un
.n_name
= dbstrtab
+ strx
;
194 if (sp
->n_type
!= N_ABS
) {
195 if (sp
->n_value
> 0 && sp
->n_value
< minsym
)
196 minsym
= sp
->n_value
;
197 if (sp
->n_value
> maxsym
)
198 maxsym
= sp
->n_value
;
206 db_qsort((char *) dbsym_start
, dbsym_end
- dbsym_start
,
207 sizeof(struct nlist
), aout_db_order_symbols
);
212 if (db_add_symbol_table(SYMTAB_AOUT
,
222 /* Successfully added symbol table */
224 pmap_protect(kernel_pmap
,
225 (vm_offset_t
) dbsym_start
, (vm_offset_t
) dbsym_end
,
226 VM_PROT_READ
|VM_PROT_WRITE
);
227 pmap_protect(kernel_pmap
,
228 (vm_offset_t
) dbstrtab
, (vm_offset_t
) dbestrtab
,
229 VM_PROT_READ
|VM_PROT_WRITE
);
236 * This KLUDGE offsets the n_values of a copied symbol table
238 void db_clone_offsetXXX(char *, long);
240 db_clone_offsetXXX(char * symtab
, long offset
)
242 register struct nlist
*sym_start
, *sym_end
, *sp
;
244 db_get_aout_symtab((int *)symtab
, sym_start
, sym_end
);
246 for (sp
= sym_start
; sp
< sym_end
; sp
++)
247 if (sp
->n_type
!= N_ABS
)
248 sp
->n_value
+= offset
;
253 * check file name or not (check xxxx.x pattern)
256 aout_db_is_filename(char *name
)
269 * special name comparison routine with a name in the symbol table entry
277 register char *s1
, *s2
;
279 s1
= sp
->n_un
.n_name
;
281 #ifndef __NO_UNDERSCORES__
282 if (*s1
== '_' && *s2
&& *s2
!= '_')
284 #endif /* __NO_UNDERSCORES__ */
286 if (*s1
++ != *s2
++) {
288 * check .c .o file name comparison case
290 if (*s2
== 0 && sp
->n_un
.n_name
<= s1
- 2
291 && s1
[-2] == '.' && s1
[-1] == 'o')
299 * do special check for
301 * xxx.ttt for N_DATA and N_BSS
303 return(*s1
== 0 || (*s1
== ':' && sp
->n_type
== N_FUN
) ||
304 (*s1
== '.' && (sp
->n_type
== N_DATA
|| sp
->n_type
== N_BSS
)));
308 * search a symbol table with name and type
309 * fp(in,out): last found text file name symbol entry
311 private struct nlist
*
320 struct nlist
*file_sp
= *fp
;
321 struct nlist
*found_sp
= 0;
323 for ( ; sp
< ep
; sp
++) {
326 if (sp
->n_type
== N_TEXT
&& aout_db_is_filename(sp
->n_un
.n_name
))
329 if (sp
->n_type
== type
) {
330 /* dwm_debug: b26 name, mk6 added last param */
331 if (aout_db_eq_name(sp
, name
, 0))
334 if (sp
->n_type
== N_SO
)
338 if (sp
->n_type
& N_STAB
)
340 if (sp
->n_un
.n_name
&& aout_db_eq_name(sp
, name
, incomplete
)) {
342 * In case of qaulified search by a file,
343 * return it immediately with some check.
344 * Otherwise, search external one
347 if ((file_sp
== *fp
) || (sp
->n_type
& N_EXT
))
349 } else if ((sp
->n_type
& N_EXT
) ||
350 (incomplete
&& !aout_db_is_filename(sp
->n_un
.n_name
)))
360 * Print sorted possible completions for a symbol.
361 * Use n_other field to mark completion symbols in order
365 aout_db_qualified_print_completion(
372 struct nlist
*ep1
= NULL
;
373 struct nlist
*fp
= 0;
382 sp
= aout_db_search_name((struct nlist
*)stab
->start
,
383 (struct nlist
*)stab
->end
,
385 if (sp
== (struct nlist
*)0)
388 symlen
= strlen(sym
);
391 if (strncmp(cur
->n_un
.n_name
, sym
, symlen
) == 0)
396 cur
= aout_db_search_name(cur
+ 1, (struct nlist
*)stab
->end
,
407 if (strncmp(&cur
->n_un
.n_name
[cur
->n_other
- 1],
408 &new->n_un
.n_name
[new->n_other
- 1],
416 if ((new->n_type
& N_EXT
) == 0) {
417 for (cur
= new - 1; cur
> (struct nlist
*)stab
->start
; cur
--) {
418 if (cur
->n_type
== N_SO
||
419 (stab
->sorted
&& cur
->n_value
< new->n_value
))
422 cur
->n_type
== N_SLINE
&&
423 cur
->n_value
== new->n_value
)
426 cur
->n_type
== N_FUN
&&
427 cur
->n_value
== new->n_value
)
431 if (cur
->n_type
== N_SO
)
432 fname
= cur
->n_un
.n_name
;
436 if (line
== 0 || func
== 0)
438 cur
< (struct nlist
*)stab
->end
; cur
++) {
439 if (cur
->n_type
== N_SO
||
440 (stab
->sorted
&& cur
->n_value
> new->n_value
))
443 cur
->n_type
== N_SLINE
&&
444 cur
->n_value
== new->n_value
) {
450 cur
->n_type
== N_FUN
&&
451 cur
->n_value
== new->n_value
) {
459 for (cur
= new - 1; cur
> (struct nlist
*)stab
->start
; cur
--) {
460 if (cur
->n_type
== N_SO
||
461 (stab
->sorted
&& cur
->n_value
< new->n_value
))
464 cur
->n_type
== N_FUN
&&
465 cur
->n_value
== new->n_value
)
470 cur
< (struct nlist
*)stab
->end
; cur
++) {
471 if (cur
->n_type
== N_SO
||
472 (stab
->sorted
&& cur
->n_value
> new->n_value
))
474 if (cur
->n_type
== N_FUN
&&
475 cur
->n_value
== new->n_value
) {
482 db_sym_print_completion(stab
, &new->n_un
.n_name
[new->n_other
- 1],
491 } else if (new == sp1
)
501 * search a (possibly incomplete) symbol with file, func and line qualification
504 aout_db_qualified_search(
513 register struct nlist
*sp
= (struct nlist
*)stab
->start
;
514 struct nlist
*ep
= (struct nlist
*)stab
->end
;
515 struct nlist
*fp
= 0;
516 struct nlist
*found_sp
;
517 unsigned long func_top
;
523 if (file
== 0 && sym
== 0)
526 if ((sp
= aout_db_search_name(sp
, ep
, file
, N_TEXT
, &fp
, 0)) == 0)
531 sp
= aout_db_search_name(sp
, ep
, sym
, (line
> 0)? N_FUN
: 0, &fp
,
532 (ret
== (db_sym_t
*)0));
538 if (strncmp(sp
->n_un
.n_name
, sym
, strlen(sym
)) == 0)
541 p
= &sp
->n_un
.n_name
[1];
543 if (*name
== (char *)0) {
547 for (i
= 0; i
< *len
; i
++)
548 if ((*name
)[i
] != p
[i
]) {
559 if (file
&& !aout_db_eq_name(fp
, file
, 0))
562 if (sp
->n_type
== N_FUN
) {
564 * qualfied by function name
565 * search backward because line number entries
566 * for the function are above it in this case.
568 func_top
= sp
->n_value
;
570 /* symbols with the same value may have been mixed up */
573 } while (sp
->n_value
== func_top
);
575 for (sp
--; sp
>= (struct nlist
*)stab
->start
; sp
--) {
576 if (sp
->n_type
!= N_SLINE
)
578 if (sp
->n_value
< func_top
)
580 if (sp
->n_desc
<= line
) {
581 if (found_sp
== 0 || found_sp
->n_desc
< sp
->n_desc
)
583 if (sp
->n_desc
== line
)
587 if (sp
->n_type
!= N_SLINE
|| sp
->n_value
< func_top
)
591 * qualified by only file name
592 * search forward in this case
596 /* symbols with the same value may have been mixed up */
597 func_top
= sp
->n_value
;
600 } while (sp
->n_value
== func_top
);
602 for (sp
++; sp
< ep
; sp
++) {
603 if (sp
->n_type
== N_TEXT
604 && aout_db_is_filename(sp
->n_un
.n_name
))
605 break; /* enter into another file */
606 if (sp
->n_type
== N_SOL
) {
607 in_file
= aout_db_eq_name(sp
, file
, 0);
610 if (!in_file
|| sp
->n_type
!= N_SLINE
)
612 if (sp
->n_desc
<= line
) {
613 if (found_sp
== 0 || found_sp
->n_desc
< sp
->n_desc
)
615 if (sp
->n_desc
== line
)
622 *ret
= (db_sym_t
) sp
;
627 * lookup symbol by name
634 return(db_sym_parse_and_lookup(aout_db_qualified_search
, stab
, symstr
));
638 * lookup (possibly incomplete) symbol by name
641 aout_db_lookup_incomplete(
648 return(db_sym_parse_and_lookup_incomplete(aout_db_qualified_search
,
649 stab
, symstr
, name
, len
, toadd
));
653 * Display possible completion for the symbol
656 aout_db_print_completion(stab
, symstr
)
661 return(db_sym_parse_and_print_completion(aout_db_qualified_print_completion
,
666 aout_db_search_symbol(
669 db_strategy_t strategy
,
670 db_expr_t
*diffp
) /* in/out */
672 db_expr_t diff
= *diffp
;
673 register struct nlist
*symp
= 0;
674 struct nlist
*sp
, *ep
, *cp
;
675 boolean_t first_pass
= FALSE
;
677 sp
= (struct nlist
*)symtab
->start
;
678 ep
= (struct nlist
*)symtab
->end
;
680 if (symtab
->sorted
) {
683 target
.n_value
= off
;
684 target
.n_un
.n_name
= (char *) 0;
685 target
.n_other
= (char) 0;
686 db_qsort_limit_search((char *)&target
, (char **)&sp
, (char **)&ep
,
687 sizeof(struct nlist
), aout_db_compare_symbols
);
692 for (cp
= ep
-1; cp
>= sp
; cp
--) {
693 if (cp
->n_un
.n_name
== 0)
695 if ((cp
->n_type
& N_STAB
) != 0)
697 if (strategy
== DB_STGY_XTRN
&& (cp
->n_type
& N_EXT
) == 0)
699 if (off
>= cp
->n_value
) {
700 if (off
- cp
->n_value
< diff
) {
701 diff
= off
- cp
->n_value
;
703 if (diff
== 0 && (cp
->n_type
& N_EXT
))
706 else if (off
- cp
->n_value
== diff
) {
709 else if ((symp
->n_type
& N_EXT
) == 0 &&
710 (cp
->n_type
& N_EXT
) != 0)
711 symp
= cp
; /* pick the external symbol */
718 sp
= (struct nlist
*) symtab
->start
;
726 return ((db_sym_t
)symp
);
730 * Return the name and value for a symbol.
733 aout_db_symbol_values(
738 register struct nlist
*sp
;
740 sp
= (struct nlist
*)sym
;
742 *namep
= sp
->n_un
.n_name
;
744 *valuep
= sp
->n_value
;
747 #define X_DB_MAX_DIFF 8 /* maximum allowable diff at the end of line */
748 extern unsigned int db_search_maxoff
; /* maximum acceptable offset */
751 * search symbol by value
754 aout_db_search_by_addr(
763 struct nlist
*sp
, *cp
;
764 register struct nlist
*line_sp
, *func_sp
, *file_sp
, *line_func
;
765 unsigned long func_diff
, line_diff
;
766 boolean_t found_line
= FALSE
;
767 struct nlist
*ep
= (struct nlist
*)stab
->end
;
768 boolean_t first_pass
= FALSE
;
772 * Added init of these two... not sure if it's correct, but
773 * can't be worse than random values.... -- jfriedl@omron.co.jp
775 func_diff
= line_diff
= /*HUGE*/0x0fffffff;
777 line_sp
= func_sp
= file_sp
= line_func
= 0;
782 sp
= (struct nlist
*)stab
->start
;
786 target
.n_value
= addr
;
787 target
.n_un
.n_name
= (char *) 0;
788 target
.n_other
= (char) 0;
789 db_qsort_limit_search((char *)&target
, (char **)&sp
,
790 (char **)&ep
, sizeof(struct nlist
),
791 aout_db_compare_symbols
);
795 for (cp
= sp
; cp
< ep
; cp
++) {
798 if (cp
->n_value
<= addr
) {
799 if (line_sp
== 0 || line_diff
>= addr
- cp
->n_value
) {
803 line_diff
= addr
- cp
->n_value
;
806 if (cp
->n_value
>= addr
&& line_sp
)
810 if ((found_line
|| (line_sp
&& line_diff
< X_DB_MAX_DIFF
))
815 if (cp
->n_value
> addr
)
817 if (file_sp
== 0 || file_sp
->n_value
<= cp
->n_value
)
821 if (aout_db_is_filename(cp
->n_un
.n_name
)) {
822 if (cp
->n_value
> addr
)
824 if (file_sp
== 0 || file_sp
->n_value
<= cp
->n_value
)
826 } else if (cp
->n_value
<= addr
&&
827 (func_sp
== 0 || func_diff
> addr
- cp
->n_value
)) {
829 func_diff
= addr
- cp
->n_value
;
833 if (cp
->n_value
<= addr
&&
834 (func_sp
== 0 || func_diff
>= addr
- cp
->n_value
)) {
836 func_diff
= addr
- cp
->n_value
;
837 if (func_diff
== 0 && file_sp
&& func_sp
&& line_sp
== 0)
842 if ((cp
->n_value
> addr
) &&
843 (cp
->n_value
- addr
> db_search_maxoff
))
850 if (first_pass
&& (!file_sp
|| !line_sp
|| !func_sp
)) {
853 sp
= (struct nlist
*)stab
->start
;
854 for (; cp
>= sp
; cp
--) {
861 if ((found_line
|| (line_sp
&& line_diff
< X_DB_MAX_DIFF
))
870 if (aout_db_is_filename(cp
->n_un
.n_name
)) {
873 } else if (func_sp
== 0) {
875 func_diff
= addr
- cp
->n_value
;
881 func_diff
= addr
- cp
->n_value
;
882 if (func_diff
== 0 && file_sp
&& func_sp
887 if (line_sp
&& file_sp
&&
888 addr
- cp
->n_value
> db_search_maxoff
)
897 * XXX - barbou@gr.osf.org
898 * I don't know if that code is useful to something, but it makes the -gline
899 * option of gcc useless.
902 if (line_func
== 0 || func_sp
== 0
903 || line_func
->n_value
!= func_sp
->n_value
)
907 if (line_sp
&& !found_line
) {
913 *diff
= addr
- file_sp
->n_value
;
914 *file
= file_sp
->n_un
.n_name
;
917 *diff
= addr
- line_sp
->n_value
;
918 *line
= line_sp
->n_desc
;
921 *diff
= addr
- func_sp
->n_value
;
922 *func
= (func_sp
->n_un
.n_name
[0] == '_')?
923 func_sp
->n_un
.n_name
+ 1: func_sp
->n_un
.n_name
;
924 if (line_func
&& (line_func
->n_desc
& 0x4000))
925 *args
= line_func
->n_desc
& 0x3ff;
927 return((db_sym_t
) func_sp
);
931 * Find filename and lineno within, given the current pc.
936 __unused db_sym_t sym
,
946 found
= (aout_db_search_by_addr(stab
, (unsigned)pc
, file
, &func
, line
,
949 return(found
&& func
&& *file
);
952 extern struct mach_header _mh_execute_header
;
954 * Initialization routine for a.out files.
959 aout_db_sym_init((char *) &_mh_execute_header
,
960 (char *)0, "mach", (char *)0);
963 #endif /* DB_NO_AOUT */