tsfile-writer 0.2.1

A simple TsFile writer in rust with a sync sender to import tsfiles to Apache IoTDB instances
Documentation
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
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
use crate::writer::encoding::time_encoder::LongTs2DiffEncoder;
use crate::writer::encoding::Encoder;
use crate::writer::statistics::Statistics;
use crate::writer::tsfile_io_writer::TsFileIoWriter;
use crate::writer::utils::{size_var_i32, size_var_u32};
use crate::writer::{
    utils, write_str, CompressionType, IoTDBValue, PositionedWrite, Serializable, TSDataType,
    TSEncoding, TsFileError, CHUNK_HEADER, ONLY_ONE_PAGE_CHUNK_HEADER,
};
use snap::raw::max_compress_len;
use std::fmt::{Display, Formatter};
use std::io;
use std::io::Write;

const MAX_NUMBER_OF_POINTS_IN_PAGE: u32 = 1048576;
const VALUE_COUNT_IN_ONE_PAGE_FOR_NEXT_CHECK: u32 = 7989;
const PAGE_SIZE_THRESHOLD: u32 = 65536;
const MINIMUM_RECORD_COUNT_FOR_CHECK: u32 = 1500;

struct PageWriter {
    time_encoder: LongTs2DiffEncoder,
    value_encoder: Box<dyn Encoder>,
    data_type: TSDataType,
    statistics: Statistics,
    point_number: u32,
    // Necessary for writing
    buffer: Vec<u8>,
}

impl PageWriter {
    fn new(data_type: TSDataType, encoding: TSEncoding) -> Result<PageWriter, TsFileError> {
        Ok(PageWriter {
            time_encoder: LongTs2DiffEncoder::new(),
            value_encoder: <dyn Encoder>::new(data_type, encoding)?,
            data_type,
            statistics: Statistics::new(data_type),
            buffer: Vec::with_capacity(65536),
            point_number: 0,
        })
    }

    pub(crate) fn reset(&mut self) {
        self.statistics = Statistics::new(self.data_type);
        self.time_encoder.reset();
        self.value_encoder.reset();
        self.point_number = 0;
    }

    pub(crate) fn estimate_max_mem_size(&mut self) -> u32 {
        let time_encoder_size = self.time_encoder.size();
        let value_encoder_size = self.value_encoder.size();
        let time_encoder_max_size = self.time_encoder.get_max_byte_size();
        let value_encoder_max_size = self.value_encoder.get_max_byte_size();
        let max_size =
            time_encoder_size + value_encoder_size + time_encoder_max_size + value_encoder_max_size;
        log::trace!("Max size estimated for page writer: {}", max_size);
        max_size
    }

    fn write(&mut self, timestamp: i64, value: &mut IoTDBValue) -> Result<u32, &str> {
        self.time_encoder.write(&timestamp.into());
        self.value_encoder.write(value);
        self.statistics.update(timestamp, value);
        self.point_number += 1;
        Ok(1)
    }

    pub(crate) fn prepare_buffer(&mut self) {
        // serialize time_encoder and value encoder
        self.buffer.clear();
        let mut time_buffer = vec![];
        self.time_encoder.serialize(&mut time_buffer);
        crate::writer::write_var_u32(time_buffer.len() as u32, &mut self.buffer);
        self.buffer.write_all(time_buffer.as_slice());
        self.value_encoder.serialize(&mut self.buffer);
    }
}

pub struct ChunkWriter {
    pub(crate) measurement_id: String,
    pub(crate) data_type: TSDataType,
    pub compression_type: CompressionType,
    pub encoding: TSEncoding,
    #[allow(dead_code)]
    pub(crate) mask: u8,
    #[allow(dead_code)]
    offset_of_chunk_header: Option<u64>,
    pub(crate) statistics: Statistics,
    current_page_writer: Option<PageWriter>,
    page_buffer: Vec<u8>,
    num_pages: u32,
    first_page_statistics: Option<Statistics>,
    value_count_in_one_page_for_next_check: u32,
    size_without_statistics: usize,
}

