xref: /4.0.0/platform/include/platform/backtrace.h (revision 4d17a68e)
1/* -*- Mode: C; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
2/*
3 *     Copyright 2015 Couchbase, Inc
4 *
5 *   Licensed under the Apache License, Version 2.0 (the "License");
6 *   you may not use this file except in compliance with the License.
7 *   You may obtain a copy of the License at
8 *
9 *       http://www.apache.org/licenses/LICENSE-2.0
10 *
11 *   Unless required by applicable law or agreed to in writing, software
12 *   distributed under the License is distributed on an "AS IS" BASIS,
13 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 *   See the License for the specific language governing permissions and
15 *   limitations under the License.
16 */
17
18#ifdef __cplusplus
19extern "C" {
20#endif
21
22typedef void (*write_cb_t)(void *ctx, const char *frame);
23
24/**
25 * Prints a backtrace from the current thread. For each frame, the
26 * `write_cb` function is called with `context` and a string describing
27 * the frame.
28 */
29PLATFORM_PUBLIC_API
30void print_backtrace(write_cb_t write_cb, void* context);
31
32#ifdef __cplusplus
33} // extern "C"
34#endif
35