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
|
/* Copyright 2015 The TensorFlow Authors. All Rights Reserved.
Licensed 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 "tensorflow/core/lib/io/record_reader.h"
#include <limits.h>
#include "tensorflow/core/lib/core/coding.h"
#include "tensorflow/core/lib/core/errors.h"
#include "tensorflow/core/lib/hash/crc32c.h"
#include "tensorflow/core/lib/io/buffered_inputstream.h"
#include "tensorflow/core/lib/io/compression.h"
#include "tensorflow/core/lib/io/random_inputstream.h"
#include "tensorflow/core/platform/env.h"
namespace tensorflow {
namespace io {
RecordReaderOptions RecordReaderOptions::CreateRecordReaderOptions(
const string& compression_type) {
RecordReaderOptions options;
if (compression_type == "ZLIB") {
options.compression_type = io::RecordReaderOptions::ZLIB_COMPRESSION;
#if defined(IS_SLIM_BUILD)
LOG(ERROR) << "Compression is not supported but compression_type is set."
<< " No compression will be used.";
#else
options.zlib_options = io::ZlibCompressionOptions::DEFAULT();
#endif // IS_SLIM_BUILD
} else if (compression_type == compression::kGzip) {
options.compression_type = io::RecordReaderOptions::ZLIB_COMPRESSION;
#if defined(IS_SLIM_BUILD)
LOG(ERROR) << "Compression is not supported but compression_type is set."
<< " No compression will be used.";
#else
options.zlib_options = io::ZlibCompressionOptions::GZIP();
#endif // IS_SLIM_BUILD
} else if (compression_type != compression::kNone) {
LOG(ERROR) << "Unsupported compression_type:" << compression_type
<< ". No compression will be used.";
}
return options;
}
RecordReader::RecordReader(RandomAccessFile* file,
const RecordReaderOptions& options)
: src_(file), options_(options) {
if (options.buffer_size > 0) {
input_stream_.reset(new BufferedInputStream(file, options.buffer_size));
} else {
input_stream_.reset(new RandomAccessInputStream(file));
}
if (options.compression_type == RecordReaderOptions::ZLIB_COMPRESSION) {
// We don't have zlib available on all embedded platforms, so fail.
#if defined(IS_SLIM_BUILD)
LOG(FATAL) << "Zlib compression is unsupported on mobile platforms.";
#else // IS_SLIM_BUILD
zlib_input_stream_.reset(new ZlibInputStream(
input_stream_.get(), options.zlib_options.input_buffer_size,
options.zlib_options.output_buffer_size, options.zlib_options));
#endif // IS_SLIM_BUILD
} else if (options.compression_type == RecordReaderOptions::NONE) {
// Nothing to do.
} else {
LOG(FATAL) << "Unspecified compression type :" << options.compression_type;
}
}
// Read n+4 bytes from file, verify that checksum of first n bytes is
// stored in the last 4 bytes and store the first n bytes in *result.
// May use *storage as backing store.
Status RecordReader::ReadChecksummed(uint64 offset, size_t n,
StringPiece* result, string* storage) {
if (n >= SIZE_MAX - sizeof(uint32)) {
return errors::DataLoss("record size too large");
}
const size_t expected = n + sizeof(uint32);
storage->resize(expected);
#if !defined(IS_SLIM_BUILD)
if (zlib_input_stream_) {
// If we have a zlib compressed buffer, we assume that the
// file is being read sequentially, and we use the underlying
// implementation to read the data.
//
// No checks are done to validate that the file is being read
// sequentially. At some point the zlib input buffer may support
// seeking, possibly inefficiently.
TF_RETURN_IF_ERROR(zlib_input_stream_->ReadNBytes(expected, storage));
if (storage->size() != expected) {
if (storage->empty()) {
return errors::OutOfRange("eof");
} else {
return errors::DataLoss("truncated record at ", offset);
}
}
uint32 masked_crc = core::DecodeFixed32(storage->data() + n);
if (crc32c::Unmask(masked_crc) != crc32c::Value(storage->data(), n)) {
return errors::DataLoss("corrupted record at ", offset);
}
*result = StringPiece(storage->data(), n);
} else {
#endif // IS_SLIM_BUILD
if (options_.buffer_size > 0) {
// If we have a buffer, we assume that the file is being read
// sequentially, and we use the underlying implementation to read the
// data.
//
// No checks are done to validate that the file is being read
// sequentially.
TF_RETURN_IF_ERROR(input_stream_->ReadNBytes(expected, storage));
if (storage->size() != expected) {
if (storage->empty()) {
return errors::OutOfRange("eof");
} else {
return errors::DataLoss("truncated record at ", offset);
}
}
const uint32 masked_crc = core::DecodeFixed32(storage->data() + n);
if (crc32c::Unmask(masked_crc) != crc32c::Value(storage->data(), n)) {
return errors::DataLoss("corrupted record at ", offset);
}
*result = StringPiece(storage->data(), n);
} else {
// This version supports reading from arbitrary offsets
// since we are accessing the random access file directly.
StringPiece data;
TF_RETURN_IF_ERROR(src_->Read(offset, expected, &data, &(*storage)[0]));
if (data.size() != expected) {
if (data.empty()) {
return errors::OutOfRange("eof");
} else {
return errors::DataLoss("truncated record at ", offset);
}
}
const uint32 masked_crc = core::DecodeFixed32(data.data() + n);
if (crc32c::Unmask(masked_crc) != crc32c::Value(data.data(), n)) {
return errors::DataLoss("corrupted record at ", offset);
}
*result = StringPiece(data.data(), n);
}
#if !defined(IS_SLIM_BUILD)
}
#endif // IS_SLIM_BUILD
return Status::OK();
}
Status RecordReader::ReadRecord(uint64* offset, string* record) {
static const size_t kHeaderSize = sizeof(uint64) + sizeof(uint32);
static const size_t kFooterSize = sizeof(uint32);
// Read header data.
StringPiece lbuf;
Status s = ReadChecksummed(*offset, sizeof(uint64), &lbuf, record);
if (!s.ok()) {
return s;
}
const uint64 length = core::DecodeFixed64(lbuf.data());
// Read data
StringPiece data;
s = ReadChecksummed(*offset + kHeaderSize, length, &data, record);
if (!s.ok()) {
if (errors::IsOutOfRange(s)) {
s = errors::DataLoss("truncated record at ", *offset);
}
return s;
}
if (record->data() != data.data()) {
// RandomAccessFile placed the data in some other location.
memmove(&(*record)[0], data.data(), data.size());
}
record->resize(data.size());
*offset += kHeaderSize + length + kFooterSize;
return Status::OK();
}
Status RecordReader::SkipNBytes(uint64 offset) {
#if !defined(IS_SLIM_BUILD)
if (zlib_input_stream_) {
TF_RETURN_IF_ERROR(zlib_input_stream_->SkipNBytes(offset));
} else {
#endif
if (options_.buffer_size > 0) {
TF_RETURN_IF_ERROR(input_stream_->SkipNBytes(offset));
}
}
return Status::OK();
} // namespace io
SequentialRecordReader::SequentialRecordReader(
RandomAccessFile* file, const RecordReaderOptions& options)
: underlying_(file, options), offset_(0) {}
} // namespace io
} // namespace tensorflow
|
