summaryrefslogtreecommitdiffstats
path: root/third_party/WebKit/Source/wtf/VectorTraits.h
blob: 8d10684913d554b5176bb38a13848e746d0d81b1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
/*
 * Copyright (C) 2006, 2007, 2008 Apple Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 */

#ifndef WTF_VectorTraits_h
#define WTF_VectorTraits_h

#include "wtf/OwnPtr.h"
#include "wtf/RefPtr.h"
#include "wtf/TypeTraits.h"
#include <type_traits>
#include <utility>

namespace WTF {

class AtomicString;

template <typename T>
struct VectorTraitsBase {
    static const bool needsDestruction = !IsTriviallyDestructible<T>::value;

    static const bool canInitializeWithMemset = IsTriviallyDefaultConstructible<T>::value;
    // true iff memset(slot, 0, size) constructs an unused slot value that is
    // valid for Oilpan to trace and if the value needs destruction, its
    // destructor can be invoked over. The zero'ed value representing an unused
    // slot in the vector's backing storage; it does not have to be equal to
    // what its constructor(s) would create, only be valid for those two uses.
    static const bool canClearUnusedSlotsWithMemset = IsTriviallyDefaultConstructible<T>::value;

    static const bool canMoveWithMemcpy = IsTriviallyMoveAssignable<T>::value;
    static const bool canCopyWithMemcpy = IsTriviallyCopyAssignable<T>::value;
    static const bool canFillWithMemset = IsTriviallyDefaultConstructible<T>::value && (sizeof(T) == sizeof(char));
    static const bool canCompareWithMemcmp = std::is_scalar<T>::value; // Types without padding.
    template <typename U = void>
    struct NeedsTracingLazily {
        static const bool value = NeedsTracing<T>::value;
    };
    static const WeakHandlingFlag weakHandlingFlag = NoWeakHandlingInCollections; // We don't support weak handling in vectors.
};

template <typename T>
struct VectorTraits : VectorTraitsBase<T> {};

// Classes marked with SimpleVectorTraits will use memmov, memcpy, memcmp
// instead of constructors, copy operators, etc for initialization, move and
// comparison.
template <typename T>
struct SimpleClassVectorTraits : VectorTraitsBase<T> {
    static const bool canInitializeWithMemset = true;
    static const bool canClearUnusedSlotsWithMemset = true;
    static const bool canMoveWithMemcpy = true;
    static const bool canCompareWithMemcmp = true;
};

// We know OwnPtr and RefPtr are simple enough that initializing to 0 and moving
// with memcpy (and then not destructing the original) will totally work.
template <typename P>
struct VectorTraits<RefPtr<P>> : SimpleClassVectorTraits<RefPtr<P>> {};

template <typename P>
struct VectorTraits<OwnPtr<P>> : SimpleClassVectorTraits<OwnPtr<P>> {
    // OwnPtr -> PassOwnPtr has a very particular structure that tricks the
    // normal type traits into thinking that the class is "trivially copyable".
    static const bool canCopyWithMemcpy = false;
};
static_assert(VectorTraits<RefPtr<int>>::canInitializeWithMemset, "inefficient RefPtr Vector");
static_assert(VectorTraits<RefPtr<int>>::canMoveWithMemcpy, "inefficient RefPtr Vector");
static_assert(VectorTraits<RefPtr<int>>::canCompareWithMemcmp, "inefficient RefPtr Vector");
static_assert(VectorTraits<OwnPtr<int>>::canInitializeWithMemset, "inefficient OwnPtr Vector");
static_assert(VectorTraits<OwnPtr<int>>::canMoveWithMemcpy, "inefficient OwnPtr Vector");
static_assert(VectorTraits<OwnPtr<int>>::canCompareWithMemcmp, "inefficient OwnPtr Vector");

template <typename First, typename Second>
struct VectorTraits<std::pair<First, Second>> {
    typedef VectorTraits<First> FirstTraits;
    typedef VectorTraits<Second> SecondTraits;

    static const bool needsDestruction = FirstTraits::needsDestruction || SecondTraits::needsDestruction;
    static const bool canInitializeWithMemset = FirstTraits::canInitializeWithMemset && SecondTraits::canInitializeWithMemset;
    static const bool canMoveWithMemcpy = FirstTraits::canMoveWithMemcpy && SecondTraits::canMoveWithMemcpy;
    static const bool canCopyWithMemcpy = FirstTraits::canCopyWithMemcpy && SecondTraits::canCopyWithMemcpy;
    static const bool canFillWithMemset = false;
    static const bool canCompareWithMemcmp = FirstTraits::canCompareWithMemcmp && SecondTraits::canCompareWithMemcmp;
    static const bool canClearUnusedSlotsWithMemset = FirstTraits::canClearUnusedSlotsWithMemset && SecondTraits::canClearUnusedSlotsWithMemset;
    template <typename U = void>
        struct NeedsTracingLazily {
        static const bool value = NeedsTracingTrait<FirstTraits>::value || NeedsTracingTrait<SecondTraits>::value;
    };
    static const WeakHandlingFlag weakHandlingFlag = NoWeakHandlingInCollections; // We don't support weak handling in vectors.
};

} // namespace WTF

#define WTF_ALLOW_MOVE_INIT_AND_COMPARE_WITH_MEM_FUNCTIONS(ClassName) \
namespace WTF { \
static_assert(!IsTriviallyDefaultConstructible<ClassName>::value || !IsTriviallyMoveAssignable<ClassName>::value || !std::is_scalar<ClassName>::value, "macro not needed"); \
template <> \
struct VectorTraits<ClassName> : SimpleClassVectorTraits<ClassName> {}; \
}

#define WTF_ALLOW_MOVE_AND_INIT_WITH_MEM_FUNCTIONS(ClassName) \
namespace WTF { \
static_assert(!IsTriviallyDefaultConstructible<ClassName>::value || !IsTriviallyMoveAssignable<ClassName>::value, "macro not needed"); \
template <> \
struct VectorTraits<ClassName> : VectorTraitsBase<ClassName> \
{ \
    static const bool canInitializeWithMemset = true; \
    static const bool canClearUnusedSlotsWithMemset = true; \
    static const bool canMoveWithMemcpy = true; \
}; \
}

#define WTF_ALLOW_INIT_WITH_MEM_FUNCTIONS(ClassName) \
namespace WTF { \
static_assert(!IsTriviallyDefaultConstructible<ClassName>::value, "macro not needed"); \
template <> \
struct VectorTraits<ClassName> : VectorTraitsBase<ClassName> \
{ \
    static const bool canInitializeWithMemset = true; \
    static const bool canClearUnusedSlotsWithMemset = true; \
}; \
}

#define WTF_ALLOW_CLEAR_UNUSED_SLOTS_WITH_MEM_FUNCTIONS(ClassName) \
namespace WTF { \
static_assert(!IsTriviallyDefaultConstructible<ClassName>::value, "macro not needed"); \
template <> \
struct VectorTraits<ClassName> : VectorTraitsBase<ClassName> \
{ \
    static const bool canClearUnusedSlotsWithMemset = true; \
}; \
}

using WTF::VectorTraits;
using WTF::SimpleClassVectorTraits;

#endif // WTF_VectorTraits_h