1bfb470deeb733ea1cca90398e962bdde8933dcc
[WebKit-https.git] / Source / JavaScriptCore / bytecode / ArrayAllocationProfile.h
1 /*
2  * Copyright (C) 2012, 2013 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 "IndexingType.h"
29 #include "JSArray.h"
30
31 namespace JSC {
32
33 class ArrayAllocationProfile {
34 public:
35     IndexingType selectIndexingType()
36     {
37         JSArray* lastArray = m_lastArray;
38         if (lastArray && UNLIKELY(lastArray->indexingType() != m_currentIndexingType))
39             updateProfile();
40         return m_currentIndexingType;
41     }
42
43     // vector length hint becomes [0, BASE_CONTIGUOUS_VECTOR_LEN_MAX].
44     unsigned vectorLengthHint()
45     {
46         JSArray* lastArray = m_lastArray;
47         if (lastArray && (m_largestSeenVectorLength != BASE_CONTIGUOUS_VECTOR_LEN_MAX) && UNLIKELY(lastArray->getVectorLength() > m_largestSeenVectorLength))
48             updateProfile();
49         return m_largestSeenVectorLength;
50     }
51     
52     JSArray* updateLastAllocation(JSArray* lastArray)
53     {
54         m_lastArray = lastArray;
55         return lastArray;
56     }
57     
58     JS_EXPORT_PRIVATE void updateProfile();
59     
60     static IndexingType selectIndexingTypeFor(ArrayAllocationProfile* profile)
61     {
62         if (!profile)
63             return ArrayWithUndecided;
64         return profile->selectIndexingType();
65     }
66     
67     static JSArray* updateLastAllocationFor(ArrayAllocationProfile* profile, JSArray* lastArray)
68     {
69         if (profile)
70             profile->updateLastAllocation(lastArray);
71         return lastArray;
72     }
73
74 private:
75     
76     IndexingType m_currentIndexingType { ArrayWithUndecided };
77     unsigned m_largestSeenVectorLength { 0 };
78     JSArray* m_lastArray { nullptr };
79 };
80
81 } // namespace JSC