folly/Demangle.cpp

   1 /*
   2  * Copyright 2015 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/Demangle.h>
  18
  19 #include <algorithm>
  20 #include <string.h>
  21
  22 #include <folly/Malloc.h>
  23 #include <folly/String.h>
  24
  25 #if FOLLY_HAVE_CPLUS_DEMANGLE_V3_CALLBACK
  26 # include <cxxabi.h>
  27
  28 // From libiberty
  29 //
  30 // TODO(tudorb): Detect this with autoconf for the open-source version.
  31 //
  32 // __attribute__((__weak__)) doesn't work, because cplus_demangle_v3_callback
  33 // is exported by an object file in libiberty.a, and the ELF spec says
  34 // "The link editor does not extract archive members to resolve undefined weak
  35 // symbols" (but, interestingly enough, will resolve undefined weak symbols
  36 // with definitions from archive members that were extracted in order to
  37 // resolve an undefined global (strong) symbol)
  38
  39 # ifndef DMGL_NO_OPTS
  40 #  define FOLLY_DEFINED_DMGL 1
  41 #  define DMGL_NO_OPTS    0          /* For readability... */
  42 #  define DMGL_PARAMS     (1 << 0)   /* Include function args */
  43 #  define DMGL_ANSI       (1 << 1)   /* Include const, volatile, etc */
  44 #  define DMGL_JAVA       (1 << 2)   /* Demangle as Java rather than C++. */
  45 #  define DMGL_VERBOSE    (1 << 3)   /* Include implementation details.  */
  46 #  define DMGL_TYPES      (1 << 4)   /* Also try to demangle type encodings.  */
  47 #  define DMGL_RET_POSTFIX (1 << 5)  /* Print function return types (when
  48                                         present) after function signature */
  49 # endif
  50
  51 extern "C" int cplus_demangle_v3_callback(
  52     const char* mangled,
  53     int options,  // We use DMGL_PARAMS | DMGL_TYPES, aka 0x11
  54     void (*callback)(const char*, size_t, void*),
  55     void* arg);
  56
  57 #endif
  58
  59 namespace folly {
  60
  61 #if FOLLY_HAVE_CPLUS_DEMANGLE_V3_CALLBACK
  62
  63 fbstring demangle(const char* name) {
  64   int status;
  65   size_t len = 0;
  66   // malloc() memory for the demangled type name
  67   char* demangled = abi::__cxa_demangle(name, nullptr, &len, &status);
  68   if (status != 0) {
  69     return name;
  70   }
  71   // len is the length of the buffer (including NUL terminator and maybe
  72   // other junk)
  73   return fbstring(demangled, strlen(demangled), len, AcquireMallocatedString());
  74 }
  75
  76 namespace {
  77
  78 struct DemangleBuf {
  79   char* dest;
  80   size_t remaining;
  81   size_t total;
  82 };
  83
  84 void demangleCallback(const char* str, size_t size, void* p) {
  85   DemangleBuf* buf = static_cast<DemangleBuf*>(p);
  86   size_t n = std::min(buf->remaining, size);
  87   memcpy(buf->dest, str, n);
  88   buf->dest += n;
  89   buf->remaining -= n;
  90   buf->total += size;
  91 }
  92
  93 }  // namespace
  94
  95 size_t demangle(const char* name, char* out, size_t outSize) {
  96   DemangleBuf dbuf;
  97   dbuf.dest = out;
  98   dbuf.remaining = outSize ? outSize - 1 : 0;   // leave room for null term
  99   dbuf.total = 0;
 100
 101   // Unlike most library functions, this returns 1 on success and 0 on failure
 102   int status = cplus_demangle_v3_callback(
 103       name,
 104       DMGL_PARAMS | DMGL_ANSI | DMGL_TYPES,
 105       demangleCallback,
 106       &dbuf);
 107   if (status == 0) {  // failed, return original
 108     return folly::strlcpy(out, name, outSize);
 109   }
 110   if (outSize != 0) {
 111     *dbuf.dest = '\0';
 112   }
 113   return dbuf.total;
 114 }
 115
 116 #else
 117
 118 fbstring demangle(const char* name) {
 119   return name;
 120 }
 121
 122 size_t demangle(const char* name, char* out, size_t outSize) {
 123   return folly::strlcpy(out, name, outSize);
 124 }
 125
 126 #endif
 127
 128 } // folly