/thirdparty/breakpad/third_party/glog/src/utilities.h

http://github.com/tomahawk-player/tomahawk · C Header · 226 lines · 115 code · 39 blank · 72 comment · 19 complexity · 20c0a59961fa8f1bf39153f37dcf3a49 MD5 · raw file

  1. // Copyright (c) 2008, Google Inc.
  2. // All rights reserved.
  3. //
  4. // Redistribution and use in source and binary forms, with or without
  5. // modification, are permitted provided that the following conditions are
  6. // met:
  7. //
  8. // * Redistributions of source code must retain the above copyright
  9. // notice, this list of conditions and the following disclaimer.
  10. // * Redistributions in binary form must reproduce the above
  11. // copyright notice, this list of conditions and the following disclaimer
  12. // in the documentation and/or other materials provided with the
  13. // distribution.
  14. // * Neither the name of Google Inc. nor the names of its
  15. // contributors may be used to endorse or promote products derived from
  16. // this software without specific prior written permission.
  17. //
  18. // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19. // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20. // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21. // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22. // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23. // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24. // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25. // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26. // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27. // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28. // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29. //
  30. // Author: Shinichiro Hamaji
  31. //
  32. // Define utilties for glog internal usage.
  33. #ifndef UTILITIES_H__
  34. #define UTILITIES_H__
  35. #if defined(WIN32) || defined(_WIN32) || defined(__WIN32__)
  36. # define OS_WINDOWS
  37. #elif defined(__CYGWIN__) || defined(__CYGWIN32__)
  38. # define OS_CYGWIN
  39. #elif defined(linux) || defined(__linux) || defined(__linux__)
  40. # define OS_LINUX
  41. #elif defined(macintosh) || defined(__APPLE__) || defined(__APPLE_CC__)
  42. # define OS_MACOSX
  43. #elif defined(__FreeBSD__)
  44. # define OS_FREEBSD
  45. #elif defined(__NetBSD__)
  46. # define OS_NETBSD
  47. #elif defined(__OpenBSD__)
  48. # define OS_OPENBSD
  49. #else
  50. // TODO(hamaji): Add other platforms.
  51. #endif
  52. // printf macros for size_t, in the style of inttypes.h
  53. #ifdef _LP64
  54. #define __PRIS_PREFIX "z"
  55. #else
  56. #define __PRIS_PREFIX
  57. #endif
  58. // Use these macros after a % in a printf format string
  59. // to get correct 32/64 bit behavior, like this:
  60. // size_t size = records.size();
  61. // printf("%"PRIuS"\n", size);
  62. #define PRIdS __PRIS_PREFIX "d"
  63. #define PRIxS __PRIS_PREFIX "x"
  64. #define PRIuS __PRIS_PREFIX "u"
  65. #define PRIXS __PRIS_PREFIX "X"
  66. #define PRIoS __PRIS_PREFIX "o"
  67. #include "base/mutex.h" // This must go first so we get _XOPEN_SOURCE
  68. #include <string>
  69. #if defined(OS_WINDOWS)
  70. # include "port.h"
  71. #endif
  72. #include "config.h"
  73. #include "glog/logging.h"
  74. // There are three different ways we can try to get the stack trace:
  75. //
  76. // 1) The libunwind library. This is still in development, and as a
  77. // separate library adds a new dependency, but doesn't need a frame
  78. // pointer. It also doesn't call malloc.
  79. //
  80. // 2) Our hand-coded stack-unwinder. This depends on a certain stack
  81. // layout, which is used by gcc (and those systems using a
  82. // gcc-compatible ABI) on x86 systems, at least since gcc 2.95.
  83. // It uses the frame pointer to do its work.
  84. //
  85. // 3) The gdb unwinder -- also the one used by the c++ exception code.
  86. // It's obviously well-tested, but has a fatal flaw: it can call
  87. // malloc() from the unwinder. This is a problem because we're
  88. // trying to use the unwinder to instrument malloc().
  89. //
  90. // Note: if you add a new implementation here, make sure it works
  91. // correctly when GetStackTrace() is called with max_depth == 0.
  92. // Some code may do that.
  93. #if defined(HAVE_LIB_UNWIND)
  94. # define STACKTRACE_H "stacktrace_libunwind-inl.h"
  95. #elif !defined(NO_FRAME_POINTER)
  96. # if defined(__i386__) && __GNUC__ >= 2
  97. # define STACKTRACE_H "stacktrace_x86-inl.h"
  98. # elif defined(__x86_64__) && __GNUC__ >= 2
  99. # define STACKTRACE_H "stacktrace_x86_64-inl.h"
  100. # elif (defined(__ppc__) || defined(__PPC__)) && __GNUC__ >= 2
  101. # define STACKTRACE_H "stacktrace_powerpc-inl.h"
  102. # endif
  103. #endif
  104. #if !defined(STACKTRACE_H) && defined(HAVE_EXECINFO_H)
  105. # define STACKTRACE_H "stacktrace_generic-inl.h"
  106. #endif
  107. #if defined(STACKTRACE_H)
  108. # define HAVE_STACKTRACE
  109. #endif
  110. // defined by gcc
  111. #if defined(__ELF__) && defined(OS_LINUX)
  112. # define HAVE_SYMBOLIZE
  113. #elif defined(OS_MACOSX) && defined(HAVE_DLADDR)
  114. // Use dladdr to symbolize.
  115. # define HAVE_SYMBOLIZE
  116. #endif
  117. #ifndef ARRAYSIZE
  118. // There is a better way, but this is good enough for our purpose.
  119. # define ARRAYSIZE(a) (sizeof(a) / sizeof(*(a)))
  120. #endif
  121. _START_GOOGLE_NAMESPACE_
  122. namespace glog_internal_namespace_ {
  123. #ifdef HAVE___ATTRIBUTE__
  124. # define ATTRIBUTE_NOINLINE __attribute__ ((noinline))
  125. # define HAVE_ATTRIBUTE_NOINLINE
  126. #else
  127. # define ATTRIBUTE_NOINLINE
  128. #endif
  129. const char* ProgramInvocationShortName();
  130. bool IsGoogleLoggingInitialized();
  131. bool is_default_thread();
  132. int64 CycleClock_Now();
  133. int64 UsecToCycles(int64 usec);
  134. typedef double WallTime;
  135. WallTime WallTime_Now();
  136. int32 GetMainThreadPid();
  137. bool PidHasChanged();
  138. pid_t GetTID();
  139. const std::string& MyUserName();
  140. // Get the part of filepath after the last path separator.
  141. // (Doesn't modify filepath, contrary to basename() in libgen.h.)
  142. const char* const_basename(const char* filepath);
  143. // Wrapper of __sync_val_compare_and_swap. If the GCC extension isn't
  144. // defined, we try the CPU specific logics (we only support x86 and
  145. // x86_64 for now) first, then use a naive implementation, which has a
  146. // race condition.
  147. template<typename T>
  148. inline T sync_val_compare_and_swap(T* ptr, T oldval, T newval) {
  149. #if defined(HAVE___SYNC_VAL_COMPARE_AND_SWAP)
  150. return __sync_val_compare_and_swap(ptr, oldval, newval);
  151. #elif defined(__GNUC__) && (defined(__i386__) || defined(__x86_64__))
  152. T ret;
  153. __asm__ __volatile__("lock; cmpxchg %1, (%2);"
  154. :"=a"(ret)
  155. // GCC may produces %sil or %dil for
  156. // constraint "r", but some of apple's gas
  157. // dosn't know the 8 bit registers.
  158. // We use "q" to avoid these registers.
  159. :"q"(newval), "q"(ptr), "a"(oldval)
  160. :"memory", "cc");
  161. return ret;
  162. #else
  163. T ret = *ptr;
  164. if (ret == oldval) {
  165. *ptr = newval;
  166. }
  167. return ret;
  168. #endif
  169. }
  170. void DumpStackTraceToString(std::string* stacktrace);
  171. struct CrashReason {
  172. CrashReason() : filename(0), line_number(0), message(0), depth(0) {}
  173. const char* filename;
  174. int line_number;
  175. const char* message;
  176. // We'll also store a bit of stack trace context at the time of crash as
  177. // it may not be available later on.
  178. void* stack[32];
  179. int depth;
  180. };
  181. void SetCrashReason(const CrashReason* r);
  182. void InitGoogleLoggingUtilities(const char* argv0);
  183. void ShutdownGoogleLoggingUtilities();
  184. } // namespace glog_internal_namespace_
  185. _END_GOOGLE_NAMESPACE_
  186. using namespace GOOGLE_NAMESPACE::glog_internal_namespace_;
  187. #endif // UTILITIES_H__