Small fix.

[wxWidgets.git] / src / unix / stackwalk.cpp

diff --git a/src/unix/stackwalk.cpp b/src/unix/stackwalk.cpp
index 556eaf68379842fcab6c3e3181df09d957f37ba9..97612c94d12c28d4dc75ee167802b95f4e6398a6 100644 (file)
--- a/src/unix/stackwalk.cpp
+++ b/src/unix/stackwalk.cpp
@@ -27,9 +27,13 @@
 
 #ifndef WX_PRECOMP
     #include "wx/string.h"
 
 #ifndef WX_PRECOMP
     #include "wx/string.h"

+    #include "wx/app.h"
+    #include "wx/log.h"
+    #include "wx/utils.h"

 #endif
 
 #include "wx/stackwalk.h"
 #endif
 
 #include "wx/stackwalk.h"

+#include "wx/stdpaths.h"

 
 #include <execinfo.h>
 
 
 #include <execinfo.h>
 


@@ -37,27 +41,53 @@
     #include <cxxabi.h>
 #endif // HAVE_CXA_DEMANGLE
 
     #include <cxxabi.h>
 #endif // HAVE_CXA_DEMANGLE
 

+// ----------------------------------------------------------------------------
+// tiny helper wrapper around popen/pclose()
+// ----------------------------------------------------------------------------
+
+class wxStdioPipe
+{
+public:
+    // ctor parameters are passed to popen()
+    wxStdioPipe(const char *command, const char *type)
+    {
+        m_fp = popen(command, type);
+    }
+
+    // conversion to stdio FILE
+    operator FILE *() const { return m_fp; }
+
+    // dtor closes the pipe
+    ~wxStdioPipe()
+    {
+        if ( m_fp )
+            pclose(m_fp);
+    }
+
+private:
+    FILE *m_fp;
+
+    DECLARE_NO_COPY_CLASS(wxStdioPipe)
+};
+

 // ============================================================================
 // implementation
 // ============================================================================
 
 // ============================================================================
 // implementation
 // ============================================================================
 

-wxString wxStackWalker::ms_exepath;
-

 // ----------------------------------------------------------------------------
 // wxStackFrame
 // ----------------------------------------------------------------------------
 
 void wxStackFrame::OnGetName()
 {
 // ----------------------------------------------------------------------------
 // wxStackFrame
 // ----------------------------------------------------------------------------
 
 void wxStackFrame::OnGetName()
 {

-    if ( m_hasName )
+    if ( !m_name.empty() )

         return;
 
         return;
 

-    m_hasName = true;
-
-    // try addr2line first because it always gives us demangled names (even if
-    // __cxa_demangle is not available) and because it seems less error-prone
+    // we already tried addr2line in wxStackWalker::InitFrames: it always
+    // gives us demangled names (even if __cxa_demangle is not available) when
+    // the function is part of the ELF (when it's in a shared object addr2line
+    // will give "??") and because it seems less error-prone.

     // when it works, backtrace_symbols() sometimes returns incorrect results
     // when it works, backtrace_symbols() sometimes returns incorrect results

-    OnGetLocation();

 
     // format is: "module(funcname+offset) [address]" but the part in
     // parentheses can be not present
 
     // format is: "module(funcname+offset) [address]" but the part in
     // parentheses can be not present


@@ -97,92 +127,183 @@ void wxStackFrame::OnGetName()
                     m_offset = ofs;
             }
         }
                     m_offset = ofs;
             }
         }

+
+        m_module.assign(syminfo, posOpen);
+    }
+    else // not in "module(funcname+offset)" format
+    {
+        m_module = syminfo;

     }
     }

+}
+
+
+// ----------------------------------------------------------------------------
+// wxStackWalker
+// ----------------------------------------------------------------------------
+
+// that many frames should be enough for everyone
+#define MAX_FRAMES          200
+
+// we need a char buffer big enough to contain a call to addr2line with
+// up to MAX_FRAMES addresses !
+// NB: %p specifier will print the pointer in hexadecimal form
+//     and thus will require 2 chars for each byte + 3 for the
+//     " 0x" prefix
+#define CHARS_PER_FRAME    (sizeof(void*) * 2 + 3)

 
 

