[Cocoa] Retire DispatchPtr, and add more move semantics and simpler #ifs to other...
[WebKit-https.git] / Source / WebKit / NetworkProcess / cache / NetworkCacheData.h
1 /*
2  * Copyright (C) 2015-2017 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 <wtf/FunctionDispatcher.h>
29 #include <wtf/SHA1.h>
30 #include <wtf/ThreadSafeRefCounted.h>
31 #include <wtf/text/WTFString.h>
32
33 #if PLATFORM(COCOA)
34 #include <wtf/OSObjectPtr.h>
35 #endif
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 class Data {
48 public:
49     Data() { }
50     Data(const uint8_t*, size_t);
51
52     ~Data() { }
53
54     static Data empty();
55     static Data adoptMap(void* map, size_t, int fd);
56
57 #if PLATFORM(COCOA)
58     enum class Backing { Buffer, Map };
59     Data(OSObjectPtr<dispatch_data_t>&&, Backing = Backing::Buffer);
60 #endif
61 #if USE(SOUP)
62     Data(GRefPtr<SoupBuffer>&&, int fd = -1);
63 #endif
64     bool isNull() const;
65     bool isEmpty() const { return !m_size; }
66
67     const uint8_t* data() const;
68     size_t size() const { return m_size; }
69     bool isMap() const { return m_isMap; }
70     RefPtr<SharedMemory> tryCreateSharedMemory() const;
71
72     Data subrange(size_t offset, size_t) const;
73
74     bool apply(const Function<bool (const uint8_t*, size_t)>&) const;
75
76     Data mapToFile(const char* path) const;
77
78 #if PLATFORM(COCOA)
79     dispatch_data_t dispatchData() const { return m_dispatchData.get(); }
80 #endif
81
82 #if USE(SOUP)
83     SoupBuffer* soupBuffer() const { return m_buffer.get(); }
84 #endif
85 private:
86 #if PLATFORM(COCOA)
87     mutable OSObjectPtr<dispatch_data_t> m_dispatchData;
88 #endif
89 #if USE(SOUP)
90     mutable GRefPtr<SoupBuffer> m_buffer;
91     int m_fileDescriptor { -1 };
92 #endif
93     mutable const uint8_t* m_data { nullptr };
94     size_t m_size { 0 };
95     bool m_isMap { false };
96 };
97
98 Data concatenate(const Data&, const Data&);
99 bool bytesEqual(const Data&, const Data&);
100 Data adoptAndMapFile(int fd, size_t offset, size_t);
101 Data mapFile(const char* path);
102
103 using Salt = std::array<uint8_t, 8>;
104
105 std::optional<Salt> readOrMakeSalt(const String& path);
106 SHA1::Digest computeSHA1(const Data&, const Salt&);
107
108 }
109
110 }