Skip to contentSkip to conversation

google-breakpad: Integration into Makefile and Config.in

PATCH Superseded Pascal Huerst 2 participants 4 messages Jul 30, 2014 – Aug 1, 2014

v8 of 9 Superseded Latest is v9 →

lore
Share & tools
lore
#0 lore raw

v8 cover google-breakpad: Integration into Makefile and Config.in

Changes v7 -> v8

	Removed use of eval in $(eval ls "${TARGET_DIR}/${@}"); do
	  as expected by Yann E. MORIN

Changes v6 -> v7
Removed comments I forgot to remove in v6 in gen-symy.sh for:
ifeq ($(BR2_PACKAGE_GOOGLE_BREAKPAD),y)
as suggested by Yann E. MORIN
Still using eval, however for:
for FILE in $(eval ls "${TARGET_DIR}/${@}"); do could not make it work without eval

Changes v5 -> v6
google-breakpad: new package has been accepted.
Moved parts from makefile into google-breakpad.mk and defined
the call to gen-symy.sh as a new variable in google-breakpas.mk. This seems to be more compatible with fabios series, as suggested by Arnout and Thomas.
Changed integration in Config.in, by adding an enable google breakpad
option which expands to a list to insert filenames as suggested by Arnout and Thomas.
Removed creation of tmp directory in gen-symy.sh as sugested
by Arnout, since this is not necessary.

Changes v4 -> v5 (All suggested by Yann E. MORIN)
Fixed some typo
Reorganized patch structure
which parts belong to 'new package' and which parts belong to 'intergration into Makefile and Config.in'
Changed and Rewrote gen-symy.sh - script
Passing $(EXTRA_ENV)
Adapted a proposed solution from Yann E. MORIN, which uses ls instead of find commands
Made better descriptions for users in:
Config.in
package/google-breakpad/Config.in

Changes v3 -> v4
Fixed minor issue in google-breakpad_gen-syms.sh
Had to remove -print from find command

Changes v2 -> v3 (All suggested by thomas.petazzoni at free-electrons.com)
Removed dependency of BR2_ENABLE_DEBUG, but added comment,
that this flag might have to be set in order to use breakpad properly.
Removed "find -name ..." for libs and binaries by generic patterns,
such as "*.so" and so forth. This will never work properly. Instead I added a list to insert libs and binaries, that will be symbol- dumped and prepared for breakpad (see Config.in patch v3 2/2)
Changed storage path for dumps from: $(TARGET_DIR).. to
$(STAGING_DIR)/usr/share/google-breakpad-symbols/
Removed most logic from Makefile. Added script instead, which is
called by Makefile
Added dependency for compatible targets: ARM, i386, MIPS... Set fixed version for checkout (instead of head)
Fixed typos, and some minor mistakes

Changes v1 -> v2 (All suggested by maxime.hadjinlian at gmail.com)
Added dependency from BR2_ENABLE_DEBUG
Removed symbolstore.py -> Its all done in Makefile now Removed new Target -> It in target-finalize before stripping now Added LICENSE and LICENSE_FILE to *.mk

Pascal Huerst (1):
google-breakpad: Integration into Makefile and Config.in

 Config.in                                  | 28 ++++++++++++++++++++++++++++
 package/google-breakpad/gen-syms.sh        | 25 +++++++++++++++++++++++++
 package/google-breakpad/google-breakpad.mk |  8 ++++++++
 3 files changed, 61 insertions(+)
 create mode 100755 package/google-breakpad/gen-syms.sh
Signature · 1 line
1.9.3
#1 lore raw

PATCH v8 1/1 google-breakpad: Integration into Makefile and Config.in

---
 Config.in                                  | 28 ++++++++++++++++++++++++++++
 package/google-breakpad/gen-syms.sh        | 25 +++++++++++++++++++++++++
 package/google-breakpad/google-breakpad.mk |  8 ++++++++
 3 files changed, 61 insertions(+)
 create mode 100755 package/google-breakpad/gen-syms.sh
Config.in +28 -0
index dd8073d..0d18ffd 100644
@@ -484,6 +484,34 @@ config BR2_OPTIMIZE_S
 
 endchoice
 
+config BR2_GOOGLE_BREAKPAD_ENABLE
+	bool "Enable google-breakpad support"
+	select BR2_PACKAGE_GOOGLE_BREAKPAD
+	help
+	  This option will enable the use of google breakpad, 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.
+
+if BR2_GOOGLE_BREAKPAD_ENABLE
+
+config BR2_GOOGLE_BREAKPAD_INCLUDE_FILES
+	string "List of executables and libraries to extract symbols from"
+	default ""
+	help
+	  You may specify a space-separated list of binaries and libraries
+	  with full paths relative to $(TARGET_DIR) of which debug symbols 
+	  will be dumped for further use with google breakpad.
+
+	  A directory structure that can be used by minidump-stackwalk will
+	  be created at:
+
+	  $(STAGING_DIR)/usr/share/google-breakpad-symbols
+
+endif
+
 config BR2_ENABLE_SSP
 	bool "build code with Stack Smashing Protection"
 	depends on BR2_TOOLCHAIN_HAS_SSP
