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
pub mod wirehair {
    use std::fmt::{Display, Error, Formatter};
    use std::os::raw::{c_int, c_void};
    use std::ptr::null;

    #[repr(C)]
    enum WirehairResultCode {
        // Success code
        Success = 0,
        // More data is needed to decode.  This is normal and does not indicate a failure
        NeedMore = 1,
        // Other values are failure codes:
        // A function parameter was invalid
        InvalidInput = 2,
        // Encoder needs a better dense seed
        BadDenseSeed = 3,
        // Encoder needs a better peel seed
        BadPeelSeed = 4,
        // N = ceil(messageBytes / blockBytes) is too small.
        // Try reducing block_size or use a larger message
        BadInputSmallN = 5,
        // N = ceil(messageBytes / blockBytes) is too large.
        // Try increasing block_size or use a smaller message
        BadInputLargeN = 6,
        // Not enough extra rows to solve it, must give up
        ExtraInsufficient = 7,
        // An error occurred during the request
        Error = 8,
        // Out of memory
        OOM = 9,
        // Platform is not supported yet
        UnsupportedPlatform = 10,
        Count,
        /* for asserts */
        Padding = 0x7fff_ffff,
        /* int32_t padding */
    }

    #[link(name = "wirehair")]
    extern "C" {
        fn wirehair_init_(version: c_int) -> WirehairResultCode;
        fn wirehair_encoder_create(
            reuse_codec_opt: *const c_void,
            message: *const u8,
            message_size_bytes: u64,
            block_size_bytes: u32,
        ) -> *const c_void;
        fn wirehair_encode(
            codec: *const c_void,
            block_id: u64,
            block: *mut u8,
            block_size: u32,
            block_out_bytes: &mut u32,
        ) -> WirehairResultCode;
        fn wirehair_decoder_create(
            reuse_codec_opt: *const c_void,
            message_size_bytes: u64,
            block_size_bytes: u32,
        ) -> *const c_void;
        fn wirehair_decode(
            codec: *const c_void,
            block_id: u64,
            block: *const u8,
            block_out_bytes: u32,
        ) -> WirehairResultCode;
        fn wirehair_recover(
            codec: *const c_void,
            message: *mut u8,
            message_size_bytes: u64,
        ) -> WirehairResultCode;
        fn wirehair_decoder_becomes_encoder(codec: *const c_void) -> WirehairResultCode;
        fn wirehair_free(codec: *const c_void) -> c_void;
    }

    #[derive(Debug, PartialEq)]
    pub enum WirehairError {
        InvalidInput,
        BadDenseSeed,
        BadPeelSeed,
        BadInputSmallN,
        BadInputLargeN,
        ExtraInsufficient,
        Error,
        OOM,
        UnsupportedPlatform,
    }

    impl Display for WirehairError {
        fn fmt(&self, f: &mut Formatter) -> Result<(), Error> {
            match *self {
                WirehairError::InvalidInput => write!(f, "A function parameter was invalid"),
                WirehairError::BadDenseSeed => write!(f, "Encoder needs a better dense seed"),
                WirehairError::BadPeelSeed => write!(f, "Encoder needs a better peel seed"),
                WirehairError::BadInputSmallN => write!(
                    f,
                    "Too less blocks! Try reducing block size or use a larger message"
                ),
                WirehairError::BadInputLargeN => write!(
                    f,
                    "Too many blocks! Try increasing block_size or use a smaller message"
                ),
                WirehairError::ExtraInsufficient => write!(
                    f,
                    "Not enough extra rows to solve it, possibly corrupted data"
                ),
                WirehairError::Error => write!(f, "Unexpected error"),
                WirehairError::OOM => write!(f, "Out of memory"),
                WirehairError::UnsupportedPlatform => write!(f, "Platform is not supported yet"),
            }
        }
    }

    #[derive(Debug, PartialEq)]
    pub enum WirehairResult {
        Success,
        NeedMore,
        Internal,
    }

    fn parse_wirehair_result(result: WirehairResultCode) -> Result<WirehairResult, WirehairError> {
        match result {
            WirehairResultCode::InvalidInput => Err(WirehairError::InvalidInput),
            WirehairResultCode::BadDenseSeed => Err(WirehairError::BadDenseSeed),
            WirehairResultCode::BadPeelSeed => Err(WirehairError::BadPeelSeed),
            WirehairResultCode::BadInputSmallN => Err(WirehairError::BadInputSmallN),
            WirehairResultCode::BadInputLargeN => Err(WirehairError::BadInputLargeN),
            WirehairResultCode::ExtraInsufficient => Err(WirehairError::ExtraInsufficient),
            WirehairResultCode::Error => Err(WirehairError::Error),
            WirehairResultCode::OOM => Err(WirehairError::OOM),
            WirehairResultCode::UnsupportedPlatform => Err(WirehairError::UnsupportedPlatform),
            WirehairResultCode::Success => Ok(WirehairResult::Success),
            WirehairResultCode::NeedMore => Ok(WirehairResult::NeedMore),
            _ => Ok(WirehairResult::Internal),
        }
    }

