summaryrefslogtreecommitdiff
path: root/include/comphelper/profilezone.hxx
blob: bd54667b198024dd962115ec30b9d5c56b0a795f (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
92
93
94
95
96
97
98
99
100
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/

#ifndef INCLUDED_COMPHELPER_PROFILEZONE_HXX
#define INCLUDED_COMPHELPER_PROFILEZONE_HXX

#include <sal/config.h>

#include <comphelper/traceevent.hxx>

// implementation of XToolkitExperimental profiling API

namespace comphelper
{
class COMPHELPER_DLLPUBLIC ProfileZone : public TraceEvent
{
    const char *m_sProfileId;
    long long m_nCreateTime;
    bool m_bConsole;
    void startConsole();
    void stopConsole();
    int m_nPid;

    void addRecording();

 public:

    /**
     * Starts measuring the cost of a C++ scope.
     *
     * Note that the char pointer is stored as such in the ProfileZone object and used in the
     * destructor, so be sure to pass a pointer that stays valid for the duration of the object's
     * lifetime.
     *
     * The second parameter can be used for ad-hoc local measuring by adding a single line of code
     * at a C++ scope start. Example:
     *
     * comphelper::ProfileZone aZone("RtfFilter::filter", true);
     *
     * Similar to the DEBUG macro in sal/log.hxx, don't forget to remove these lines before
     * committing.
     */
    ProfileZone(const char* sProfileId, bool bConsole = false)
        : m_sProfileId(sProfileId ? sProfileId : "(null)")
        , m_bConsole(bConsole)
    {
        if (s_bRecording)
        {
            TimeValue systemTime;
            osl_getSystemTime( &systemTime );
            m_nCreateTime = static_cast<long long>(systemTime.Seconds) * 1000000 + systemTime.Nanosec/1000;

            oslProcessInfo aProcessInfo;
            aProcessInfo.Size = sizeof(oslProcessInfo);
            if (osl_getProcessInfo(nullptr, osl_Process_IDENTIFIER, &aProcessInfo) == osl_Process_E_None)
                m_nPid = aProcessInfo.Ident;

            s_nNesting++;
        }
        else
            m_nCreateTime = 0;
        if (m_bConsole)
        {
            startConsole();
        }
    }

    ~ProfileZone()
    {
        if (s_bRecording)
        {
            s_nNesting--;
            addRecording();
        }
        if (m_bConsole)
        {
            stopConsole();
        }
    }

    ProfileZone(const ProfileZone&) = delete;
    void operator=(const ProfileZone&) = delete;

    static void startRecording();
    static void stopRecording();

    static css::uno::Sequence<OUString> getRecordingAndClear();
};

} // namespace comphelper

#endif // INCLUDED_COMPHELPER_PROFILEZONE_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */