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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
/*
* Copyright (C) 2006 Apple Computer, Inc. All rights reserved.
* Copyright (C) Research In Motion Limited 2009-2010. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef SharedBuffer_h
#define SharedBuffer_h
#include <wtf/Forward.h>
#include <wtf/OwnPtr.h>
#include <wtf/RefCounted.h>
#include <wtf/Vector.h>
#include <wtf/text/WTFString.h>
#if USE(CF)
#include <wtf/RetainPtr.h>
#endif
#if USE(SOUP)
#include "GUniquePtrSoup.h"
#endif
#if PLATFORM(MAC)
OBJC_CLASS NSData;
#endif
namespace WebCore {
class PurgeableBuffer;
class SharedBuffer : public RefCounted<SharedBuffer> {
public:
static PassRefPtr<SharedBuffer> create() { return adoptRef(new SharedBuffer); }
static PassRefPtr<SharedBuffer> create(unsigned size) { return adoptRef(new SharedBuffer(size)); }
static PassRefPtr<SharedBuffer> create(const char* c, unsigned i) { return adoptRef(new SharedBuffer(c, i)); }
static PassRefPtr<SharedBuffer> create(const unsigned char* c, unsigned i) { return adoptRef(new SharedBuffer(c, i)); }
static PassRefPtr<SharedBuffer> createWithContentsOfFile(const String& filePath);
static PassRefPtr<SharedBuffer> adoptVector(Vector<char>& vector);
// The buffer must be in non-purgeable state before adopted to a SharedBuffer.
// It will stay that way until released.
static PassRefPtr<SharedBuffer> adoptPurgeableBuffer(PassOwnPtr<PurgeableBuffer>);
~SharedBuffer();
#if PLATFORM(MAC)
// FIXME: This class exists as a temporary workaround so that code that does:
// [buffer->createNSData() autorelease] will fail to compile.
// Once both Mac and iOS builds with this change we can change the return type to be RetainPtr<NSData>,
// since we're mostly worried about existing code breaking (it's unlikely that we'd use retain/release together
// with RetainPtr in new code.
class NSDataRetainPtrWithoutImplicitConversionOperator : public RetainPtr<NSData*> {
public:
template<typename T>
NSDataRetainPtrWithoutImplicitConversionOperator(RetainPtr<T*>&& other)
: RetainPtr<NSData*>(std::move(other))
{
}
explicit operator PtrType() = delete;
};
NSDataRetainPtrWithoutImplicitConversionOperator createNSData();
static PassRefPtr<SharedBuffer> wrapNSData(NSData *data);
#endif
#if USE(CF)
RetainPtr<CFDataRef> createCFData();
static PassRefPtr<SharedBuffer> wrapCFData(CFDataRef);
#endif
#if USE(SOUP)
static PassRefPtr<SharedBuffer> wrapSoupBuffer(SoupBuffer*);
#endif
// Calling this function will force internal segmented buffers
// to be merged into a flat buffer. Use getSomeData() whenever possible
// for better performance.
const char* data() const;
unsigned size() const;
bool isEmpty() const { return !size(); }
void append(SharedBuffer*);
void append(const char*, unsigned);
void append(const Vector<char>&);
void clear();
const char* platformData() const;
unsigned platformDataSize() const;
#if USE(NETWORK_CFDATA_ARRAY_CALLBACK)
void append(CFDataRef);
#endif
PassRefPtr<SharedBuffer> copy() const;
bool hasPurgeableBuffer() const { return m_purgeableBuffer.get(); }
// Ensure this buffer has no other clients before calling this.
PassOwnPtr<PurgeableBuffer> releasePurgeableBuffer();
// Return the number of consecutive bytes after "position". "data"
// points to the first byte.
// Return 0 when no more data left.
// When extracting all data with getSomeData(), the caller should
// repeat calling it until it returns 0.
// Usage:
// const char* segment;
// unsigned pos = 0;
// while (unsigned length = sharedBuffer->getSomeData(segment, pos)) {
// // Use the data. for example: decoder->decode(segment, length);
// pos += length;
// }
unsigned getSomeData(const char*& data, unsigned position = 0) const;
void shouldUsePurgeableMemory(bool use) { m_shouldUsePurgeableMemory = use; }
#if ENABLE(DISK_IMAGE_CACHE)
enum MemoryMappingState { QueuedForMapping, PreviouslyQueuedForMapping, SuccessAlreadyMapped, FailureCacheFull };
// Calling this will cause this buffer to be memory mapped.
MemoryMappingState allowToBeMemoryMapped();
bool isAllowedToBeMemoryMapped() const;
// This is called to indicate that the memory mapping failed.
void failedMemoryMap();
// This is called only once the buffer has been completely memory mapped.
void markAsMemoryMapped();
bool isMemoryMapped() const { return m_isMemoryMapped; }
// This callback function will be called when either the buffer has been memory mapped or failed to be memory mapped.
enum CompletionStatus { Failed, Succeeded };
typedef void* MemoryMappedNotifyCallbackData;
typedef void (*MemoryMappedNotifyCallback)(PassRefPtr<SharedBuffer>, CompletionStatus, MemoryMappedNotifyCallbackData);
MemoryMappedNotifyCallbackData memoryMappedNotificationCallbackData() const;
MemoryMappedNotifyCallback memoryMappedNotificationCallback() const;
void setMemoryMappedNotificationCallback(MemoryMappedNotifyCallback, MemoryMappedNotifyCallbackData);
#endif
void createPurgeableBuffer() const;
void tryReplaceContentsWithPlatformBuffer(SharedBuffer*);
private:
SharedBuffer();
explicit SharedBuffer(unsigned);
SharedBuffer(const char*, unsigned);
SharedBuffer(const unsigned char*, unsigned);
// Calling this function will force internal segmented buffers
// to be merged into a flat buffer. Use getSomeData() whenever possible
// for better performance.
// As well, be aware that this method does *not* return any purgeable
// memory, which can be a source of bugs.
const Vector<char>& buffer() const;
void clearPlatformData();
void maybeTransferPlatformData();
bool hasPlatformData() const;
void copyBufferAndClear(char* destination, unsigned bytesToCopy) const;
unsigned m_size;
mutable Vector<char> m_buffer;
bool m_shouldUsePurgeableMemory;
mutable OwnPtr<PurgeableBuffer> m_purgeableBuffer;
#if USE(NETWORK_CFDATA_ARRAY_CALLBACK)
mutable Vector<RetainPtr<CFDataRef>> m_dataArray;
unsigned copySomeDataFromDataArray(const char*& someData, unsigned position) const;
const char *singleDataArrayBuffer() const;
#else
mutable Vector<char*> m_segments;
#endif
#if ENABLE(DISK_IMAGE_CACHE)
bool m_isMemoryMapped;
unsigned m_diskImageCacheId; // DiskImageCacheId is unsigned.
MemoryMappedNotifyCallback m_notifyMemoryMappedCallback;
MemoryMappedNotifyCallbackData m_notifyMemoryMappedCallbackData;
#endif
#if USE(CF)
explicit SharedBuffer(CFDataRef);
RetainPtr<CFDataRef> m_cfData;
#endif
#if USE(SOUP)
explicit SharedBuffer(SoupBuffer*);
GUniquePtr<SoupBuffer> m_soupBuffer;
#endif
};
PassRefPtr<SharedBuffer> utf8Buffer(const String&);
} // namespace WebCore
#endif // SharedBuffer_h
|
