Merge lp:~darkxst/apport/sandbox-autoload into lp:~apport-hackers/apport/trunk

[Tim Lunn]

This is mostly useful for glib based apps to get the pretty printers working, which gives improved output on gobjects and signals. Though there are a few other packages that ship them as well.

apport-retrace when run against the system filesystem would already pick up these scripts.

[Martin Pitt (pitti)]

Very nice, thanks! Will that append to the default search path, or completely replace it? https://sourceware.org/gdb/onlinedocs/gdb/objfile_002dgdbdotext-file.html#set%20auto-load%20scripts-directory doesn't really tell.. We certainly do want to keep gdb's scripts on the host, just additionally load the ones in the sandbox.

review: Needs Information

[Tim Lunn (darkxst)]

It currently replaces the search path, which seems fine to me since the scripts are always versioned with soname, so doesnt make sense to load them from the host. (actually thats not entirely true, python has a wrapper for the binary which obviously not versioned.)

auto-load: Attempted file "/lib/x86_64-linux-gnu/libglib-2.0.so.0.4391.0-gdb.gdb" does not exist.
auto-load: Attempted file "sandbox/usr/share/gdb/auto-load/lib/x86_64-linux-gnu/libglib-2.0.so.0.4391.0-gdb.gdb" does not exist.
auto-load: Attempted file "/lib/x86_64-linux-gnu/libglib-2.0.so.0.4391.0-gdb.py" does not exist.
auto-load: Attempted file "sandbox/usr/share/gdb/auto-load/lib/x86_64-linux-gnu/libglib-2.0.so.0.4391.0-gdb.py" exists.
auto-load: Loading python script "sandbox/usr/share/gdb/auto-load/lib/x86_64-linux-gnu/libglib-2.0.so.0.4391.0-gdb.py" by extension for objfile "/lib/x86_64-linux-gnu/libglib-2.0.so.0".
auto-load: Matching file "sandbox/usr/share/gdb/auto-load/lib/x86_64-linux-gnu/libglib-2.0.so.0.4391.0-gdb.py" to pattern "sandbox/usr/share/gdb/auto-load"
auto-load: File "sandbox/usr/share/gdb/auto-load/lib/x86_64-linux-gnu/libglib-2.0.so.0.4391.0-gdb.py" matches directory "sandbox/usr/share/gdb/auto-load".

The default search path is
(gdb) show auto-load scripts-directory
List of directories from which to load auto-loaded scripts is $debugdir:$datadir/auto-load

So could use the following to append to the default search paths
set auto-load scripts-directory $debugdir:$datadir/auto-load:sandbox/$debugdir:sandbox/$datadir/auto-load

[lp:~darkxst/apport/sandbox-autoload]

2931. By Tim Lunn on 2015-03-12

search both host and sandbox for scripts

[Tim Lunn (darkxst)]

actually the solib prefix gets inserted in the path, so we will never match a script on the system $debugdir is already sandbox-ified. we also need to insert a symlink into the sandbox so the path can match

auto-load: Attempted file "/tmp/apport_sandbox_74lv3Y//usr/share/gdb/auto-load/tmp/apport_sandbox_74lv3Y/lib/x86_64-linux-gnu/libglib-2.0.so.0.4391.0-gdb.py" exists.

[lp:~darkxst/apport/sandbox-autoload]

2932. By Tim Lunn on 2015-03-13

clean up search path and insert a symlinnk into the sandbox so we match full solib path

[Tim Lunn (darkxst)]

This is better:
$ apport-retrace -g -S config /var/crash/_usr_bin_gjs-console.1000.crash
(gdb) info auto-load python-scripts
Loaded Script
Yes /tmp/apport_sandbox_eMbqCa//usr/share/gdb/auto-load/tmp/apport_sandbox_eMbqCa/lib/x86_64-linux-gnu/libglib-2.0.so.0.4391.0-gdb.py
Yes /tmp/apport_sandbox_eMbqCa//usr/share/gdb/auto-load/tmp/apport_sandbox_eMbqCa/usr/lib/x86_64-linux-gnu/libgobject-2.0.so.0.4391.0-gdb.py
Yes /tmp/apport_sandbox_eMbqCa//usr/share/gdb/auto-load/tmp/apport_sandbox_eMbqCa/usr/lib/x86_64-linux-gnu/libstdc++.so.6.0.20-gdb.py

