summaryrefslogtreecommitdiff
path: root/src/mongo/util/stacktrace.h
blob: 9fc307f8cac0a80e3f3e74a11d1fd91945da780a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
/*    Copyright 2009 10gen Inc.
 *
 *    This program is free software: you can redistribute it and/or  modify
 *    it under the terms of the GNU Affero General Public License, version 3,
 *    as published by the Free Software Foundation.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU Affero General Public License for more details.
 *
 *    You should have received a copy of the GNU Affero General Public License
 *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *    As a special exception, the copyright holders give permission to link the
 *    code of portions of this program with the OpenSSL library under certain
 *    conditions as described in each individual source file and distribute
 *    linked combinations including the program with the OpenSSL library. You
 *    must comply with the GNU Affero General Public License in all respects
 *    for all of the code used other than as permitted herein. If you modify
 *    file(s) with this exception, you may extend this exception to your
 *    version of the file(s), but you are not obligated to do so. If you do not
 *    wish to do so, delete this exception statement from your version. If you
 *    delete this exception statement from all source files in the program,
 *    then also delete it in the license file.
 */

/**
 * Tools for working with in-process stack traces.
 */

#pragma once

#include "mongo/logger/log_severity.h"
#include "mongo/logger/logger.h"
#include "mongo/logger/logstream_builder.h"
#include "mongo/util/concurrency/thread_name.h"

#if defined(_WIN32)
// We need to pick up a decl for CONTEXT. Forward declaring would be preferable, but it is
// unclear that we can do so.
#include "mongo/platform/windows_basic.h"
#endif

namespace mongo {

    /**
      * Returns a log stream builder suitable for printStackTrace() default argument
      * Do not use in any other context.
      */
    inline logger::LogstreamBuilder getStackTraceLogger() {
        using namespace logger;
        return LogstreamBuilder(globalLogDomain(), getThreadName(), LogSeverity::Log());
    }

    // Print stack trace information to "os", default to the log stream.
    void printStackTrace(std::ostream &os=getStackTraceLogger().stream());

#if defined(_WIN32)
    // Print stack trace (using a specified stack context) to "os", default to the log stream.
    void printWindowsStackTrace(CONTEXT &context, std::ostream &os=getStackTraceLogger().stream());

    // Print error message from C runtime followed by stack trace
    int crtDebugCallback(int, char* originalMessage, int*);
#endif

}  // namespace mongo