impl ChunkWriter {
    pub fn new(
        measurement_id: &str,
        data_type: TSDataType,
        compression_type: CompressionType,
        encoding: TSEncoding,
    ) -> ChunkWriter {
        ChunkWriter {
            measurement_id: measurement_id.to_owned(),
            data_type,
            compression_type,
            encoding,
            mask: 0,
            offset_of_chunk_header: None,
            statistics: Statistics::new(data_type),
            current_page_writer: None,
            page_buffer: vec![],
            num_pages: 0,
            first_page_statistics: None,
            value_count_in_one_page_for_next_check: VALUE_COUNT_IN_ONE_PAGE_FOR_NEXT_CHECK,
            size_without_statistics: 0,
        }
    }

    // // This method is used?!
    // #[allow(dead_code)]
    // pub(crate) fn serialize(&mut self, file: &mut dyn PositionedWrite) -> Result<(), TsFileError> {
    //     // Before we can write the header we have to serialize the current page
    //     self.write_page_to_buffer();
    //
    //     // Chunk Header
    //     // store offset for metadata
    //     self.offset_of_chunk_header = Some(file.get_position());
    //
    //     // Marker
    //     // (byte)((numOfPages <= 1 ? MetaMarker.ONLY_ONE_PAGE_CHUNK_HEADER : MetaMarker.CHUNK_HEADER) | (byte) mask),
    //     let marker = if self.num_pages <= 1 {
    //         ONLY_ONE_PAGE_CHUNK_HEADER
    //     } else {
    //         CHUNK_HEADER
    //     };
    //     let marker = marker | self.mask;
    //     file.write(&[marker])?; // Marker
    //
    //     write_str(file, self.measurement_id.as_str())?;
    //     // Data Length
    //     utils::write_var_u32(self.page_buffer.len() as u32, file)?;
    //     // Data Type INT32 -> 1
    //     file.write(&[self.data_type.serialize()])?;
    //     // Compression Type UNCOMPRESSED -> 0
    //     file.write_all(&[self.compression_type.serialize()])?;
    //     // Encoding PLAIN -> 0
    //     file.write_all(&[self.encoding.serialize()])?;
    //     // End Chunk Header
    //
    //     log::trace!("Dumping pages at offset {}", file.get_position());
    //
    //     // Write the full page
    //     file.write_all(&self.page_buffer)?;
    //
    //     log::trace!("Offset after {}", file.get_position());
    //
    //     Ok(())
    // }

    // This method is used?!
    #[allow(dead_code)]
    pub(crate) fn get_metadata(&self) -> ChunkMetadata {
        ChunkMetadata {
            measurement_id: self.measurement_id.clone(),
            data_type: self.data_type,
            // FIXME add this
            mask: 0,
            offset_of_chunk_header: match self.offset_of_chunk_header {
                None => {
                    panic!("get_metadata called before offset is defined");
                }
                Some(offset) => offset,
            } as i64,
            statistics: self.statistics.clone(),
        }
    }

    pub(crate) fn seal_current_page(&mut self) {
        match &self.current_page_writer {
            None => {}
            Some(pw) => {
                if pw.point_number > 0 {
                    self.write_page_to_buffer();
                }
            }
        }
    }

    pub(crate) fn get_serialized_chunk_size(&self) -> u64 {
        if self.page_buffer.is_empty() {
            0
        } else {
            let measurement_length = self.measurement_id.len() as i32;
            // int measurementIdLength = measurementID.getBytes(TSFileConfig.STRING_CHARSET).length;
            1_u64 // chunkType
                + size_var_i32(measurement_length) as u64// measurementID length
                + measurement_length as u64 // measurementID
                + size_var_u32(self.page_buffer.len() as u32) as u64// dataSize
                + 1_u64 // dataType
                + 1_u64 // compressionType
                + 1_u64 // encodingType
                + self.page_buffer.len() as u64
        }
    }

    pub(crate) fn write_to_file_writer<T: PositionedWrite>(
        &mut self,
        file_writer: &mut TsFileIoWriter<T>,
    ) {
        self.seal_current_page();
        self.write_all_pages_of_chunk_to_ts_file(file_writer, &self.statistics);

        // re-init this chunk writer
        self.page_buffer.clear();
        self.num_pages = 0;
        self.first_page_statistics = None;
        self.statistics = Statistics::new(self.data_type);
    }