Unmerged revisions

2932. By Tim Lunn on 2015-03-13

clean up search path and insert a symlinnk into the sandbox so we match full solib path

2931. By Tim Lunn on 2015-03-12

search both host and sandbox for scripts

2930. By Tim Lunn on 2015-03-12

use sandbox for gdb auto-load scripts

This allows for the pretty printers to work

=== modified file 'apport/report.py'
--- apport/report.py	2015-02-10 10:21:40 +0000
+++ apport/report.py	2015-03-13 02:05:48 +0000
@@ -9,7 +9,7 @@
 # option) any later version.  See http://www.gnu.org/copyleft/gpl.html for
 # the full text of the license.
 
-import subprocess, tempfile, os.path, re, pwd, grp, os, time
+import subprocess, tempfile, os.path, re, pwd, grp, os, time, shutil
 import fnmatch, glob, traceback, errno, sys, atexit, locale
 
 import xml.dom, xml.dom.minidom
@@ -688,6 +688,7 @@
         # call gdb
         try:
             out = _command_output(gdb_cmd).decode('UTF-8', errors='replace')
+            self.autoload_clean(rootdir)
         except OSError:
             return
 
@@ -1461,6 +1462,21 @@
                     else:
                         self[k] = pattern.sub(repl, self[k])
 
+    def autoload_links(self, sandbox):
+        rel_sandbox = sandbox.lstrip(os.path.sep)
+        base = rel_sandbox.rsplit(os.path.sep,1)[0]
+        autoload_path = os.path.join(sandbox, 'usr', 'share', 'gdb', 'auto-load')
+        base_path = os.path.join(autoload_path, base)
+        if not os.path.exists(base_path) and len(base) > 1:
+            os.makedirs(base_path)
+        if not os.path.exists(os.path.join(autoload_path, rel_sandbox)):
+            os.symlink(autoload_path, os.path.join(autoload_path, rel_sandbox))
+
+    def autoload_clean(self,sandbox):
+        if sandbox:
+            rel_sandbox = sandbox.lstrip('/')
+            shutil.rmtree(os.path.join(sandbox, 'usr', 'share', 'gdb', 'auto-load', rel_sandbox.split(os.path.sep)[0]))
+
     def gdb_command(self, sandbox):
         '''Build gdb command for this report.
 
@@ -1501,8 +1517,12 @@
             # note, i386 vs. x86_64 is auto-detected just fine
 
         if sandbox:
+            self.autoload_links(sandbox)
+            scripts_path = '$debugdir:%s/$datadir/auto-load' % sandbox
             command += ['--ex', 'set debug-file-directory %s/usr/lib/debug' % sandbox,
-                        '--ex', 'set solib-absolute-prefix ' + sandbox]
+                        '--ex', 'set solib-absolute-prefix ' + sandbox,
+                        '--ex', 'set auto-load scripts-directory ' + scripts_path,
+                        '--ex', 'set auto-load safe-path ' + scripts_path]
             executable = sandbox + '/' + executable
 
         assert os.path.exists(executable)
 
=== modified file 'bin/apport-retrace'
--- bin/apport-retrace	2014-08-29 10:32:33 +0000
+++ bin/apport-retrace	2015-03-13 02:05:48 +0000
@@ -316,6 +316,7 @@
         apport.log('Calling gdb command: ' + cmd, log_timestamps)
     apport.memdbg('before calling gdb')
     subprocess.call(gdb_cmd)
+    report.autoload_clean(sandbox)
 else:
     # regenerate gdb info
     apport.memdbg('before collecting gdb info')