package/google-breakpad/gen-syms.sh new file +25 -0
new file mode 100755
index 0000000..284d210
@@ -0,0 +1,25 @@
+#!/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}"
+
+for FILE in $(ls ${TARGET_DIR}/${@}); do
+	if [ -d "${FILE}" ]; then
+		printf "Error: '%s' is a directory\n" "${FILE}" >&2
+		exit 1
+	fi
+	if dump_syms "${FILE}" > "${SYMBOLS_DIR}/tmp.sym" 2>/dev/null; then
+		HASH=$(head -n1 "${SYMBOLS_DIR}/tmp.sym" | cut -d ' ' -f 4);
+		FILENAME=$(basename "$FILE");
+		mkdir -p "${SYMBOLS_DIR}/${FILENAME}/${HASH}"
+		mv "${SYMBOLS_DIR}/tmp.sym" "${SYMBOLS_DIR}/${FILENAME}/${HASH}/${FILENAME}.sym";
+	else
+		printf "Error dumping symbols for: '%s'\n" "${FILE}" >&2
+		exit 1
+	fi
+done
+rm -rf "${SYMBOLS_DIR}/tmp"
package/google-breakpad/google-breakpad.mk +8 -0
index bf857ba..8dea916 100644
@@ -14,5 +14,13 @@ GOOGLE_BREAKPAD_INSTALL_STAGING = YES
 GOOGLE_BREAKPAD_LICENSE = BSD-3c
 GOOGLE_BREAKPAD_LICENSE_FILES = LICENSE
 
+ifeq ($(BR2_PACKAGE_GOOGLE_BREAKPAD),y)
+define GOOGLE_BREAKPAD_EXTRACT_SYMBOLS
+	$(EXTRA_ENV) package/google-breakpad/gen-syms.sh $(STAGING_DIR) \
+		$(TARGET_DIR) $(call qstrip,$(BR2_GOOGLE_BREAKPAD_INCLUDE_FILES))
+endef
+TARGET_FINALIZE_HOOKS += GOOGLE_BREAKPAD_EXTRACT_SYMBOLS
+endif
+
 $(eval $(autotools-package))
 $(eval $(host-autotools-package))
Signature · 1 line
1.9.3
#2 lore raw

PATCH v8 1/1 google-breakpad: Integration into Makefile and Config.in

Pascal, All,

On 2014-07-30 17:27 +0200, Pascal Huerst spake thusly:

Quoted 2 lines

---

[--SNIP--]

Quoted 6 lines
package/google-breakpad/gen-syms.sh new file +0 -0
new file mode 100755
index 0000000..284d210

package/google-breakpad/gen-syms.sh line 10

Quoted 10 lines
package/google-breakpad/gen-syms.sh new file +10 -0
@@ -0,0 +1,25 @@
+#!/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}"
+
+for FILE in $(ls ${TARGET_DIR}/${@}); do

This is broken, since it would pick binaries from the host system.

For example, I set the list to: /bin/busybox /bin/bzip2

And it does not fail, even though we install bzip2 in /usr/bin/bzip2. That's because it picks my host's bzip2 which is /bin/bzip2.

I've reworked this script in my recent respin:

    http://patchwork.ozlabs.org/patch/375417/

package/google-breakpad/gen-syms.sh line 15

Quoted 5 lines
package/google-breakpad/gen-syms.sh new file +5 -0
+	if [ -d "${FILE}" ]; then
+		printf "Error: '%s' is a directory\n" "${FILE}" >&2
+		exit 1
+	fi
+	if dump_syms "${FILE}" > "${SYMBOLS_DIR}/tmp.sym" 2>/dev/null; then

We need to install host-google-breakpad, which so far nothing depends on, so it does not get installed unless you manually do it (either in the host system, or manually run 'make host-google-breakpad), which defeats the initial purpose of having an entry in the menuconfig.

I've fixed that in my respin, too.

Regards,
Yann E. MORIN.

Signature · 6 lines
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 223 225 172 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'
#3 lore raw

PATCH v8 1/1 google-breakpad: Integration into Makefile and Config.in

Hey Yann, all,

Quoted 30 lines · Yann E. MORIN

Pascal, All,

On 2014-07-30 17:27 +0200, Pascal Huerst spake thusly:

Quoted 2 lines

---

[--SNIP--]

Quoted 6 lines
package/google-breakpad/gen-syms.sh new file +0 -0
new file mode 100755
index 0000000..284d210

package/google-breakpad/gen-syms.sh line 10

Quoted 10 lines
package/google-breakpad/gen-syms.sh new file +10 -0
@@ -0,0 +1,25 @@
+#!/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}"
+
+for FILE in $(ls ${TARGET_DIR}/${@}); do

This is broken, since it would pick binaries from the host system.

For example, I set the list to: /bin/busybox /bin/bzip2

And it does not fail, even though we install bzip2 in /usr/bin/bzip2. That's because it picks my host's bzip2 which is /bin/bzip2.

Quoted 8 lines

I've reworked this script in my recent respin:

    http://patchwork.ozlabs.org/patch/375417/

package/google-breakpad/gen-syms.sh line 15

Quoted 5 lines
package/google-breakpad/gen-syms.sh new file +5 -0
+	if [ -d "${FILE}" ]; then
+		printf "Error: '%s' is a directory\n" "${FILE}" >&2
+		exit 1
+	fi
+	if dump_syms "${FILE}" > "${SYMBOLS_DIR}/tmp.sym" 2>/dev/null; then

I see, makes sense to me, Thanks!

Quoted 6 lines

We need to install host-google-breakpad, which so far nothing depends on, so it does not get installed unless you manually do it (either in the host system, or manually run 'make host-google-breakpad), which defeats the initial purpose of having an entry in the menuconfig.

I've fixed that in my respin, too.

You're right! I did a 'make host-google-breakpad' in my tree a while ago, that's why the tool where there. Forgot about that.

Quoted 3 lines

Regards,
Yann E. MORIN.