google-breakpad: new package

Breakpad is a library and tool suite that allows you to distribute an application to users with compiler-provided debugging information removed, record crashes in compact "minidump" files, send them back to your server, and produce C and C++ stack traces from these minidumps. Breakpad can also write minidumps on request for programs that have not crashed.

Signed-off-by Pascal Huerst <[email protected]>

---
 package/Config.in                                  |  1 +
 package/google-breakpad/Config.in                  | 21 ++++++++++++
 .../google-breakpad/google-breakpad-gen-syms.sh    | 37 ++++++++++++++++++++++
 package/google-breakpad/google-breakpad.mk         | 17 ++++++++++
 4 files changed, 76 insertions(+)
 create mode 100644 package/google-breakpad/Config.in
 create mode 100755 package/google-breakpad/google-breakpad-gen-syms.sh
 create mode 100644 package/google-breakpad/google-breakpad.mk

package/Config.in +1 -0

index 1706197..ea94f01 100644
@@ -54,6 +54,7 @@ source "package/dstat/Config.in"
 source "package/duma/Config.in"
 source "package/fio/Config.in"
 source "package/gdb/Config.in"
+source "package/google-breakpad/Config.in"
 source "package/iozone/Config.in"
 source "package/kexec/Config.in"
 source "package/ktap/Config.in"

package/google-breakpad/Config.in new file +0 -0

new file mode 100644
index 0000000..5c9e18b

package/google-breakpad/google-breakpad-gen-syms.sh new file +14 -0

+# Create directory structure
+SYMBOLS_DIR=$STAGING_DIR/usr/share/google-breakpad-symbols
+
+mkdir -p $SYMBOLS_DIR/tmp
+
+for BIN_PATH in $(eval $FIND_CMD); do
+	BIN=$(basename $BIN_PATH);
+	SYM=$BIN.sym;
+
+	$HOST_DIR/usr/bin/dump_syms $BIN_PATH > $SYMBOLS_DIR/tmp/$SYM 2>/dev/null;
+
+	if [ $? -eq 0 ]; then
+		HASH=$(head -n1 $SYMBOLS_DIR/tmp/$SYM | cut -d ' ' -f 4);
+		mkdir -p $SYMBOLS_DIR/$BIN/$HASH

package/google-breakpad/google-breakpad.mk new file +0 -0

new file mode 100644
index 0000000..e5b69c0

package/google-breakpad/google-breakpad.mk new file +6 -0

+GOOGLE_BREAKPAD_INSTALL_STAGING = YES
+GOOGLE_BREAKPAD_LICENSE = BSD-3c
+GOOGLE_BREAKPAD_LICENSE_FILES = LICENSE
+
+$(eval $(host-autotools-package))
+$(eval $(autotools-package))

Signature · 6 lines

1.9.3

_______________________________________________
buildroot mailing list
buildroot at busybox.net
http://lists.busybox.net/mailman/listinfo/buildroot

Quoted 4 lines

(quoted diff) +0 -0

b/package/google-breakpad/google-breakpad-gen-syms.sh new file mode 100755 index 0000000..e082875 --- /dev/null +++ b/package/google-breakpad/google-breakpad-gen-syms.sh

This script should have been part of your next patch.

Review +#!/bin/sh + +STAGING_DIR=$1 +HOST_DIR=$2

Quoted 1 line

(quoted diff) +0 -0

@@ -0,0 +1,37 @@ +#!/bin/sh + +STAGING_DIR=$1 +HOST_DIR=$2

Passing HOST_DIR is not needed. You should call the script with the EXTRA_ENV which contains the PATH variable, in the Makefile:

$(EXTRA_ENV) your-script your-args

Quoted 2 lines

(quoted diff) +1 -0

+INCLUDE_FILES=$3 + +# Search for files we want to dump symbols 

of +FIND_CMD="find $STAGING_DIR -name \"\""

Ugly hack. It took me a moment to understand what you wanted. See below for a suggested better way to achieve the same result.

Besides, not all package install their files in staging. You should use TARGET_DIR instead.

Review

Quoted 2 lines

(quoted diff) +1 -1

+for INCLUDE_FILE in $INCLUDE_FILES; do +	FIND_CMD="$FIND_CMD -o 
-name \"$INCLUDE_FILE\"" +done

This does not handle the case where two files would have the same basename but reside in different directories. For example:
/usr/bin/my-exec <- ELF file /data/config/my-exec <-
database

Please state that INCLUDE_FILES should be relative to $(TARGET_DIR). That way, we guarantee breakpad is not run against unwanted files, which would otherwise confuse the unsuspecting user.

Quoted 11 lines

(quoted diff) +3 -0

+# Create directory structure 
+SYMBOLS_DIR=$STAGING_DIR/usr/share/google-breakpad-symbols + 
+mkdir -p $SYMBOLS_DIR/tmp + +for BIN_PATH in $(eval $FIND_CMD); 

