folly/experimental/symbolizer/Symbolizer.cpp

   1 /*
   2  * Copyright 2014 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include "folly/experimental/symbolizer/Symbolizer.h"
  18
  19 #include <limits.h>
  20 #include <cstdio>
  21 #include <iostream>
  22 #include <map>
  23
  24 #ifdef __GNUC__
  25 #include <ext/stdio_filebuf.h>
  26 #include <ext/stdio_sync_filebuf.h>
  27 #endif
  28
  29 #include "folly/Conv.h"
  30 #include "folly/FileUtil.h"
  31 #include "folly/ScopeGuard.h"
  32 #include "folly/String.h"
  33
  34 #include "folly/experimental/symbolizer/Elf.h"
  35 #include "folly/experimental/symbolizer/Dwarf.h"
  36 #include "folly/experimental/symbolizer/LineReader.h"
  37
  38
  39 namespace folly {
  40 namespace symbolizer {
  41
  42 namespace {
  43
  44 /**
  45  * Read a hex value.
  46  */
  47 uintptr_t readHex(StringPiece& sp) {
  48   uintptr_t val = 0;
  49   const char* p = sp.begin();
  50   for (; p != sp.end(); ++p) {
  51     unsigned int v;
  52     if (*p >= '0' && *p <= '9') {
  53       v = (*p - '0');
  54     } else if (*p >= 'a' && *p <= 'f') {
  55       v = (*p - 'a') + 10;
  56     } else if (*p >= 'A' && *p <= 'F') {
  57       v = (*p - 'A') + 10;
  58     } else {
  59       break;
  60     }
  61     val = (val << 4) + v;
  62   }
  63   sp.assign(p, sp.end());
  64   return val;
  65 }
  66
  67 /**
  68  * Skip over non-space characters.
  69  */
  70 void skipNS(StringPiece& sp) {
  71   const char* p = sp.begin();
  72   for (; p != sp.end() && (*p != ' ' && *p != '\t'); ++p) { }
  73   sp.assign(p, sp.end());
  74 }
  75
  76 /**
  77  * Skip over space and tab characters.
  78  */
  79 void skipWS(StringPiece& sp) {
  80   const char* p = sp.begin();
  81   for (; p != sp.end() && (*p == ' ' || *p == '\t'); ++p) { }
  82   sp.assign(p, sp.end());
  83 }
  84
  85 /**
  86  * Parse a line from /proc/self/maps
  87  */
  88 bool parseProcMapsLine(StringPiece line,
  89                        uintptr_t& from, uintptr_t& to,
  90                        StringPiece& fileName) {
  91   // from     to       perm offset   dev   inode             path
  92   // 00400000-00405000 r-xp 00000000 08:03 35291182          /bin/cat
  93   if (line.empty()) {
  94     return false;
  95   }
  96
  97   // Remove trailing newline, if any
  98   if (line.back() == '\n') {
  99     line.pop_back();
 100   }
 101
 102   // from
 103   from = readHex(line);
 104   if (line.empty() || line.front() != '-') {
 105     return false;
 106   }
 107   line.pop_front();
 108
 109   // to
 110   to = readHex(line);
 111   if (line.empty() || line.front() != ' ') {
 112     return false;
 113   }
 114   line.pop_front();
 115
 116   // perms
 117   skipNS(line);
 118   if (line.empty() || line.front() != ' ') {
 119     return false;
 120   }
 121   line.pop_front();
 122
 123   uintptr_t fileOffset = readHex(line);
 124   if (line.empty() || line.front() != ' ') {
 125     return false;
 126   }
 127   line.pop_front();
 128   if (fileOffset != 0) {
 129     return false;  // main mapping starts at 0
 130   }
 131
 132   // dev
 133   skipNS(line);
 134   if (line.empty() || line.front() != ' ') {
 135     return false;
 136   }
 137   line.pop_front();
 138
 139   // inode
 140   skipNS(line);
 141   if (line.empty() || line.front() != ' ') {
 142     return false;
 143   }
 144
 145   skipWS(line);
 146   if (line.empty()) {
 147     fileName.clear();
 148     return true;
 149   }
 150
 151   fileName = line;
 152   return true;
 153 }
 154
 155 ElfCache* defaultElfCache() {
 156   static constexpr size_t defaultCapacity = 500;
 157   static ElfCache cache(defaultCapacity);
 158   return &cache;
 159 }
 160
 161 }  // namespace
 162
 163 Symbolizer::Symbolizer(ElfCacheBase* cache)
 164   : cache_(cache ?: defaultElfCache()) {
 165 }
 166
 167 void Symbolizer::symbolize(const uintptr_t* addresses,
 168                            SymbolizedFrame* frames,
 169                            size_t addressCount) {
 170   size_t remaining = 0;
 171   for (size_t i = 0; i < addressCount; ++i) {
 172     auto& frame = frames[i];
 173     if (!frame.found) {
 174       ++remaining;
 175       frame.name.clear();
 176       frame.location = Dwarf::LocationInfo();
 177     }
 178   }
 179
 180   if (remaining == 0) {  // we're done
 181     return;
 182   }
 183
 184   int fd = openNoInt("/proc/self/maps", O_RDONLY);
 185   if (fd == -1) {
 186     return;
 187   }
 188
 189   char buf[PATH_MAX + 100];  // Long enough for any line
 190   LineReader reader(fd, buf, sizeof(buf));
 191
 192   while (remaining != 0) {
 193     StringPiece line;
 194     if (reader.readLine(line) != LineReader::kReading) {
 195       break;
 196     }
 197
 198     // Parse line
 199     uintptr_t from;
 200     uintptr_t to;
 201     StringPiece fileName;
 202     if (!parseProcMapsLine(line, from, to, fileName)) {
 203       continue;
 204     }
 205
 206     bool first = true;
 207     std::shared_ptr<ElfFile> elfFile;
 208
 209     // See if any addresses are here
 210     for (size_t i = 0; i < addressCount; ++i) {
 211       auto& frame = frames[i];
 212       if (frame.found) {
 213         continue;
 214       }
 215
 216       uintptr_t address = addresses[i];
 217
 218       if (from > address || address >= to) {
 219         continue;
 220       }
 221
 222       // Found
 223       frame.found = true;
 224       --remaining;
 225
 226       // Open the file on first use
 227       if (first) {
 228         first = false;
 229         elfFile = cache_->getFile(fileName);
 230       }
 231
 232       if (!elfFile) {
 233         continue;
 234       }
 235
 236       // Undo relocation
 237       uintptr_t fileAddress = address - from + elfFile->getBaseAddress();
 238       auto sym = elfFile->getDefinitionByAddress(fileAddress);
 239       if (!sym.first) {
 240         continue;
 241       }
 242       auto name = elfFile->getSymbolName(sym);
 243       if (name) {
 244         frame.name = name;
 245       }
 246
 247       Dwarf(elfFile.get()).findAddress(fileAddress, frame.location);
 248     }
 249   }
 250
 251   closeNoInt(fd);
 252 }
 253
 254 namespace {
 255 const char kHexChars[] = "0123456789abcdef";
 256 const SymbolizePrinter::Color kAddressColor = SymbolizePrinter::Color::BLUE;
 257 const SymbolizePrinter::Color kFunctionColor = SymbolizePrinter::Color::PURPLE;
 258 const SymbolizePrinter::Color kFileColor = SymbolizePrinter::Color::DEFAULT;
 259 }  // namespace
 260
 261 constexpr char AddressFormatter::bufTemplate[];
 262
 263 AddressFormatter::AddressFormatter() {
 264   memcpy(buf_, bufTemplate, sizeof(buf_));
 265 }
 266
 267 folly::StringPiece AddressFormatter::format(uintptr_t address) {
 268   // Can't use sprintf, not async-signal-safe
 269   static_assert(sizeof(uintptr_t) <= 8, "huge uintptr_t?");
 270   char* end = buf_ + sizeof(buf_) - 1 - (16 - 2 * sizeof(uintptr_t));
 271   char* p = end;
 272   *p-- = '\0';
 273   while (address != 0) {
 274     *p-- = kHexChars[address & 0xf];
 275     address >>= 4;
 276   }
 277
 278   return folly::StringPiece(buf_, end);
 279 }
 280
 281 void SymbolizePrinter::print(uintptr_t address, const SymbolizedFrame& frame) {
 282   if (options_ & TERSE) {
 283     printTerse(address, frame);
 284     return;
 285   }
 286
 287   SCOPE_EXIT { color(Color::DEFAULT); };
 288
 289   color(kAddressColor);
 290
 291   AddressFormatter formatter;
 292   doPrint(formatter.format(address));
 293
 294   const char padBuf[] = "                       ";
 295   folly::StringPiece pad(padBuf,
 296                          sizeof(padBuf) - 1 - (16 - 2 * sizeof(uintptr_t)));
 297
 298   color(kFunctionColor);
 299   char mangledBuf[1024];
 300   if (!frame.found) {
 301     doPrint(" (not found)");
 302     return;
 303   }
 304
 305   if (frame.name.empty()) {
 306     doPrint(" (unknown)");
 307   } else if (frame.name.size() >= sizeof(mangledBuf)) {
 308     doPrint(" ");
 309     doPrint(frame.name);
 310   } else {
 311     memcpy(mangledBuf, frame.name.data(), frame.name.size());
 312     mangledBuf[frame.name.size()] = '\0';
 313
 314     char demangledBuf[1024];
 315     demangle(mangledBuf, demangledBuf, sizeof(demangledBuf));
 316     doPrint(" ");
 317     doPrint(demangledBuf);
 318   }
 319
 320   if (!(options_ & NO_FILE_AND_LINE)) {
 321     color(kFileColor);
 322     char fileBuf[PATH_MAX];
 323     fileBuf[0] = '\0';
 324     if (frame.location.hasFileAndLine) {
 325       frame.location.file.toBuffer(fileBuf, sizeof(fileBuf));
 326       doPrint("\n");
 327       doPrint(pad);
 328       doPrint(fileBuf);
 329
 330       char buf[22];
 331       uint32_t n = uint64ToBufferUnsafe(frame.location.line, buf);
 332       doPrint(":");
 333       doPrint(StringPiece(buf, n));
 334     }
 335
 336     if (frame.location.hasMainFile) {
 337       char mainFileBuf[PATH_MAX];
 338       mainFileBuf[0] = '\0';
 339       frame.location.mainFile.toBuffer(mainFileBuf, sizeof(mainFileBuf));
 340       if (!frame.location.hasFileAndLine || strcmp(fileBuf, mainFileBuf)) {
 341         doPrint("\n");
 342         doPrint(pad);
 343         doPrint("-> ");
 344         doPrint(mainFileBuf);
 345       }
 346     }
 347   }
 348 }
 349
 350 namespace {
 351
 352 const std::map<SymbolizePrinter::Color, std::string> kColorMap = {
 353   { SymbolizePrinter::Color::DEFAULT,  "\x1B[0m" },
 354   { SymbolizePrinter::Color::RED,  "\x1B[31m" },
 355   { SymbolizePrinter::Color::GREEN,  "\x1B[32m" },
 356   { SymbolizePrinter::Color::YELLOW,  "\x1B[33m" },
 357   { SymbolizePrinter::Color::BLUE,  "\x1B[34m" },
 358   { SymbolizePrinter::Color::CYAN,  "\x1B[36m" },
 359   { SymbolizePrinter::Color::WHITE,  "\x1B[37m" },
 360   { SymbolizePrinter::Color::PURPLE,  "\x1B[35m" },
 361 };
 362
 363 }
 364
 365 void SymbolizePrinter::color(SymbolizePrinter::Color color) {
 366   if ((options_ & COLOR) == 0 &&
 367       ((options_ & COLOR_IF_TTY) == 0 || !isTty_)) {
 368     return;
 369   }
 370   auto it = kColorMap.find(color);
 371   if (it == kColorMap.end()) {
 372     return;
 373   }
 374   doPrint(it->second);
 375 }
 376
 377 void SymbolizePrinter::println(uintptr_t address,
 378                                const SymbolizedFrame& frame) {
 379   print(address, frame);
 380   doPrint("\n");
 381 }
 382
 383 void SymbolizePrinter::printTerse(uintptr_t address,
 384                                   const SymbolizedFrame& frame) {
 385   if (frame.found) {
 386     char mangledBuf[1024];
 387     memcpy(mangledBuf, frame.name.data(), frame.name.size());
 388     mangledBuf[frame.name.size()] = '\0';
 389
 390     char demangledBuf[1024] = {0};
 391     demangle(mangledBuf, demangledBuf, sizeof(demangledBuf));
 392     doPrint(strlen(demangledBuf) == 0 ? "(unknown)" : demangledBuf);
 393   } else {
 394     // Can't use sprintf, not async-signal-safe
 395     static_assert(sizeof(uintptr_t) <= 8, "huge uintptr_t?");
 396     char buf[] = "0x0000000000000000";
 397     char* end = buf + sizeof(buf) - 1 - (16 - 2 * sizeof(uintptr_t));
 398     char* p = end;
 399     *p-- = '\0';
 400     while (address != 0) {
 401       *p-- = kHexChars[address & 0xf];
 402       address >>= 4;
 403     }
 404     doPrint(StringPiece(buf, end));
 405   }
 406 }
 407
 408 void SymbolizePrinter::println(const uintptr_t* addresses,
 409                                const SymbolizedFrame* frames,
 410                                size_t frameCount) {
 411   for (size_t i = 0; i < frameCount; ++i) {
 412     println(addresses[i], frames[i]);
 413   }
 414 }
 415
 416 namespace {
 417
 418 int getFD(const std::ios& stream) {
 419 #ifdef __GNUC__
 420   std::streambuf* buf = stream.rdbuf();
 421   using namespace __gnu_cxx;
 422
 423   {
 424     auto sbuf = dynamic_cast<stdio_sync_filebuf<char>*>(buf);
 425     if (sbuf) {
 426       return fileno(sbuf->file());
 427     }
 428   }
 429   {
 430     auto sbuf = dynamic_cast<stdio_filebuf<char>*>(buf);
 431     if (sbuf) {
 432       return sbuf->fd();
 433     }
 434   }
 435 #endif  // __GNUC__
 436   return -1;
 437 }
 438
 439 bool isTty(int options, int fd) {
 440   return ((options & SymbolizePrinter::TERSE) == 0 &&
 441           (options & SymbolizePrinter::COLOR_IF_TTY) != 0 &&
 442           fd >= 0 && ::isatty(fd));
 443 }
 444
 445 }  // anonymous namespace
 446
 447 OStreamSymbolizePrinter::OStreamSymbolizePrinter(std::ostream& out, int options)
 448   : SymbolizePrinter(options, isTty(options, getFD(out))),
 449     out_(out) {
 450 }
 451
 452 void OStreamSymbolizePrinter::doPrint(StringPiece sp) {
 453   out_ << sp;
 454 }
 455
 456 FDSymbolizePrinter::FDSymbolizePrinter(int fd, int options)
 457   : SymbolizePrinter(options, isTty(options, fd)),
 458     fd_(fd) {
 459 }
 460
 461 void FDSymbolizePrinter::doPrint(StringPiece sp) {
 462   writeFull(fd_, sp.data(), sp.size());
 463 }
 464
 465 FILESymbolizePrinter::FILESymbolizePrinter(FILE* file, int options)
 466   : SymbolizePrinter(options, isTty(options, fileno(file))),
 467     file_(file) {
 468 }
 469
 470 void FILESymbolizePrinter::doPrint(StringPiece sp) {
 471   fwrite(sp.data(), 1, sp.size(), file_);
 472 }
 473
 474 void StringSymbolizePrinter::doPrint(StringPiece sp) {
 475   buf_.append(sp.data(), sp.size());
 476 }
 477
 478 }  // namespace symbolizer
 479 }  // namespace folly