summaryrefslogtreecommitdiff
path: root/indra/llcommon/llcallstack.h
blob: 33f2b507b84a123a9559e9fd8da4843dcfa9d621 (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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/**
 * @file llcallstack.h
 * @brief run-time extraction of the current callstack
 *
 * $LicenseInfo:firstyear=2016&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2016, Linden Research, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#include <map>

class LLCallStackImpl;

class LLCallStack
{
public:
    LLCallStack(S32 skip_count=0, bool verbose=false);
    std::vector<std::string> m_strings;
    bool m_verbose;
    bool contains(const std::string& str);
private:
    static LLCallStackImpl *s_impl;
    S32 m_skipCount;
};

LL_COMMON_API std::ostream& operator<<(std::ostream& s, const LLCallStack& call_stack);

class LLContextStrings
{
public:
    LLContextStrings();
    static void addContextString(const std::string& str);
    static void removeContextString(const std::string& str);
    static void output(std::ostream& os);
    static LLContextStrings* getThreadLocalInstance();
    static bool contains(const std::string& str);
private:
    std::map<std::string,S32> m_contextStrings;
};

class LLScopedContextString
{
public:
    LLScopedContextString(const std::string& str):
        m_str(str)
    {
        LLContextStrings::addContextString(m_str);
    }
    ~LLScopedContextString()
    {
        LLContextStrings::removeContextString(m_str);
    }
private:
    std::string m_str;
};

// Mostly exists as a class to hook an ostream override to.
struct LLContextStatus
{
    bool contains(const std::string& str);
};

LL_COMMON_API std::ostream& operator<<(std::ostream& s, const LLContextStatus& context_status);

#ifndef LL_RELEASE_FOR_DOWNLOAD
#define dumpStack(tag)                          \
    LL_DEBUGS(tag) << "STACK:\n"                \
                   << "====================\n"  \
                   << LLCallStack()             \
                   << "===================="    \
                   << LL_ENDL;
#else
#define dumpStack(tag)
#endif