    fn write_all_pages_of_chunk_to_ts_file<T: PositionedWrite>(
        &self,
        file_writer: &mut TsFileIoWriter<T>,
        statistics: &Statistics,
    ) {
        if statistics.count() == 0 {
            return;
        }
        file_writer.start_flush_chunk(
            self.measurement_id.clone(),
            self.compression_type,
            self.data_type,
            self.encoding,
            statistics.clone(),
            self.page_buffer.len() as u32,
            self.num_pages,
            0,
        );

        let data_offset = file_writer.out.get_position();
        log::trace!("Dumping pages at offset {}", data_offset);

        // Write the full page
        file_writer.out.write_all(&self.page_buffer);

        log::trace!("Offset after {}", file_writer.out.get_position());

        // TODO implement this check?!
        // int dataSize = (int) (writer.getPos() - dataOffset);
        // if (dataSize != pageBuffer.size()) {
        //   throw new IOException(
        //       "Bytes written is inconsistent with the size of data: "
        //           + dataSize
        //           + " !="
        //           + " "
        //           + pageBuffer.size());
        // }
        //
        file_writer.end_current_chunk();
    }

    pub(crate) fn estimate_max_series_mem_size(&mut self) -> u32 {
        // return pageBuffer.size()
        // + pageWriter.estimateMaxMemSize()
        // + PageHeader.estimateMaxPageHeaderSizeWithoutStatistics()
        // + pageWriter.getStatistics().getSerializedSize();
        match &mut self.current_page_writer {
            Some(pw) => {
                let pw_mem_size = pw.estimate_max_mem_size();
                let stat_size = 2 * (4 + 1) + pw.statistics.get_serialized_size();
                let size = self.page_buffer.len() as u32 +
                    pw_mem_size +
                    // Header size
                    stat_size;
                log::trace!("Estimated max series mem size: {}", size);
                size
            }
            None => 0,
        }
    }

    pub fn write(&mut self, timestamp: i64, mut value: IoTDBValue) -> Result<u32, TsFileError> {
        // self.statistics.update(timestamp, &value);
        match &mut self.current_page_writer {
            None => {
                // Create a page
                self.current_page_writer = Some(PageWriter::new(self.data_type, self.encoding)?)
            }
            Some(_) => {
                // do nothing
            }
        }
        let records_written = match &mut self.current_page_writer {
            None => {
                panic!("Something bad happened!");
            }
            Some(page_writer) => page_writer.write(timestamp, &mut value).unwrap(),
        };
        self.check_page_size_and_may_open_new_page();
        Ok(records_written)
    }

    fn check_page_size_and_may_open_new_page(&mut self) {
        if self.current_page_writer.is_none() {
            return;
        }
        let page_writer = self.current_page_writer.as_mut().unwrap();
        if page_writer.point_number > MAX_NUMBER_OF_POINTS_IN_PAGE {
            self.write_page_to_buffer();
        } else if page_writer.point_number >= self.value_count_in_one_page_for_next_check {
            let current_page_size = page_writer.estimate_max_mem_size();

            if current_page_size > PAGE_SIZE_THRESHOLD {
                log::trace!(
            "enough size, write page {}, pageSizeThreshold:{}, currentPateSize:{}, valueCountInOnePage:{}",
            self.measurement_id.clone(),
            PAGE_SIZE_THRESHOLD,
            current_page_size,
            page_writer.point_number);
                self.write_page_to_buffer();
                self.value_count_in_one_page_for_next_check = MINIMUM_RECORD_COUNT_FOR_CHECK;
            } else {
                // valueCountInOnePageForNextCheck =
                //     (int) (((float) pageSizeThreshold / currentPageSize) * pageWriter.getPointNumber());
                self.value_count_in_one_page_for_next_check =
                    ((PAGE_SIZE_THRESHOLD as f32) / (current_page_size as f32)
                        * (page_writer.point_number as f32)) as u32;
            }
        }
    }

