rsbx 2.0.0

Enhanced implementation of SeqBox in Rust
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
use std::sync::{Arc, Mutex};
use std::fmt;
use file_utils;
use std::io::SeekFrom;

use json_printer::{JSONPrinter,
                   BracketType};

use progress_report::*;
use cli_utils::setup_ctrlc_handler;

use file_reader::{FileReader,
                  FileReaderParam};

use reader::ReadResult;

use general_error::Error;
use sbx_specs::Version;

use sbx_block::Block;
use sbx_block;
use sbx_specs::SBX_LARGEST_BLOCK_SIZE;
use sbx_specs::{ver_to_block_size,
                ver_uses_rs,
                SBX_LAST_SEQ_NUM,
                ver_to_usize};

use cli_utils::report_ref_block_info;

use time_utils;
use block_utils;

use rs_codec::RSRepairer;
use rs_codec::RSCodecState;

use block_utils::RefBlockChoice;
use sbx_block::BlockType;

#[derive(Clone, Debug)]
pub struct Stats {
    version                              : Version,
    pub meta_blocks_decoded              : u64,
    pub data_or_par_blocks_decoded       : u64,
    pub blocks_decode_failed             : u64,
    pub meta_blocks_repaired             : u64,
    pub data_or_par_blocks_repaired      : u64,
    pub data_or_par_blocks_repair_failed : u64,
    total_blocks                         : u64,
    start_time                           : f64,
    end_time                             : f64,
    json_printer                         : Arc<JSONPrinter>,
}

impl Stats {
    pub fn new(ref_block    : &Block,
               total_blocks : u64,
               json_printer : &Arc<JSONPrinter>)
               -> Stats {
        Stats {
            version                          : ref_block.get_version(),
            blocks_decode_failed             : 0,
            meta_blocks_decoded              : 0,
            data_or_par_blocks_decoded       : 0,
            meta_blocks_repaired             : 0,
            data_or_par_blocks_repaired      : 0,
            data_or_par_blocks_repair_failed : 0,
            total_blocks,
            start_time                       : 0.,
            end_time                         : 0.,
            json_printer                     : Arc::clone(json_printer),
        }
    }
}

impl ProgressReport for Stats {
    fn start_time_mut(&mut self) -> &mut f64 { &mut self.start_time }

    fn end_time_mut(&mut self)   -> &mut f64 { &mut self.end_time }

    fn units_so_far(&self)       -> u64      {
        (self.meta_blocks_decoded
         + self.data_or_par_blocks_decoded
         + self.blocks_decode_failed) as u64
    }

    fn total_units(&self)        -> u64      { self.total_blocks as u64 }
}

impl fmt::Display for Stats {
    fn fmt(&self, f : &mut fmt::Formatter) -> fmt::Result {
        let block_size             = ver_to_block_size(self.version);
        let time_elapsed           = (self.end_time - self.start_time) as i64;
        let (hour, minute, second) = time_utils::seconds_to_hms(time_elapsed);

        let json_printer = &self.json_printer;

        json_printer.write_open_bracket(f, Some("stats"), BracketType::Curly)?;

        write_maybe_json!(f, json_printer, "SBX version                              : {}", ver_to_usize(self.version))?;
        write_maybe_json!(f, json_printer, "Block size used in checking              : {}", block_size                            => skip_quotes)?;
        write_maybe_json!(f, json_printer, "Number of blocks processed               : {}", self.units_so_far()                   => skip_quotes)?;
        write_maybe_json!(f, json_printer, "Number of blocks passed check (metadata) : {}", self.meta_blocks_decoded              => skip_quotes)?;
        write_maybe_json!(f, json_printer, "Number of blocks passed check (data)     : {}", self.data_or_par_blocks_decoded       => skip_quotes)?;
        write_maybe_json!(f, json_printer, "Number of blocks failed check            : {}", self.blocks_decode_failed             => skip_quotes)?;
        write_maybe_json!(f, json_printer, "Number of blocks repaired (metadata)     : {}", self.meta_blocks_repaired             => skip_quotes)?;
        write_maybe_json!(f, json_printer, "Number of blocks repaired (data)         : {}", self.data_or_par_blocks_repaired      => skip_quotes)?;
        write_maybe_json!(f, json_printer, "Number of blocks failed to repair (data) : {}", self.data_or_par_blocks_repair_failed => skip_quotes)?;
        write_maybe_json!(f, json_printer, "Time elapsed                             : {:02}:{:02}:{:02}", hour, minute, second)?;

        if self.blocks_decode_failed == 0 {
            write_if!(not_json => f, json_printer => "No repairs required";)?;
        } else {
            if self.data_or_par_blocks_repair_failed == 0 {
                write_if!(not_json => f, json_printer => "All corrupted/missing blocks were repaired successfully";)?;
            } else {
                if self.blocks_decode_failed == self.data_or_par_blocks_repair_failed {
                    write_if!(not_json => f, json_printer => "All repairs failed";)?;
                } else {
                    write_if!(not_json => f, json_printer => "Some repairs failed";)?;
                }
            }
        }

        json_printer.write_close_bracket(f)?;

        Ok(())
    }
}