do + BIN=$(basename $BIN_PATH); + SYM=$BIN.sym; + +
$HOST_DIR/usr/bin/dump_syms $BIN_PATH > $SYMBOLS_DIR/tmp/$SYM
2>/dev/null; + + if [ $? -eq 0 ]; then + HASH=$(head -n1
$SYMBOLS_DIR/tmp/$SYM | cut -d ' ' -f 4); + mkdir -p
$SYMBOLS_DIR/$BIN/$HASH + mv $SYMBOLS_DIR/tmp/$SYM
$SYMBOLS_DIR/$BIN/$HASH; + else + rm -f $SYMBOLS_DIR/tmp/$SYM +
echo "Can not dump symbols of $BIN for google-breakpad!" + fi
+done + +rm -Rf $SYMBOLS_DIR/tmp + +exit 0

'exit 0' is not needed.

What about the following (untested)?

#!/bin/sh STAGING_DIR="${1}" TARGET_DIR="${2}" shift 2

symbols_dir="${STAGING_DIR}/usr/share/google-breakpad-symbols" rm -rf "${symbols_dir}" mkdir -p "${symbols_dir}/tmp"

cd "${TARGET_DIR}" for file in $(ls -1d "${@}"); do if [ -d "${file}" ]; then printf "Error: '%s' is a directory\n" "${file}"

Quoted 3 lines

&2 exit 1 fi if dump_syms "${file}" "${symbols_dir}/tmp/tmp.syms"; then sha1="$( printf "%s" "${file}"

|sha1sum |awk '{print $1}' )" mv "${symbols_dir}/tmp/tmp.syms" "${symbols_dir}/${sha1}.sym" printf "%s %s\n" "${sha1}" "${file}"

Quoted 2 lines

Quoted 2 lines

"${symbols_dir}/hashes.list" else printf "Error dumping symbols

for: '%s'\n" "${file}" >&2 exit 1 fi done rm -rf
"${symbols_dir}/tmp"

It is more concise, and handles mutilple files with the same name, and packages which do not install their files in STAGING_DIR.

${1} and ${2} are the staging and target dirs, so we store them and shift, so the remaining arguments are all the paths to files we want to extract symbols from.

We $(ls -1d) the args, in case one of them is a glob.

A directory argument is invalid. The user should use a glob.

We can use 'dump_syms' without full path since it is guaranteed to be in the PATH, as exported by the EXTRA_ENV variable used above.

We store the symbols in a file named after the sha1 of the filename. We could use the symbols file's hash if it is a strong enough hash (eg sha1 or above, but since I don;t know what hash dump_syms generates, I can't trust it to not collide). This allows to store symbols for file with the same name in different directories.

We store the correspondence {sha1,file} in a text file, so it is easy to retrieve the filename from a sha1, and conversely.

We exit as soon as we can't extract symbols from a file, as we want to catch it as a failure, instead of ignoring it.

Quoted 2 lines

Besides, not all package install their files in staging. You should use TARGET_DIR instead.

Aren't all binaries in TARGET_DIR stripped? If so, it doesn't really make sense to run gen_syms in TARGET_DIR.

Ok, I understand your concerns and the find-call is by far not perfect, but the whole reason why I setup the directory structure that way, is because googles minidump-stackwalk expects it that way. See:
https://code.google.com/p/google-breakpad/wiki/LinuxStarterGuide#Producing_symbols_for_your_application

package/google-breakpad/google-breakpad.mk new file +6 -0

+################################################################################
+#
+# google-breakpad
+#
+################################################################################
+

+$(eval $(autotools-package))
--
1.9.3

_______________________________________________
buildroot mailing list
buildroot at busybox.net
http://lists.busybox.net/mailman/listinfo/buildroot

This adds the symbol generation for google-breakpad to the Makefile and adds a list were users can insert libraries and binaries that should be symbol-dumped.

Signed-off-by Pascal Huerst <[email protected]>

---
 Config.in         | 10 ++++++++++
 Makefile          |  7 +++++++
 package/Config.in |  1 +
 3 files changed, 18 insertions(+)

Config.in +0 -0

index 0799cb7..0849146 100644

Makefile +5 -0

+		$(STAGING_DIR) \
+		$(HOST_DIR) \
+		"$(call qstrip,$(BR2_GOOGLE_BREAKPAD_INCLUDE_FILES))" 
+endif
+
 	rm -rf $(TARGET_DIR)/usr/lib/luarocks
 	$(STRIP_FIND_CMD) | xargs $(STRIPCMD) 2>/dev/null || true
 	if test -d $(TARGET_DIR)/lib/modules; then \

package/Config.in +0 -0

index ea94f01..47cb483 100644

package/Config.in +0 -0

 source "package/gsl/Config.in"
 source "package/gtest/Config.in"
 source "package/libargtable2/Config.in"

Signature · 6 lines

1.9.3

_______________________________________________
buildroot mailing list
buildroot at busybox.net
http://lists.busybox.net/mailman/listinfo/buildroot