ba1a122ec239477522eb98d7bade53ff19326d2e
[WebKit-https.git] / Source / JavaScriptCore / runtime / ScopedArgumentsTable.h
1 /*
2  * Copyright (C) 2015 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 "JSCell.h"
29 #include "ScopeOffset.h"
30 #include <wtf/Assertions.h>
31
32 namespace JSC {
33
34 // This class's only job is to hold onto the list of ScopeOffsets for each argument that a
35 // function has. Most of the time, the BytecodeGenerator will create one of these and it will
36 // never be modified subsequently. There is a rare case where a ScopedArguments object is created
37 // and aliases one of these and then decides to modify it; in that case we do copy-on-write. This
38 // makes sense because such modifications are so uncommon. You'd have to do something crazy like
39 // "delete arguments[i]" or some variant of defineOwnProperty.
40 class ScopedArgumentsTable final : public JSCell {
41 public:
42     typedef JSCell Base;
43     static const unsigned StructureFlags = Base::StructureFlags | StructureIsImmortal;
44     
45 private:
46     ScopedArgumentsTable(VM&);
47     ~ScopedArgumentsTable();
48
49 public:
50     static ScopedArgumentsTable* create(VM&);
51     static ScopedArgumentsTable* create(VM&, uint32_t length);
52     
53     static const bool needsDestruction = true;
54     static void destroy(JSCell*);
55
56     ScopedArgumentsTable* clone(VM&);
57     
58     uint32_t length() const { return m_length; }
59     ScopedArgumentsTable* setLength(VM&, uint32_t newLength);
60     
61     ScopeOffset get(uint32_t i) const
62     {
63         return const_cast<ScopedArgumentsTable*>(this)->at(i);
64     }
65     
66     void lock()
67     {
68         m_locked = true;
69     }
70     
71     ScopedArgumentsTable* set(VM&, uint32_t index, ScopeOffset);
72     
73     DECLARE_INFO;
74     
75     static Structure* createStructure(VM&, JSGlobalObject*, JSValue prototype);
76
77     static ptrdiff_t offsetOfLength() { return OBJECT_OFFSETOF(ScopedArgumentsTable, m_length); }
78     static ptrdiff_t offsetOfArguments() { return OBJECT_OFFSETOF(ScopedArgumentsTable, m_arguments); }
79
80 private:
81     ScopeOffset& at(uint32_t i)
82     {
83         ASSERT_WITH_SECURITY_IMPLICATION(i < m_length);
84         return m_arguments[i];
85     }
86     
87     uint32_t m_length;
88     bool m_locked; // Being locked means that there are multiple references to this object and none of them expect to see the others' modifications. This means that modifications need to make a copy first.
89     // FIXME: Allocate this in the primitive gigacage
90     // https://bugs.webkit.org/show_bug.cgi?id=174921
91     std::unique_ptr<ScopeOffset[]> m_arguments;
92 };
93
94 } // namespace JSC