Reduce copies and allocations in SharedBuffer::append
[WebKit-https.git] / Source / WebCore / platform / SharedBuffer.h
1 /*
2  * Copyright (C) 2006-2017 Apple Inc. All rights reserved.
3  * Copyright (C) Research In Motion Limited 2009-2010. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #pragma once
28
29 #include "FileSystem.h"
30 #include <runtime/ArrayBuffer.h>
31 #include <wtf/Forward.h>
32 #include <wtf/RefCounted.h>
33 #include <wtf/ThreadSafeRefCounted.h>
34 #include <wtf/Variant.h>
35 #include <wtf/Vector.h>
36 #include <wtf/text/WTFString.h>
37
38 #if USE(CF)
39 #include <wtf/RetainPtr.h>
40 #endif
41
42 #if USE(SOUP)
43 #include "GUniquePtrSoup.h"
44 #endif
45
46 #if USE(FOUNDATION)
47 OBJC_CLASS NSArray;
48 OBJC_CLASS NSData;
49 #endif
50
51 namespace WebCore {
52     
53 class WEBCORE_EXPORT SharedBuffer : public RefCounted<SharedBuffer> {
54 public:
55     static Ref<SharedBuffer> create() { return adoptRef(*new SharedBuffer); }
56     static Ref<SharedBuffer> create(const char* data, size_t size) { return adoptRef(*new SharedBuffer(data, size)); }
57     static Ref<SharedBuffer> create(const unsigned char* data, size_t size) { return adoptRef(*new SharedBuffer(data, size)); }
58     static RefPtr<SharedBuffer> createWithContentsOfFile(const String& filePath);
59
60     static Ref<SharedBuffer> create(Vector<char>&&);
61     
62 #if USE(FOUNDATION)
63     RetainPtr<NSData> createNSData();
64     RetainPtr<NSArray> createNSDataArray() const;
65     static Ref<SharedBuffer> create(NSData *);
66 #endif
67 #if USE(CF)
68     RetainPtr<CFDataRef> createCFData();
69     static Ref<SharedBuffer> create(CFDataRef);
70     void append(CFDataRef);
71 #endif
72
73 #if USE(SOUP)
74     GUniquePtr<SoupBuffer> createSoupBuffer(unsigned offset = 0, unsigned size = 0);
75     static Ref<SharedBuffer> wrapSoupBuffer(SoupBuffer*);
76 #endif
77
78     // Calling data() causes all the data segments to be copied into one segment if they are not already.
79     // Iterate the segments using begin() and end() instead.
80     // FIXME: Audit the call sites of this function and replace them with iteration if possible.
81     const char* data() const;
82
83     // Creates an ArrayBuffer and copies this SharedBuffer's contents to that
84     // ArrayBuffer without merging segmented buffers into a flat buffer.
85     RefPtr<ArrayBuffer> createArrayBuffer() const;
86
87     // FIXME: This should return a size_t.
88     unsigned size() const { return m_size; }
89
90     bool isEmpty() const { return !size(); }
91
92     void append(const SharedBuffer&);
93     void append(const char*, size_t);
94     void append(Vector<char>&&);
95
96     void clear();
97
98     Ref<SharedBuffer> copy() const;
99
100     // Data wrapped by a DataSegment should be immutable because it can be referenced by other objects.
101     // To modify or combine the data, allocate a new DataSegment.
102     class DataSegment : public ThreadSafeRefCounted<DataSegment> {
103     public:
104         const char* data() const;
105         size_t size() const;
106
107         static Ref<DataSegment> create(Vector<char>&& data) { return adoptRef(*new DataSegment(WTFMove(data))); }
108 #if USE(CF)
109         static Ref<DataSegment> create(RetainPtr<CFDataRef>&& data) { return adoptRef(*new DataSegment(WTFMove(data))); }
110 #endif
111 #if USE(SOUP)
112         static Ref<DataSegment> create(GUniquePtr<SoupBuffer>&& data) { return adoptRef(*new DataSegment(WTFMove(data))); }
113 #endif
114         static Ref<DataSegment> create(MappedFileData&& data) { return adoptRef(*new DataSegment(WTFMove(data))); }
115
116     private:
117         DataSegment(Vector<char>&& data)
118             : m_immutableData(WTFMove(data)) { }
119 #if USE(CF)
120         DataSegment(RetainPtr<CFDataRef>&& data)
121             : m_immutableData(WTFMove(data)) { }
122 #endif
123 #if USE(SOUP)
124         DataSegment(GUniquePtr<SoupBuffer>&& data)
125             : m_immutableData(WTFMove(data)) { }
126 #endif
127         DataSegment(MappedFileData&& data)
128             : m_immutableData(WTFMove(data)) { }
129
130         Variant<Vector<char>,
131 #if USE(CF)
132             RetainPtr<CFDataRef>,
133 #endif
134 #if USE(SOUP)
135             GUniquePtr<SoupBuffer>,
136 #endif
137             MappedFileData> m_immutableData;
138         friend class SharedBuffer;
139     };
140
141     Vector<Ref<const DataSegment>>::const_iterator begin() const { return m_segments.begin(); }
142     Vector<Ref<const DataSegment>>::const_iterator end() const { return m_segments.end(); }
143
144     void hintMemoryNotNeededSoon();
145
146 private:
147     SharedBuffer() = default;
148     SharedBuffer(const char*, size_t);
149     SharedBuffer(const unsigned char*, size_t);
150     SharedBuffer(Vector<char>&&);
151     SharedBuffer(MappedFileData&&);
152 #if USE(CF)
153     SharedBuffer(CFDataRef);
154 #endif
155 #if USE(SOUP)
156     SharedBuffer(SoupBuffer*);
157 #endif
158
159     void combineToOneSegment() const;
160     
161     static RefPtr<SharedBuffer> createFromReadingFile(const String& filePath);
162
163     size_t m_size { 0 };
164     mutable Vector<Ref<const DataSegment>> m_segments;
165 };
166
167 RefPtr<SharedBuffer> utf8Buffer(const String&);
168
169 } // namespace WebCore