vlsvrs 1.0.0

VLSV reader with C and Python bindings
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

#include <stdarg.h>
#include <stddef.h>
#include <stdint.h>
#include <setjmp.h>
#include <cmocka.h>

#include <stdlib.h>
#include <stdio.h>
#include <string.h>

#include "utils/testMacros.h"
#include "utils/zfpChecksums.h"
#include "utils/zfpHash.h"

struct setupVars {
  size_t dimLens[4];
  Scalar* dataArr;
  void* buffer;
  size_t bufsizeBytes;
  zfp_stream* stream;
};

static void
populateInitialArray(Scalar** dataArrPtr)
{
  size_t i;
  *dataArrPtr = malloc(sizeof(Scalar) * BLOCK_SIZE);
  assert_non_null(*dataArrPtr);

  for (i = 0; i < BLOCK_SIZE; i++) {
#ifdef FL_PT_DATA
    (*dataArrPtr)[i] = nextSignedRandFlPt();
#else
    (*dataArrPtr)[i] = nextSignedRandInt();
#endif
  }
}

static void
populateInitialArraySpecial(Scalar* dataArr, int index)
{
#ifdef FL_PT_DATA
  // IEEE-754 special values
  static const uint32 special_float_values[] = {
    0x00000000u, // +0
    0x80000000u, // -0
    0x00000001u, // +FLT_TRUE_MIN
    0x80000001u, // -FLT_TRUE_MIN
    0x7f7fffffu, // +FLT_MAX
    0xff7fffffu, // -FLT_MAX
    0x7f800000u, // +infinity
    0xff800000u, // -infinity
    0x7fc00000u, // qNaN
    0x7fa00000u, // sNaN
  };
  static const uint64 special_double_values[] = {
    UINT64C(0x0000000000000000), // +0
    UINT64C(0x8000000000000000), // -0
    UINT64C(0x0000000000000001), // +DBL_TRUE_MIN
    UINT64C(0x8000000000000001), // -DBL_TRUE_MIN
    UINT64C(0x7fefffffffffffff), // +DBL_MAX
    UINT64C(0xffefffffffffffff), // -DBL_MAX
    UINT64C(0x7ff0000000000000), // +infinity
    UINT64C(0xfff0000000000000), // -infinity
    UINT64C(0x7ff8000000000000), // qNaN
    UINT64C(0x7ff4000000000000), // sNaN
  };
#endif
  size_t i;

  for (i = 0; i < BLOCK_SIZE; i++) {
#ifdef FL_PT_DATA
    // generate special values
    if ((i & 3u) == 0) {
      switch(ZFP_TYPE) {
        case zfp_type_float:
          memcpy(dataArr + i, &special_float_values[index], sizeof(Scalar));
          break;
        case zfp_type_double:
          memcpy(dataArr + i, &special_double_values[index], sizeof(Scalar));
          break;
      }
    }
    else
      dataArr[i] = 0;
#else
    dataArr[i] = nextSignedRandInt();
#endif
  }
}

// specialValueIndex -1 implies test without special values
static void
setupZfpStream(struct setupVars* bundle, int specialValueIndex)
{
  memset(bundle->dimLens, 0, sizeof(bundle->dimLens));
#if DIMS >= 1
  bundle->dimLens[0] = BLOCK_SIDE_LEN;
#endif
#if DIMS >= 2
  bundle->dimLens[1] = BLOCK_SIDE_LEN;
#endif
#if DIMS >= 3
  bundle->dimLens[2] = BLOCK_SIDE_LEN;
#endif
#if DIMS >= 4
  bundle->dimLens[3] = BLOCK_SIDE_LEN;
#endif
  size_t* n = bundle->dimLens;

  zfp_type type = ZFP_TYPE;
  zfp_field* field;
  switch (DIMS) {
    case 1:
      field = zfp_field_1d(bundle->dataArr, type, n[0]);
      break;
    case 2:
      field = zfp_field_2d(bundle->dataArr, type, n[0], n[1]);
      break;
    case 3:
      field = zfp_field_3d(bundle->dataArr, type, n[0], n[1], n[2]);
      break;
    case 4:
      field = zfp_field_4d(bundle->dataArr, type, n[0], n[1], n[2], n[3]);
      break;
  }

  zfp_stream* stream = zfp_stream_open(NULL);
  if (specialValueIndex >= 0) {
    zfp_stream_set_reversible(stream);
  } else {
    zfp_stream_set_rate(stream, ZFP_RATE_PARAM_BITS, type, DIMS, zfp_false);
  }

  size_t bufsizeBytes = zfp_stream_maximum_size(stream, field);
  char* buffer = calloc(bufsizeBytes, sizeof(char));
  assert_non_null(buffer);

  bitstream* s = stream_open(buffer, bufsizeBytes);
  assert_non_null(s);

  zfp_stream_set_bit_stream(stream, s);
  zfp_stream_rewind(stream);
  zfp_field_free(field);

  bundle->bufsizeBytes = bufsizeBytes;
  bundle->buffer = buffer;
  bundle->stream = stream;
}