#[derive(Clone, Debug)]
pub struct Param {
    in_file            : String,
    dry_run            : bool,
    json_printer       : Arc<JSONPrinter>,
    verbose            : bool,
    pr_verbosity_level : PRVerbosityLevel,
    burst              : Option<usize>,
}

impl Param {
    pub fn new(in_file            : &str,
               dry_run            : bool,
               json_printer       : &Arc<JSONPrinter>,
               verbose            : bool,
               pr_verbosity_level : PRVerbosityLevel,
               burst              : Option<usize>) -> Param {
        Param {
            in_file            : String::from(in_file),
            dry_run,
            json_printer       : Arc::clone(json_printer),
            verbose,
            pr_verbosity_level,
            burst,
        }
    }
}

fn update_rs_codec_and_stats(version     : Version,
                             pred        : &Fn(&Block) -> bool,
                             read_res    : &ReadResult,
                             block       : &mut Block,
                             cur_seq_num : u32,
                             rs_codec    : &mut RSRepairer,
                             stats       : &Arc<Mutex<Stats>>)
                             -> RSCodecState {
    let block_size = ver_to_block_size(version);

    if read_res.len_read < block_size {   // read an incomplete block
        stats.lock().unwrap().blocks_decode_failed += 1;
        rs_codec.mark_missing()
    } else if let Err(_) = block.sync_from_buffer(rs_codec.get_block_buffer(),
                                                  Some(pred)) {
        stats.lock().unwrap().blocks_decode_failed += 1;
        rs_codec.mark_missing()
    } else {
        if block.get_seq_num() != cur_seq_num {
            stats.lock().unwrap().blocks_decode_failed += 1;
            rs_codec.mark_missing()
        } else {
            if block.is_meta() {
                stats.lock().unwrap().meta_blocks_decoded += 1;
            } else {
                stats.lock().unwrap().data_or_par_blocks_decoded += 1;
            }

            rs_codec.mark_present()
        }
    }
}

fn repair_blocks_and_update_stats_using_repair_stats(param       : &Param,
                                                     cur_seq_num : u32,
                                                     rs_codec    : &mut RSRepairer,
                                                     stats       : &Arc<Mutex<Stats>>,
                                                     reader      : &mut FileReader,
                                                     reporter    : &ProgressReporter<Stats>)
                                                     -> Result<(), Error> {
    let (repair_stats, repaired_blocks) =
        rs_codec.repair_with_block_sync(cur_seq_num);

    if repair_stats.successful {
        stats.lock().unwrap().data_or_par_blocks_repaired +=
            repair_stats.missing_count as u64;
    } else {
        stats.lock().unwrap().data_or_par_blocks_repair_failed +=
            repair_stats.missing_count as u64;
    }

    if repair_stats.missing_count > 0 {
        print_if!(verbose => param, reporter =>
                  "{}", repair_stats;);
    }

    if !param.dry_run {
        // write the repaired data blocks
        for &(pos, block_buf) in repaired_blocks.iter() {
            reader.seek(SeekFrom::Start(pos))?;
            reader.write(&block_buf)?;
        }
    }

    Ok(())
}

