cbed73b6302433b56edb29b4a5033340835ab3b9
[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 "Profile.h"
30 #include <wtf/PassRefPtr.h>
31 #include <wtf/RefCounted.h>
32 #include <wtf/RefPtr.h>
33
34 namespace JSC {
35
36     class ExecState;
37     class Profile;
38     class ProfileNode;
39     class UString;
40     struct CallIdentifier;    
41
42     class ProfileGenerator : public RefCounted<ProfileGenerator>  {
43     public:
44         static PassRefPtr<ProfileGenerator> create(const UString& title, ExecState* originatingExec, unsigned uid);
45
46         // Members
47         const UString& title() const;
48         PassRefPtr<Profile> profile() const { return m_profile; }
49         ExecState* originatingGlobalExec() const { return m_originatingGlobalExec; }
50         unsigned profileGroup() const { return m_profileGroup; }
51
52         // Collecting
53         void willExecute(ExecState* callerCallFrame, const CallIdentifier&);
54         void didExecute(ExecState* callerCallFrame, const CallIdentifier&);
55
56         void exceptionUnwind(ExecState* handlerCallFrame, const CallIdentifier&);
57
58         // Stopping Profiling
59         void stopProfiling();
60
61         typedef void (ProfileGenerator::*ProfileFunction)(ExecState* callerOrHandlerCallFrame, const CallIdentifier& callIdentifier);
62
63     private:
64         ProfileGenerator(const UString& title, ExecState* originatingExec, unsigned uid);
65         void addParentForConsoleStart(ExecState*);
66
67         void removeProfileStart();
68         void removeProfileEnd();
69
70         RefPtr<Profile> m_profile;
71         ExecState* m_originatingGlobalExec;
72         unsigned m_profileGroup;
73         RefPtr<ProfileNode> m_head;
74         RefPtr<ProfileNode> m_currentNode;
75     };
76
77 } // namespace JSC
78
79 #endif // ProfileGenerator_h