-
Notifications
You must be signed in to change notification settings - Fork 23
/
leopard.cpp
347 lines (291 loc) · 10.1 KB
/
leopard.cpp
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
/*
Copyright (c) 2017 Christopher A. Taylor. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of Leopard-RS nor the names of its contributors may be
used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
*/
#include "leopard.h"
#include "LeopardCommon.h"
#ifdef LEO_HAS_FF8
#include "LeopardFF8.h"
#endif // LEO_HAS_FF8
#ifdef LEO_HAS_FF16
#include "LeopardFF16.h"
#endif // LEO_HAS_FF16
#include <string.h>
extern "C" {
//------------------------------------------------------------------------------
// Initialization API
static bool m_Initialized = false;
LEO_EXPORT int leo_init_(int version)
{
if (version != LEO_VERSION)
return Leopard_InvalidInput;
leopard::InitializeCPUArch();
#ifdef LEO_HAS_FF8
if (!leopard::ff8::Initialize())
return Leopard_Platform;
#endif // LEO_HAS_FF8
#ifdef LEO_HAS_FF16
if (!leopard::ff16::Initialize())
return Leopard_Platform;
#endif // LEO_HAS_FF16
m_Initialized = true;
return Leopard_Success;
}
//------------------------------------------------------------------------------
// Result
LEO_EXPORT const char* leo_result_string(LeopardResult result)
{
switch (result)
{
case Leopard_Success: return "Operation succeeded";
case Leopard_NeedMoreData: return "Not enough recovery data received";
case Leopard_TooMuchData: return "Buffer counts are too high";
case Leopard_InvalidSize: return "Buffer size must be a multiple of 64 bytes";
case Leopard_InvalidCounts: return "Invalid counts provided";
case Leopard_InvalidInput: return "A function parameter was invalid";
case Leopard_Platform: return "Platform is unsupported";
case Leopard_CallInitialize: return "Call leo_init() first";
}
return "Unknown";
}
//------------------------------------------------------------------------------
// Encoder API
LEO_EXPORT unsigned leo_encode_work_count(
unsigned original_count,
unsigned recovery_count)
{
if (original_count == 1)
return recovery_count;
if (recovery_count == 1)
return 1;
return leopard::NextPow2(recovery_count) * 2;
}
// recovery_data = parity of original_data (xor sum)
static void EncodeM1(
uint64_t buffer_bytes,
unsigned original_count,
const void* const * const original_data,
void* recovery_data)
{
memcpy(recovery_data, original_data[0], buffer_bytes);
leopard::XORSummer summer;
summer.Initialize(recovery_data);
for (unsigned i = 1; i < original_count; ++i)
summer.Add(original_data[i], buffer_bytes);
summer.Finalize(buffer_bytes);
}
LEO_EXPORT LeopardResult leo_encode(
uint64_t buffer_bytes, // Number of bytes in each data buffer
unsigned original_count, // Number of original_data[] buffer pointers
unsigned recovery_count, // Number of recovery_data[] buffer pointers
unsigned work_count, // Number of work_data[] buffer pointers, from leo_encode_work_count()
const void* const * const original_data, // Array of pointers to original data buffers
void** work_data) // Array of work buffers
{
if (buffer_bytes <= 0 || buffer_bytes % 64 != 0)
return Leopard_InvalidSize;
if (recovery_count <= 0 || recovery_count > original_count)
return Leopard_InvalidCounts;
if (!original_data || !work_data)
return Leopard_InvalidInput;
if (!m_Initialized)
return Leopard_CallInitialize;
// Handle k = 1 case
if (original_count == 1)
{
for (unsigned i = 0; i < recovery_count; ++i)
memcpy(work_data[i], original_data[i], buffer_bytes);
return Leopard_Success;
}
// Handle m = 1 case
if (recovery_count == 1)
{
EncodeM1(
buffer_bytes,
original_count,
original_data,
work_data[0]);
return Leopard_Success;
}
const unsigned m = leopard::NextPow2(recovery_count);
const unsigned n = leopard::NextPow2(m + original_count);
if (work_count != m * 2)
return Leopard_InvalidCounts;
#ifdef LEO_HAS_FF8
if (n <= leopard::ff8::kOrder)
{
leopard::ff8::ReedSolomonEncode(
buffer_bytes,
original_count,
recovery_count,
m,
original_data,
work_data);
}
else
#endif // LEO_HAS_FF8
#ifdef LEO_HAS_FF16
if (n <= leopard::ff16::kOrder)
{
leopard::ff16::ReedSolomonEncode(
buffer_bytes,
original_count,
recovery_count,
m,
original_data,
work_data);
}
else
#endif // LEO_HAS_FF16
return Leopard_TooMuchData;
return Leopard_Success;
}
//------------------------------------------------------------------------------
// Decoder API
LEO_EXPORT unsigned leo_decode_work_count(
unsigned original_count,
unsigned recovery_count)
{
if (original_count == 1 || recovery_count == 1)
return original_count;
const unsigned m = leopard::NextPow2(recovery_count);
const unsigned n = leopard::NextPow2(m + original_count);
return n;
}
static void DecodeM1(
uint64_t buffer_bytes,
unsigned original_count,
const void* const * original_data,
const void* recovery_data,
void* work_data)
{
memcpy(work_data, recovery_data, buffer_bytes);
leopard::XORSummer summer;
summer.Initialize(work_data);
for (unsigned i = 0; i < original_count; ++i)
if (original_data[i])
summer.Add(original_data[i], buffer_bytes);
summer.Finalize(buffer_bytes);
}
LEO_EXPORT LeopardResult leo_decode(
uint64_t buffer_bytes, // Number of bytes in each data buffer
unsigned original_count, // Number of original_data[] buffer pointers
unsigned recovery_count, // Number of recovery_data[] buffer pointers
unsigned work_count, // Number of buffer pointers in work_data[]
const void* const * const original_data, // Array of original data buffers
const void* const * const recovery_data, // Array of recovery data buffers
void** work_data) // Array of work data buffers
{
if (buffer_bytes <= 0 || buffer_bytes % 64 != 0)
return Leopard_InvalidSize;
if (recovery_count <= 0 || recovery_count > original_count)
return Leopard_InvalidCounts;
if (!original_data || !recovery_data || !work_data)
return Leopard_InvalidInput;
if (!m_Initialized)
return Leopard_CallInitialize;
// Check if not enough recovery data arrived
unsigned original_loss_count = 0;
unsigned original_loss_i = 0;
for (unsigned i = 0; i < original_count; ++i)
{
if (!original_data[i])
{
++original_loss_count;
original_loss_i = i;
}
}
unsigned recovery_got_count = 0;
unsigned recovery_got_i = 0;
for (unsigned i = 0; i < recovery_count; ++i)
{
if (recovery_data[i])
{
++recovery_got_count;
recovery_got_i = i;
}
}
if (recovery_got_count < original_loss_count)
return Leopard_NeedMoreData;
// Handle k = 1 case
if (original_count == 1)
{
memcpy(work_data[0], recovery_data[recovery_got_i], buffer_bytes);
return Leopard_Success;
}
// Handle case original_loss_count = 0
if (original_loss_count == 0)
{
for(unsigned i = 0; i < original_count; i++)
memcpy(work_data[i], original_data[i], buffer_bytes);
return Leopard_Success;
}
// Handle m = 1 case
if (recovery_count == 1)
{
DecodeM1(
buffer_bytes,
original_count,
original_data,
recovery_data[0],
work_data[original_loss_i]);
return Leopard_Success;
}
const unsigned m = leopard::NextPow2(recovery_count);
const unsigned n = leopard::NextPow2(m + original_count);
if (work_count != n)
return Leopard_InvalidCounts;
#ifdef LEO_HAS_FF8
if (n <= leopard::ff8::kOrder)
{
leopard::ff8::ReedSolomonDecode(
buffer_bytes,
original_count,
recovery_count,
m,
n,
original_data,
recovery_data,
work_data);
}
else
#endif // LEO_HAS_FF8
#ifdef LEO_HAS_FF16
if (n <= leopard::ff16::kOrder)
{
leopard::ff16::ReedSolomonDecode(
buffer_bytes,
original_count,
recovery_count,
m,
n,
original_data,
recovery_data,
work_data);
}
else
#endif // LEO_HAS_FF16
return Leopard_TooMuchData;
return Leopard_Success;
}
} // extern "C"