Fixed an ASSERT(m_actualSelfTime <= m_actualTotalTime) when starting
[WebKit-https.git] / JavaScriptCore / profiler / Profile.h
1 /*
2  * Copyright (C) 2008 Apple Inc. 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25  
26 #ifndef Profile_h
27 #define Profile_h
28
29 #include "ProfileNode.h"
30 #include <wtf/RefCounted.h>
31 #include <wtf/RefPtr.h>
32
33 namespace KJS {
34
35     class ExecState;
36     class ProfilerClient;
37     typedef void (*UnaryFunction)(ProfileNode*);
38
39     class Profile : public RefCounted<Profile> {
40     public:
41         static PassRefPtr<Profile> create(const UString& title, ExecState* originatingGlobalExec, unsigned pageGroupIdentifier, ProfilerClient*);
42
43         void willExecute(const CallIdentifier&);
44         void didExecute(const CallIdentifier&);
45         void stopProfiling();
46         bool didFinishAllExecution();
47
48         const UString& title() const { return m_title; };
49         ProfileNode* callTree() const { return m_head.get(); };
50
51         double totalTime() const { return m_head->totalTime(); }
52
53         ExecState* originatingGlobalExec() const { return m_originatingGlobalExec; }
54         unsigned pageGroupIdentifier() const { return m_pageGroupIdentifier; }
55         ProfilerClient* client() { return m_client; }
56
57         void forEach(UnaryFunction);
58         void sortTotalTimeDescending() { forEach(ProfileNode::sortTotalTimeDescending); }
59         void sortTotalTimeAscending() { forEach(ProfileNode::sortTotalTimeAscending); }
60         void sortSelfTimeDescending() { forEach(ProfileNode::sortSelfTimeDescending); }
61         void sortSelfTimeAscending() { forEach(ProfileNode::sortSelfTimeAscending); }
62         void sortCallsDescending() { forEach(ProfileNode::sortCallsDescending); }
63         void sortCallsAscending() { forEach(ProfileNode::sortCallsAscending); }
64         void sortFunctionNameDescending() { forEach(ProfileNode::sortFunctionNameDescending); }
65         void sortFunctionNameAscending() { forEach(ProfileNode::sortFunctionNameAscending); }
66
67         void focus(const ProfileNode* profileNode);
68         void exclude(const ProfileNode* profileNode);
69         void restoreAll();
70
71 #ifndef NDEBUG
72         void debugPrintData() const;
73         void debugPrintDataSampleStyle() const;
74 #endif
75         typedef void (Profile::*ProfileFunction)(const CallIdentifier& callIdentifier);
76
77     private:
78         Profile(const UString& title, ExecState* originatingGlobalExec, unsigned pageGroupIdentifier, ProfilerClient*);
79         void removeProfileStart();
80         void removeProfileEnd();
81
82         UString m_title;
83         ExecState* m_originatingGlobalExec;
84         unsigned m_pageGroupIdentifier;
85         RefPtr<ProfileNode> m_head;
86         RefPtr<ProfileNode> m_currentNode;
87         ProfilerClient* m_client;
88         bool m_stoppedProfiling;
89     };
90
91 } // namespace KJS
92
93 #endif // Profiler_h