Skip to main content
`Ctrl`+`K`

# /build/rocrand-cWAlCE/rocrand-7.2.4/library/include/rocrand/rocrand_philox4x32_10.h Source File

API library: /build/rocrand-cWAlCE/rocrand-7.2.4/library/include/rocrand/rocrand_philox4x32_10.h Source File
rocrand_philox4x32_10.h
1// Copyright (c) 2017-2025 Advanced Micro Devices, Inc. All rights reserved.
2//
3// Permission is hereby granted, free of charge, to any person obtaining a copy
4// of this software and associated documentation files (the "Software"), to deal
5// in the Software without restriction, including without limitation the rights
6// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7// copies of the Software, and to permit persons to whom the Software is
8// furnished to do so, subject to the following conditions:
9//
10// The above copyright notice and this permission notice shall be included in
11// all copies or substantial portions of the Software.
12//
13// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19// THE SOFTWARE.
20
21/*
22 Copyright 2010-2011, D. E. Shaw Research.
23 All rights reserved.
24
25 Redistribution and use in source and binary forms, with or without
26 modification, are permitted provided that the following conditions are
27 met:
28
29* Redistributions of source code must retain the above copyright
30 notice, this list of conditions, and the following disclaimer.
31
32* Redistributions in binary form must reproduce the above copyright
33 notice, this list of conditions, and the following disclaimer in the
34 documentation and/or other materials provided with the distribution.
35
36* Neither the name of D. E. Shaw Research nor the names of its
37 contributors may be used to endorse or promote products derived from
38 this software without specific prior written permission.
39
40 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
41"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
42 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
43 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
44 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
46 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
47 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
48 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
49(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
50 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
51*/
52
53#ifndef ROCRAND_PHILOX4X32_10_H_
54#define ROCRAND_PHILOX4X32_10_H_
55
56#include "rocrand/rocrand_common.h"
57
58#include <hip/hip_runtime.h>
59
60// Constants from Random123
61// See https://www.deshawresearch.com/resources_random123.html
62#define ROCRAND_PHILOX_M4x32_0 0xD2511F53U
63#define ROCRAND_PHILOX_M4x32_1 0xCD9E8D57U
64#define ROCRAND_PHILOX_W32_0 0x9E3779B9U
65#define ROCRAND_PHILOX_W32_1 0xBB67AE85U
66
75#define ROCRAND_PHILOX4x32_DEFAULT_SEED 0xdeadbeefdeadbeefULL // end of group rocranddevice
77
78 namespace rocrand_device
79{
80
81 class philox4x32_10_engine
82{
83 public:
84 struct philox4x32_10_state
85 {
86 uint4 counter;
87 uint4 result;
88 uint2 key;
89 unsigned int substate;
90
91 #ifndef ROCRAND_DETAIL_BM_NOT_IN_STATE
92 // The Box–Muller transform requires two inputs to convert uniformly
93 // distributed real values [0; 1] to normally distributed real values
94 // (with mean = 0, and stddev = 1). Often user wants only one
95 // normally distributed number, to save performance and random
96 // numbers the 2nd value is saved for future requests.
97 float boxmuller_float; // normally distributed float
98 double boxmuller_double; // normally distributed double
99 #endif
100 };
101
102 __forceinline__ __device__ __host__ philox4x32_10_engine()
103 {
104 this->seed(ROCRAND_PHILOX4x32_DEFAULT_SEED, 0, 0);
105 }
106
112 __forceinline__ __device__ __host__ philox4x32_10_engine(const unsigned long long seed,
113 const unsigned long long subsequence,
114 const unsigned long long offset)
115 {
116 this->seed(seed, subsequence, offset);
117 }
118
124 __forceinline__ __device__ __host__ void seed(unsigned long long seed_value,
125 const unsigned long long subsequence,
126 const unsigned long long offset)
127 {
128 m_state.key.x = static_cast<unsigned int>(seed_value);
129 m_state.key.y = static_cast<unsigned int>(seed_value >> 32);
130 this->restart(subsequence, offset);
131 }
132
134 __forceinline__ __device__ __host__ void discard(unsigned long long offset)
135 {
136 this->discard_impl(offset);
137 this->m_state.result = this->ten_rounds(m_state.counter, m_state.key);
138 }
139
144 __forceinline__ __device__ __host__ void discard_subsequence(unsigned long long subsequence)
145 {
146 this->discard_subsequence_impl(subsequence);
147 m_state.result = this->ten_rounds(m_state.counter, m_state.key);
148 }
149
150 __forceinline__ __device__ __host__ void restart(const unsigned long long subsequence,
151 const unsigned long long offset)
152 {
153 m_state.counter = {0, 0, 0, 0};
154 m_state.result = {0, 0, 0, 0};
155 m_state.substate = 0;
156 #ifndef ROCRAND_DETAIL_BM_NOT_IN_STATE
157 m_state.boxmuller_float = ROCRAND_NAN_FLOAT;
158 m_state.boxmuller_double = ROCRAND_NAN_DOUBLE;
159 #endif
160 this->discard_subsequence_impl(subsequence);
161 this->discard_impl(offset);
162 m_state.result = this->ten_rounds(m_state.counter, m_state.key);
163 }
164
165 __forceinline__ __device__ __host__ unsigned int operator()()
166 {
167 return this->next();
168 }
169
170 __forceinline__ __device__ __host__ unsigned int next()
171 {
172 #if defined(__HIP_PLATFORM_AMD__)
173 unsigned int ret = ROCRAND_HIPVEC_ACCESS(m_state.result)[m_state.substate];
174 #else
175 unsigned int ret = (&m_state.result.x)[m_state.substate];
176 #endif
177
178 m_state.substate++;
179 if(m_state.substate == 4)
180 {
181 m_state.substate = 0;
182 this->discard_state();
183 m_state.result = this->ten_rounds(m_state.counter, m_state.key);
184 }
185 return ret;
186 }
187
188 __forceinline__ __device__ __host__ uint4 next4()
189 {
190 uint4 ret = m_state.result;
191 this->discard_state();
192 m_state.result = this->ten_rounds(m_state.counter, m_state.key);
193 return this->interleave(ret, m_state.result);
194 }
195
196 protected:
197 // Advances the internal state to skip \p offset numbers.
198 // DOES NOT CALCULATE NEW 4 UINTs (m_state.result)
199 __forceinline__ __device__ __host__ void discard_impl(unsigned long long offset)
200 {
201 // Adjust offset for subset
202 m_state.substate += offset & 3;
203 unsigned long long counter_offset = offset / 4;
204 counter_offset += m_state.substate < 4 ? 0 : 1;
205 m_state.substate += m_state.substate < 4 ? 0 : -4;
206 // Discard states
207 this->discard_state(counter_offset);
208 }
209
210 // DOES NOT CALCULATE NEW 4 UINTs (m_state.result)
211 __forceinline__ __device__ __host__ void
212 discard_subsequence_impl(unsigned long long subsequence)
213 {
214 unsigned int lo = static_cast<unsigned int>(subsequence);
215 unsigned int hi = static_cast<unsigned int>(subsequence >> 32);
216
217 unsigned int temp = m_state.counter.z;
218 m_state.counter.z += lo;
219 m_state.counter.w += hi + (m_state.counter.z < temp ? 1 : 0);
220 }
221
222 // Advances the internal state by offset times.
223 // DOES NOT CALCULATE NEW 4 UINTs (m_state.result)
224 __forceinline__ __device__ __host__ void discard_state(unsigned long long offset)
225 {
226 unsigned int lo = static_cast<unsigned int>(offset);
227 unsigned int hi = static_cast<unsigned int>(offset >> 32);
228
229 uint4 temp = m_state.counter;
230 m_state.counter.x += lo;
231 m_state.counter.y += hi + (m_state.counter.x < temp.x ? 1 : 0);
232 m_state.counter.z += (m_state.counter.y < temp.y ? 1 : 0);
233 m_state.counter.w += (m_state.counter.z < temp.z ? 1 : 0);
234 }
235
236 // Advances the internal state to the next state
237 // DOES NOT CALCULATE NEW 4 UINTs (m_state.result)
238 __forceinline__ __device__ __host__ void discard_state()
239 {
240 m_state.counter = this->bump_counter(m_state.counter);
241 }
242
243 __forceinline__ __device__ __host__ static uint4 bump_counter(uint4 counter)
244 {
245 counter.x++;
246 unsigned int add = counter.x == 0 ? 1 : 0;
247 counter.y += add; add = counter.y == 0 ? add : 0;
248 counter.z += add; add = counter.z == 0 ? add : 0;
249 counter.w += add;
250 return counter;
251 }
252
253 __forceinline__ __device__ __host__ uint4 interleave(const uint4 prev, const uint4 next) const
254 {
255 switch(m_state.substate)
256 {
257 case 0:
258 return prev;
259 case 1:
260 return uint4{ prev.y, prev.z, prev.w, next.x };
261 case 2:
262 return uint4{ prev.z, prev.w, next.x, next.y };
263 case 3:
264 return uint4{ prev.w, next.x, next.y, next.z };
265 }
266 __builtin_unreachable();
267 }
268
269 // 10 Philox4x32 rounds
270 __forceinline__ __device__ __host__ uint4 ten_rounds(uint4 counter, uint2 key)
271 {
272 counter = this->single_round(counter, key); key = this->bumpkey(key); // 1
273 counter = this->single_round(counter, key); key = this->bumpkey(key); // 2
274 counter = this->single_round(counter, key); key = this->bumpkey(key); // 3
275 counter = this->single_round(counter, key); key = this->bumpkey(key); // 4
276 counter = this->single_round(counter, key); key = this->bumpkey(key); // 5
277 counter = this->single_round(counter, key); key = this->bumpkey(key); // 6
278 counter = this->single_round(counter, key); key = this->bumpkey(key); // 7
279 counter = this->single_round(counter, key); key = this->bumpkey(key); // 8
280 counter = this->single_round(counter, key); key = this->bumpkey(key); // 9
281 return this->single_round(counter, key); // 10
282 }
283
284 private:
285 // Single Philox4x32 round
286 __forceinline__ __device__ __host__ static uint4 single_round(uint4 counter, uint2 key)
287 {
288 // Source: Random123
289 unsigned long long mul0 = detail::mul_u64_u32(ROCRAND_PHILOX_M4x32_0, counter.x);
290 unsigned int hi0 = static_cast<unsigned int>(mul0 >> 32);
291 unsigned int lo0 = static_cast<unsigned int>(mul0);
292 unsigned long long mul1 = detail::mul_u64_u32(ROCRAND_PHILOX_M4x32_1, counter.z);
293 unsigned int hi1 = static_cast<unsigned int>(mul1 >> 32);
294 unsigned int lo1 = static_cast<unsigned int>(mul1);
295 return uint4{hi1 ^ counter.y ^ key.x, lo1, hi0 ^ counter.w ^ key.y, lo0};
296 }
297
298 __forceinline__ __device__ __host__ static uint2 bumpkey(uint2 key)
299 {
300 key.x += ROCRAND_PHILOX_W32_0;
301 key.y += ROCRAND_PHILOX_W32_1;
302 return key;
303 }
304
305 protected:
306 // State
307 philox4x32_10_state m_state;
308
309 #ifndef ROCRAND_DETAIL_BM_NOT_IN_STATE
310 friend struct detail::engine_boxmuller_helper<philox4x32_10_engine>;
311 #endif
312
313}; // philox4x32_10_engine class
314
315} // end namespace rocrand_device
316
321
323 typedef rocrand_device::philox4x32_10_engine rocrand_state_philox4x32_10;
325
337__forceinline__ __device__ __host__
338 void rocrand_init(const unsigned long long seed,
339 const unsigned long long subsequence,
340 const unsigned long long offset,
341 rocrand_state_philox4x32_10* state)
342{
343 *state = rocrand_state_philox4x32_10(seed, subsequence, offset);
344}
345
358__forceinline__ __device__ __host__
359 unsigned int rocrand(rocrand_state_philox4x32_10* state)
360{
361 return state->next();
362}
363
376__forceinline__ __device__ __host__
377uint4 rocrand4(rocrand_state_philox4x32_10* state)
378{
379 return state->next4();
380}
381
390__forceinline__ __device__ __host__
391 void skipahead(unsigned long long offset, rocrand_state_philox4x32_10* state)
392{
393 return state->discard(offset);
394}
395
405__forceinline__ __device__ __host__
406 void skipahead_subsequence(unsigned long long subsequence, rocrand_state_philox4x32_10* state)
407{
408 return state->discard_subsequence(subsequence);
409}
410
420__forceinline__ __device__ __host__
421 void skipahead_sequence(unsigned long long sequence, rocrand_state_philox4x32_10* state)
422{
423 return state->discard_subsequence(sequence);
424}
425 // end of group rocranddevice
427
428#endif // ROCRAND_PHILOX4X32_10_H_
skipahead
__forceinline__ __device__ __host__ void skipahead(unsigned long long offset, rocrand_state_philox4x32_10 *state)
Updates Philox state to skip ahead by offset elements.
Definition rocrand_philox4x32_10.h:391
rocrand_init
__forceinline__ __device__ __host__ void rocrand_init(const unsigned long long seed, const unsigned long long subsequence, const unsigned long long offset, rocrand_state_philox4x32_10 *state)
Initializes Philox state.
Definition rocrand_philox4x32_10.h:338
ROCRAND_PHILOX4x32_DEFAULT_SEED
#define ROCRAND_PHILOX4x32_DEFAULT_SEED
Default seed for PHILOX4x32 PRNG.
Definition rocrand_philox4x32_10.h:75
rocrand4
__forceinline__ __device__ __host__ uint4 rocrand4(rocrand_state_philox4x32_10 *state)
Returns four uniformly distributed random unsigned int values from [0; 2^32 - 1] range.
Definition rocrand_philox4x32_10.h:377
skipahead_sequence
__forceinline__ __device__ __host__ void skipahead_sequence(unsigned long long sequence, rocrand_state_philox4x32_10 *state)
Updates Philox state to skip ahead by sequence sequences.
Definition rocrand_philox4x32_10.h:421
rocrand
__forceinline__ __device__ __host__ unsigned int rocrand(rocrand_state_philox4x32_10 *state)
Returns uniformly distributed random unsigned int value from [0; 2^32 - 1] range.
Definition rocrand_philox4x32_10.h:359
skipahead_subsequence
__forceinline__ __device__ __host__ void skipahead_subsequence(unsigned long long subsequence, rocrand_state_philox4x32_10 *state)
Updates Philox state to skip ahead by subsequence subsequences.
Definition rocrand_philox4x32_10.h:406