[Resource Timing] Gather timing information with reliable responseEnd time
[WebKit-https.git] / Source / WTF / wtf / persistence / Coders.h
1 /*
2  * Copyright (C) 2010, 2014-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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include <utility>
29 #include <wtf/Forward.h>
30 #include <wtf/HashMap.h>
31 #include <wtf/HashSet.h>
32 #include <wtf/SHA1.h>
33 #include <wtf/Seconds.h>
34 #include <wtf/Vector.h>
35 #include <wtf/persistence/Decoder.h>
36 #include <wtf/persistence/Encoder.h>
37
38 namespace WTF {
39 namespace Persistence {
40
41 template<typename T, typename U> struct Coder<std::pair<T, U>> {
42     static void encode(Encoder& encoder, const std::pair<T, U>& pair)
43     {
44         encoder << pair.first << pair.second;
45     }
46
47     static bool decode(Decoder& decoder, std::pair<T, U>& pair)
48     {
49         T first;
50         if (!decoder.decode(first))
51             return false;
52
53         U second;
54         if (!decoder.decode(second))
55             return false;
56
57         pair.first = first;
58         pair.second = second;
59         return true;
60     }
61 };
62
63 template<typename Rep, typename Period> struct Coder<std::chrono::duration<Rep, Period>> {
64     static void encode(Encoder& encoder, const std::chrono::duration<Rep, Period>& duration)
65     {
66         static_assert(std::is_integral<Rep>::value && std::is_signed<Rep>::value && sizeof(Rep) <= sizeof(int64_t), "Serialization of this Rep type is not supported yet. Only signed integer type which can be fit in an int64_t is currently supported.");
67         encoder << static_cast<int64_t>(duration.count());
68     }
69
70     static bool decode(Decoder& decoder, std::chrono::duration<Rep, Period>& result)
71     {
72         int64_t count;
73         if (!decoder.decode(count))
74             return false;
75         result = std::chrono::duration<Rep, Period>(static_cast<Rep>(count));
76         return true;
77     }
78 };
79
80 template<typename T> struct Coder<std::optional<T>> {
81     static void encode(Encoder& encoder, const std::optional<T>& optional)
82     {
83         if (!optional) {
84             encoder << false;
85             return;
86         }
87         
88         encoder << true;
89         encoder << optional.value();
90     }
91     
92     static bool decode(Decoder& decoder, std::optional<T>& optional)
93     {
94         bool isEngaged;
95         if (!decoder.decode(isEngaged))
96             return false;
97         
98         if (!isEngaged) {
99             optional = std::nullopt;
100             return true;
101         }
102         
103         T value;
104         if (!decoder.decode(value))
105             return false;
106         
107         optional = WTFMove(value);
108         return true;
109     }
110 };
111
112 template<typename KeyType, typename ValueType> struct Coder<WTF::KeyValuePair<KeyType, ValueType>> {
113     static void encode(Encoder& encoder, const WTF::KeyValuePair<KeyType, ValueType>& pair)
114     {
115         encoder << pair.key << pair.value;
116     }
117
118     static bool decode(Decoder& decoder, WTF::KeyValuePair<KeyType, ValueType>& pair)
119     {
120         KeyType key;
121         if (!decoder.decode(key))
122             return false;
123
124         ValueType value;
125         if (!decoder.decode(value))
126             return false;
127
128         pair.key = key;
129         pair.value = value;
130         return true;
131     }
132 };
133
134 template<bool fixedSizeElements, typename T, size_t inlineCapacity> struct VectorCoder;
135
136 template<typename T, size_t inlineCapacity> struct VectorCoder<false, T, inlineCapacity> {
137     static void encode(Encoder& encoder, const Vector<T, inlineCapacity>& vector)
138     {
139         encoder << static_cast<uint64_t>(vector.size());
140         for (size_t i = 0; i < vector.size(); ++i)
141             encoder << vector[i];
142     }
143
144     static bool decode(Decoder& decoder, Vector<T, inlineCapacity>& vector)
145     {
146         uint64_t size;
147         if (!decoder.decode(size))
148             return false;
149
150         Vector<T, inlineCapacity> tmp;
151         for (size_t i = 0; i < size; ++i) {
152             T element;
153             if (!decoder.decode(element))
154                 return false;
155             
156             tmp.append(WTFMove(element));
157         }
158
159         tmp.shrinkToFit();
160         vector.swap(tmp);
161         return true;
162     }
163 };
164
165 template<typename T, size_t inlineCapacity> struct VectorCoder<true, T, inlineCapacity> {
166     static void encode(Encoder& encoder, const Vector<T, inlineCapacity>& vector)
167     {
168         encoder << static_cast<uint64_t>(vector.size());
169         encoder.encodeFixedLengthData(reinterpret_cast<const uint8_t*>(vector.data()), vector.size() * sizeof(T), alignof(T));
170     }
171     
172     static bool decode(Decoder& decoder, Vector<T, inlineCapacity>& vector)
173     {
174         uint64_t size;
175         if (!decoder.decode(size))
176             return false;
177
178         // Since we know the total size of the elements, we can allocate the vector in
179         // one fell swoop. Before allocating we must however make sure that the decoder buffer
180         // is big enough.
181         if (!decoder.bufferIsLargeEnoughToContain<T>(size))
182             return false;
183
184         Vector<T, inlineCapacity> temp;
185         temp.resize(size);
186
187         decoder.decodeFixedLengthData(reinterpret_cast<uint8_t*>(temp.data()), size * sizeof(T));
188
189         vector.swap(temp);
190         return true;
191     }
192 };
193
194 template<typename T, size_t inlineCapacity> struct Coder<Vector<T, inlineCapacity>> : VectorCoder<std::is_arithmetic<T>::value, T, inlineCapacity> { };
195
196 template<typename KeyArg, typename MappedArg, typename HashArg, typename KeyTraitsArg, typename MappedTraitsArg> struct Coder<HashMap<KeyArg, MappedArg, HashArg, KeyTraitsArg, MappedTraitsArg>> {
197     typedef HashMap<KeyArg, MappedArg, HashArg, KeyTraitsArg, MappedTraitsArg> HashMapType;
198
199     static void encode(Encoder& encoder, const HashMapType& hashMap)
200     {
201         encoder << static_cast<uint64_t>(hashMap.size());
202         for (typename HashMapType::const_iterator it = hashMap.begin(), end = hashMap.end(); it != end; ++it)
203             encoder << *it;
204     }
205
206     static bool decode(Decoder& decoder, HashMapType& hashMap)
207     {
208         uint64_t hashMapSize;
209         if (!decoder.decode(hashMapSize))
210             return false;
211
212         HashMapType tempHashMap;
213         for (uint64_t i = 0; i < hashMapSize; ++i) {
214             KeyArg key;
215             MappedArg value;
216             if (!decoder.decode(key))
217                 return false;
218             if (!decoder.decode(value))
219                 return false;
220
221             if (!tempHashMap.add(key, value).isNewEntry) {
222                 // The hash map already has the specified key, bail.
223                 return false;
224             }
225         }
226
227         hashMap.swap(tempHashMap);
228         return true;
229     }
230 };
231
232 template<typename KeyArg, typename HashArg, typename KeyTraitsArg> struct Coder<HashSet<KeyArg, HashArg, KeyTraitsArg>> {
233     typedef HashSet<KeyArg, HashArg, KeyTraitsArg> HashSetType;
234
235     static void encode(Encoder& encoder, const HashSetType& hashSet)
236     {
237         encoder << static_cast<uint64_t>(hashSet.size());
238         for (typename HashSetType::const_iterator it = hashSet.begin(), end = hashSet.end(); it != end; ++it)
239             encoder << *it;
240     }
241
242     static bool decode(Decoder& decoder, HashSetType& hashSet)
243     {
244         uint64_t hashSetSize;
245         if (!decoder.decode(hashSetSize))
246             return false;
247
248         HashSetType tempHashSet;
249         for (uint64_t i = 0; i < hashSetSize; ++i) {
250             KeyArg key;
251             if (!decoder.decode(key))
252                 return false;
253
254             if (!tempHashSet.add(key).isNewEntry) {
255                 // The hash map already has the specified key, bail.
256                 return false;
257             }
258         }
259
260         hashSet.swap(tempHashSet);
261         return true;
262     }
263 };
264
265 template<> struct Coder<std::chrono::system_clock::time_point> {
266     static void encode(Encoder& encoder, const std::chrono::system_clock::time_point& timePoint)
267     {
268         encoder << static_cast<int64_t>(timePoint.time_since_epoch().count());
269     }
270     
271     static bool decode(Decoder& decoder, std::chrono::system_clock::time_point& result)
272     {
273         int64_t time;
274         if (!decoder.decode(time))
275             return false;
276
277         result = std::chrono::system_clock::time_point(std::chrono::system_clock::duration(static_cast<std::chrono::system_clock::rep>(time)));
278         return true;
279     }
280 };
281
282 template<> struct Coder<Seconds> {
283     static void encode(Encoder& encoder, const Seconds& seconds)
284     {
285         encoder << seconds.value();
286     }
287
288     static bool decode(Decoder& decoder, Seconds& result)
289     {
290         double value;
291         if (!decoder.decode(value))
292             return false;
293
294         result = Seconds(value);
295         return true;
296     }
297 };
298
299 template<> struct Coder<AtomicString> {
300     WTF_EXPORT_PRIVATE static void encode(Encoder&, const AtomicString&);
301     WTF_EXPORT_PRIVATE static bool decode(Decoder&, AtomicString&);
302 };
303
304 template<> struct Coder<CString> {
305     WTF_EXPORT_PRIVATE static void encode(Encoder&, const CString&);
306     WTF_EXPORT_PRIVATE static bool decode(Decoder&, CString&);
307 };
308
309 template<> struct Coder<String> {
310     WTF_EXPORT_PRIVATE static void encode(Encoder&, const String&);
311     WTF_EXPORT_PRIVATE static bool decode(Decoder&, String&);
312 };
313
314 template<> struct Coder<SHA1::Digest> {
315     WTF_EXPORT_PRIVATE static void encode(Encoder&, const SHA1::Digest&);
316     WTF_EXPORT_PRIVATE static bool decode(Decoder&, SHA1::Digest&);
317 };
318
319 }
320 }