/ runtime / CachedBytecode.h
CachedBytecode.h
 1  /*
 2   * Copyright (C) 2019 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 "CacheUpdate.h"
29  #include "LeafExecutable.h"
30  #include "ParserModes.h"
31  #include <wtf/MallocPtr.h>
32  #include <wtf/Noncopyable.h>
33  #include <wtf/RefCounted.h>
34  #include <wtf/Vector.h>
35  
36  namespace JSC {
37  
38  class UnlinkedFunctionExecutable;
39  
40  class CachedBytecode : public RefCounted<CachedBytecode> {
41      WTF_MAKE_NONCOPYABLE(CachedBytecode);
42  
43  public:
44      static Ref<CachedBytecode> create()
45      {
46          return adoptRef(*new CachedBytecode(CachePayload::makeEmptyPayload()));
47      }
48  
49      static Ref<CachedBytecode> create(FileSystem::MappedFileData&& data, LeafExecutableMap&& leafExecutables = { })
50      {
51          return adoptRef(*new CachedBytecode(CachePayload::makeMappedPayload(WTFMove(data)), WTFMove(leafExecutables)));
52      }
53  
54      static Ref<CachedBytecode> create(MallocPtr<uint8_t, VMMalloc>&& data, size_t size, LeafExecutableMap&& leafExecutables)
55      {
56          return adoptRef(*new CachedBytecode(CachePayload::makeMallocPayload(WTFMove(data), size), WTFMove(leafExecutables)));
57      }
58  
59      LeafExecutableMap& leafExecutables() { return m_leafExecutables; }
60  
61      JS_EXPORT_PRIVATE void addGlobalUpdate(Ref<CachedBytecode>);
62      JS_EXPORT_PRIVATE void addFunctionUpdate(const UnlinkedFunctionExecutable*, CodeSpecializationKind, Ref<CachedBytecode>);
63  
64      using ForEachUpdateCallback = Function<void(off_t, const void*, size_t)>;
65      JS_EXPORT_PRIVATE void commitUpdates(const ForEachUpdateCallback&) const;
66  
67      const uint8_t* data() const { return m_payload.data(); }
68      size_t size() const { return m_payload.size(); }
69      bool hasUpdates() const { return !m_updates.isEmpty(); }
70      size_t sizeForUpdate() const { return m_size; }
71  
72  private:
73      CachedBytecode(CachePayload&& payload, LeafExecutableMap&& leafExecutables = { })
74          : m_size(payload.size())
75          , m_payload(WTFMove(payload))
76          , m_leafExecutables(WTFMove(leafExecutables))
77      {
78      }
79  
80      void copyLeafExecutables(const CachedBytecode&);
81  
82      size_t m_size { 0 };
83      CachePayload m_payload;
84      LeafExecutableMap m_leafExecutables;
85      Vector<CacheUpdate> m_updates;
86  };
87  
88  
89  } // namespace JSC