source: libcfa/src/stdlib.hfa@ 15a0f6f

Last change on this file since 15a0f6f was 97c75bf, checked in by Peter A. Buhr <pabuhr@…>, 5 days ago

change routine name from rdtscl to rdtsc
  • Property mode set to 100644
File size: 23.5 KB
Line 
1//
2// Cforall Version 1.0.0 Copyright (C) 2016 University of Waterloo
3//
4// The contents of this file are covered under the licence agreement in the
5// file "LICENCE" distributed with Cforall.
6//
7// stdlib --
8//
9// Author : Peter A. Buhr
10// Created On : Thu Jan 28 17:12:35 2016
11// Last Modified By : Peter A. Buhr
12// Last Modified On : Sat Jul 4 15:28:46 2026
13// Update Count : 970
14//
15
16#pragma once
17
18#include "bits/defs.hfa" // OPTIONAL_THREAD
19#include "bits/align.hfa" // libAlign
20#include "bits/random.hfa" // prng
21#include "bits/atomic.hfa" // rdtsc
22#include <Exception.hfa>
23#include <heap.hfa>
24
25#include <stdlib.h> // *alloc, strto*, ato*
26#include <errno.h>
27
28// Reduce includes by explicitly defining these routines.
29extern "C" {
30 void * memalign( size_t alignment, size_t size ); // malloc.h
31 void * pvalloc( size_t size ); // malloc.h
32 void * memset( void * dest, int fill, size_t size ); // string.h
33 void * memcpy( void * dest, const void * src, size_t size ); // string.h
34} // extern "C"
35
36//---------------------------------------
37
38#ifndef EXIT_FAILURE
39#define EXIT_FAILURE 1 // failing exit status
40#define EXIT_SUCCESS 0 // successful exit status
41#endif // ! EXIT_FAILURE
42
43//---------------------------------------
44
45#include "common.hfa"
46
47//---------------------------------------
48
49static inline forall( T & | sized(T) ) {
50 // CFA safe equivalents, i.e., implicit size specification, eliminate return-type cast
51
52 T * malloc( void ) {
53 if ( _Alignof(T) <= libAlign() ) return (T *)malloc( sizeof(T) ); // C allocation
54 else return (T *)memalign( _Alignof(T), sizeof(T) );
55 } // malloc
56
57 T * aalloc( size_t dim ) {
58 if ( _Alignof(T) <= libAlign() ) return (T *)aalloc( dim, sizeof(T) ); // C allocation
59 else return (T *)amemalign( _Alignof(T), dim, sizeof(T) );
60 } // aalloc
61
62 T * calloc( size_t dim ) {
63 if ( _Alignof(T) <= libAlign() ) return (T *)calloc( dim, sizeof(T) ); // C allocation
64 else return (T *)cmemalign( _Alignof(T), dim, sizeof(T) );
65 } // calloc
66
67 T * resize( T * ptr, size_t size ) {
68 if ( _Alignof(T) <= libAlign() ) return (T *)resize( (void *)ptr, size ); // C resize
69 else return (T *)resize( (void *)ptr, _Alignof(T), size ); // CFA resize
70 } // resize
71
72 T * resize( T * ptr, size_t alignment, size_t size ) {
73 return (T *)resize( (void *)ptr, alignment, size ); // CFA resize
74 } // resize
75
76 T * realloc( T * ptr, size_t size ) { // CFA realloc
77 if ( _Alignof(T) <= libAlign() ) return (T *)realloc( (void *)ptr, size ); // C realloc
78 else return (T *)realloc( (void *)ptr, _Alignof(T), size ); // CFA realloc
79 } // realloc
80
81 T * realloc( T * ptr, size_t alignment, size_t size ) {
82 return (T *)realloc( (void *)ptr, alignment, size ); // CFA realloc
83 } // realloc
84
85 T * reallocarray( T * ptr, size_t dim ) { // CFA reallocarray
86 if ( _Alignof(T) <= libAlign() ) return (T *)reallocarray( (void *)ptr, dim, sizeof(T) ); // C reallocarray
87 else return (T *)reallocarray( (void *)ptr, _Alignof(T), dim ); // CFA reallocarray
88 } // realloc
89
90 T * reallocarray( T * ptr, size_t alignment, size_t dim ) {
91 return (T *)reallocarray( (void *)ptr, alignment, dim ); // CFA reallocarray
92 } // realloc
93
94 T * memalign( size_t align ) {
95 return (T *)memalign( align, sizeof(T) ); // C memalign
96 } // memalign
97
98 T * amemalign( size_t align, size_t dim ) {
99 return (T *)amemalign( align, dim, sizeof(T) ); // CFA amemalign
100 } // amemalign
101
102 T * cmemalign( size_t align, size_t dim ) {
103 return (T *)cmemalign( align, dim, sizeof(T) ); // CFA cmemalign
104 } // cmemalign
105
106 T * aligned_alloc( size_t align ) {
107 return (T *)aligned_alloc( align, sizeof(T) ); // C aligned_alloc
108 } // aligned_alloc
109
110 int posix_memalign( T ** ptr, size_t align ) {
111 return posix_memalign( (void **)ptr, align, sizeof(T) ); // C posix_memalign
112 } // posix_memalign
113
114 T * valloc( void ) {
115 return (T *)valloc( sizeof(T) ); // C valloc
116 } // valloc
117
118 T * pvalloc( void ) {
119 return (T *)pvalloc( sizeof(T) ); // C pvalloc
120 } // pvalloc
121} // distribution
122
123/*
124 FIX ME : fix alloc interface after Ticker Number 214 is resolved, define and add union to S_fill. Then, modify
125 postfix-fill functions to support T * with nmemb, char, and T object of any size. Finally, change alloc_internal.
126 Or, just follow the instructions below for that.
127
128 1. Replace the current forall-block that contains defintions of S_fill and S_realloc with following:
129 forall( T & | sized(T) ) {
130 union U_fill { char c; T * a; T t; };
131 struct S_fill { char tag; U_fill(T) fill; };
132 struct S_realloc { inline T *; };
133 }
134
135 2. Replace all current postfix-fill functions with following for updated S_fill:
136 S_fill(T) ?`fill( char a ) { S_fill(T) ret = {'c'}; ret.fill.c = a; return ret; }
137 S_fill(T) ?`fill( T a ) { S_fill(T) ret = {'t'}; memcpy(&ret.fill.t, &a, sizeof(T)); return ret; }
138 S_fill(T) ?`fill( T a[], size_t nmemb ) { S_fill(T) ret = {'a', nmemb}; ret.fill.a = a; return ret; }
139
140 3. Replace the alloc_internal$ function which is outside ttype forall-block with following function:
141 T * alloc_internal$( void * Resize, T * Realloc, size_t Align, size_t Dim, S_fill(T) Fill) {
142 T * ptr = NULL;
143 size_t size = sizeof(T);
144 size_t copy_end = 0;
145
146 if(Resize) {
147 ptr = (T*) (void *) resize( (int *)Resize, Align, Dim * size );
148 } else if (Realloc) {
149 if (Fill.tag != '0') copy_end = min(malloc_size( Realloc ), Dim * size);
150 ptr = (T*) (void *) realloc( (int *)Realloc, Align, Dim * size );
151 } else {
152 ptr = (T*) (void *) memalign( Align, Dim * size );
153 }
154
155 if(Fill.tag == 'c') {
156 memset( (char *)ptr + copy_end, (int)Fill.fill.c, Dim * size - copy_end );
157 } else if(Fill.tag == 't') {
158 for ( int i = copy_end; i <= Dim * size - size ; i += size ) {
159 memcpy( (char *)ptr + i, &Fill.fill.t, size );
160 }
161 } else if(Fill.tag == 'a') {
162 memcpy( (char *)ptr + copy_end, Fill.fill.a, min(Dim * size - copy_end, size * Fill.nmemb) );
163 }
164
165 return ptr;
166 } // alloc_internal$
167*/
168
169#pragma GCC diagnostic push
170#pragma GCC diagnostic ignored "-Wmaybe-uninitialized"
171#pragma GCC diagnostic ignored "-Wuninitialized"
172
173struct T_align { size_t align; };
174struct T_resize { void * addr; };
175struct T_realloc { void * addr; };
176forall( T & ) struct T_fill {
177 // 'N' => no fill, 'c' => fill with character c, 'a' => fill first N array elements from another array,
178 // 'A' => fill all array elements from another array, 'T' => fill using a T value.
179 char tag;
180 size_t nelem; // number of elements copied from "at" (used with tag 'a')
181// union {
182 char c;
183 T * at;
184 char t[64]; // T t;
185// };
186};
187
188#pragma GCC diagnostic pop
189
190static inline {
191 T_align ?`align( size_t a ) { return (T_align){ a }; }
192 T_resize ?`resize( void * a ) { return (T_resize){ a }; }
193 T_realloc ?`realloc( void * a ) { return (T_realloc){ a }; }
194}
195
196static inline forall( T & | sized(T) ) {
197 T_fill(T) ?`fill( char c ) { return (T_fill(T)){ 'c', 0, c }; }
198 T_fill(T) ?`fill( T t ) {
199 T_fill(T) ret = { 'T' };
200 size_t size = sizeof(T);
201 if ( size > sizeof(ret.t) ) {
202 abort( "ERROR: const object of size greater than 50 bytes given for dynamic memory fill\n" );
203 } // if
204 memcpy( &ret.t, &t, size );
205 return ret;
206 }
207 T_fill(T) ?`fill( T a[] ) { return (T_fill(T)){ 'A', 0, '\0', a }; } // FIX ME: remove this once ticket 214 is resolved
208 T_fill(T) ?`fill( T a[], size_t nelem ) { return (T_fill(T)){ 'a', nelem * sizeof(T), '\0', a }; }
209
210 // private interface
211 T * alloc_internal$( size_t Dim, T_resize Resize, T_realloc Realloc, size_t Align, T_fill(T) Fill ) {
212 T * ptr;
213 size_t tsize = sizeof(T);
214 size_t copy_end = 0;
215
216 if ( Resize.addr ) {
217 ptr = (T *)(void *)resize( Resize.addr, Align, Dim * tsize );
218 } else if ( Realloc.addr ) {
219 if ( Fill.tag != 'N' ) copy_end = min(malloc_size( Realloc.addr ), Dim * tsize );
220 ptr = (T *)(void *)realloc( Realloc.addr, Align, Dim * tsize );
221 } else {
222 ptr = (T *)(void *)memalign( Align, Dim * tsize );
223 } // if
224
225 if ( Fill.tag == 'c' ) {
226 memset( (char *)ptr + copy_end, (int)Fill.c, Dim * tsize - copy_end );
227 } else if ( Fill.tag == 'T' ) {
228 for ( i; copy_end ~ Dim * tsize ~ tsize ) {
229 assert( tsize <= sizeof(Fill.t) );
230 memcpy( (char *)ptr + i, &Fill.t, tsize );
231 } // for
232 } else if ( Fill.tag == 'a' ) {
233 memcpy( (char *)ptr + copy_end, Fill.at, min( Dim * tsize - copy_end, Fill.nelem ) );
234 } else if ( Fill.tag == 'A' ) {
235 memcpy( (char *)ptr + copy_end, Fill.at, Dim * tsize );
236 } // if
237 return ptr;
238 } // alloc_internal$
239
240 // Dim is a fixed (optional first) parameter, and hence is not set using a postfix function. A dummy parameter is
241 // being overwritten by the postfix argument in the ttype.
242 forall( List ... | { T * alloc_internal$( size_t Dim, T_resize Resize, T_realloc Realloc, size_t Align, T_fill(T) Fill, List ); } ) {
243 // middle interface
244 T * alloc_internal$( size_t Dim, T_resize /*dummy*/, T_realloc /*Realloc*/, size_t Align, T_fill(T) Fill, T_resize Resize, List rest ) {
245 return alloc_internal$( Dim, Resize, (T_realloc){0p}, Align, Fill, rest );
246 }
247 T * alloc_internal$( size_t Dim, T_resize /*Resize*/, T_realloc /*dummy*/, size_t Align, T_fill(T) Fill, T_realloc Realloc, List rest ) {
248 return alloc_internal$( Dim, (T_resize){0p}, Realloc, Align, Fill, rest );
249 }
250 T * alloc_internal$( size_t Dim, T_resize Resize, T_realloc Realloc, size_t /*dummy*/, T_fill(T) Fill, T_align Align, List rest ) {
251 return alloc_internal$( Dim, Resize, Realloc, Align.align, Fill, rest );
252 }
253 T * alloc_internal$( size_t Dim, T_resize Resize, T_realloc Realloc, size_t Align, T_fill(T) /*dummy*/, T_fill(T) Fill, List rest ) {
254 return alloc_internal$( Dim, Resize, Realloc, Align, Fill, rest );
255 }
256 // public interface
257 T * alloc( List rest ) {
258 return alloc_internal$( (size_t)1, (T_resize){0p}, (T_realloc){0p}, (_Alignof(T) > libAlign() ? _Alignof(T) : libAlign()), (T_fill(T)){'N'}, rest );
259 }
260 T * alloc( size_t Dim, List rest ) {
261 return alloc_internal$( Dim, (T_resize){0p}, (T_realloc){0p}, (_Alignof(T) > libAlign() ? _Alignof(T) : libAlign()), (T_fill(T)){'N'}, rest );
262 }
263 } // distribution List
264} // distribution T
265
266static inline forall( T & | sized(T) ) {
267 // CFA safe initialization/copy, i.e., implicit size specification, non-array types
268 T * memset( T * dest, char fill ) { // all combinations of pointer/reference
269 return (T *)memset( dest, fill, sizeof(T) ); // C memset
270 } // memset
271 T * memset( T & dest, char fill ) {
272 return (T *)memset( &dest, fill, sizeof(T) ); // C memset
273 } // memset
274
275 T * memcpy( T * dest, const T * src ) { // all combinations of pointer/reference
276 return (T *)memcpy( dest, src, sizeof(T) ); // C memcpy
277 } // memcpy
278 T * memcpy( T & dest, const T & src ) {
279 return (T *)memcpy( &dest, &src, sizeof(T) ); // C memcpy
280 } // memcpy
281 T * memcpy( T * dest, const T & src ) {
282 return (T *)memcpy( dest, &src, sizeof(T) ); // C memcpy
283 } // memcpy
284 T * memcpy( T & dest, const T * src ) {
285 return (T *)memcpy( &dest, src, sizeof(T) ); // C memcpy
286 } // memcpy
287
288 // CFA safe initialization/copy, i.e., implicit size specification, array types
289 T * amemset( T dest[], char fill, size_t dim ) {
290 return (T *)(void *)memset( dest, fill, dim * sizeof(T) ); // C memset
291 } // amemset
292
293 T * amemcpy( T dest[], const T src[], size_t dim ) {
294 return (T *)(void *)memcpy( dest, src, dim * sizeof(T) ); // C memcpy
295 } // amemcpy
296} // distribution
297
298// CFA deallocation for multiple objects
299static inline forall( T & )
300void free( T * ptr ) {
301 free( (void *)ptr ); // C free
302} // free
303static inline forall( T &, List ... | { void free( List ); } )
304void free( T * ptr, List rest ) {
305 free( ptr );
306 free( rest );
307} // free
308
309// CFA allocation/deallocation and constructor/destructor, non-array types
310static inline forall( T & | sized(T), Parms ... | { void ?{}( T &, Parms ); } )
311T * new( Parms p ) {
312 return &(*(T *)malloc()){ p }; // run constructor
313} // new
314
315static inline forall( T & | { void ^?{}( T & ); } )
316void delete( T * ptr ) {
317 // special case for 0-sized object => always call destructor
318 if ( ptr || sizeof(ptr) == 0 ) { // ignore null but not 0-sized objects
319 ^(*ptr){}; // run destructor
320 } // if
321 free( ptr ); // always call free
322} // delete
323static inline forall( T &, List ... | { void ^?{}( T & ); void delete( List ); } )
324void delete( T * ptr, List rest ) {
325 delete( ptr );
326 delete( rest );
327} // delete
328
329// CFA allocation/deallocation and constructor/destructor, array types
330forall( T & | sized(T), Parms ... | { void ?{}( T &, Parms ); } ) T * anew( size_t dim, Parms p );
331forall( T & | sized(T) | { void ^?{}( T & ); } ) void adelete( T arr[] );
332forall( T & | sized(T) | { void ^?{}( T & ); }, List ... | { void adelete( List ); } ) void adelete( T arr[], List rest );
333
334//---------------------------------------
335
336// Check if all string characters are a specific kind, e.g., checkif( s, isblank )
337bool checkif( const char s[], int (* kind)( int ) );
338bool checkif( const char s[], int (* kind)( int, locale_t ), locale_t locale );
339
340//---------------------------------------
341
342static inline {
343 int strto( const char sptr[], char * eptr[], int base ) { return (int)strtol( sptr, eptr, base ); }
344 unsigned int strto( const char sptr[], char * eptr[], int base ) { return (unsigned int)strtoul( sptr, eptr, base ); }
345 long int strto( const char sptr[], char * eptr[], int base ) { return strtol( sptr, eptr, base ); }
346 unsigned long int strto( const char sptr[], char * eptr[], int base ) { return strtoul( sptr, eptr, base ); }
347 long long int strto( const char sptr[], char * eptr[], int base ) { return strtoll( sptr, eptr, base ); }
348 unsigned long long int strto( const char sptr[], char * eptr[], int base ) { return strtoull( sptr, eptr, base ); }
349
350 float strto( const char sptr[], char * eptr[] ) { return strtof( sptr, eptr ); }
351 double strto( const char sptr[], char * eptr[] ) { return strtod( sptr, eptr ); }
352 long double strto( const char sptr[], char * eptr[] ) { return strtold( sptr, eptr ); }
353} // distribution
354
355float _Complex strto( const char sptr[], char * eptr[] );
356double _Complex strto( const char sptr[], char * eptr[] );
357long double _Complex strto( const char sptr[], char * eptr[] );
358
359ExceptionDecl( out_of_range );
360ExceptionDecl( invalid_argument );
361
362forall( T | { T strto( const char sptr[], char * eptr[], int ); } )
363T convert( const char sptr[] ); // integrals
364forall( T | { T strto( const char sptr[], char * eptr[] ); } )
365T convert( const char sptr[] ); // floating-point (no base)
366
367static inline {
368 int ato( const char sptr[] ) { return (int)strtol( sptr, 0p, 10 ); }
369 unsigned int ato( const char sptr[] ) { return (unsigned int)strtoul( sptr, 0p, 10 ); }
370 long int ato( const char sptr[] ) { return strtol( sptr, 0p, 10 ); }
371 unsigned long int ato( const char sptr[] ) { return strtoul( sptr, 0p, 10 ); }
372 long long int ato( const char sptr[] ) { return strtoll( sptr, 0p, 10 ); }
373 unsigned long long int ato( const char sptr[] ) { return strtoull( sptr, 0p, 10 ); }
374
375 float ato( const char sptr[] ) { return strtof( sptr, 0p ); }
376 double ato( const char sptr[] ) { return strtod( sptr, 0p ); }
377 long double ato( const char sptr[] ) { return strtold( sptr, 0p ); }
378
379 float _Complex ato( const char sptr[] ) { return strto( sptr, 0p ); }
380 double _Complex ato( const char sptr[] ) { return strto( sptr, 0p ); }
381 long double _Complex ato( const char sptr[] ) { return strto( sptr, 0p ); }
382} // distribution
383
384//---------------------------------------
385
386forall( E | { int ?<?( E, E ); } ) {
387 E * bsearch( E key, const E * vals, size_t dim );
388 size_t bsearch( E key, const E * vals, size_t dim );
389 E * bsearchl( E key, const E * vals, size_t dim );
390 size_t bsearchl( E key, const E * vals, size_t dim );
391 E * bsearchu( E key, const E * vals, size_t dim );
392 size_t bsearchu( E key, const E * vals, size_t dim );
393} // distribution
394
395forall( K, E | { int ?<?( K, K ); K getKey( const E & ); } ) {
396 E * bsearch( K key, const E * vals, size_t dim );
397 size_t bsearch( K key, const E * vals, size_t dim );
398 E * bsearchl( K key, const E * vals, size_t dim );
399 size_t bsearchl( K key, const E * vals, size_t dim );
400 E * bsearchu( K key, const E * vals, size_t dim );
401 size_t bsearchu( K key, const E * vals, size_t dim );
402} // distribution
403
404forall( E | { int ?<?( E, E ); } ) {
405 void qsort( E * vals, size_t dim );
406} // distribution
407
408//---------------------------------------
409
410extern "C" { // override C version
411 void srandom( unsigned int seed );
412 long int random( void ); // GENERATES POSITIVE AND NEGATIVE VALUES
413 // For positive values, use unsigned int, e.g., unsigned int r = random() % 100U;
414} // extern "C"
415
416static inline {
417 long int random( long int l, long int u ) { if ( u < l ) [u, l] = [l, u]; return lrand48() % (u - l + 1) + l; } // [l,u]
418 long int random( long int u ) { return random( 0, u - 1 ); } // [0,u)
419 unsigned long int random( void ) { return lrand48(); }
420 unsigned long int random( unsigned long int u ) { return lrand48() % u; } // [0,u)
421 unsigned long int random( unsigned long int l, unsigned long int u ) { if ( u < l ) [u, l] = [l, u]; return lrand48() % (u - l + 1) + l; } // [l,u]
422
423 char random( void ) { return (unsigned long int)random(); }
424 char random( char u ) { return (unsigned long int)random( (unsigned long int)u ); } // [0,u)
425 char random( char l, char u ) { return random( (unsigned long int)l, (unsigned long int)u ); } // [l,u)
426 int random( void ) { return (long int)random(); }
427 int random( int u ) { return (long int)random( (long int)u ); } // [0,u]
428 int random( int l, int u ) { return random( (long int)l, (long int)u ); } // [l,u)
429 unsigned int random( void ) { return (unsigned long int)random(); }
430 unsigned int random( unsigned int u ) { return (unsigned long int)random( (unsigned long int)u ); } // [0,u]
431 unsigned int random( unsigned int l, unsigned int u ) { return random( (unsigned long int)l, (unsigned long int)u ); } // [l,u)
432} // distribution
433
434float random( void ); // [0.0, 1.0)
435double random( void ); // [0.0, 1.0)
436float _Complex random( void ); // [0.0, 1.0)+[0.0, 1.0)i
437double _Complex random( void ); // [0.0, 1.0)+[0.0, 1.0)i
438long double _Complex random( void ); // [0.0, 1.0)+[0.0, 1.0)i
439
440//---------------------------------------
441
442// Sequential Pseudo Random-Number Generator : generate repeatable sequence of values that appear random.
443//
444// Declaration :
445// PRNG sprng = { 1009 } - set starting seed versus random seed
446//
447// Interface :
448// set_seed( sprng, 1009 ) - set starting seed for ALL kernel threads versus random seed
449// get_seed( sprng ) - read seed
450// prng( sprng ) - generate random value in range [0,UINT_MAX]
451// prng( sprng, u ) - generate random value in range [0,u)
452// prng( sprng, l, u ) - generate random value in range [l,u]
453// calls( sprng ) - number of generated random value so far
454//
455// Examples : generate random number between 5-21
456// prng( sprng ) % 17 + 5; values 0-16 + 5 = 5-21
457// prng( sprng, 16 + 1 ) + 5;
458// prng( sprng, 5, 21 );
459// calls( sprng );
460
461forall( PRNG &, R )
462trait basic_prng {
463 void set_seed( PRNG & prng, R seed ); // set seed
464 R get_seed( PRNG & prng ); // get seed
465 R prng( PRNG & prng );
466 void ?{}( PRNG & prng ); // random seed
467 void ?{}( PRNG & prng, R seed ); // fixed seed
468}; // basic_prng
469
470static inline forall( PRNG &, R | basic_prng( PRNG, R ) | { R ?%?( R, R ); } ) {
471 R prng( PRNG & prng, R u ) { return prng( prng ) % u; } // [0,u)
472}
473static inline forall( PRNG &, R | basic_prng( PRNG, R ) | { R ?+?( R, R ); R ?-?( R, R ); R ?%?( R, R ); void ?{}( R &, one_t ); } ) {
474 R prng( PRNG & prng, R l, R u ) { return prng( prng, u - l + (R){1} ) + l; } // [l,u]
475}
476
477struct PRNG32 {
478 uint32_t callcnt; // call count
479 uint32_t seed; // current seed
480 PRNG_STATE_32_T state; // random state
481}; // PRNG32
482
483static inline {
484 void set_seed( PRNG32 & prng, uint32_t seed_ ) with( prng ) { seed = seed_; PRNG_SET_SEED_32( state, seed ); }
485 uint32_t get_seed( PRNG32 & prng ) __attribute__(( warn_unused_result )) with( prng ) { return seed; }
486 void ?{}( PRNG32 & prng, uint32_t seed ) with( prng ) { callcnt = 0; set_seed( prng, seed ); } // fixed seed
487 void ?{}( PRNG32 & prng ) with( prng ) { ?{}( prng, rdtsc() ); } // random seed
488 uint32_t prng( PRNG32 & prng ) __attribute__(( warn_unused_result )) with( prng ) { callcnt += 1; return PRNG_NAME_32( state ); } // [0,UINT_MAX]
489 uint32_t prng( PRNG32 & prng, uint32_t u ) __attribute__(( warn_unused_result )) { return prng( prng ) % u; } // [0,u)
490 uint32_t prng( PRNG32 & prng, uint32_t l, uint32_t u ) __attribute__(( warn_unused_result )) { return prng( prng, u - l + 1 ) + l; } // [l,u]
491 uint32_t calls( PRNG32 & prng ) __attribute__(( warn_unused_result )) with( prng ) { return callcnt; }
492 void copy( PRNG32 & dst, PRNG32 & src ) { dst = src; } // checkpoint PRNG state, use autogen assignment
493} // distribution
494void ?{}( PRNG32 &, PRNG32 & ) = void; // no copy, remove autogen copy constructor
495PRNG32 & ?=?( PRNG32 &, const PRNG32 ) = void; // no assignment, remove autogen assignment
496
497struct PRNG64 {
498 uint64_t callcnt; // call count
499 uint64_t seed; // current seed
500 PRNG_STATE_64_T state; // random state
501}; // PRNG64
502
503static inline {
504 void set_seed( PRNG64 & prng, uint64_t seed_ ) with( prng ) { seed = seed_; PRNG_SET_SEED_64( state, seed ); }
505 uint64_t get_seed( PRNG64 & prng ) __attribute__(( warn_unused_result )) with( prng ) { return seed; }
506 void ?{}( PRNG64 & prng, uint64_t seed ) with( prng ) { callcnt = 0; set_seed( prng, seed ); } // fixed seed
507 void ?{}( PRNG64 & prng ) with( prng ) { ?{}( prng, rdtsc() ); } // random seed
508 uint64_t prng( PRNG64 & prng ) __attribute__(( warn_unused_result )) with( prng ) { callcnt += 1; return PRNG_NAME_64( state ); } // [0,UINT_MAX]
509 uint64_t prng( PRNG64 & prng, uint64_t u ) __attribute__(( warn_unused_result )) { return prng( prng ) % u; } // [0,u)
510 uint64_t prng( PRNG64 & prng, uint64_t l, uint64_t u ) __attribute__(( warn_unused_result )) { return prng( prng, u - l + 1 ) + l; } // [l,u]
511 uint64_t calls( PRNG64 & prng ) __attribute__(( warn_unused_result )) with( prng ) { return callcnt; }
512 void copy( PRNG64 & dst, PRNG64 & src ) { dst = src; } // checkpoint PRNG state, use autogen assignment
513} // distribution
514void ?{}( PRNG64 &, PRNG64 & ) = void; // no copy, remove autogen copy constructor
515PRNG64 & ?=?( PRNG64 &, const PRNG64 ) = void; // no assignment, remove autogen assignment
516
517// Set default random-generator size.
518#if defined( __x86_64__ ) || defined( __aarch64__ ) // 64-bit architecture
519#define PRNG PRNG64
520#else // 32-bit architecture
521#define PRNG PRNG32
522#endif // __x86_64__
523
524// Concurrent Pseudo Random-Number Generator : generate repeatable sequence of values that appear random.
525//
526// Interface :
527// set_seed( 1009 ) - fixed seed for all kernel threads versus random seed
528// get_seed() - read seed
529// prng() - generate random value in range [0,UINT_MAX]
530// prng( u ) - generate random value in range [0,u)
531// prng( l, u ) - generate random value in range [l,u]
532//
533// Examples : generate random number between 5-21
534// prng() % 17 + 5; values 0-16 + 5 = 5-21
535// prng( 16 + 1 ) + 5;
536// prng( 5, 21 );
537
538// Harmonize with concurrency/thread.hfa.
539void set_seed( size_t seed_ ) OPTIONAL_THREAD; // set global seed
540size_t get_seed() __attribute__(( warn_unused_result )); // get global seed
541size_t prng( void ) __attribute__(( warn_unused_result )) OPTIONAL_THREAD; // [0,UINT_MAX]
542static inline {
543 size_t prng( size_t u ) __attribute__(( warn_unused_result )) { return prng() % u; } // [0,u)
544 size_t prng( size_t l, size_t u ) __attribute__(( warn_unused_result )) { return prng( u - l + 1 ) + l; } // [l,u]
545} // distribution
546
547//---------------------------------------
548
549extern bool threading_enabled( void ) OPTIONAL_THREAD;
550
551// Local Variables: //
552// mode: c //
553// tab-width: 4 //
554// End: //
Note: See TracBrowser for help on using the repository browser.