-    m_module.assign(syminfo, posOpen);
+// BUFSIZE will be 2250 for 32 bit machines
+#define BUFSIZE            (50 + MAX_FRAMES*CHARS_PER_FRAME)
+
+// static data
+void *wxStackWalker::ms_addresses[MAX_FRAMES];
+char **wxStackWalker::ms_symbols = NULL;
+int wxStackWalker::m_depth = 0;
+wxString wxStackWalker::ms_exepath;
+static char g_buf[BUFSIZE];
+
+
+void wxStackWalker::SaveStack(size_t maxDepth)
+{
+    // read all frames required
+    maxDepth = wxMin(WXSIZEOF(ms_addresses)/sizeof(void*), maxDepth);
+    m_depth = backtrace(ms_addresses, maxDepth*sizeof(void*));
+    if ( !m_depth )
+        return;
+
+    ms_symbols = backtrace_symbols(ms_addresses, m_depth);

 }
 
 }
 

-void wxStackFrame::OnGetLocation()
+void wxStackWalker::ProcessFrames(size_t skip)

 {
 {

-    if ( m_hasLocation )
+    wxStackFrame frames[MAX_FRAMES];
+
+    if (!ms_symbols || !m_depth)

         return;
 
         return;
 

-    m_hasLocation = true;
+    // we have 3 more "intermediate" frames which the calling code doesn't know
+    // about, account for them
+    skip += 3;
+
+    // call addr2line only once since this call may be very slow
+    // (it has to load in memory the entire EXE of this app which may be quite
+    //  big, especially if it contains debug info and is compiled statically!)
+    int towalk = InitFrames(frames, m_depth - skip, &ms_addresses[skip], &ms_symbols[skip]);

 
 

+    // now do user-defined operations on each frame
+    for ( int n = 0; n < towalk - (int)skip; n++ )
+        OnStackFrame(frames[n]);
+}
+
+void wxStackWalker::FreeStack()
+{
+    // ms_symbols has been allocated by backtrace_symbols() and it's the responsibility
+    // of the caller, i.e. us, to free that pointer
+    if (ms_symbols)
+        free( ms_symbols );
+    ms_symbols = NULL;
+    m_depth = 0;
+}
+
+int wxStackWalker::InitFrames(wxStackFrame *arr, size_t n, void **addresses, char **syminfo)
+{

     // we need to launch addr2line tool to get this information and we need to
     // have the program name for this
     wxString exepath = wxStackWalker::GetExePath();
     if ( exepath.empty() )
     {
     // we need to launch addr2line tool to get this information and we need to
     // have the program name for this
     wxString exepath = wxStackWalker::GetExePath();
     if ( exepath.empty() )
     {

-        if ( !wxTheApp || !wxTheApp->argv )
-            return;
-        exepath = wxTheApp->argv[0];
+        exepath = wxStandardPaths::Get().GetExecutablePath();
+        if ( exepath.empty() )
+        {
+            wxLogDebug(wxT("Cannot parse stack frame because the executable ")
+                       wxT("path could not be detected"));
+            return 0;
+        }
+    }
+
+    // build the (long) command line for executing addr2line in an optimized way
+    // (e.g. use always chars, even in Unicode build: popen() always takes chars)
+    int len = snprintf(g_buf, BUFSIZE, "addr2line -C -f -e \"%s\"", (const char*) exepath.mb_str());
+    len = (len <= 0) ? strlen(g_buf) : len;     // in case snprintf() is broken
+    for (size_t i=0; i<n; i++)
+    {
+        snprintf(&g_buf[len], BUFSIZE - len, " %p", addresses[i]);
+        len = strlen(g_buf);

     }
 
     }
 

-    wxArrayString output;
-    wxLogNull noLog;
-    if ( wxExecute(wxString::Format(_T("addr2line -C -f -e \"%s\" %p"),
-                                    exepath.c_str(),
-                                    m_address), output) == 0 )
+    //wxLogDebug(wxT("piping the command '%s'"), g_buf);  // for debug only
+
+    wxStdioPipe fp(g_buf, "r");
+    if ( !fp )
+        return 0;
+
+    // parse addr2line output (should be exactly 2 lines for each address)
+    // reusing the g_buf used for building the command line above
+    wxString name, filename;
+    unsigned long line, curr=0;
+    for (size_t i=0; i<n; i++)

     {
     {

-        if ( output.GetCount() != 2 )
+        // 1st line has function name
+        if ( fgets(g_buf, WXSIZEOF(g_buf), fp) )

         {
         {

-            wxLogDebug(_T("Unexpected addr2line output."));
+            name = wxString::FromAscii(g_buf);
+            name.RemoveLast(); // trailing newline
+
+            if ( name == _T("??") )
+                name.clear();

         }
         }

-        else // 1st line has function name, 2nd one -- the file/line info
+        else

         {
         {

-            if ( GetName().empty() )
-            {
-                m_name = output[0];
-                if ( m_name == _T("??") )
-                    m_name.clear();
-            }
+            wxLogDebug(_T("cannot read addr2line output for %d-th stack frame!"), i);
+            return false;
+        }
+
+        // 2nd one -- the file/line info
+        if ( fgets(g_buf, WXSIZEOF(g_buf), fp) )
+        {
+            filename = wxString::FromAscii(g_buf);
+            filename.RemoveLast();

 
 

-            const size_t posColon = output[1].find(_T(':'));
+            const size_t posColon = filename.find(_T(':'));

             if ( posColon != wxString::npos )
             {
             if ( posColon != wxString::npos )
             {

-                m_filename.assign(output[1], 0, posColon);
-                if ( m_filename == _T("??") )
-                {
-                    m_filename.clear();
-                }
-                else
-                {
-                    unsigned long line;
-                    if ( wxString(output[1], posColon + 1, wxString::npos).
-                            ToULong(&line) )
-                        m_line = line;
-                }
+                // parse line number
+                if ( !wxString(filename, posColon + 1, wxString::npos).
+                        ToULong(&line) )
+                    line = 0;
+
+                // remove line number from 'filename'
+                filename.erase(posColon);
+                if ( filename == _T("??") )
+                    filename.clear();

             }
             else
             {
             }
             else
             {

-                wxLogDebug(_T("Unexpected addr2line format: \"%s\""),
-                           output[1].c_str());
+                wxLogDebug(_T("Unexpected addr2line format: \"%s\" - ")
+                           _T("the semicolon is missing"),
+                           filename.c_str());

             }
         }
             }
         }

+
+        if (!name.empty() || !filename.empty())
+        {
+            // now we've got enough info to initialize curr-th stack frame:
+            arr[curr++].Set(name, filename, syminfo[i], i, line, addresses[i]);
+        }

     }
     }

-}

 
 

-// ----------------------------------------------------------------------------
-// wxStackWalker
-// ----------------------------------------------------------------------------
+    return curr;
+}

 
 

-void wxStackWalker::Walk(size_t skip)
+void wxStackWalker::Walk(size_t skip, size_t maxDepth)

 {
 {

-    // that many frames should be enough for everyone
-    void *addresses[200];
+    // read all frames required
+    SaveStack(maxDepth);

 
 

-    int depth = backtrace(addresses, WXSIZEOF(addresses));
-    if ( !depth )
-        return;
-
-    char **symbols = backtrace_symbols(addresses, depth);
+    // process them
+    ProcessFrames(skip);

 
 

-    for ( int n = 0; n < depth; n++ )
-    {
-        wxStackFrame frame(n, addresses[n], symbols[n]);
-        OnStackFrame(frame);
-    }
+    // cleanup
+    FreeStack();

 }
 
 #endif // wxUSE_STACKWALKER
 }
 
 #endif // wxUSE_STACKWALKER