Valgrind complains about uninitialized values

[xTibor]

Valgrind complains about uninitialized values

[dtolnay]

According to https://doc.rust-lang.org/nightly/unstable-book/compiler-flags/sanitizer.html#memorysanitizer you need to build with -Zbuild-std in order for initializations inside the standard library to be understood by MemorySanitizer, otherwise you get false positives. That looks like what this is because building with -Zbuid-std does not report any uninitialized accesses.

$ cargo clean
$ export RUSTFLAGS='-Zsanitizer=memory -Zsanitizer-memory-track-origins'
$ cargo run -Zbuild-std --target x86_64-unknown-linux-gnu --release

[dtolnay]

This crate contains zero unsafe code so the root cause is almost surely not in this crate.

[hoodie]

linked hashmap does though
https://github.com/contain-rs/linked-hash-map/blob/4f681be6f3b1b2c7d67647ce3abbe48470e20855/src/lib.rs#L73

[dtolnay]

This reproduces without linked-hash-map though, so it looks like an LLVM or rustc bug. Reduced somewhat:

enum Token {
    DocumentStart,
    #[allow(dead_code)]
    Tag(String, String),
}

fn main() {
    let _ = peek_token(&mut None);
    if process_directives(&mut None).is_err() {
        let _ = process_directives(&mut None);
    }
    skip(&mut None);
}

fn peek_token(token: &mut Option<Token>) -> Result<&Token, String> {
    *token = Some(*Box::new(Token::DocumentStart));
    Ok(token.as_ref().unwrap())
}

fn skip(token: &mut Option<Token>) {
    *token = None;
}

fn process_directives(token: &mut Option<Token>) -> Result<(), String> {
    loop {
        match peek_token(token)? {
            Token::Tag(..) => {}
            _ => break,
        }
        skip(token);
    }
    Ok(())
}

$ cargo build --release && valgrind target/release/testing 
   Compiling testing v0.0.0
    Finished release [optimized] target(s) in 0.25s
==12801== Memcheck, a memory error detector
==12801== Copyright (C) 2002-2017, and GNU GPL'd, by Julian Seward et al.
==12801== Using Valgrind-3.15.0 and LibVEX; rerun with -h for copyright info
==12801== Command: target/release/testing
==12801== 
==12801== Conditional jump or move depends on uninitialised value(s)
==12801==    at 0x10D8E3: testing::parser_process_directives (in /git/testing/target/release/testing)
==12801==    by 0x10D3B6: testing::main (in /git/testing/target/release/testing)
==12801==    by 0x10DAC2: std::rt::lang_start::{{closure}} (in /git/testing/target/release/testing)
==12801==    by 0x115887: {{closure}} (rt.rs:52)
==12801==    by 0x115887: do_call<closure-0,i32> (panicking.rs:297)
==12801==    by 0x115887: try<i32,closure-0> (panicking.rs:274)
==12801==    by 0x115887: catch_unwind<closure-0,i32> (panic.rs:394)
==12801==    by 0x115887: std::rt::lang_start_internal (rt.rs:51)
==12801==    by 0x10D971: main (in /git/testing/target/release/testing)
==12801== 
==12801== 
==12801== HEAP SUMMARY:
==12801==     in use at exit: 0 bytes in 0 blocks
==12801==   total heap usage: 12 allocs, 12 frees, 2,561 bytes allocated
==12801== 
==12801== All heap blocks were freed -- no leaks are possible
==12801== 
==12801== Use --track-origins=yes to see where uninitialised values come from
==12801== For lists of detected and suppressed errors, rerun with: -s
==12801== ERROR SUMMARY: 1 errors from 1 contexts (suppressed: 0 from 0)