-
Notifications
You must be signed in to change notification settings - Fork 3.3k
/
buffer.cc
221 lines (184 loc) · 7.83 KB
/
buffer.cc
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
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
#include "arrow/buffer.h"
#include <algorithm>
#include <cstdint>
#include <utility>
#include "arrow/result.h"
#include "arrow/status.h"
#include "arrow/util/bit_util.h"
#include "arrow/util/logging.h"
#include "arrow/util/slice_util_internal.h"
#include "arrow/util/string.h"
namespace arrow {
Result<std::shared_ptr<Buffer>> Buffer::CopySlice(const int64_t start,
const int64_t nbytes,
MemoryPool* pool) const {
// Sanity checks
ARROW_CHECK_LE(start, size_);
ARROW_CHECK_LE(nbytes, size_ - start);
DCHECK_GE(nbytes, 0);
ARROW_ASSIGN_OR_RAISE(auto new_buffer, AllocateResizableBuffer(nbytes, pool));
std::memcpy(new_buffer->mutable_data(), data() + start, static_cast<size_t>(nbytes));
return std::move(new_buffer);
}
namespace {
Status CheckBufferSlice(const Buffer& buffer, int64_t offset, int64_t length) {
return internal::CheckSliceParams(buffer.size(), offset, length, "buffer");
}
Status CheckBufferSlice(const Buffer& buffer, int64_t offset) {
if (ARROW_PREDICT_FALSE(offset < 0)) {
// Avoid UBSAN in subtraction below
return Status::IndexError("Negative buffer slice offset");
}
return CheckBufferSlice(buffer, offset, buffer.size() - offset);
}
} // namespace
Result<std::shared_ptr<Buffer>> SliceBufferSafe(const std::shared_ptr<Buffer>& buffer,
int64_t offset) {
RETURN_NOT_OK(CheckBufferSlice(*buffer, offset));
return SliceBuffer(buffer, offset);
}
Result<std::shared_ptr<Buffer>> SliceBufferSafe(const std::shared_ptr<Buffer>& buffer,
int64_t offset, int64_t length) {
RETURN_NOT_OK(CheckBufferSlice(*buffer, offset, length));
return SliceBuffer(buffer, offset, length);
}
Result<std::shared_ptr<Buffer>> SliceMutableBufferSafe(
const std::shared_ptr<Buffer>& buffer, int64_t offset) {
RETURN_NOT_OK(CheckBufferSlice(*buffer, offset));
return SliceMutableBuffer(buffer, offset);
}
Result<std::shared_ptr<Buffer>> SliceMutableBufferSafe(
const std::shared_ptr<Buffer>& buffer, int64_t offset, int64_t length) {
RETURN_NOT_OK(CheckBufferSlice(*buffer, offset, length));
return SliceMutableBuffer(buffer, offset, length);
}
std::string Buffer::ToHexString() {
return HexEncode(data(), static_cast<size_t>(size()));
}
bool Buffer::Equals(const Buffer& other, const int64_t nbytes) const {
return this == &other || (size_ >= nbytes && other.size_ >= nbytes &&
(data_ == other.data_ ||
!memcmp(data_, other.data_, static_cast<size_t>(nbytes))));
}
bool Buffer::Equals(const Buffer& other) const {
return this == &other || (size_ == other.size_ &&
(data_ == other.data_ ||
!memcmp(data_, other.data_, static_cast<size_t>(size_))));
}
std::string Buffer::ToString() const {
return std::string(reinterpret_cast<const char*>(data_), static_cast<size_t>(size_));
}
void Buffer::CheckMutable() const { DCHECK(is_mutable()) << "buffer not mutable"; }
void Buffer::CheckCPU() const {
DCHECK(is_cpu()) << "not a CPU buffer (device: " << device()->ToString() << ")";
}
Result<std::shared_ptr<io::RandomAccessFile>> Buffer::GetReader(
std::shared_ptr<Buffer> buf) {
return buf->memory_manager_->GetBufferReader(buf);
}
Result<std::shared_ptr<io::OutputStream>> Buffer::GetWriter(std::shared_ptr<Buffer> buf) {
if (!buf->is_mutable()) {
return Status::Invalid("Expected mutable buffer");
}
return buf->memory_manager_->GetBufferWriter(buf);
}
Result<std::shared_ptr<Buffer>> Buffer::Copy(std::shared_ptr<Buffer> source,
const std::shared_ptr<MemoryManager>& to) {
return MemoryManager::CopyBuffer(source, to);
}
Result<std::unique_ptr<Buffer>> Buffer::CopyNonOwned(
const Buffer& source, const std::shared_ptr<MemoryManager>& to) {
return MemoryManager::CopyNonOwned(source, to);
}
Result<std::shared_ptr<Buffer>> Buffer::View(std::shared_ptr<Buffer> source,
const std::shared_ptr<MemoryManager>& to) {
return MemoryManager::ViewBuffer(source, to);
}
Result<std::shared_ptr<Buffer>> Buffer::ViewOrCopy(
std::shared_ptr<Buffer> source, const std::shared_ptr<MemoryManager>& to) {
auto maybe_buffer = MemoryManager::ViewBuffer(source, to);
if (maybe_buffer.ok()) {
return maybe_buffer;
}
return MemoryManager::CopyBuffer(source, to);
}
class StlStringBuffer : public Buffer {
public:
explicit StlStringBuffer(std::string data)
: Buffer(nullptr, 0), input_(std::move(data)) {
data_ = reinterpret_cast<const uint8_t*>(input_.c_str());
size_ = static_cast<int64_t>(input_.size());
capacity_ = size_;
}
private:
std::string input_;
};
std::shared_ptr<Buffer> Buffer::FromString(std::string data) {
return std::make_shared<StlStringBuffer>(std::move(data));
}
std::shared_ptr<Buffer> SliceMutableBuffer(const std::shared_ptr<Buffer>& buffer,
const int64_t offset, const int64_t length) {
return std::make_shared<MutableBuffer>(buffer, offset, length);
}
MutableBuffer::MutableBuffer(const std::shared_ptr<Buffer>& parent, const int64_t offset,
const int64_t size)
: MutableBuffer(reinterpret_cast<uint8_t*>(parent->mutable_address()) + offset,
size) {
DCHECK(parent->is_mutable()) << "Must pass mutable buffer";
parent_ = parent;
}
Result<std::shared_ptr<Buffer>> AllocateBitmap(int64_t length, MemoryPool* pool) {
ARROW_ASSIGN_OR_RAISE(auto buf, AllocateBuffer(bit_util::BytesForBits(length), pool));
// Zero out any trailing bits
if (buf->size() > 0) {
buf->mutable_data()[buf->size() - 1] = 0;
}
return std::move(buf);
}
Result<std::shared_ptr<Buffer>> AllocateEmptyBitmap(int64_t length, MemoryPool* pool) {
return AllocateEmptyBitmap(length, kDefaultBufferAlignment, pool);
}
Result<std::shared_ptr<Buffer>> AllocateEmptyBitmap(int64_t length, int64_t alignment,
MemoryPool* pool) {
ARROW_ASSIGN_OR_RAISE(auto buf,
AllocateBuffer(bit_util::BytesForBits(length), alignment, pool));
memset(buf->mutable_data(), 0, static_cast<size_t>(buf->size()));
return std::move(buf);
}
Status AllocateEmptyBitmap(int64_t length, std::shared_ptr<Buffer>* out) {
return AllocateEmptyBitmap(length).Value(out);
}
Result<std::shared_ptr<Buffer>> ConcatenateBuffers(
const std::vector<std::shared_ptr<Buffer>>& buffers, MemoryPool* pool) {
int64_t out_length = 0;
for (const auto& buffer : buffers) {
out_length += buffer->size();
}
ARROW_ASSIGN_OR_RAISE(auto out, AllocateBuffer(out_length, pool));
auto out_data = out->mutable_data();
for (const auto& buffer : buffers) {
// Passing nullptr to std::memcpy is undefined behavior, so skip empty buffers
if (buffer->size() != 0) {
std::memcpy(out_data, buffer->data(), buffer->size());
out_data += buffer->size();
}
}
return std::move(out);
}
} // namespace arrow