first stab at supporting custom renderers

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

diff --git a/src/unix/stackwalk.cpp b/src/unix/stackwalk.cpp
index b8b92ef92470ab822cf3223d2890d54fed4eec63..6c234adbea4b33120309d5e9f68672ff0cdafa1f 100644 (file)
--- a/src/unix/stackwalk.cpp
+++ b/src/unix/stackwalk.cpp
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        msw/stackwalk.cpp
+// Name:        src/unix/stackwalk.cpp

 // Purpose:     wxStackWalker implementation for Unix/glibc
 // Author:      Vadim Zeitlin
 // Modified by:
 // Purpose:     wxStackWalker implementation for Unix/glibc
 // Author:      Vadim Zeitlin
 // Modified by:


@@ -33,6 +33,7 @@
 #endif
 
 #include "wx/stackwalk.h"
 #endif
 
 #include "wx/stackwalk.h"

+#include "wx/stdpaths.h"

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


@@ -66,41 +67,38 @@ public:
 private:
     FILE *m_fp;
 
 private:
     FILE *m_fp;
 

-    DECLARE_NO_COPY_CLASS(wxStdioPipe)
+    wxDECLARE_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
     wxString syminfo = wxString::FromAscii(m_syminfo);
 
     // format is: "module(funcname+offset) [address]" but the part in
     // parentheses can be not present
     wxString syminfo = wxString::FromAscii(m_syminfo);

-    const size_t posOpen = syminfo.find(_T('('));
+    const size_t posOpen = syminfo.find(wxT('('));

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

-        const size_t posPlus = syminfo.find(_T('+'), posOpen + 1);
+        const size_t posPlus = syminfo.find(wxT('+'), posOpen + 1);

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

-            const size_t posClose = syminfo.find(_T(')'), posPlus + 1);
+            const size_t posClose = syminfo.find(wxT(')'), posPlus + 1);

             if ( posClose != wxString::npos )
             {
                 if ( m_name.empty() )
             if ( posClose != wxString::npos )
             {
                 if ( m_name.empty() )


@@ -129,106 +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;
+    }
+}
+

 
 

-    m_module.assign(syminfo, posOpen);
+// ----------------------------------------------------------------------------
+// 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)
+
+// 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;
+        }

     }
 
     }
 

-    wxStdioPipe fp(wxString::Format(_T("addr2line -C -f -e \"%s\" %p"),
-                                    exepath.c_str(), m_address).mb_str(),
-                   "r");
-
-    if ( !fp )
-        return;
-
-    // parse addr2line output
-    char buf[1024];
-    if ( !fgets(buf, WXSIZEOF(buf), fp) )
+    // 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++)

     {
     {

-        wxLogDebug(_T("Empty addr2line output?"));
-        return;
+        snprintf(&g_buf[len], BUFSIZE - len, " %p", addresses[i]);
+        len = strlen(g_buf);

     }
 
     }
 

-    // 1st line has function name
-    if ( GetName().empty() )
-    {
-        m_name = wxString::FromAscii(buf);
-        m_name.RemoveLast(); // trailing newline
-
-        if ( m_name == _T("??") )
-            m_name.clear();
-    }
+    //wxLogDebug(wxT("piping the command '%s'"), g_buf);  // for debug only

 
 

-    // 2nd one -- the file/line info
-    if ( fgets(buf, WXSIZEOF(buf), fp) )
+    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 = 0,
+                  curr = 0;
+    for  ( size_t i = 0; i < n; i++ )

     {
     {

-        wxString output(wxString::FromAscii(buf));
-        output.RemoveLast();
+        // 1st line has function name
+        if ( fgets(g_buf, WXSIZEOF(g_buf), fp) )
+        {
+            name = wxString::FromAscii(g_buf);
+            name.RemoveLast(); // trailing newline
+
+            if ( name == wxT("??") )
+                name.clear();
+        }
+        else
+        {
+            wxLogDebug(wxT("cannot read addr2line output for stack frame #%lu"),
+                       (unsigned long)i);
+            return false;
+        }

 
 

-        const size_t posColon = output.find(_T(':'));
-        if ( posColon != wxString::npos )
+        // 2nd one -- the file/line info
+        if ( fgets(g_buf, WXSIZEOF(g_buf), fp) )

         {
         {

-            m_filename.assign(output, 0, posColon);
-            if ( m_filename == _T("??") )
+            filename = wxString::FromAscii(g_buf);
+            filename.RemoveLast();
+
+            const size_t posColon = filename.find(wxT(':'));
+            if ( posColon != wxString::npos )

             {
             {

-                m_filename.clear();
+                // parse line number (it's ok if it fails, this will just leave
+                // line at its current, invalid, 0 value)
+                wxString(filename, posColon + 1, wxString::npos).ToULong(&line);
+
+                // remove line number from 'filename'
+                filename.erase(posColon);
+                if ( filename == wxT("??") )
+                    filename.clear();

             }
             else
             {
             }
             else
             {

-                unsigned long line;
-                if ( wxString(output, posColon + 1, wxString::npos).
-                        ToULong(&line) )
-                    m_line = line;
+                wxLogDebug(wxT("Unexpected addr2line format: \"%s\" - ")
+                           wxT("the semicolon is missing"),
+                           filename.c_str());

             }
         }
             }
         }

-        else
-        {
-            wxLogDebug(_T("Unexpected addr2line format: \"%s\""),
-                       output.c_str());
-        }
+
+        // now we've got enough info to initialize curr-th stack frame
+        // (at worst, only addresses[i] and syminfo[i] have been initialized,
+        //  but wxStackFrame::OnGetName may still be able to get function name):
+        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];
-
-    int depth = backtrace(addresses, WXSIZEOF(addresses));
-    if ( !depth )
-        return;
+    // read all frames required
+    SaveStack(maxDepth);

 
 

-    char **symbols = backtrace_symbols(addresses, depth);
+    // process them
+    ProcessFrames(skip);

 
 

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

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