    //   private void checkPageSizeAndMayOpenANewPage() {
    //   if (pageWriter.getPointNumber() == maxNumberOfPointsInPage) {
    //     logger.debug("current line count reaches the upper bound, write page {}", measurementSchema);
    //     writePageToPageBuffer();
    //   } else if (pageWriter.getPointNumber()
    //       >= valueCountInOnePageForNextCheck) { // need to check memory size
    //     // not checking the memory used for every value
    //     long currentPageSize = pageWriter.estimateMaxMemSize();
    //     if (currentPageSize > pageSizeThreshold) { // memory size exceeds threshold
    //       // we will write the current page
    //       logger.debug(
    //           "enough size, write page {}, pageSizeThreshold:{}, currentPateSize:{}, valueCountInOnePage:{}",
    //           measurementSchema.getMeasurementId(),
    //           pageSizeThreshold,
    //           currentPageSize,
    //           pageWriter.getPointNumber());
    //       writePageToPageBuffer();
    //       valueCountInOnePageForNextCheck = MINIMUM_RECORD_COUNT_FOR_CHECK;
    //     } else {
    //       // reset the valueCountInOnePageForNextCheck for the next page
    //       valueCountInOnePageForNextCheck =
    //           (int) (((float) pageSizeThreshold / currentPageSize) * pageWriter.getPointNumber());
    //     }
    //   }
    // }
    fn write_page_to_buffer(&mut self) -> Result<(), TsFileError> {
        if let Some(page_writer) = self.current_page_writer.as_mut() {
            page_writer.prepare_buffer();

            let buffer_size: u32 = page_writer.buffer.len() as u32;

            let uncompressed_bytes = buffer_size;
            let mut compressed_buffer: Vec<u8> = Vec::new();

            let compressed_bytes = match self.compression_type {
                CompressionType::UNCOMPRESSED => uncompressed_bytes,
                CompressionType::SNAPPY => {
                    let mut encoder1 = snap::raw::Encoder::new();
                    let out_buffer_len = max_compress_len(page_writer.buffer.len());
                    let mut out = vec![0; out_buffer_len];
                    match encoder1.compress(&page_writer.buffer, out.as_mut_slice()) {
                        Ok(size) => {
                            let mut reader = &out.as_mut_slice()[..size];
                            io::copy(&mut reader, &mut compressed_buffer);
                            size as u32
                        }
                        Err(_) => {
                            return Err(TsFileError::Compression);
                        }
                    }
                }
            };

            // TODO we need a change here if multiple pages exist
            if self.num_pages == 0 {
                // Uncompressed size
                self.size_without_statistics +=
                    utils::write_var_u32(uncompressed_bytes as u32, &mut self.page_buffer)?
                        as usize;
                // Compressed size
                self.size_without_statistics +=
                    utils::write_var_u32(compressed_bytes as u32, &mut self.page_buffer)? as usize;

                // Write page content
                match self.compression_type {
                    CompressionType::UNCOMPRESSED => {
                        self.page_buffer.write_all(&page_writer.buffer);
                    }
                    _ => {
                        self.page_buffer.write_all(&compressed_buffer);
                    }
                }

                page_writer.buffer.clear();

                self.first_page_statistics = Some(page_writer.statistics.clone())
            } else if self.num_pages == 1 {
                let temp = self.page_buffer.clone();
                self.page_buffer.clear();

                log::trace!("Page Buffer offset: {}", self.page_buffer.get_position());
                let header_bytes = &temp[0..self.size_without_statistics];
                self.page_buffer.write_all(header_bytes);
                log::trace!("Page Buffer offset: {}", self.page_buffer.get_position());
                match &self.first_page_statistics {
                    Some(stat) => stat.serialize(&mut self.page_buffer),
                    _ => panic!("This should not happen!"),
                };
                log::trace!("Page Buffer offset: {}", self.page_buffer.get_position());
                let remainder_bytes = &temp[self.size_without_statistics..];
                self.page_buffer.write_all(remainder_bytes);
                log::trace!("Page Buffer offset: {}", self.page_buffer.get_position());
                // Uncompressed size
                utils::write_var_u32(uncompressed_bytes as u32, &mut self.page_buffer);
                // Compressed size
                utils::write_var_u32(compressed_bytes as u32, &mut self.page_buffer);
                log::trace!("Page Buffer offset: {}", self.page_buffer.get_position());
                // Write page content
                log::trace!("Statistics: {:?}", &page_writer.statistics);
                page_writer.statistics.serialize(&mut self.page_buffer);

                log::trace!(
                    "Flushing page at page buffer offset {}",
                    self.page_buffer.get_position()
                );

                let pos_before_flush = self.page_buffer.get_position();

                // Write page content
                match self.compression_type {
                    CompressionType::UNCOMPRESSED => {
                        self.page_buffer.write_all(&page_writer.buffer);
                    }
                    _ => {
                        self.page_buffer.write_all(&compressed_buffer);
                    }
                }

                let pos_after_flush = self.page_buffer.get_position();

                log::trace!(
                    "Wrote {} bytes to page buffer",
                    pos_after_flush - pos_before_flush
                );

                log::trace!("Page Buffer offset: {}", self.page_buffer.get_position());

                page_writer.buffer.clear();
                self.first_page_statistics = None;
            } else {
                // Uncompressed size
                utils::write_var_u32(uncompressed_bytes as u32, &mut self.page_buffer);
                // Compressed size
                utils::write_var_u32(compressed_bytes as u32, &mut self.page_buffer);
                // Write page content
                page_writer.statistics.serialize(&mut self.page_buffer);

                let pos_before_flush = self.page_buffer.get_position();

                // Write page content
                match self.compression_type {
                    CompressionType::UNCOMPRESSED => {
                        self.page_buffer.write_all(&page_writer.buffer);
                    }
                    _ => {
                        self.page_buffer.write_all(&compressed_buffer);
                    }
                }

                let pos_after_flush = self.page_buffer.get_position();

                log::trace!(
                    "Wrote {} bytes to page buffer",
                    pos_after_flush - pos_before_flush
                );
                page_writer.buffer.clear();
            }
            self.num_pages += 1;
            self.statistics.merge(&page_writer.statistics);
            page_writer.reset();
        }

        Ok(())
    }
}

