folly/experimental/exception_tracer/ExceptionTracer.h

   1 /*
   2  * Copyright 2016 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 //
  18 // Exception tracer library.
  19
  20 #ifndef FOLLY_EXPERIMENTAL_EXCEPTION_TRACER_EXCEPTIONTRACER_H_
  21 #define FOLLY_EXPERIMENTAL_EXCEPTION_TRACER_EXCEPTIONTRACER_H_
  22
  23 #include <cstdint>
  24 #include <iosfwd>
  25 #include <typeinfo>
  26 #include <vector>
  27
  28 namespace folly {
  29 namespace exception_tracer {
  30
  31 struct ExceptionInfo {
  32   const std::type_info* type;
  33   // The values in frames are IP (instruction pointer) addresses.
  34   // They are only filled if the low-level exception tracer library is
  35   // linked in or LD_PRELOADed.
  36   std::vector<uintptr_t> frames;  // front() is top of stack
  37 };
  38
  39 std::ostream& operator<<(std::ostream& out, const ExceptionInfo& info);
  40
  41 /**
  42  * Get current exceptions being handled.  front() is the most recent exception.
  43  * There should be at most one unless rethrowing.
  44  */
  45 std::vector<ExceptionInfo> getCurrentExceptions();
  46
  47 /**
  48  * Install the terminate / unexpected handlers to dump exceptions.
  49  */
  50 void installHandlers();
  51
  52 }  // namespace exception_tracer
  53 }  // namespace folly
  54
  55 #endif /* FOLLY_EXPERIMENTAL_EXCEPTION_TRACER_EXCEPTIONTRACER_H_ */