pub fn repair_file(param : &Param)
                   -> Result<Option<Stats>, Error> {
    let ctrlc_stop_flag = setup_ctrlc_handler(param.json_printer.json_enabled());

    let json_printer = &param.json_printer;

    let (ref_block_pos, mut ref_block) = get_ref_block!(param,
                                                        json_printer,
                                                        RefBlockChoice::MustBe(BlockType::Meta),
                                                        ctrlc_stop_flag);

    let version = ref_block.get_version();

    return_if_not_ver_uses_rs!(version, json_printer);

    let block_size = ver_to_block_size(version);

    let burst = get_burst_or_guess!(param,
                                    ref_block_pos,
                                    ref_block);

    let data_par_burst =
        Some((get_RSD_from_ref_block!(ref_block_pos, ref_block, "repair"),
              get_RSP_from_ref_block!(ref_block_pos, ref_block, "repair"),
              burst));

    let total_block_count = {
        use file_utils::from_orig_file_size::calc_total_block_count_exc_burst_gaps;
        match ref_block.get_FSZ().unwrap() {
            Some(x) =>
                calc_total_block_count_exc_burst_gaps(version,
                                                      None,
                                                      data_par_burst,
                                                      x),
            None    => {
                print_if!(not_json => json_printer =>
                          "";
                          "Warning :";
                          "";
                          "    No recorded file size found, using container file size to estimate total";
                          "    number of blocks. This may overestimate total number of blocks, and may";
                          "    show false repair/verify failures when gaps in container are encountered.";
                          "";
                );
                let file_size = file_utils::get_file_size(&param.in_file)?;
                file_size / block_size as u64
            },
        }
    };

    let stats = Arc::new(Mutex::new(Stats::new(&ref_block, total_block_count, json_printer)));

    let mut reader = FileReader::new(&param.in_file,
                                     FileReaderParam { write    : !param.dry_run,
                                                       buffered : true  })?;

    let mut block = Block::dummy();

    let reporter = Arc::new(ProgressReporter::new(&stats,
                                                  "SBX block repairing progress",
                                                  "blocks",
                                                  param.pr_verbosity_level,
                                                  param.json_printer.json_enabled()));

    let pred = block_pred_same_ver_uid!(ref_block);

    let mut rs_codec = RSRepairer::new(&param.json_printer,
                                       &ref_block,
                                       data_par_burst.unwrap().0,
                                       data_par_burst.unwrap().1,
                                       data_par_burst.unwrap().2);

    reporter.start();

    json_printer.print_open_bracket(Some("metadata repairs"), BracketType::Square);
    // replace metadata blocks with reference block if broken
    {
        let mut buffer : [u8; SBX_LARGEST_BLOCK_SIZE] =
            [0; SBX_LARGEST_BLOCK_SIZE];

        ref_block.sync_to_buffer(None, &mut buffer).unwrap();

        for &p in sbx_block::calc_meta_block_all_write_pos_s(version,
                                                             data_par_burst).iter()
        {
            break_if_atomic_bool!(ctrlc_stop_flag);

            reader.seek(SeekFrom::Start(p))?;
            reader.read(sbx_block::slice_buf_mut(version, &mut buffer))?;
            match block.sync_from_buffer(&buffer, Some(&pred)) {
                Ok(()) => {
                    stats.lock().unwrap().meta_blocks_decoded += 1;
                },
                Err(_) => {
                    if json_printer.json_enabled() {
                        if param.verbose {
                            json_printer.print_open_bracket(None, BracketType::Curly);

                            print_maybe_json!(param.json_printer, "seq num : 0");
                            print_maybe_json!(param.json_printer, "pos : {}", p);

                            json_printer.print_close_bracket();
                        }
                    } else {
                        print_if!(verbose => param, reporter =>
                                  "Replaced invalid metadata block at {} (0x{:X}) with reference block", p, p;);
                    }

                    stats.lock().unwrap().blocks_decode_failed += 1;

                    reader.seek(SeekFrom::Start(p))?;

                    ref_block.sync_to_buffer(None, &mut buffer).unwrap();
                    if !param.dry_run {
                        reader.write(sbx_block::slice_buf(version, &buffer))?;
                    }

                    stats.lock().unwrap().meta_blocks_repaired += 1;
                }
            }
        }
    }
    json_printer.print_close_bracket();

    if stats.lock().unwrap().meta_blocks_repaired > 0 {
        print_if!(verbose not_json => param, json_printer => "";);
    }

    json_printer.print_open_bracket(Some("data repairs"), BracketType::Square);
    // repair data blocks
    let mut seq_num = 1;
    while seq_num <= SBX_LAST_SEQ_NUM {
        break_if_atomic_bool!(ctrlc_stop_flag);

        if stats.lock().unwrap().units_so_far() >= total_block_count { break; }

        let pos = sbx_block::calc_data_block_write_pos(version,
                                                       seq_num,
                                                       None,
                                                       data_par_burst);

        reader.seek(SeekFrom::Start(pos))?;

        let read_res = reader.read(rs_codec.get_block_buffer())?;

        let codec_state =
            update_rs_codec_and_stats(version,
                                      &pred,
                                      &read_res,
                                      &mut block,
                                      seq_num,
                                      &mut rs_codec,
                                      &stats);

        match codec_state {
            RSCodecState::Ready => {
                repair_blocks_and_update_stats_using_repair_stats(&param,
                                                                  seq_num,
                                                                  &mut rs_codec,
                                                                  &stats,
                                                                  &mut reader,
                                                                  &reporter)?;
            },
            RSCodecState::NotReady => {},
        }

        seq_num += 1;
    }
    json_printer.print_close_bracket();

    if stats.lock().unwrap().blocks_decode_failed > 0 {
        print_if!(verbose not_json => param, json_printer => "";);
    }

    reporter.stop();

    let stats = stats.lock().unwrap().clone();

    Ok(Some(stats))
}