60f437f4eb9527f78a7dd5f05dd963e603be6fba
[WebKit-https.git] / Source / JavaScriptCore / profiler / ProfilerDatabase.h
1 /*
2  * Copyright (C) 2012-2013, 2016 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 #pragma once
27
28 #include "JSCJSValue.h"
29 #include "ProfilerBytecodes.h"
30 #include "ProfilerCompilation.h"
31 #include "ProfilerCompilationKind.h"
32 #include "ProfilerEvent.h"
33 #include <wtf/FastMalloc.h>
34 #include <wtf/HashMap.h>
35 #include <wtf/Lock.h>
36 #include <wtf/Noncopyable.h>
37 #include <wtf/SegmentedVector.h>
38 #include <wtf/ThreadingPrimitives.h>
39 #include <wtf/text/WTFString.h>
40
41 namespace JSC { namespace Profiler {
42
43 class Database {
44     WTF_MAKE_FAST_ALLOCATED; WTF_MAKE_NONCOPYABLE(Database);
45 public:
46     JS_EXPORT_PRIVATE Database(VM&);
47     JS_EXPORT_PRIVATE ~Database();
48     
49     int databaseID() const { return m_databaseID; }
50     
51     Bytecodes* ensureBytecodesFor(CodeBlock*);
52     void notifyDestruction(CodeBlock*);
53     
54     void addCompilation(CodeBlock*, Ref<Compilation>&&);
55     
56     // Converts the database to a JavaScript object that is suitable for JSON stringification.
57     // Note that it's probably a good idea to use an ExecState* associated with a global
58     // object that is "clean" - i.e. array and object prototypes haven't had strange things
59     // done to them. And yes, it should be appropriate to just use a globalExec here.
60     JS_EXPORT_PRIVATE JSValue toJS(ExecState*) const;
61     
62     // Converts the database to a JavaScript object using a private temporary global object,
63     // and then returns the JSON representation of that object.
64     JS_EXPORT_PRIVATE String toJSON() const;
65     
66     // Saves the JSON representation (from toJSON()) to the given file. Returns false if the
67     // save failed.
68     JS_EXPORT_PRIVATE bool save(const char* filename) const;
69
70     void registerToSaveAtExit(const char* filename);
71     
72     JS_EXPORT_PRIVATE void logEvent(CodeBlock* codeBlock, const char* summary, const CString& detail);
73     
74 private:
75     Bytecodes* ensureBytecodesFor(const AbstractLocker&, CodeBlock*);
76     
77     void addDatabaseToAtExit();
78     void removeDatabaseFromAtExit();
79     void performAtExitSave() const;
80     static Database* removeFirstAtExitDatabase();
81     static void atExitCallback();
82     
83     int m_databaseID;
84     VM& m_vm;
85     SegmentedVector<Bytecodes> m_bytecodes;
86     HashMap<CodeBlock*, Bytecodes*> m_bytecodesMap;
87     Vector<Ref<Compilation>> m_compilations;
88     HashMap<CodeBlock*, Ref<Compilation>> m_compilationMap;
89     Vector<Event> m_events;
90     bool m_shouldSaveAtExit;
91     CString m_atExitSaveFilename;
92     Database* m_nextRegisteredDatabase;
93     Lock m_lock;
94 };
95
96 } } // namespace JSC::Profiler