[WTF] Import std::optional reference implementation as WTF::Optional
[WebKit-https.git] / Source / WebKit2 / NetworkProcess / cache / NetworkCacheData.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. 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 #ifndef NetworkCacheData_h
27 #define NetworkCacheData_h
28
29 #if ENABLE(NETWORK_CACHE)
30
31 #include <functional>
32 #include <wtf/FunctionDispatcher.h>
33 #include <wtf/SHA1.h>
34 #include <wtf/ThreadSafeRefCounted.h>
35 #include <wtf/text/WTFString.h>
36
37 #if USE(SOUP)
38 #include <WebCore/GRefPtrSoup.h>
39 #endif
40
41 namespace WebKit {
42
43 class SharedMemory;
44
45 namespace NetworkCache {
46
47 #if PLATFORM(COCOA)
48 template <typename T> class DispatchPtr;
49 template <typename T> DispatchPtr<T> adoptDispatch(T dispatchObject);
50
51 // FIXME: Use OSObjectPtr instead when it works with dispatch_data_t on all platforms.
52 template<typename T> class DispatchPtr {
53 public:
54     DispatchPtr()
55         : m_ptr(nullptr)
56     {
57     }
58     explicit DispatchPtr(T ptr)
59         : m_ptr(ptr)
60     {
61         if (m_ptr)
62             dispatch_retain(m_ptr);
63     }
64     DispatchPtr(const DispatchPtr& other)
65         : m_ptr(other.m_ptr)
66     {
67         if (m_ptr)
68             dispatch_retain(m_ptr);
69     }
70     ~DispatchPtr()
71     {
72         if (m_ptr)
73             dispatch_release(m_ptr);
74     }
75
76     DispatchPtr& operator=(const DispatchPtr& other)
77     {
78         auto copy = other;
79         std::swap(m_ptr, copy.m_ptr);
80         return *this;
81     }
82
83     T get() const { return m_ptr; }
84     explicit operator bool() const { return m_ptr; }
85
86     friend DispatchPtr adoptDispatch<T>(T);
87
88 private:
89     struct Adopt { };
90     DispatchPtr(Adopt, T data)
91         : m_ptr(data)
92     {
93     }
94
95     T m_ptr;
96 };
97
98 template <typename T> DispatchPtr<T> adoptDispatch(T dispatchObject)
99 {
100     return DispatchPtr<T>(typename DispatchPtr<T>::Adopt { }, dispatchObject);
101 }
102 #endif
103
104 class Data {
105 public:
106     Data() { }
107     Data(const uint8_t*, size_t);
108
109     ~Data() { }
110
111     static Data empty();
112     static Data adoptMap(void* map, size_t, int fd);
113
114 #if PLATFORM(COCOA)
115     enum class Backing { Buffer, Map };
116     Data(DispatchPtr<dispatch_data_t>, Backing = Backing::Buffer);
117 #endif
118 #if USE(SOUP)
119     Data(GRefPtr<SoupBuffer>&&, int fd = -1);
120 #endif
121     bool isNull() const;
122     bool isEmpty() const { return !m_size; }
123
124     const uint8_t* data() const;
125     size_t size() const { return m_size; }
126     bool isMap() const { return m_isMap; }
127     RefPtr<SharedMemory> tryCreateSharedMemory() const;
128
129     Data subrange(size_t offset, size_t) const;
130
131     bool apply(const std::function<bool (const uint8_t*, size_t)>&&) const;
132
133     Data mapToFile(const char* path) const;
134
135 #if PLATFORM(COCOA)
136     dispatch_data_t dispatchData() const { return m_dispatchData.get(); }
137 #endif
138
139 #if USE(SOUP)
140     SoupBuffer* soupBuffer() const { return m_buffer.get(); }
141 #endif
142 private:
143 #if PLATFORM(COCOA)
144     mutable DispatchPtr<dispatch_data_t> m_dispatchData;
145 #endif
146 #if USE(SOUP)
147     mutable GRefPtr<SoupBuffer> m_buffer;
148     int m_fileDescriptor { -1 };
149 #endif
150     mutable const uint8_t* m_data { nullptr };
151     size_t m_size { 0 };
152     bool m_isMap { false };
153 };
154
155 Data concatenate(const Data&, const Data&);
156 bool bytesEqual(const Data&, const Data&);
157 Data adoptAndMapFile(int fd, size_t offset, size_t);
158 Data mapFile(const char* path);
159
160 using Salt = std::array<uint8_t, 8>;
161
162 std::optional<Salt> readOrMakeSalt(const String& path);
163 SHA1::Digest computeSHA1(const Data&, const Salt&);
164
165 }
166 }
167
168 #endif
169 #endif