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