1// Copyright 2012 The Kyua Authors.
2// All rights reserved.
3//
4// Redistribution and use in source and binary forms, with or without
5// modification, are permitted provided that the following conditions are
6// met:
7//
8// * Redistributions of source code must retain the above copyright
9//   notice, this list of conditions and the following disclaimer.
10// * Redistributions in binary form must reproduce the above copyright
11//   notice, this list of conditions and the following disclaimer in the
12//   documentation and/or other materials provided with the distribution.
13// * Neither the name of Google Inc. nor the names of its contributors
14//   may be used to endorse or promote products derived from this software
15//   without specific prior written permission.
16//
17// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29/// \file utils/stacktrace.hpp
30/// Utilities to gather a stacktrace of a crashing binary.
31
32#if !defined(ENGINE_STACKTRACE_HPP)
33#define ENGINE_STACKTRACE_HPP
34
35#include <ostream>
36
37#include "utils/datetime_fwd.hpp"
38#include "utils/fs/path_fwd.hpp"
39#include "utils/optional_fwd.hpp"
40#include "utils/process/executor_fwd.hpp"
41#include "utils/process/status_fwd.hpp"
42
43namespace utils {
44
45
46extern const char* builtin_gdb;
47extern utils::datetime::delta gdb_timeout;
48
49utils::optional< utils::fs::path > find_gdb(void);
50
51utils::optional< utils::fs::path > find_core(const utils::fs::path&,
52                                             const utils::process::status&,
53                                             const utils::fs::path&);
54
55bool unlimit_core_size(void);
56
57void dump_stacktrace(const utils::fs::path&,
58                     utils::process::executor::executor_handle&,
59                     const utils::process::executor::exit_handle&);
60
61void dump_stacktrace_if_available(const utils::fs::path&,
62                                  utils::process::executor::executor_handle&,
63                                  const utils::process::executor::exit_handle&);
64
65
66}  // namespace utils
67
68#endif  // !defined(ENGINE_STACKTRACE_HPP)
69