static int
setup(void **state)
{
  struct setupVars *bundle = malloc(sizeof(struct setupVars));
  assert_non_null(bundle);

  resetRandGen();
  populateInitialArray(&bundle->dataArr);
  setupZfpStream(bundle, -1);

  *state = bundle;

  return 0;
}

static int
setupSpecial(void **state)
{
  struct setupVars *bundle = malloc(sizeof(struct setupVars));
  assert_non_null(bundle);

  bundle->dataArr = malloc(sizeof(Scalar) * BLOCK_SIZE);
  assert_non_null(bundle->dataArr);

  setupZfpStream(bundle, 0);

  *state = bundle;

  return 0;
}

static int
teardown(void **state)
{
  struct setupVars *bundle = *state;

  stream_close(bundle->stream->stream);
  zfp_stream_close(bundle->stream);
  free(bundle->buffer);
  free(bundle->dataArr);
  free(bundle);

  return 0;
}

static void
when_seededRandomDataGenerated_expect_ChecksumMatches(void **state)
{
  struct setupVars *bundle = *state;
  UInt checksum = _catFunc2(hashArray, SCALAR_BITS)((const UInt*)bundle->dataArr, BLOCK_SIZE, 1);
  uint64 key1, key2;
  computeKeyOriginalInput(BLOCK_FULL_TEST, bundle->dimLens, &key1, &key2);
  // random data checksum only run for full block, and for non-special values
  ASSERT_EQ_CHECKSUM(DIMS, ZFP_TYPE, checksum, key1, key2);
}

static void
_catFunc3(given_, DIM_INT_STR, Block_when_EncodeBlock_expect_ReturnValReflectsNumBitsWrittenToBitstream)(void **state)
{
  struct setupVars *bundle = *state;
  zfp_stream* stream = bundle->stream;
  bitstream* s = zfp_stream_bit_stream(stream);

  size_t returnValBits = _t2(zfp_encode_block, Scalar, DIMS)(stream, bundle->dataArr);
  // do not flush, otherwise extra zeros included in count

  assert_int_equal(returnValBits, stream_wtell(s));
}

static void
_catFunc3(given_, DIM_INT_STR, Block_when_EncodeBlock_expect_BitstreamChecksumMatches)(void **state)
{
  struct setupVars *bundle = *state;
  zfp_stream* stream = bundle->stream;
  bitstream* s = zfp_stream_bit_stream(stream);

  _t2(zfp_encode_block, Scalar, DIMS)(stream, bundle->dataArr);
  zfp_stream_flush(stream);

  uint64 checksum = hashBitstream(stream_data(s), stream_size(s));
  uint64 key1, key2;
  computeKey(BLOCK_FULL_TEST, COMPRESSED_BITSTREAM, bundle->dimLens, zfp_mode_fixed_rate, 0, &key1, &key2);
  ASSERT_EQ_CHECKSUM(DIMS, ZFP_TYPE, checksum, key1, key2);
}

static void
_catFunc3(given_, DIM_INT_STR, Block_when_EncodeSpecialBlocks_expect_BitstreamChecksumMatches)(void **state)
{
  struct setupVars *bundle = *state;
  zfp_stream* stream = bundle->stream;
  bitstream* s = zfp_stream_bit_stream(stream);

  int failures = 0;
  int i;
  for (i = 0; i < 10; i++) {
    populateInitialArraySpecial(bundle->dataArr, i);

    _t2(zfp_encode_block, Scalar, DIMS)(stream, bundle->dataArr);
    zfp_stream_flush(stream);

    uint64 checksum = hashBitstream(stream_data(s), stream_size(s));
    uint64 key1, key2;
    computeKey(BLOCK_FULL_TEST, COMPRESSED_BITSTREAM, bundle->dimLens, zfp_mode_reversible, i + 1, &key1, &key2);
    if (COMPARE_NEQ_CHECKSUM(DIMS, ZFP_TYPE, checksum, key1, key2)) {
      printf("Special Block testcase %d failed\n", i);
      failures++;
    }

    // reset/zero bitstream, rewind for next iteration
    memset(bundle->buffer, 0, bundle->bufsizeBytes);
    zfp_stream_rewind(stream);
  }

  if (failures > 0) {
    fail_msg("At least 1 special block testcase failed\n");
  }
}