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
extern crate libc;
use std::convert::TryInto;
use std::ffi::c_void;

pub(crate) mod raw;

pub type Result<T> = std::result::Result<T, Error>;

/// Convenience Error type
#[derive(thiserror::Error, Debug)]
pub enum Error {
    #[error("Header expected but not found.")]
    NoHeader,
    #[error("Invalid header format.")]
    InvalidHeader,
    #[error("LZO initialization failed: {code:?}")]
    LzoInit { code: i8 },
    #[error("LZO de/compression error: {code:?}")]
    LzoError { code: i8 },
}

// Required by LZO to be called before operations
fn init() -> Result<()> {
    let r = unsafe { raw::lzo_initialize() };
    if r != 0 {
        Err(Error::LzoInit { code: r as i8 })
    } else {
        Ok(())
    }
}

/// Calculate the max compressed len of an input.
pub fn max_compress_len(input_len: usize) -> usize {
    // ref: docs/LZO.FAQ
    input_len + (input_len / 16) + 64 + 3
}

/// Convenience function to handle vec allocation for decompression, taking into account the header.
///
/// ### Note
/// Will always fail if the input does not contain a header; if this is your case, you'll need
/// to pre-allocate a vec of appropriate length for decompression output and use [decompress](fn.decompress.html)
/// directly.
pub fn decompress_vec(input: &[u8]) -> Result<Vec<u8>> {
    if [0xf0, 0xf1].contains(&input[0]) {
        let length_bytes: [u8; 4] = input[1..5].try_into().map_err(|_| Error::InvalidHeader)?;
        let length = u32::from_be_bytes(length_bytes) as usize;
        let mut output = vec![0; length];
        let n = decompress(input, output.as_mut_slice())?;
        output.truncate(n);
        Ok(output)
    } else {
        Err(Error::NoHeader)
    }
}

/// Decompress input into output. Will ignore any header if present in the input.
pub fn decompress(input: &[u8], output: &mut [u8]) -> Result<usize> {
    init()?;

    // Determine if there is a header
    let input_buf = if [0xf0, 0xf1].contains(&input[0]) {
        &input[5..]
    } else {
        &input[..]
    };

    let n_bytes_written = unsafe {
        let mut wrkmem: [u8; 0] = std::mem::MaybeUninit::uninit().assume_init();
        let out_len: u32 = 0;
        let r = raw::lzo1x_decompress(
            input_buf.as_ptr(),
            input_buf.len() as _,
            output.as_mut_ptr(),
            &out_len as *const _ as *mut _,
            wrkmem.as_mut_ptr() as *mut c_void,
        );
        if r != 0 {
            return Err(Error::LzoError { code: r as i8 });
        }
        out_len
    };
    Ok(n_bytes_written as usize)
}

/// Compress input into output buffer, optionally with a header written to the front of the output
/// buffer.
pub fn compress(input: &[u8], output: &mut [u8], header: bool) -> Result<usize> {
    init()?;

    let mut out_len = 0;
    let out = if header {
        &mut output[5..]
    } else {
        &mut output[..]
    };
    let r = unsafe {
        let mut wrkmem: [u8; 64000] = std::mem::MaybeUninit::uninit().assume_init();
        raw::lzo1x_1_compress(
            input.as_ptr(),
            input.len() as _,
            out.as_mut_ptr(),
            &out_len as *const _ as *mut _,
            wrkmem.as_mut_ptr() as *mut c_void,
        )
    };
    if r != 0 {
        return Err(Error::LzoError { code: r as i8 });
    }
    if header {
        output[0] = 0xf0;
        output[1..5].copy_from_slice(&(input.len() as u32).to_be_bytes());
        out_len += 5;
    }
    Ok(out_len as usize)
}

/// Convenience function to compress input into an appropriately sized output buffer, optionally
/// with a header.
pub fn compress_vec(input: &[u8], header: bool) -> Result<Vec<u8>> {
    let mut output = vec![0; max_compress_len(input.len())];
    let n = compress(input, output.as_mut_slice(), header)?;
    output.truncate(n);
    Ok(output)
}

#[cfg(test)]
mod tests {
    use crate::{compress, compress_vec, decompress, decompress_vec, max_compress_len};

    fn gen_data() -> Vec<u8> {
        (0..100000)
            .map(|_| b"Oh what a beautiful day, oh what a beaitufl morning!!!".to_vec())
            .flat_map(|v| v)
            .collect::<Vec<u8>>()
    }

    #[test]
    fn roundtrip_slices_with_header() {
        let input = gen_data();

        let mut compressed = vec![0; max_compress_len(input.len())];
        let n_bytes = compress(&input, compressed.as_mut_slice(), true).unwrap();

        let mut decompressed: Vec<u8> = vec![0; input.len()];
        let n_bytes = decompress(&compressed[..n_bytes], decompressed.as_mut_slice()).unwrap();

        assert_eq!(&decompressed[..n_bytes], input.as_slice());
    }

    #[test]
    fn roundtrip_slices_without_header() {
        let input = gen_data();

        let mut compressed = vec![0; max_compress_len(input.len())];
        let n_bytes = compress(&input, compressed.as_mut_slice(), false).unwrap();

        let mut decompressed: Vec<u8> = vec![0; input.len()];
        let n_bytes = decompress(&compressed[..n_bytes], decompressed.as_mut_slice()).unwrap();

        assert_eq!(&decompressed[..n_bytes], input.as_slice());
    }

    #[test]
    fn rountrip_vecs_with_header() {
        let input = gen_data();
        let compressed = compress_vec(input.as_slice(), true).unwrap();
        let decompressed = decompress_vec(compressed.as_slice()).unwrap();
        assert_eq!(decompressed, input);
    }

    #[test]
    fn rountrip_vecs_without_header() {
        let input = gen_data();
        let compressed = compress_vec(input.as_slice(), false).unwrap();
        let decompressed = decompress_vec(compressed.as_slice());
        assert!(decompressed.is_err()) // decompress_vec needs to have a header.
    }

    // expected output from python-lzo: lzo.compress(b'bytes')
    #[test]
    fn expected_format_with_header() {
        let input = b"bytes".to_vec();
        let output = compress_vec(input.as_slice(), true).unwrap();
        assert_eq!(output, b"\xf0\x00\x00\x00\x05\x16bytes\x11\x00\x00")
    }

    // expected output from python-lzo: lzo.compress(b'bytes', 1, False) where 1 level and False header
    #[test]
    fn expected_format_without_header() {
        let input = b"bytes".to_vec();
        let output = compress_vec(input.as_slice(), false).unwrap();
        assert_eq!(output, b"\x16bytes\x11\x00\x00")
    }
}