7c970d69cc678ec65db678c6fedd58bd0feffa40
[WebKit-https.git] / Source / JavaScriptCore / profiler / ProfileGenerator.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 ProfileGenerator_h
27 #define ProfileGenerator_h
28
29 #include <wtf/PassRefPtr.h>
30 #include <wtf/RefCounted.h>
31 #include <wtf/RefPtr.h>
32 #include <wtf/text/WTFString.h>
33
34 namespace JSC {
35
36     class DebuggerCallFrame;
37     class ExecState;
38     class JSGlobalObject;
39     class Profile;
40     class ProfileNode;
41     struct CallIdentifier;
42
43     class ProfileGenerator : public RefCounted<ProfileGenerator>  {
44     public:
45         static PassRefPtr<ProfileGenerator> create(ExecState*, const WTF::String& title, unsigned uid);
46
47         // Members
48         const WTF::String& title() const;
49         PassRefPtr<Profile> profile() const { return m_profile; }
50         JSGlobalObject* origin() const { return m_origin; }
51         unsigned profileGroup() const { return m_profileGroup; }
52
53         void willExecute(ExecState* callerCallFrame, const CallIdentifier&);
54         void didExecute(ExecState* callerCallFrame, const CallIdentifier&);
55         void exceptionUnwind(ExecState* handlerCallFrame, const CallIdentifier&);
56
57         void didPause(PassRefPtr<DebuggerCallFrame>, const CallIdentifier&);
58         void didContinue(PassRefPtr<DebuggerCallFrame>, const CallIdentifier&);
59
60         void stopProfiling();
61
62         typedef void (ProfileGenerator::*ProfileFunction)(ExecState* callerOrHandlerCallFrame, const CallIdentifier& callIdentifier);
63
64     private:
65         ProfileGenerator(ExecState*, const WTF::String& title, unsigned uid);
66         void addParentForConsoleStart(ExecState*);
67
68         void removeProfileStart();
69         void removeProfileEnd();
70
71         void beginCallEntry(ProfileNode*, double startTime = NAN);
72         void endCallEntry(ProfileNode*);
73
74         RefPtr<Profile> m_profile;
75         JSGlobalObject* m_origin;
76         unsigned m_profileGroup;
77         // Timestamp is set to NAN when the debugger is not currently paused.
78         double m_debuggerPausedTimestamp;
79         RefPtr<ProfileNode> m_rootNode;
80         RefPtr<ProfileNode> m_currentNode;
81         bool m_foundConsoleStartParent;
82     };
83
84 } // namespace JSC
85
86 #endif // ProfileGenerator_h