pub struct ChunkHeader {
    pub measurement_id: String,
    pub data_size: u32,
    pub data_type: TSDataType,
    pub compression: CompressionType,
    pub encoding: TSEncoding,
    pub num_pages: u32,
    pub mask: u8,
}

impl ChunkHeader {
    pub(crate) fn serialize<T: PositionedWrite>(
        &self,
        file_writer: &mut T,
    ) -> Result<(), TsFileError> {
        // Marker
        // (byte)((numOfPages <= 1 ? MetaMarker.ONLY_ONE_PAGE_CHUNK_HEADER : MetaMarker.CHUNK_HEADER) | (byte) mask),
        let marker = if self.num_pages <= 1 {
            ONLY_ONE_PAGE_CHUNK_HEADER
        } else {
            CHUNK_HEADER
        };
        let marker = marker | self.mask;
        file_writer.write_all(&[marker])?; // Marker

        write_str(file_writer, self.measurement_id.as_str())?;
        // Data Length
        utils::write_var_u32(self.data_size, file_writer)?;
        // Data Type INT32 -> 1
        file_writer.write_all(&[self.data_type.serialize()])?;
        // Compression Type UNCOMPRESSED -> 0
        file_writer.write_all(&[self.compression.serialize()])?;
        // Encoding PLAIN -> 0
        file_writer.write_all(&[self.encoding.serialize()])?;
        // End Chunk Header
        Ok(())
    }

    pub(crate) fn new(
        measurement_id: String,
        data_size: u32,
        data_type: TSDataType,
        compression: CompressionType,
        encoding: TSEncoding,
        num_pages: u32,
        mask: u8,
    ) -> ChunkHeader {
        ChunkHeader {
            measurement_id,
            data_size,
            data_type,
            compression,
            encoding,
            num_pages,
            mask,
        }
    }
}

#[derive(Clone)]
pub struct ChunkMetadata {
    pub(crate) measurement_id: String,
    pub(crate) data_type: TSDataType,
    pub(crate) mask: u8,
    offset_of_chunk_header: i64,
    pub(crate) statistics: Statistics,
}

impl ChunkMetadata {
    pub(crate) fn new(
        measurement_id: String,
        data_type: TSDataType,
        position: u64,
        statistics: Statistics,
        mask: u8,
    ) -> ChunkMetadata {
        ChunkMetadata {
            measurement_id,
            data_type,
            mask,
            offset_of_chunk_header: position as i64,
            statistics,
        }
    }

    pub(crate) fn serialize(
        &self,
        file: &mut dyn PositionedWrite,
        serialize_statistics: bool,
    ) -> io::Result<()> {
        let result = file.write_all(&self.offset_of_chunk_header.to_be_bytes());
        if serialize_statistics {
            self.statistics.serialize(file);
        }
        result
    }
}

impl Display for ChunkMetadata {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(f, "{} (...)", self.measurement_id)
    }
}