contrib/llvm/tools/lldb/source/Plugins/Process/Utility/UnwindLLDB.cpp

   1 //===-- UnwindLLDB.cpp -------------------------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #include "lldb/Core/Module.h"
  11 #include "lldb/Core/Log.h"
  12 #include "lldb/Symbol/FuncUnwinders.h"
  13 #include "lldb/Symbol/Function.h"
  14 #include "lldb/Symbol/UnwindPlan.h"
  15 #include "lldb/Target/ABI.h"
  16 #include "lldb/Target/Thread.h"
  17 #include "lldb/Target/Target.h"
  18 #include "lldb/Target/Process.h"
  19 #include "lldb/Target/RegisterContext.h"
  20
  21 #include "UnwindLLDB.h"
  22 #include "RegisterContextLLDB.h"
  23
  24 using namespace lldb;
  25 using namespace lldb_private;
  26
  27 UnwindLLDB::UnwindLLDB (Thread &thread) :
  28     Unwind (thread),
  29     m_frames(),
  30     m_unwind_complete(false),
  31     m_user_supplied_trap_handler_functions()
  32 {
  33     ProcessSP process_sp(thread.GetProcess());
  34     if (process_sp)
  35     {
  36         Args args;
  37         process_sp->GetTarget().GetUserSpecifiedTrapHandlerNames (args);
  38         size_t count = args.GetArgumentCount();
  39         for (size_t i = 0; i < count; i++)
  40         {
  41             const char *func_name = args.GetArgumentAtIndex(i);
  42             m_user_supplied_trap_handler_functions.push_back (ConstString (func_name));
  43         }
  44     }
  45 }
  46
  47 uint32_t
  48 UnwindLLDB::DoGetFrameCount()
  49 {
  50     if (!m_unwind_complete)
  51     {
  52 //#define DEBUG_FRAME_SPEED 1
  53 #if DEBUG_FRAME_SPEED
  54 #define FRAME_COUNT 10000
  55         TimeValue time_value (TimeValue::Now());
  56 #endif
  57         if (!AddFirstFrame ())
  58             return 0;
  59
  60         ProcessSP process_sp (m_thread.GetProcess());
  61         ABI *abi = process_sp ? process_sp->GetABI().get() : NULL;
  62
  63         while (AddOneMoreFrame (abi))
  64         {
  65 #if DEBUG_FRAME_SPEED
  66             if ((m_frames.size() % FRAME_COUNT) == 0)
  67             {
  68                 TimeValue now(TimeValue::Now());
  69                 uint64_t delta_t = now - time_value;
  70                 printf ("%u frames in %" PRIu64 ".%09llu ms (%g frames/sec)\n",
  71                         FRAME_COUNT,
  72                         delta_t / TimeValue::NanoSecPerSec,
  73                         delta_t % TimeValue::NanoSecPerSec,
  74                         (float)FRAME_COUNT / ((float)delta_t / (float)TimeValue::NanoSecPerSec));
  75                 time_value = now;
  76             }
  77 #endif
  78         }
  79     }
  80     return m_frames.size ();
  81 }
  82
  83 bool
  84 UnwindLLDB::AddFirstFrame ()
  85 {
  86     if (m_frames.size() > 0)
  87         return true;
  88
  89     // First, set up the 0th (initial) frame
  90     CursorSP first_cursor_sp(new Cursor ());
  91     RegisterContextLLDBSP reg_ctx_sp (new RegisterContextLLDB (m_thread,
  92                                                                RegisterContextLLDBSP(),
  93                                                                first_cursor_sp->sctx,
  94                                                                0, *this));
  95     if (reg_ctx_sp.get() == NULL)
  96         goto unwind_done;
  97
  98     if (!reg_ctx_sp->IsValid())
  99         goto unwind_done;
 100
 101     if (!reg_ctx_sp->GetCFA (first_cursor_sp->cfa))
 102         goto unwind_done;
 103
 104     if (!reg_ctx_sp->ReadPC (first_cursor_sp->start_pc))
 105         goto unwind_done;
 106
 107     // Everything checks out, so release the auto pointer value and let the
 108     // cursor own it in its shared pointer
 109     first_cursor_sp->reg_ctx_lldb_sp = reg_ctx_sp;
 110     m_frames.push_back (first_cursor_sp);
 111     return true;
 112
 113 unwind_done:
 114     Log *log(GetLogIfAllCategoriesSet (LIBLLDB_LOG_UNWIND));
 115     if (log)
 116     {
 117         log->Printf ("th%d Unwind of this thread is complete.", m_thread.GetIndexID());
 118     }
 119     m_unwind_complete = true;
 120     return false;
 121 }
 122
 123 // For adding a non-zero stack frame to m_frames.
 124 bool
 125 UnwindLLDB::AddOneMoreFrame (ABI *abi)
 126 {
 127     // If we've already gotten to the end of the stack, don't bother to try again...
 128     if (m_unwind_complete)
 129         return false;
 130
 131     Log *log(GetLogIfAllCategoriesSet (LIBLLDB_LOG_UNWIND));
 132     CursorSP cursor_sp(new Cursor ());
 133
 134     // Frame zero is a little different
 135     if (m_frames.size() == 0)
 136         return false;
 137
 138     uint32_t cur_idx = m_frames.size ();
 139     RegisterContextLLDBSP reg_ctx_sp(new RegisterContextLLDB (m_thread,
 140                                                               m_frames[cur_idx - 1]->reg_ctx_lldb_sp,
 141                                                               cursor_sp->sctx,
 142                                                               cur_idx,
 143                                                               *this));
 144
 145     // We want to detect an unwind that cycles erronously and stop backtracing.
 146     // Don't want this maximum unwind limit to be too low -- if you have a backtrace
 147     // with an "infinitely recursing" bug, it will crash when the stack blows out
 148     // and the first 35,000 frames are uninteresting - it's the top most 5 frames that
 149     // you actually care about.  So you can't just cap the unwind at 10,000 or something.
 150     // Realistically anything over around 200,000 is going to blow out the stack space.
 151     // If we're still unwinding at that point, we're probably never going to finish.
 152     if (cur_idx > 300000)
 153     {
 154         if (log)
 155             log->Printf ("%*sFrame %d unwound too many frames, assuming unwind has gone astray, stopping.",
 156                          cur_idx < 100 ? cur_idx : 100, "", cur_idx);
 157         goto unwind_done;
 158     }
 159
 160     if (reg_ctx_sp.get() == NULL)
 161     {
 162         // If the RegisterContextLLDB has a fallback UnwindPlan, it will switch to that and return
 163         // true.  Subsequent calls to TryFallbackUnwindPlan() will return false.
 164         if (m_frames[cur_idx - 1]->reg_ctx_lldb_sp->TryFallbackUnwindPlan())
 165         {
 166             return AddOneMoreFrame (abi);
 167         }
 168         if (log)
 169             log->Printf ("%*sFrame %d did not get a RegisterContext, stopping.",
 170                          cur_idx < 100 ? cur_idx : 100, "", cur_idx);
 171         goto unwind_done;
 172     }
 173
 174     if (!reg_ctx_sp->IsValid())
 175     {
 176         // We failed to get a valid RegisterContext.
 177         // See if the regctx below this on the stack has a fallback unwind plan it can use.
 178         // Subsequent calls to TryFallbackUnwindPlan() will return false.
 179         if (m_frames[cur_idx - 1]->reg_ctx_lldb_sp->TryFallbackUnwindPlan())
 180         {
 181             return AddOneMoreFrame (abi);
 182         }
 183         if (log)
 184         {
 185             log->Printf("%*sFrame %d invalid RegisterContext for this frame, stopping stack walk",
 186                         cur_idx < 100 ? cur_idx : 100, "", cur_idx);
 187         }
 188         goto unwind_done;
 189     }
 190     if (!reg_ctx_sp->GetCFA (cursor_sp->cfa))
 191     {
 192         // If the RegisterContextLLDB has a fallback UnwindPlan, it will switch to that and return
 193         // true.  Subsequent calls to TryFallbackUnwindPlan() will return false.
 194         if (m_frames[cur_idx - 1]->reg_ctx_lldb_sp->TryFallbackUnwindPlan())
 195         {
 196             return AddOneMoreFrame (abi);
 197         }
 198         if (log)
 199         {
 200             log->Printf("%*sFrame %d did not get CFA for this frame, stopping stack walk",
 201                         cur_idx < 100 ? cur_idx : 100, "", cur_idx);
 202         }
 203         goto unwind_done;
 204     }
 205     if (abi && !abi->CallFrameAddressIsValid(cursor_sp->cfa))
 206     {
 207         // On Mac OS X, the _sigtramp asynchronous signal trampoline frame may not have
 208         // its (constructed) CFA aligned correctly -- don't do the abi alignment check for
 209         // these.
 210         if (reg_ctx_sp->IsTrapHandlerFrame() == false)
 211         {
 212             // See if we can find a fallback unwind plan for THIS frame.  It may be
 213             // that the UnwindPlan we're using for THIS frame was bad and gave us a
 214             // bad CFA.
 215             // If that's not it, then see if we can change the UnwindPlan for the frame
 216             // below us ("NEXT") -- see if using that other UnwindPlan gets us a better
 217             // unwind state.
 218             if (reg_ctx_sp->TryFallbackUnwindPlan() == false
 219                 || reg_ctx_sp->GetCFA (cursor_sp->cfa) == false
 220                 || abi->CallFrameAddressIsValid(cursor_sp->cfa) == false)
 221             {
 222                 if (m_frames[cur_idx - 1]->reg_ctx_lldb_sp->TryFallbackUnwindPlan())
 223                 {
 224                     return AddOneMoreFrame (abi);
 225                 }
 226                 if (log)
 227                 {
 228                     log->Printf("%*sFrame %d did not get a valid CFA for this frame, stopping stack walk",
 229                                 cur_idx < 100 ? cur_idx : 100, "", cur_idx);
 230                 }
 231                 goto unwind_done;
 232             }
 233             else
 234             {
 235                 if (log)
 236                 {
 237                     log->Printf("%*sFrame %d had a bad CFA value but we switched the UnwindPlan being used and got one that looks more realistic.",
 238                                 cur_idx < 100 ? cur_idx : 100, "", cur_idx);
 239                 }
 240             }
 241         }
 242     }
 243     if (!reg_ctx_sp->ReadPC (cursor_sp->start_pc))
 244     {
 245         // If the RegisterContextLLDB has a fallback UnwindPlan, it will switch to that and return
 246         // true.  Subsequent calls to TryFallbackUnwindPlan() will return false.
 247         if (m_frames[cur_idx - 1]->reg_ctx_lldb_sp->TryFallbackUnwindPlan())
 248         {
 249             return AddOneMoreFrame (abi);
 250         }
 251         if (log)
 252         {
 253             log->Printf("%*sFrame %d did not get PC for this frame, stopping stack walk",
 254                         cur_idx < 100 ? cur_idx : 100, "", cur_idx);
 255         }
 256         goto unwind_done;
 257     }
 258     if (abi && !abi->CodeAddressIsValid (cursor_sp->start_pc))
 259     {
 260         // If the RegisterContextLLDB has a fallback UnwindPlan, it will switch to that and return
 261         // true.  Subsequent calls to TryFallbackUnwindPlan() will return false.
 262         if (m_frames[cur_idx - 1]->reg_ctx_lldb_sp->TryFallbackUnwindPlan())
 263         {
 264             return AddOneMoreFrame (abi);
 265         }
 266         if (log)
 267         {
 268             log->Printf("%*sFrame %d did not get a valid PC, stopping stack walk",
 269                         cur_idx < 100 ? cur_idx : 100, "", cur_idx);
 270         }
 271         goto unwind_done;
 272     }
 273     if (!m_frames.empty())
 274     {
 275         // Infinite loop where the current cursor is the same as the previous one...
 276         if (m_frames.back()->start_pc == cursor_sp->start_pc && m_frames.back()->cfa == cursor_sp->cfa)
 277         {
 278             if (log)
 279                 log->Printf ("th%d pc of this frame is the same as the previous frame and CFAs for both frames are identical -- stopping unwind", m_thread.GetIndexID());
 280             goto unwind_done;
 281         }
 282     }
 283
 284     cursor_sp->reg_ctx_lldb_sp = reg_ctx_sp;
 285     m_frames.push_back (cursor_sp);
 286     return true;
 287
 288 unwind_done:
 289     if (log)
 290     {
 291         log->Printf ("th%d Unwind of this thread is complete.", m_thread.GetIndexID());
 292     }
 293     m_unwind_complete = true;
 294     return false;
 295 }
 296
 297 bool
 298 UnwindLLDB::DoGetFrameInfoAtIndex (uint32_t idx, addr_t& cfa, addr_t& pc)
 299 {
 300     if (m_frames.size() == 0)
 301     {
 302         if (!AddFirstFrame())
 303             return false;
 304     }
 305
 306     ProcessSP process_sp (m_thread.GetProcess());
 307     ABI *abi = process_sp ? process_sp->GetABI().get() : NULL;
 308
 309     while (idx >= m_frames.size() && AddOneMoreFrame (abi))
 310         ;
 311
 312     if (idx < m_frames.size ())
 313     {
 314         cfa = m_frames[idx]->cfa;
 315         pc = m_frames[idx]->start_pc;
 316         return true;
 317     }
 318     return false;
 319 }
 320
 321 lldb::RegisterContextSP
 322 UnwindLLDB::DoCreateRegisterContextForFrame (StackFrame *frame)
 323 {
 324     lldb::RegisterContextSP reg_ctx_sp;
 325     uint32_t idx = frame->GetConcreteFrameIndex ();
 326
 327     if (idx == 0)
 328     {
 329         return m_thread.GetRegisterContext();
 330     }
 331
 332     if (m_frames.size() == 0)
 333     {
 334         if (!AddFirstFrame())
 335             return reg_ctx_sp;
 336     }
 337
 338     ProcessSP process_sp (m_thread.GetProcess());
 339     ABI *abi = process_sp ? process_sp->GetABI().get() : NULL;
 340
 341     while (idx >= m_frames.size())
 342     {
 343         if (!AddOneMoreFrame (abi))
 344             break;
 345     }
 346
 347     const uint32_t num_frames = m_frames.size();
 348     if (idx < num_frames)
 349     {
 350         Cursor *frame_cursor = m_frames[idx].get();
 351         reg_ctx_sp = frame_cursor->reg_ctx_lldb_sp;
 352     }
 353     return reg_ctx_sp;
 354 }
 355
 356 UnwindLLDB::RegisterContextLLDBSP
 357 UnwindLLDB::GetRegisterContextForFrameNum (uint32_t frame_num)
 358 {
 359     RegisterContextLLDBSP reg_ctx_sp;
 360     if (frame_num < m_frames.size())
 361         reg_ctx_sp = m_frames[frame_num]->reg_ctx_lldb_sp;
 362     return reg_ctx_sp;
 363 }
 364
 365 bool
 366 UnwindLLDB::SearchForSavedLocationForRegister (uint32_t lldb_regnum, lldb_private::UnwindLLDB::RegisterLocation &regloc, uint32_t starting_frame_num, bool pc_reg)
 367 {
 368     int64_t frame_num = starting_frame_num;
 369     if (static_cast<size_t>(frame_num) >= m_frames.size())
 370         return false;
 371
 372     // Never interrogate more than one level while looking for the saved pc value.  If the value
 373     // isn't saved by frame_num, none of the frames lower on the stack will have a useful value.
 374     if (pc_reg)
 375     {
 376         UnwindLLDB::RegisterSearchResult result;
 377         result = m_frames[frame_num]->reg_ctx_lldb_sp->SavedLocationForRegister (lldb_regnum, regloc);
 378         if (result == UnwindLLDB::RegisterSearchResult::eRegisterFound)
 379           return true;
 380         else
 381           return false;
 382     }
 383     while (frame_num >= 0)
 384     {
 385         UnwindLLDB::RegisterSearchResult result;
 386         result = m_frames[frame_num]->reg_ctx_lldb_sp->SavedLocationForRegister (lldb_regnum, regloc);
 387
 388         // We descended down to the live register context aka stack frame 0 and are reading the value
 389         // out of a live register.
 390         if (result == UnwindLLDB::RegisterSearchResult::eRegisterFound
 391             && regloc.type == UnwindLLDB::RegisterLocation::eRegisterInLiveRegisterContext)
 392         {
 393             return true;
 394         }
 395
 396         // If we have unwind instructions saying that register N is saved in register M in the middle of
 397         // the stack (and N can equal M here, meaning the register was not used in this function), then
 398         // change the register number we're looking for to M and keep looking for a concrete  location
 399         // down the stack, or an actual value from a live RegisterContext at frame 0.
 400         if (result == UnwindLLDB::RegisterSearchResult::eRegisterFound
 401             && regloc.type == UnwindLLDB::RegisterLocation::eRegisterInRegister
 402             && frame_num > 0)
 403         {
 404             result = UnwindLLDB::RegisterSearchResult::eRegisterNotFound;
 405             lldb_regnum = regloc.location.register_number;
 406         }
 407
 408         if (result == UnwindLLDB::RegisterSearchResult::eRegisterFound)
 409             return true;
 410         if (result == UnwindLLDB::RegisterSearchResult::eRegisterIsVolatile)
 411             return false;
 412         frame_num--;
 413     }
 414     return false;
 415 }