OpenVDB 12.1.0

Loading...
Searching...
No Matches
pnanovdb_validate_strides.h
Go to the documentation of this file.
1// Copyright Contributors to the OpenVDB Project
2// SPDX-License-Identifier: Apache-2.0
3
4/*!
5 \file pnanovdb_validate_strides.h
6
7 \author Andrew Reidmeyer
8
9 \brief This header implements validation tests for the strides used
10 in PNanaoVDB.h (instead of pointers). It can be used both for
11 unit-testing (hence its location), but also to update PNanoVDB.h
12 if the ABI changes in NanoVDB.h.
13*/
14
15#ifndef NANOVDB_PNANOVDB_VALIDATE_STRIDES_H_HAS_BEEN_INCLUDED
16#define NANOVDB_PNANOVDB_VALIDATE_STRIDES_H_HAS_BEEN_INCLUDED
17
18#include <nanovdb/PNanoVDB.h>
19
20 static pnanovdb_uint32_t allocate(pnanovdb_uint32_t* poffset, pnanovdb_uint32_t size, pnanovdb_uint32_t alignment)
21{
22 if (alignment > 0u)
23 {
24 (*poffset) = alignment * (((*poffset) + (alignment - 1)) / alignment);
25 }
26 pnanovdb_uint32_t ret = (*poffset);
27 (*poffset) += size;
28 return ret;
29}
30
31 static void compute_root_strides(
32 pnanovdb_uint32_t grid_type,
33 pnanovdb_uint32_t* background_off,
34 pnanovdb_uint32_t* min_off, pnanovdb_uint32_t* max_off,
35 pnanovdb_uint32_t* ave_off, pnanovdb_uint32_t* stddev_off,
36 pnanovdb_uint32_t* total_size)
37{
38 pnanovdb_uint32_t offset = 0u;
39 allocate(&offset, PNANOVDB_ROOT_BASE_SIZE, 32u);
40
41 pnanovdb_uint32_t minmaxStride = pnanovdb_grid_type_minmax_strides_bits[grid_type] / 8u;
42 pnanovdb_uint32_t minmaxAlign = pnanovdb_grid_type_minmax_aligns_bits[grid_type] / 8u;
43 pnanovdb_uint32_t statStride = pnanovdb_grid_type_stat_strides_bits[grid_type] / 8u;
44
45 *background_off = allocate(&offset, minmaxStride, minmaxAlign);
46 *min_off = allocate(&offset, minmaxStride, minmaxAlign);
47 *max_off = allocate(&offset, minmaxStride, minmaxAlign);
48 *ave_off = allocate(&offset, statStride, statStride);
49 *stddev_off = allocate(&offset, statStride, statStride);
50 *total_size = allocate(&offset, 0u, 32u);
51}
52
53 static void compute_tile_strides(pnanovdb_uint32_t grid_type, pnanovdb_uint32_t* value_off, pnanovdb_uint32_t* total_size)
54{
55 pnanovdb_uint32_t offset = 0u;
56 allocate(&offset, PNANOVDB_ROOT_TILE_BASE_SIZE, 32u);
57
58 pnanovdb_uint32_t valueStride = pnanovdb_grid_type_minmax_strides_bits[grid_type] / 8u;
59 pnanovdb_uint32_t valueAlign = pnanovdb_grid_type_minmax_aligns_bits[grid_type] / 8u;
60
61 *value_off = allocate(&offset, valueStride, valueAlign);
62 *total_size = allocate(&offset, 0u, 32u);
63}
64
65 static void compute_node_strides(
66 pnanovdb_uint32_t grid_type,
67 pnanovdb_uint32_t nodeLevel,
68 pnanovdb_uint32_t* min_off, pnanovdb_uint32_t* max_off,
69 pnanovdb_uint32_t* ave_off, pnanovdb_uint32_t* stddev_off,
70 pnanovdb_uint32_t* table_off,
71 pnanovdb_uint32_t* total_size)
72{
73 static const pnanovdb_uint32_t node_size[3] = { PNANOVDB_LEAF_BASE_SIZE, PNANOVDB_LOWER_BASE_SIZE, PNANOVDB_UPPER_BASE_SIZE };
74 static const pnanovdb_uint32_t node_elements[3] = { PNANOVDB_LEAF_TABLE_COUNT, PNANOVDB_LOWER_TABLE_COUNT, PNANOVDB_UPPER_TABLE_COUNT };
75 pnanovdb_uint32_t offset = 0u;
76 allocate(&offset, node_size[nodeLevel], 32u);
77
78 pnanovdb_uint32_t valueStrideBits = pnanovdb_grid_type_value_strides_bits[grid_type];
79 pnanovdb_uint32_t tableStrideBits = nodeLevel == 0u ? valueStrideBits : pnanovdb_grid_type_table_strides_bits[grid_type];
80 pnanovdb_uint32_t tableAlign = 32u;
81 pnanovdb_uint32_t tableFullStride = (tableStrideBits * node_elements[nodeLevel]) / 8u;
82
83 pnanovdb_uint32_t minmaxStride = pnanovdb_grid_type_minmax_strides_bits[grid_type] / 8u;
84 pnanovdb_uint32_t minmaxAlign = pnanovdb_grid_type_minmax_aligns_bits[grid_type] / 8u;
85 pnanovdb_uint32_t statStride = pnanovdb_grid_type_stat_strides_bits[grid_type] / 8u;
86 pnanovdb_uint32_t indexMaskStride = 0u;
87 if (nodeLevel == 0u)
88 {
89 if (pnanovdb_grid_type_leaf_type[grid_type] == PNANOVDB_LEAF_TYPE_LITE)
90 {
91 minmaxStride = 0u;
92 minmaxAlign = 0u;
93 statStride = 0u;
94 }
95 else if (pnanovdb_grid_type_leaf_type[grid_type] == PNANOVDB_LEAF_TYPE_FP)
96 {
97 minmaxStride = 2u;
98 minmaxAlign = 2u;
99 statStride = 2u;
100 // allocate minimum and quantum
101 allocate(&offset, 4u, 4u);
102 allocate(&offset, 4u, 4u);
103 }
104 else if (pnanovdb_grid_type_leaf_type[grid_type] == PNANOVDB_LEAF_TYPE_INDEX)
105 {
106 minmaxStride = 0u;
107 minmaxAlign = 0u;
108 statStride = 0u;
109 tableAlign = 8u;
110 tableFullStride = 8u;
111 }
112 else if (pnanovdb_grid_type_leaf_type[grid_type] == PNANOVDB_LEAF_TYPE_INDEXMASK)
113 {
114 minmaxStride = 0u;
115 minmaxAlign = 0u;
116 statStride = 0u;
117 tableAlign = 8u;
118 tableFullStride = 8u;
119 indexMaskStride = 64u;
120 }
121 else if (pnanovdb_grid_type_leaf_type[grid_type] == PNANOVDB_LEAF_TYPE_POINTINDEX)
122 {
123 minmaxStride = 8u;
124 minmaxAlign = 8u;
125 statStride = 0u;
126 tableAlign = 2u;
127 tableFullStride = (16u * node_elements[nodeLevel]) / 8u;
128 }
129 }
130 *min_off = allocate(&offset, minmaxStride, minmaxAlign);
131 *max_off = allocate(&offset, minmaxStride, minmaxAlign);
132 *ave_off = allocate(&offset, statStride, statStride);
133 *stddev_off = allocate(&offset, statStride, statStride);
134 *table_off = allocate(&offset, tableFullStride, tableAlign);
135 allocate(&offset, indexMaskStride, tableAlign);
136 *total_size = allocate(&offset, 0u, 32u);
137}
138
139 static bool validate_strides(int(*local_printf)(const char* format, ...))
140{
141 pnanovdb_grid_type_constants_t constants[PNANOVDB_GRID_TYPE_END];
142
143 for (pnanovdb_uint32_t idx = 0u; idx < PNANOVDB_GRID_TYPE_END; idx++)
144 {
145
146 pnanovdb_uint32_t root_background, root_min, root_max, root_ave, root_stddev, root_size;
147 compute_root_strides(idx, &root_background, &root_min, &root_max, &root_ave, &root_stddev, &root_size);
148
149 pnanovdb_uint32_t tile_value, tile_size;
150 compute_tile_strides(idx, &tile_value, &tile_size);
151
152 pnanovdb_uint32_t upper_min, upper_max, upper_ave, upper_stddev, upper_table, upper_size;
153 compute_node_strides(idx, 2, &upper_min, &upper_max, &upper_ave, &upper_stddev, &upper_table, &upper_size);
154
155 pnanovdb_uint32_t lower_min, lower_max, lower_ave, lower_stddev, lower_table, lower_size;
156 compute_node_strides(idx, 1, &lower_min, &lower_max, &lower_ave, &lower_stddev, &lower_table, &lower_size);
157
158 pnanovdb_uint32_t leaf_min, leaf_max, leaf_ave, leaf_stddev, leaf_table, leaf_size;
159 compute_node_strides(idx, 0, &leaf_min, &leaf_max, &leaf_ave, &leaf_stddev, &leaf_table, &leaf_size);
160
161 pnanovdb_uint32_t valueStrideBits = pnanovdb_grid_type_value_strides_bits[idx];
162 pnanovdb_uint32_t tableStrideBits = pnanovdb_grid_type_table_strides_bits[idx];
163 pnanovdb_uint32_t tableStride = tableStrideBits / 8u;
164
165 // For FP, always return the base of the table
166 if (pnanovdb_grid_type_leaf_type[idx] == PNANOVDB_LEAF_TYPE_FP)
167 {
168 valueStrideBits = 0u;
169 }
170
171 pnanovdb_grid_type_constants_t local_constants = {
172 root_background, root_min, root_max, root_ave, root_stddev, root_size,
173 valueStrideBits, tableStride, tile_value, tile_size,
174 upper_min, upper_max, upper_ave, upper_stddev, upper_table, upper_size,
175 lower_min, lower_max, lower_ave, lower_stddev, lower_table, lower_size,
176 leaf_min, leaf_max, leaf_ave, leaf_stddev, leaf_table, leaf_size
177 };
178 constants[idx] = local_constants;
179 }
180
181 bool mismatch = false;
182 for (pnanovdb_uint32_t idx = 0u; idx < PNANOVDB_GRID_TYPE_END; idx++)
183 {
184 pnanovdb_grid_type_constants_t c = constants[idx];
185 pnanovdb_grid_type_constants_t t = pnanovdb_grid_type_constants[idx];
186 if (memcmp(&c, &t, sizeof(pnanovdb_grid_type_constants_t)) != 0)
187 {
188 mismatch = true;
189 }
190 }
191 if (mismatch)
192 {
193 local_printf("Error: Mismatch between constant tables.\n");
194 for (pnanovdb_uint32_t pass = 0u; pass < 2u; pass++)
195 {
196 if (pass == 0u)
197 {
198 local_printf("Printing expected values:\n");
199 }
200 else
201 {
202 local_printf("Printing current header values:\n");
203 }
204 for (pnanovdb_uint32_t idx = 0u; idx < PNANOVDB_GRID_TYPE_END; idx++)
205 {
206 pnanovdb_grid_type_constants_t c = (pass == 0u) ? constants[idx] : pnanovdb_grid_type_constants[idx];
207 local_printf("{%d, %d, %d, %d, %d, %d, %d, %d, %d, %d, %d, %d, %d, %d, %d, %d, %d, %d, %d, %d, %d, %d, %d, %d, %d, %d, %d, %d},\n",
208 c.root_off_background, c.root_off_min, c.root_off_max, c.root_off_ave, c.root_off_stddev, c.root_size,
209 c.value_stride_bits, c.table_stride, c.root_tile_off_value, c.root_tile_size,
210 c.upper_off_min, c.upper_off_max, c.upper_off_ave, c.upper_off_stddev, c.upper_off_table, c.upper_size,
211 c.lower_off_min, c.lower_off_max, c.lower_off_ave, c.lower_off_stddev, c.lower_off_table, c.lower_size,
212 c.leaf_off_min, c.leaf_off_max, c.leaf_off_ave, c.leaf_off_stddev, c.leaf_off_table, c.leaf_size
213 );
214 }
215 }
216 }
217 return !mismatch;
218}
219
220#endif// end of NANOVDB_PNANOVDB_VALIDATE_STRIDES_H_HAS_BEEN_INCLUDED
PNanoVDB.h
This file is a portable (e.g. pointer-less) C99/GLSL/HLSL port of NanoVDB.h, which is compatible with...
pnanovdb_grid_type_minmax_strides_bits
PNANOVDB_STATIC_CONST pnanovdb_uint32_t pnanovdb_grid_type_minmax_strides_bits[27]
Definition PNanoVDB.h:1001
PNANOVDB_LEAF_TYPE_LITE
#define PNANOVDB_LEAF_TYPE_LITE
Definition PNanoVDB.h:989
PNANOVDB_LEAF_TYPE_INDEXMASK
#define PNANOVDB_LEAF_TYPE_INDEXMASK
Definition PNanoVDB.h:992
PNANOVDB_ROOT_BASE_SIZE
#define PNANOVDB_ROOT_BASE_SIZE
Definition PNanoVDB.h:1393
pnanovdb_grid_type_minmax_aligns_bits
PNANOVDB_STATIC_CONST pnanovdb_uint32_t pnanovdb_grid_type_minmax_aligns_bits[27]
Definition PNanoVDB.h:1003
PNANOVDB_LEAF_TYPE_FP
#define PNANOVDB_LEAF_TYPE_FP
Definition PNanoVDB.h:990
pnanovdb_grid_type_stat_strides_bits
PNANOVDB_STATIC_CONST pnanovdb_uint32_t pnanovdb_grid_type_stat_strides_bits[27]
Definition PNanoVDB.h:1005
PNANOVDB_UPPER_BASE_SIZE
#define PNANOVDB_UPPER_BASE_SIZE
Definition PNanoVDB.h:1472
pnanovdb_grid_type_table_strides_bits
PNANOVDB_STATIC_CONST pnanovdb_uint32_t pnanovdb_grid_type_table_strides_bits[27]
Definition PNanoVDB.h:999
pnanovdb_grid_type_leaf_type
PNANOVDB_STATIC_CONST pnanovdb_uint32_t pnanovdb_grid_type_leaf_type[27]
Definition PNanoVDB.h:1007
PNANOVDB_LOWER_BASE_SIZE
#define PNANOVDB_LOWER_BASE_SIZE
Definition PNanoVDB.h:1527
pnanovdb_grid_type_constants
PNANOVDB_STATIC_CONST pnanovdb_grid_type_constants_t pnanovdb_grid_type_constants[27]
Definition PNanoVDB.h:1642
PNANOVDB_GRID_TYPE_END
#define PNANOVDB_GRID_TYPE_END
Definition PNanoVDB.h:966
PNANOVDB_LEAF_TYPE_INDEX
#define PNANOVDB_LEAF_TYPE_INDEX
Definition PNanoVDB.h:991
pnanovdb_grid_type_value_strides_bits
PNANOVDB_STATIC_CONST pnanovdb_uint32_t pnanovdb_grid_type_value_strides_bits[27]
Definition PNanoVDB.h:997
PNANOVDB_ROOT_TILE_BASE_SIZE
#define PNANOVDB_ROOT_TILE_BASE_SIZE
Definition PNanoVDB.h:1431
PNANOVDB_LOWER_TABLE_COUNT
#define PNANOVDB_LOWER_TABLE_COUNT
Definition PNanoVDB.h:1526
PNANOVDB_LEAF_TABLE_COUNT
#define PNANOVDB_LEAF_TABLE_COUNT
Definition PNanoVDB.h:1579
PNANOVDB_UPPER_TABLE_COUNT
#define PNANOVDB_UPPER_TABLE_COUNT
Definition PNanoVDB.h:1471
PNANOVDB_LEAF_BASE_SIZE
#define PNANOVDB_LEAF_BASE_SIZE
Definition PNanoVDB.h:1580
PNANOVDB_LEAF_TYPE_POINTINDEX
#define PNANOVDB_LEAF_TYPE_POINTINDEX
Definition PNanoVDB.h:993
compute_root_strides
static void compute_root_strides(pnanovdb_uint32_t grid_type, pnanovdb_uint32_t *background_off, pnanovdb_uint32_t *min_off, pnanovdb_uint32_t *max_off, pnanovdb_uint32_t *ave_off, pnanovdb_uint32_t *stddev_off, pnanovdb_uint32_t *total_size)
Definition pnanovdb_validate_strides.h:31
compute_node_strides
static void compute_node_strides(pnanovdb_uint32_t grid_type, pnanovdb_uint32_t nodeLevel, pnanovdb_uint32_t *min_off, pnanovdb_uint32_t *max_off, pnanovdb_uint32_t *ave_off, pnanovdb_uint32_t *stddev_off, pnanovdb_uint32_t *table_off, pnanovdb_uint32_t *total_size)
Definition pnanovdb_validate_strides.h:65
allocate
static pnanovdb_uint32_t allocate(pnanovdb_uint32_t *poffset, pnanovdb_uint32_t size, pnanovdb_uint32_t alignment)
Definition pnanovdb_validate_strides.h:20
compute_tile_strides
static void compute_tile_strides(pnanovdb_uint32_t grid_type, pnanovdb_uint32_t *value_off, pnanovdb_uint32_t *total_size)
Definition pnanovdb_validate_strides.h:53
validate_strides
static bool validate_strides(int(*local_printf)(const char *format,...))
Definition pnanovdb_validate_strides.h:139
pnanovdb_grid_type_constants_t
Definition PNanoVDB.h:1609
pnanovdb_grid_type_constants_t::leaf_off_stddev
pnanovdb_uint32_t leaf_off_stddev
Definition PNanoVDB.h:1635
pnanovdb_grid_type_constants_t::leaf_off_ave
pnanovdb_uint32_t leaf_off_ave
Definition PNanoVDB.h:1634
pnanovdb_grid_type_constants_t::upper_off_min
pnanovdb_uint32_t upper_off_min
Definition PNanoVDB.h:1620
pnanovdb_grid_type_constants_t::leaf_size
pnanovdb_uint32_t leaf_size
Definition PNanoVDB.h:1637
pnanovdb_grid_type_constants_t::root_size
pnanovdb_uint32_t root_size
Definition PNanoVDB.h:1615
pnanovdb_grid_type_constants_t::leaf_off_table
pnanovdb_uint32_t leaf_off_table
Definition PNanoVDB.h:1636
pnanovdb_grid_type_constants_t::upper_off_max
pnanovdb_uint32_t upper_off_max
Definition PNanoVDB.h:1621
pnanovdb_grid_type_constants_t::upper_off_ave
pnanovdb_uint32_t upper_off_ave
Definition PNanoVDB.h:1622
pnanovdb_grid_type_constants_t::table_stride
pnanovdb_uint32_t table_stride
Definition PNanoVDB.h:1617
pnanovdb_grid_type_constants_t::upper_off_table
pnanovdb_uint32_t upper_off_table
Definition PNanoVDB.h:1624
pnanovdb_grid_type_constants_t::root_tile_size
pnanovdb_uint32_t root_tile_size
Definition PNanoVDB.h:1619
pnanovdb_grid_type_constants_t::leaf_off_min
pnanovdb_uint32_t leaf_off_min
Definition PNanoVDB.h:1632
pnanovdb_grid_type_constants_t::lower_size
pnanovdb_uint32_t lower_size
Definition PNanoVDB.h:1631
pnanovdb_grid_type_constants_t::lower_off_min
pnanovdb_uint32_t lower_off_min
Definition PNanoVDB.h:1626
pnanovdb_grid_type_constants_t::upper_size
pnanovdb_uint32_t upper_size
Definition PNanoVDB.h:1625
pnanovdb_grid_type_constants_t::value_stride_bits
pnanovdb_uint32_t value_stride_bits
Definition PNanoVDB.h:1616
pnanovdb_grid_type_constants_t::root_off_min
pnanovdb_uint32_t root_off_min
Definition PNanoVDB.h:1611
pnanovdb_grid_type_constants_t::root_tile_off_value
pnanovdb_uint32_t root_tile_off_value
Definition PNanoVDB.h:1618
pnanovdb_grid_type_constants_t::root_off_ave
pnanovdb_uint32_t root_off_ave
Definition PNanoVDB.h:1613
pnanovdb_grid_type_constants_t::lower_off_stddev
pnanovdb_uint32_t lower_off_stddev
Definition PNanoVDB.h:1629
pnanovdb_grid_type_constants_t::root_off_stddev
pnanovdb_uint32_t root_off_stddev
Definition PNanoVDB.h:1614
pnanovdb_grid_type_constants_t::root_off_background
pnanovdb_uint32_t root_off_background
Definition PNanoVDB.h:1610
pnanovdb_grid_type_constants_t::root_off_max
pnanovdb_uint32_t root_off_max
Definition PNanoVDB.h:1612
pnanovdb_grid_type_constants_t::lower_off_table
pnanovdb_uint32_t lower_off_table
Definition PNanoVDB.h:1630
pnanovdb_grid_type_constants_t::lower_off_max
pnanovdb_uint32_t lower_off_max
Definition PNanoVDB.h:1627
pnanovdb_grid_type_constants_t::leaf_off_max
pnanovdb_uint32_t leaf_off_max
Definition PNanoVDB.h:1633
pnanovdb_grid_type_constants_t::upper_off_stddev
pnanovdb_uint32_t upper_off_stddev
Definition PNanoVDB.h:1623
pnanovdb_grid_type_constants_t::lower_off_ave
pnanovdb_uint32_t lower_off_ave
Definition PNanoVDB.h:1628