source: libcfa/src/stdlib.hfa @ 7d0ebd0

ADTast-experimentalenumforall-pointer-decaypthread-emulationqualifiedEnum
Last change on this file since 7d0ebd0 was aa0a1ad, checked in by Peter A. Buhr <pabuhr@…>, 2 years ago

remove macro ARRAY_ALLOC$ and expand inline, remove unnecessary void * casts
  • Property mode set to 100644
File size: 17.1 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 : Sun Jan  2 22:53:57 2022
13// Update Count     : 594
14//
15
16#pragma once
17
18#include "bits/defs.hfa"                                                                // OPTIONAL_THREAD
19#include "bits/align.hfa"                                                               // libAlign
20
21#include <stdlib.h>                                                                             // *alloc, strto*, ato*
22#include <heap.hfa>
23
24// Reduce includes by explicitly defining these routines.
25extern "C" {
26        void * memalign( size_t alignment, size_t size );       // malloc.h
27        void * pvalloc( size_t size );                                          // malloc.h
28        void * memset( void * dest, int fill, size_t size ); // string.h
29        void * memcpy( void * dest, const void * src, size_t size ); // string.h
30} // extern "C"
31
32//---------------------------------------
33
34#ifndef EXIT_FAILURE
35#define EXIT_FAILURE    1                                                               // failing exit status
36#define EXIT_SUCCESS    0                                                               // successful exit status
37#endif // ! EXIT_FAILURE
38
39//---------------------------------------
40
41#include "common.hfa"
42
43//---------------------------------------
44
45static inline forall( T & | sized(T) ) {
46        // CFA safe equivalents, i.e., implicit size specification
47
48        T * malloc( void ) {
49                if ( _Alignof(T) <= libAlign() ) return (T *)malloc( sizeof(T) ); // C allocation
50                else return (T *)memalign( _Alignof(T), sizeof(T) );
51        } // malloc
52
53        T * aalloc( size_t dim ) {
54                if ( _Alignof(T) <= libAlign() ) return (T *)aalloc( dim, sizeof(T) ); // C allocation
55                else return (T *)amemalign( _Alignof(T), dim, sizeof(T) );
56        } // aalloc
57
58        T * calloc( size_t dim ) {
59                if ( _Alignof(T) <= libAlign() ) return (T *)calloc( dim, sizeof(T) ); // C allocation
60                else return (T *)cmemalign( _Alignof(T), dim, sizeof(T) );
61        } // calloc
62
63        T * resize( T * ptr, size_t size ) {                            // CFA resize, eliminate return-type cast
64                if ( _Alignof(T) <= libAlign() ) return (T *)resize( (void *)ptr, size ); // CFA resize
65                else return (T *)resize( (void *)ptr, _Alignof(T), size ); // CFA resize
66        } // resize
67
68        T * realloc( T * ptr, size_t size ) {                           // CFA realloc, eliminate return-type cast
69                if ( _Alignof(T) <= libAlign() ) return (T *)realloc( (void *)ptr, size ); // C realloc
70                else return (T *)realloc( (void *)ptr, _Alignof(T), size ); // CFA realloc
71        } // realloc
72
73        T * memalign( size_t align ) {
74                return (T *)memalign( align, sizeof(T) );               // C memalign
75        } // memalign
76
77        T * amemalign( size_t align, size_t dim ) {
78                return (T *)amemalign( align, dim, sizeof(T) ); // CFA amemalign
79        } // amemalign
80
81        T * cmemalign( size_t align, size_t dim  ) {
82                return (T *)cmemalign( align, dim, sizeof(T) ); // CFA cmemalign
83        } // cmemalign
84
85        T * aligned_alloc( size_t align ) {
86                return (T *)aligned_alloc( align, sizeof(T) );  // C aligned_alloc
87        } // aligned_alloc
88
89        int posix_memalign( T ** ptr, size_t align ) {
90                return posix_memalign( (void **)ptr, align, sizeof(T) ); // C posix_memalign
91        } // posix_memalign
92
93        T * valloc( void ) {
94                return (T *)valloc( sizeof(T) );                                // C valloc
95        } // valloc
96
97        T * pvalloc( void ) {
98                return (T *)pvalloc( sizeof(T) );                               // C pvalloc
99        } // pvalloc
100} // distribution
101
102/*
103        FIX ME : fix alloc interface after Ticker Number 214 is resolved, define and add union to S_fill. Then, modify postfix-fill functions to support T * with nmemb, char, and T object of any size. Finally, change alloc_internal.
104        Or, just follow the instructions below for that.
105
106        1. Replace the current forall-block that contains defintions of S_fill and S_realloc with following:
107                forall( T & | sized(T) ) {
108                        union  U_fill           { char c; T * a; T t; };
109                        struct S_fill           { char tag; U_fill(T) fill; };
110                        struct S_realloc        { inline T *; };
111                }
112
113        2. Replace all current postfix-fill functions with following for updated S_fill:
114                S_fill(T) ?`fill( char a )                                      { S_fill(T) ret = {'c'}; ret.fill.c = a; return ret; }
115                S_fill(T) ?`fill( T    a )                                      { S_fill(T) ret = {'t'}; memcpy(&ret.fill.t, &a, sizeof(T)); return ret; }
116                S_fill(T) ?`fill( T    a[], size_t nmemb )      { S_fill(T) ret = {'a', nmemb}; ret.fill.a = a; return ret; }
117
118        3. Replace the alloc_internal$ function which is outside ttype forall-block with following function:
119                T * alloc_internal$( void * Resize, T * Realloc, size_t Align, size_t Dim, S_fill(T) Fill) {
120                        T * ptr = NULL;
121                        size_t size = sizeof(T);
122                        size_t copy_end = 0;
123
124                        if(Resize) {
125                                ptr = (T*) (void *) resize( (int *)Resize, Align, Dim * size );
126                        } else if (Realloc) {
127                                if (Fill.tag != '0') copy_end = min(malloc_size( Realloc ), Dim * size);
128                                ptr = (T*) (void *) realloc( (int *)Realloc, Align, Dim * size );
129                        } else {
130                                ptr = (T*) (void *) memalign( Align, Dim * size );
131                        }
132
133                        if(Fill.tag == 'c') {
134                                memset( (char *)ptr + copy_end, (int)Fill.fill.c, Dim * size - copy_end );
135                        } else if(Fill.tag == 't') {
136                                for ( int i = copy_end; i <= Dim * size - size ; i += size ) {
137                                        memcpy( (char *)ptr + i, &Fill.fill.t, size );
138                                }
139                        } else if(Fill.tag == 'a') {
140                                memcpy( (char *)ptr + copy_end, Fill.fill.a, min(Dim * size - copy_end, size * Fill.nmemb) );
141                        }
142
143                        return ptr;
144                } // alloc_internal$
145*/
146
147typedef struct S_align                  { inline size_t;  } T_align;
148typedef struct S_resize                 { inline void *;  }     T_resize;
149
150forall( T & ) {
151        struct S_fill           { char tag; char c; size_t size; T * at; char t[50]; };
152        struct S_realloc        { inline T *; };
153}
154
155static inline T_align   ?`align   ( size_t a )  { return (T_align){a}; }
156static inline T_resize  ?`resize  ( void * a )  { return (T_resize){a}; }
157
158static inline forall( T & | sized(T) ) {
159        S_fill(T) ?`fill ( T t ) {
160                S_fill(T) ret = { 't' };
161                size_t size = sizeof(T);
162                if ( size > sizeof(ret.t) ) {
163                        abort( "ERROR: const object of size greater than 50 bytes given for dynamic memory fill\n" );
164                } // if
165                memcpy( &ret.t, &t, size );
166                return ret;
167        }
168        S_fill(T)               ?`fill ( zero_t ) = void; // FIX ME: remove this once ticket 214 is resolved
169        S_fill(T)               ?`fill ( T * a )                                { return (S_fill(T)){ 'T', '0', 0, a }; } // FIX ME: remove this once ticket 214 is resolved
170        S_fill(T)               ?`fill ( char c )                               { return (S_fill(T)){ 'c', c }; }
171        S_fill(T)               ?`fill ( T a[], size_t nmemb )  { return (S_fill(T)){ 'a', '0', nmemb * sizeof(T), a }; }
172
173        S_realloc(T)    ?`realloc ( T * a )                             { return (S_realloc(T)){a}; }
174
175        T * alloc_internal$( void * Resize, T * Realloc, size_t Align, size_t Dim, S_fill(T) Fill ) {
176                T * ptr = NULL;
177                size_t size = sizeof(T);
178                size_t copy_end = 0;
179
180                if ( Resize ) {
181                        ptr = (T*) (void *) resize( (void *)Resize, Align, Dim * size );
182                } else if ( Realloc ) {
183                        if ( Fill.tag != '0' ) copy_end = min(malloc_size( Realloc ), Dim * size );
184                        ptr = (T *) (void *) realloc( (void *)Realloc, Align, Dim * size );
185                } else {
186                        ptr = (T *) (void *) memalign( Align, Dim * size );
187                }
188
189                if ( Fill.tag == 'c' ) {
190                        memset( (char *)ptr + copy_end, (int)Fill.c, Dim * size - copy_end );
191                } else if ( Fill.tag == 't' ) {
192                        for ( int i = copy_end; i < Dim * size; i += size ) {
193                                #pragma GCC diagnostic push
194                                #pragma GCC diagnostic ignored "-Wmaybe-uninitialized"
195                                assert( size <= sizeof(Fill.t) );
196                                memcpy( (char *)ptr + i, &Fill.t, size );
197                                #pragma GCC diagnostic pop
198                        }
199                } else if ( Fill.tag == 'a' ) {
200                        memcpy( (char *)ptr + copy_end, Fill.at, min(Dim * size - copy_end, Fill.size) );
201                } else if ( Fill.tag == 'T' ) {
202                        memcpy( (char *)ptr + copy_end, Fill.at, Dim * size );
203                }
204
205                return ptr;
206        } // alloc_internal$
207
208        forall( TT... | { T * alloc_internal$( void *, T *, size_t, size_t, S_fill(T), TT ); } ) {
209
210                T * alloc_internal$( void *       , T * Realloc, size_t Align, size_t Dim, S_fill(T) Fill, T_resize Resize, TT rest) {
211                return alloc_internal$( Resize, (T*)0p, Align, Dim, Fill, rest);
212                }
213
214                T * alloc_internal$( void * Resize, T *        , size_t Align, size_t Dim, S_fill(T) Fill, S_realloc(T) Realloc, TT rest) {
215                return alloc_internal$( (void*)0p, Realloc, Align, Dim, Fill, rest);
216                }
217
218                T * alloc_internal$( void * Resize, T * Realloc, size_t      , size_t Dim, S_fill(T) Fill, T_align Align, TT rest) {
219                return alloc_internal$( Resize, Realloc, Align, Dim, Fill, rest);
220                }
221
222                T * alloc_internal$( void * Resize, T * Realloc, size_t Align, size_t Dim, S_fill(T)     , S_fill(T) Fill, TT rest) {
223                return alloc_internal$( Resize, Realloc, Align, Dim, Fill, rest);
224                }
225
226            T * alloc( TT all ) {
227                return alloc_internal$( (void*)0p, (T*)0p, (_Alignof(T) > libAlign() ? _Alignof(T) : libAlign()), (size_t)1, (S_fill(T)){'0'}, all);
228            }
229
230            T * alloc( size_t dim, TT all ) {
231                return alloc_internal$( (void*)0p, (T*)0p, (_Alignof(T) > libAlign() ? _Alignof(T) : libAlign()), dim, (S_fill(T)){'0'}, all);
232            }
233
234        } // distribution TT
235} // distribution T
236
237static inline forall( T & | sized(T) ) {
238        // CFA safe initialization/copy, i.e., implicit size specification, non-array types
239        T * memset( T * dest, char fill ) {
240                return (T *)memset( dest, fill, sizeof(T) );
241        } // memset
242
243        T * memcpy( T * dest, const T * src ) {
244                return (T *)memcpy( dest, src, sizeof(T) );
245        } // memcpy
246
247        // CFA safe initialization/copy, i.e., implicit size specification, array types
248        T * amemset( T dest[], char fill, size_t dim ) {
249                return (T *)(void *)memset( dest, fill, dim * sizeof(T) ); // C memset
250        } // amemset
251
252        T * amemcpy( T dest[], const T src[], size_t dim ) {
253                return (T *)(void *)memcpy( dest, src, dim * sizeof(T) ); // C memcpy
254        } // amemcpy
255} // distribution
256
257// CFA deallocation for multiple objects
258static inline forall( T & )                                                     // FIX ME, problems with 0p in list
259void free( T * ptr ) {
260        free( (void *)ptr );                                                            // C free
261} // free
262static inline forall( T &, TT... | { void free( TT ); } )
263void free( T * ptr, TT rest ) {
264        free( ptr );
265        free( rest );
266} // free
267
268// CFA allocation/deallocation and constructor/destructor, non-array types
269static inline forall( T & | sized(T), TT... | { void ?{}( T &, TT ); } )
270T * new( TT p ) {
271        return &(*(T *)malloc()){ p };                                          // run constructor
272} // new
273
274static inline forall( T & | { void ^?{}( T & ); } )
275void delete( T * ptr ) {
276        // special case for 0-sized object => always call destructor
277        if ( ptr || sizeof(ptr) == 0 ) {                                        // ignore null but not 0-sized objects
278                ^(*ptr){};                                                                              // run destructor
279        } // if
280        free( ptr );                                                                            // always call free
281} // delete
282static inline forall( T &, TT... | { void ^?{}( T & ); void delete( TT ); } )
283void delete( T * ptr, TT rest ) {
284        delete( ptr );
285        delete( rest );
286} // delete
287
288// CFA allocation/deallocation and constructor/destructor, array types
289forall( T & | sized(T), TT... | { void ?{}( T &, TT ); } ) T * anew( size_t dim, TT p );
290forall( T & | sized(T) | { void ^?{}( T & ); } ) void adelete( T arr[] );
291forall( T & | sized(T) | { void ^?{}( T & ); }, TT... | { void adelete( TT ); } ) void adelete( T arr[], TT rest );
292
293//---------------------------------------
294
295static inline {
296        int strto( const char sptr[], char ** eptr, int base ) { return (int)strtol( sptr, eptr, base ); }
297        unsigned int strto( const char sptr[], char ** eptr, int base ) { return (unsigned int)strtoul( sptr, eptr, base ); }
298        long int strto( const char sptr[], char ** eptr, int base ) { return strtol( sptr, eptr, base ); }
299        unsigned long int strto( const char sptr[], char ** eptr, int base ) { return strtoul( sptr, eptr, base ); }
300        long long int strto( const char sptr[], char ** eptr, int base ) { return strtoll( sptr, eptr, base ); }
301        unsigned long long int strto( const char sptr[], char ** eptr, int base ) { return strtoull( sptr, eptr, base ); }
302
303        float strto( const char sptr[], char ** eptr ) { return strtof( sptr, eptr ); }
304        double strto( const char sptr[], char ** eptr ) { return strtod( sptr, eptr ); }
305        long double strto( const char sptr[], char ** eptr ) { return strtold( sptr, eptr ); }
306} // distribution
307
308float _Complex strto( const char sptr[], char ** eptr );
309double _Complex strto( const char sptr[], char ** eptr );
310long double _Complex strto( const char sptr[], char ** eptr );
311
312static inline {
313        int ato( const char sptr[] ) { return (int)strtol( sptr, 0p, 10 ); }
314        unsigned int ato( const char sptr[] ) { return (unsigned int)strtoul( sptr, 0p, 10 ); }
315        long int ato( const char sptr[] ) { return strtol( sptr, 0p, 10 ); }
316        unsigned long int ato( const char sptr[] ) { return strtoul( sptr, 0p, 10 ); }
317        long long int ato( const char sptr[] ) { return strtoll( sptr, 0p, 10 ); }
318        unsigned long long int ato( const char sptr[] ) { return strtoull( sptr, 0p, 10 ); }
319
320        float ato( const char sptr[] ) { return strtof( sptr, 0p ); }
321        double ato( const char sptr[] ) { return strtod( sptr, 0p ); }
322        long double ato( const char sptr[] ) { return strtold( sptr, 0p ); }
323
324        float _Complex ato( const char sptr[] ) { return strto( sptr, 0p ); }
325        double _Complex ato( const char sptr[] ) { return strto( sptr, 0p ); }
326        long double _Complex ato( const char sptr[] ) { return strto( sptr, 0p ); }
327} // distribution
328
329//---------------------------------------
330
331forall( E | { int ?<?( E, E ); } ) {
332        E * bsearch( E key, const E * vals, size_t dim );
333        size_t bsearch( E key, const E * vals, size_t dim );
334        E * bsearchl( E key, const E * vals, size_t dim );
335        size_t bsearchl( E key, const E * vals, size_t dim );
336        E * bsearchu( E key, const E * vals, size_t dim );
337        size_t bsearchu( E key, const E * vals, size_t dim );
338} // distribution
339
340forall( K, E | { int ?<?( K, K ); K getKey( const E & ); } ) {
341        E * bsearch( K key, const E * vals, size_t dim );
342        size_t bsearch( K key, const E * vals, size_t dim );
343        E * bsearchl( K key, const E * vals, size_t dim );
344        size_t bsearchl( K key, const E * vals, size_t dim );
345        E * bsearchu( K key, const E * vals, size_t dim );
346        size_t bsearchu( K key, const E * vals, size_t dim );
347} // distribution
348
349forall( E | { int ?<?( E, E ); } ) {
350        void qsort( E * vals, size_t dim );
351} // distribution
352
353//---------------------------------------
354
355extern "C" {                                                                                    // override C version
356        void srandom( unsigned int seed );
357        long int random( void );                                                        // GENERATES POSITIVE AND NEGATIVE VALUES
358        // For positive values, use unsigned int, e.g., unsigned int r = random() % 100U;
359} // extern "C"
360
361static inline {
362        long int random( long int l, long int u ) { if ( u < l ) [u, l] = [l, u]; return lrand48() % (u - l + 1) + l; } // [l,u]
363        long int random( long int u ) { return random( 0, u - 1 ); } // [0,u)
364        unsigned long int random( void ) { return lrand48(); }
365        unsigned long int random( unsigned long int u ) { return lrand48() % u; } // [0,u)
366        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]
367
368        char random( void ) { return (unsigned long int)random(); }
369        char random( char u ) { return random( (unsigned long int)u ); } // [0,u)
370        char random( char l, char u ) { return random( (unsigned long int)l, (unsigned long int)u ); } // [l,u)
371        int random( void ) { return (long int)random(); }
372        int random( int u ) { return random( (long int)u ); } // [0,u]
373        int random( int l, int u ) { return random( (long int)l, (long int)u ); } // [l,u)
374        unsigned int random( void ) { return (unsigned long int)random(); }
375        unsigned int random( unsigned int u ) { return random( (unsigned long int)u ); } // [0,u]
376        unsigned int random( unsigned int l, unsigned int u ) { return random( (unsigned long int)l, (unsigned long int)u ); } // [l,u)
377} // distribution
378
379float random( void );                                                                   // [0.0, 1.0)
380double random( void );                                                                  // [0.0, 1.0)
381float _Complex random( void );                                                  // [0.0, 1.0)+[0.0, 1.0)i
382double _Complex random( void );                                                 // [0.0, 1.0)+[0.0, 1.0)i
383long double _Complex random( void );                                    // [0.0, 1.0)+[0.0, 1.0)i
384
385//---------------------------------------
386
387struct PRNG {
388        uint32_t callcnt;                                                                       // call count
389        uint32_t seed;                                                                          // current seed
390        uint32_t state;                                                                         // random state
391}; // PRNG
392
393extern uint32_t prng( PRNG & prng ) __attribute__(( warn_unused_result )); // [0,UINT_MAX]
394static inline {
395        void set_seed( PRNG & prng, uint32_t seed_ ) with( prng ) { state = seed = seed_; } // set seed
396        void ?{}( PRNG & prng ) { set_seed( prng, rdtscl() ); } // random seed
397        void ?{}( PRNG & prng, uint32_t seed ) { set_seed( prng, seed ); } // fixed seed
398        uint32_t get_seed( PRNG & prng ) __attribute__(( warn_unused_result )) with( prng ) { return seed; } // get seed
399        uint32_t prng( PRNG & prng, uint32_t u ) __attribute__(( warn_unused_result )) { return prng( prng ) % u; } // [0,u)
400        uint32_t prng( PRNG & prng, uint32_t l, uint32_t u ) __attribute__(( warn_unused_result )) { return prng( prng, u - l + 1 ) + l; } // [l,u]
401        uint32_t calls( PRNG & prng ) __attribute__(( warn_unused_result )) with( prng ) { return callcnt; }
402} // distribution
403
404extern void set_seed( uint32_t seed );                                  // set per thread seed
405extern uint32_t get_seed();                                                             // get seed
406extern uint32_t prng( void ) __attribute__(( warn_unused_result )); // [0,UINT_MAX]
407static inline {
408        uint32_t prng( uint32_t u ) __attribute__(( warn_unused_result ));
409        uint32_t prng( uint32_t u ) { return prng() % u; }      // [0,u)
410        uint32_t prng( uint32_t l, uint32_t u ) __attribute__(( warn_unused_result ));
411        uint32_t prng( uint32_t l, uint32_t u ) { return prng( u - l + 1 ) + l; } // [l,u]
412} // distribution
413
414//---------------------------------------
415
416extern bool threading_enabled( void ) OPTIONAL_THREAD;
417
418// Local Variables: //
419// mode: c //
420// tab-width: 4 //
421// End: //
Note: See TracBrowser for help on using the repository browser.