folly/experimental/symbolizer/StackTrace.h

   1 /*
   2  * Copyright 2017 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 #pragma once
  18
  19 #include <cstdint>
  20 #include <cstdlib>
  21
  22 namespace folly { namespace symbolizer {
  23
  24 /**
  25  * Get the current stack trace into addresses, which has room for at least
  26  * maxAddresses frames.
  27  *
  28  * Returns the number of frames written in the array.
  29  * Returns -1 on failure.
  30  *
  31  * NOT async-signal-safe, but fast.
  32  */
  33 ssize_t getStackTrace(uintptr_t* addresses, size_t maxAddresses);
  34
  35 /**
  36  * Get the current stack trace into addresses, which has room for at least
  37  * maxAddresses frames.
  38  *
  39  * Returns the number of frames written in the array.
  40  * Returns -1 on failure.
  41  *
  42  * Async-signal-safe, but likely slower.
  43  */
  44 ssize_t getStackTraceSafe(uintptr_t* addresses, size_t maxAddresses);
  45
  46 }}  // namespaces