1 /**
2  * Copyright (c) 2021-2022 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef LIBPANDABASE_OS_STACKTRACE_H
17 #define LIBPANDABASE_OS_STACKTRACE_H
18 
19 #include <vector>
20 #include <iostream>
21 
22 namespace panda {
23 
24 class StackPrinterImpl;
25 
26 /*
27  * Return stack trace as a vector of PCs
28  *
29  * Use std::vector instead of PandaVector due to have ability
30  * to print stack traces in internal allocator.
31  * Since PandaVector uses internal allocator it leads to
32  * infinite recursion.
33  */
34 std::vector<uintptr_t> GetStacktrace();
35 
36 /*
37  * Print stack trace provided into 'Print' function.
38  * The class caches information. So it is aimed to be used
39  * to print multiple stack traces.
40  */
41 std::ostream &PrintStack(const std::vector<uintptr_t> &stacktrace, std::ostream &out);
42 
43 /*
44  * Print stack trace
45  */
46 // NOLINTNEXTLINE(misc-definitions-in-headers)
PrintStack(std::ostream &out)47 inline std::ostream &PrintStack(std::ostream &out)
48 {
49     return PrintStack(GetStacktrace(), out);
50 }
51 
52 }  // namespace panda
53 
54 #endif  // LIBPANDABASE_OS_STACKTRACE_H
55