#!/bin/sh
-# $PostgreSQL: pgsql/src/tools/find_typedef,v 1.10 2008/03/18 23:04:34 momjian Exp $
+# src/tools/find_typedef
# This script attempts to find all typedef's in the postgres binaries
-# by using 'nm' to report all typedef debugging symbols.
-#
-# For this program to work, you must have compiled all binaries with
-# debugging symbols.
+# by using 'objdump' or local equivalent to print typedef debugging symbols.
+# We need this because pgindent needs a list of typedef names.
#
-# This is run on BSD/OS 4.0 or Linux, so you may need to make changes.
-#
-# Ignore the nm errors about a file not being a binary file.
+# For this program to work, you must have compiled all code with
+# debugging symbols.
#
-# It gets typedefs by reading "STABS":
+# We intentionally examine all files in the targeted directories so as to
+# find both .o files and executables. Therefore, ignore error messages about
+# unsuitable files being fed to objdump.
#
-# http://www.informatik.uni-frankfurt.de/doc/texi/stabs_toc.html
+# This is known to work on Linux and on some BSDen, including Mac OS X.
#
-# objdump:
-# -G, --stabs Display (in raw form) any STABS info in the file
+# Caution: on the platforms we use, this only prints typedefs that are used
+# to declare at least one variable or struct field. If you have say
+# "typedef struct foo { ... } foo;", and then the structure is only ever
+# referenced as "struct foo", "foo" will not be reported as a typedef,
+# causing pgindent to indent the typedef definition oddly. This is not a
+# huge problem, since by definition there's just the one misindented line.
#
-# --stabs
-# Display the contents of the .stab, .stab.index, and
-# .stab.excl sections from an ELF file. This is only
-# useful on systems (such as Solaris 2.0) in which
-# .stab debugging symbol-table entries are carried in
-# an ELF section. In most other file formats, debug-
-# ging symbol-table entries are interleaved with
-# linkage symbols, and are visible in the --syms out-
-# put.
+# We get typedefs by reading "STABS":
+# http://www.informatik.uni-frankfurt.de/doc/texi/stabs_toc.html
if [ "$#" -eq 0 -o ! -d "$1" ]
do # if objdump -W is recognized, only one line of error should appear
if [ `objdump -W 2>&1 | wc -l` -eq 1 ]
then # Linux
- # unfortunately the Linux version doesn't show unreferenced typedefs
objdump -W "$DIR"/* |
- egrep -A3 '(DW_TAG_typedef|DW_TAG_structure_type|DW_TAG_union_type)' |
+ egrep -A3 '\(DW_TAG_typedef\)' |
awk ' $2 == "DW_AT_name" {print $NF}'
- else # BSD/OS
- objdump --stabs "$DIR"/* |
- awk ' $2 == "LSYM" && $7 ~ /:[tT]/ {sub(":.*", "", $7); print $7}'
+ elif [ `readelf -w 2>&1 | wc -l` -gt 1 ]
+ then # FreeBSD, similar output to Linux
+ readelf -w "$DIR"/* |
+ egrep -A3 '\(DW_TAG_typedef\)' |
+ awk ' $1 == "DW_AT_name" {print $NF}'
fi
done |
grep -v ' ' | # some typedefs have spaces, remove them