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 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
use std::pin::Pin;
use bytes::{Buf, BytesMut};
use re_build_info::CrateVersion;
use re_log::external::log::warn;
use re_log_types::LogMsg;
use tokio::io::{AsyncBufRead, AsyncReadExt};
use tokio_stream::Stream;
use crate::{
codec::file::{self},
Compression, EncodingOptions, VersionPolicy,
};
use super::{read_options, DecodeError, FileHeader};
pub struct StreamingDecoder<R: AsyncBufRead> {
version: CrateVersion,
options: EncodingOptions,
reader: R,
/// buffer used for uncompressing data. This is a tiny optimization
/// to (potentially) avoid allocation for each (compressed) message
uncompressed: Vec<u8>,
/// internal buffer for unprocessed bytes
unprocessed_bytes: BytesMut,
/// flag to indicate if we're expecting more data to be read.
expect_more_data: bool,
}
impl<R: AsyncBufRead + Unpin> StreamingDecoder<R> {
pub async fn new(version_policy: VersionPolicy, mut reader: R) -> Result<Self, DecodeError> {
let mut data = [0_u8; FileHeader::SIZE];
reader
.read_exact(&mut data)
.await
.map_err(DecodeError::Read)?;
let (version, options) = read_options(version_policy, &data)?;
Ok(Self {
version,
options,
reader,
uncompressed: Vec::new(),
unprocessed_bytes: BytesMut::new(),
expect_more_data: false,
})
}
/// Returns true if `data` can be successfully decoded into a `FileHeader`.
fn peek_file_header(data: &[u8]) -> bool {
let mut read = std::io::Cursor::new(data);
FileHeader::decode(&mut read).is_ok()
}
}
/// `StreamingDecoder` relies on the underlying reader for the wakeup mechanism.
/// The fact that we can have concatanated file or corrupted file ( / input stream) pushes us to keep
/// the state of the decoder in the struct itself (through `unprocessed_bytes` and `expect_more_data`).
impl<R: AsyncBufRead + Unpin> Stream for StreamingDecoder<R> {
type Item = Result<LogMsg, DecodeError>;
fn poll_next(
mut self: std::pin::Pin<&mut Self>,
cx: &mut std::task::Context<'_>,
) -> std::task::Poll<Option<Self::Item>> {
loop {
let Self {
options,
reader,
uncompressed,
unprocessed_bytes,
expect_more_data,
..
} = &mut *self;
let serializer = options.serializer;
let compression = options.compression;
let mut buf_length = 0;
// poll_fill_buf() implicitly handles the EOF case, so we don't need to check for it
match Pin::new(reader).poll_fill_buf(cx) {
std::task::Poll::Ready(Ok([])) => {
if unprocessed_bytes.is_empty() {
return std::task::Poll::Ready(None);
}
// there's more unprocessed data, but there's nothing in the underlying
// bytes stream - this indicates a corrupted stream
if *expect_more_data {
warn!("There's {} unprocessed data, but not enough for decoding a full message", unprocessed_bytes.len());
return std::task::Poll::Ready(None);
}
}
std::task::Poll::Ready(Ok(buf)) => {
unprocessed_bytes.extend_from_slice(buf);
buf_length = buf.len();
}
std::task::Poll::Ready(Err(err)) => {
return std::task::Poll::Ready(Some(Err(DecodeError::Read(err))));
}
std::task::Poll::Pending => return std::task::Poll::Pending,
};
// check if this is a start of a new concatenated file
if unprocessed_bytes.len() >= FileHeader::SIZE
&& Self::peek_file_header(&unprocessed_bytes[..FileHeader::SIZE])
{
let data = &unprocessed_bytes[..FileHeader::SIZE];
// We've found another file header in the middle of the stream, it's time to switch
// gears and start over on this new file.
match read_options(VersionPolicy::Warn, data) {
Ok((version, options)) => {
self.version = CrateVersion::max(self.version, version);
self.options = options;
Pin::new(&mut self.reader).consume(buf_length);
self.unprocessed_bytes.advance(FileHeader::SIZE);
continue;
}
Err(err) => return std::task::Poll::Ready(Some(Err(err))),
}
}
let (msg, processed_length) = match serializer {
crate::Serializer::MsgPack => {
let header_size = super::MessageHeader::SIZE;
if unprocessed_bytes.len() < header_size {
// Not enough data to read the header, need to wait for more
self.expect_more_data = true;
Pin::new(&mut self.reader).consume(buf_length);
continue;
}
let data = &unprocessed_bytes[..header_size];
let header = super::MessageHeader::from_bytes(data)?;
match header {
super::MessageHeader::Data {
compressed_len,
uncompressed_len,
} => {
let uncompressed_len = uncompressed_len as usize;
let compressed_len = compressed_len as usize;
// read the data
let (data, length) = match compression {
Compression::Off => {
if unprocessed_bytes.len() < uncompressed_len + header_size {
self.expect_more_data = true;
Pin::new(&mut self.reader).consume(buf_length);
continue;
}
(
&unprocessed_bytes
[header_size..uncompressed_len + header_size],
uncompressed_len,
)
}
Compression::LZ4 => {
if unprocessed_bytes.len() < compressed_len + header_size {
// Not enough data to read the message, need to wait for more
self.expect_more_data = true;
Pin::new(&mut self.reader).consume(buf_length);
continue;
}
uncompressed
.resize(uncompressed.len().max(uncompressed_len), 0);
let data = &unprocessed_bytes
[header_size..compressed_len + header_size];
if let Err(err) =
lz4_flex::block::decompress_into(data, uncompressed)
{
return std::task::Poll::Ready(Some(Err(
DecodeError::Lz4(err),
)));
}
(&uncompressed[..], compressed_len)
}
};
// decode the message
let msg = rmp_serde::from_slice::<LogMsg>(data);
match msg {
Ok(msg) => (Some(msg), length + header_size),
Err(err) => {
return std::task::Poll::Ready(Some(Err(
DecodeError::MsgPack(err),
)));
}
}
}
super::MessageHeader::EndOfStream => return std::task::Poll::Ready(None),
}
}
crate::Serializer::Protobuf => {
let header_size = std::mem::size_of::<file::MessageHeader>();
if unprocessed_bytes.len() < header_size {
// Not enough data to read the header, need to wait for more
self.expect_more_data = true;
Pin::new(&mut self.reader).consume(buf_length);
continue;
}
let data = &unprocessed_bytes[..header_size];
let header = file::MessageHeader::from_bytes(data)?;
if unprocessed_bytes.len() < header.len as usize + header_size {
// Not enough data to read the message, need to wait for more
self.expect_more_data = true;
Pin::new(&mut self.reader).consume(buf_length);
continue;
}
// decode the message
let data = &unprocessed_bytes[header_size..header_size + header.len as usize];
let msg = file::decoder::decode_bytes(header.kind, data)?;
(msg, header.len as usize + header_size)
}
};
let Some(mut msg) = msg else {
// we've reached the end of the stream (i.e. read the EoS header), we check if there's another file concatenated
if unprocessed_bytes.len() < processed_length + FileHeader::SIZE {
return std::task::Poll::Ready(None);
}
let data =
&unprocessed_bytes[processed_length..processed_length + FileHeader::SIZE];
if Self::peek_file_header(data) {
re_log::debug!(
"Reached end of stream, but it seems we have a concatenated file, continuing"
);
Pin::new(&mut self.reader).consume(buf_length);
continue;
}
re_log::debug!("Reached end of stream, iterator complete");
return std::task::Poll::Ready(None);
};
if let LogMsg::SetStoreInfo(msg) = &mut msg {
// Propagate the protocol version from the header into the `StoreInfo` so that all
// parts of the app can easily access it.
msg.info.store_version = Some(self.version);
}
Pin::new(&mut self.reader).consume(buf_length);
self.unprocessed_bytes.advance(processed_length);
self.expect_more_data = false;
return std::task::Poll::Ready(Some(Ok(msg)));
}
}
}
#[cfg(all(test, feature = "decoder", feature = "encoder"))]
mod tests {
use re_build_info::CrateVersion;
use tokio_stream::StreamExt;
use crate::{
decoder::{
streaming::StreamingDecoder,
tests::{fake_log_messages, strip_arrow_extensions_from_log_messages},
},
Compression, EncodingOptions, Serializer, VersionPolicy,
};
#[tokio::test]
async fn test_streaming_decoder_handles_corrupted_input_file() {
let rrd_version = CrateVersion::LOCAL;
let messages = fake_log_messages();
let options = [
EncodingOptions {
compression: Compression::Off,
serializer: Serializer::MsgPack,
},
EncodingOptions {
compression: Compression::LZ4,
serializer: Serializer::MsgPack,
},
EncodingOptions {
compression: Compression::Off,
serializer: Serializer::Protobuf,
},
EncodingOptions {
compression: Compression::LZ4,
serializer: Serializer::Protobuf,
},
];
for options in options {
let mut data = vec![];
crate::encoder::encode_ref(rrd_version, options, messages.iter().map(Ok), &mut data)
.unwrap();
// We cut the input file by one byte to simulate a corrupted file and check that we don't end up in an infinite loop
// waiting for more data when there's none to be read.
let data = &data[..data.len() - 1];
let buf_reader = tokio::io::BufReader::new(std::io::Cursor::new(data));
let decoder = StreamingDecoder::new(VersionPolicy::Error, buf_reader)
.await
.unwrap();
let decoded_messages = strip_arrow_extensions_from_log_messages(
decoder.collect::<Result<Vec<_>, _>>().await.unwrap(),
);
similar_asserts::assert_eq!(decoded_messages, messages);
}
}
#[tokio::test]
async fn test_streaming_decoder_happy_paths() {
let rrd_version = CrateVersion::LOCAL;
let messages = fake_log_messages();
let options = [
EncodingOptions {
compression: Compression::Off,
serializer: Serializer::MsgPack,
},
EncodingOptions {
compression: Compression::LZ4,
serializer: Serializer::MsgPack,
},
EncodingOptions {
compression: Compression::Off,
serializer: Serializer::Protobuf,
},
EncodingOptions {
compression: Compression::LZ4,
serializer: Serializer::Protobuf,
},
];
for options in options {
let mut data = vec![];
crate::encoder::encode_ref(rrd_version, options, messages.iter().map(Ok), &mut data)
.unwrap();
let buf_reader = tokio::io::BufReader::new(std::io::Cursor::new(data));
let decoder = StreamingDecoder::new(VersionPolicy::Error, buf_reader)
.await
.unwrap();
let decoded_messages = strip_arrow_extensions_from_log_messages(
decoder.collect::<Result<Vec<_>, _>>().await.unwrap(),
);
similar_asserts::assert_eq!(decoded_messages, messages);
}
}
}