    pub fn wirehair_init() -> Result<(), WirehairError> {
        let result = unsafe { parse_wirehair_result(wirehair_init_(2)) };
        match result {
            Ok(_r) => Ok(()),
            Err(e) => Err(e),
        }
    }

    pub fn wirehair_decoder_to_encoder(
        decoder: WirehairDecoder,
    ) -> Result<WirehairEncoder, WirehairError> {
        let result = unsafe { wirehair_decoder_becomes_encoder(decoder.native_handler) };

        match parse_wirehair_result(result) {
            Ok(_) => Ok(WirehairEncoder {
                native_handler: decoder.native_handler,
            }),
            Err(e) => Err(e),
        }
    }

    pub struct WirehairEncoder {
        native_handler: *const c_void,
    }

    impl WirehairEncoder {
        pub fn new(
            message: &[u8],
            message_size_bytes: u64,
            block_size_bytes: u32,
        ) -> WirehairEncoder {
            WirehairEncoder {
                native_handler: unsafe {
                    wirehair_encoder_create(
                        null::<c_void>(),
                        message.as_ptr(),
                        message_size_bytes,
                        block_size_bytes,
                    )
                },
            }
        }

        pub fn encode(
            &self,
            block_id: u64,
            block: &mut [u8],
            block_size: u32,
            block_out_bytes: &mut u32,
        ) -> Result<WirehairResult, WirehairError> {
            let result = unsafe {
                wirehair_encode(
                    self.native_handler,
                    block_id,
                    block.as_mut_ptr(),
                    block_size,
                    block_out_bytes,
                )
            };

            parse_wirehair_result(result)
        }
    }

    impl Drop for WirehairEncoder {
        fn drop(&mut self) {
            unsafe { wirehair_free(self.native_handler) };
        }
    }

    pub struct WirehairDecoder {
        native_handler: *const c_void,
    }

    impl WirehairDecoder {
        pub fn new(message_size_bytes: u64, block_size_bytes: u32) -> WirehairDecoder {
            WirehairDecoder {
                native_handler: unsafe {
                    wirehair_decoder_create(null::<c_void>(), message_size_bytes, block_size_bytes)
                },
            }
        }

        pub fn decode(
            &self,
            block_id: u64,
            block: &[u8],
            block_out_size_bytes: u32,
        ) -> Result<WirehairResult, WirehairError> {
            let result = unsafe {
                wirehair_decode(
                    self.native_handler,
                    block_id,
                    block.as_ptr(),
                    block_out_size_bytes,
                )
            };

            parse_wirehair_result(result)
        }

        pub fn recover(
            &self,
            message: &mut [u8],
            message_size_bytes: u64,
        ) -> Result<WirehairResult, WirehairError> {
            let result = unsafe {
                wirehair_recover(
                    self.native_handler,
                    message.as_mut_ptr(),
                    message_size_bytes,
                )
            };

            parse_wirehair_result(result)
        }
    }
}

#[cfg(test)]
mod tests {
    use super::wirehair::*;

    #[test]
    fn basic_flow_works() {
        assert!(wirehair_init().is_ok());

        let mut message = [0u8; 500];
        for i in 0..500 {
            message[i] = i as u8
        }

        let encoder = WirehairEncoder::new(&message, 500, 50);
        let decoder = WirehairDecoder::new(500, 50);

        let mut block_id = 0;

        loop {
            let mut block = [0u8; 50];
            let mut block_out_bytes: u32 = 0;
            let result = encoder.encode(block_id, &mut block, 50, &mut block_out_bytes);
            assert!(result.is_ok());

            if block_id % 5 == 0 {
                block_id += 1;
                continue;
            }

            let result = decoder.decode(block_id, &block, block_out_bytes);
            assert!(result.is_ok());

            block_id += 1;

            match result.unwrap() {
                WirehairResult::NeedMore => continue,
                WirehairResult::Success => break,
                _ => panic!(),
            }
        }

        let mut decoded_message = [0u8; 500];

        let result = decoder.recover(&mut decoded_message, 500);
        assert!(result.is_ok());

        assert!(wirehair_decoder_to_encoder(decoder).is_ok());
    }
}