File: GrB_Global_get.c

package info (click to toggle)
suitesparse 1%3A7.10.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 254,920 kB
  • sloc: ansic: 1,134,743; cpp: 46,133; makefile: 4,875; fortran: 2,087; java: 1,826; sh: 996; ruby: 725; python: 495; asm: 371; sed: 166; awk: 44
file content (605 lines) | stat: -rw-r--r-- 16,167 bytes parent folder | download
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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
//------------------------------------------------------------------------------
// GrB_Global_get_*: get a global option
//------------------------------------------------------------------------------

// SuiteSparse:GraphBLAS, Timothy A. Davis, (c) 2017-2025, All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0

//------------------------------------------------------------------------------

#include "get_set/GB_get_set.h"
#include "jitifyer/GB_jitifyer.h"

//------------------------------------------------------------------------------
// GrB_Global: an object defining the global state
//------------------------------------------------------------------------------

struct GB_Global_opaque GB_OPAQUE (WORLD_OBJECT) =
{
    GB_MAGIC,                       // magic: initialized
    0,                              // header_size: statically allocated
} ;

const GrB_Global GrB_GLOBAL = & GB_OPAQUE (WORLD_OBJECT) ;

//------------------------------------------------------------------------------
// GB_global_enum_get: get an enum value from the global state
//------------------------------------------------------------------------------

static GrB_Info GB_global_enum_get (int32_t *value, int field)
{

    switch (field)
    {

        case GrB_LIBRARY_VER_MAJOR : 

            (*value) = GxB_IMPLEMENTATION_MAJOR ;
            break ;

        case GrB_LIBRARY_VER_MINOR : 

            (*value) = GxB_IMPLEMENTATION_MINOR ;
            break ;

        case GrB_LIBRARY_VER_PATCH : 

            (*value) = GxB_IMPLEMENTATION_SUB ;
            break ;

        case GrB_API_VER_MAJOR : 

            (*value) = GxB_SPEC_MAJOR ;
            break ;

        case GrB_API_VER_MINOR : 

            (*value) = GxB_SPEC_MINOR ;
            break ;

        case GrB_API_VER_PATCH : 

            (*value) = GxB_SPEC_SUB ;
            break ;

        case GrB_BLOCKING_MODE : 

            // return just the GrB modes
            (*value) = (int) GB_Global_mode_get ( )  ;
            if ((*value) == GxB_NONBLOCKING_GPU) (*value) = GrB_NONBLOCKING ;
            if ((*value) == GxB_BLOCKING_GPU) (*value) = GrB_BLOCKING ;
            break ;

        case GxB_MODE : 

            // return all 4 possible modes (GrB and GxB)
            (*value) = (int) GB_Global_mode_get ( )  ;
            break ;

        case GrB_STORAGE_ORIENTATION_HINT : 

            (*value) = (int) (GB_Global_is_csc_get ( )) ?
                    GrB_COLMAJOR : GrB_ROWMAJOR ;
            break ;

        case GxB_FORMAT : 

            (*value) = (int) (GB_Global_is_csc_get ( )) ?
                    GxB_BY_COL : GxB_BY_ROW ;
            break ;

        case GxB_OFFSET_INTEGER_HINT : 

            (*value) = (int) GB_Global_p_control_get ( ) ;
            break ;

        case GxB_COLINDEX_INTEGER_HINT : 

            (*value) = (int) (GB_Global_is_csc_get ( ) ?
                GB_Global_j_control_get ( ) :
                GB_Global_i_control_get ( )) ;
            break ;

        case GxB_ROWINDEX_INTEGER_HINT : 

            (*value) = (int) (GB_Global_is_csc_get ( ) ?
                GB_Global_i_control_get ( ) :
                GB_Global_j_control_get ( )) ;
            break ;

        case GxB_GLOBAL_NTHREADS :      // same as GxB_NTHREADS

            (*value) = (int) GB_Context_nthreads_max_get (NULL) ;
            break ;

        case GxB_GLOBAL_GPU_ID :            // same as GxB_GPU_ID

            (*value) = (int) GB_Context_gpu_id_get (NULL) ;
            break ;

        case GxB_BURBLE : 

            (*value) = (int) GB_Global_burble_get ( ) ;
            break ;

        case GxB_LIBRARY_OPENMP : 

            #ifdef _OPENMP
            (*value) = (int) true ;
            #else
            (*value) = (int) false ;
            #endif
            break ;

        case GxB_PRINT_1BASED : 

            (*value) = (int) GB_Global_print_one_based_get ( ) ;
            break ;

        case GxB_INCLUDE_READONLY_STATISTICS : 

            (*value) = (int) GB_Global_stats_mem_shallow_get ( ) ;
            break ;

        case GxB_JIT_C_CONTROL : 

            (*value) = (int) GB_jitifyer_get_control ( ) ;
            break ;

        case GxB_JIT_USE_CMAKE : 

            (*value) = (int) GB_jitifyer_get_use_cmake ( ) ;
            break ;

        default : 

            return (GrB_INVALID_VALUE) ;
    }

    #pragma omp flush
    return (GrB_SUCCESS) ;
}

//------------------------------------------------------------------------------
// GrB_Global_get_Scalar
//------------------------------------------------------------------------------

GrB_Info GrB_Global_get_Scalar
(
    GrB_Global g,
    GrB_Scalar scalar,
    int field
)
{

    //--------------------------------------------------------------------------
    // check inputs
    //--------------------------------------------------------------------------

    GB_RETURN_IF_NULL (g) ;
    GB_RETURN_IF_NULL (scalar) ;
    GB_WHERE_1 (scalar, "GrB_Global_get_Scalar (g, scalar, field)") ;
    ASSERT_SCALAR_OK (scalar, "input Scalar for GrB_Global_get_Scalar", GB0) ;

    //--------------------------------------------------------------------------
    // get the field
    //--------------------------------------------------------------------------

    info = GrB_NO_VALUE ;

    #pragma omp critical (GB_global_get_set)
    {
        int32_t i ;
        info = GB_global_enum_get (&i, field) ;
        if (info == GrB_SUCCESS)
        { 
            // field specifies an int: assign it to the scalar
            info = GB_setElement ((GrB_Matrix) scalar, NULL, &i, 0, 0,
                GB_INT32_code, Werk) ;
        }
        else
        { 
            double x ;
            int64_t i64 ;
            switch ((int) field)
            {

                case GxB_HYPER_SWITCH : 

                    x = (double) GB_Global_hyper_switch_get ( ) ;
                    info = GB_setElement ((GrB_Matrix) scalar, NULL, &x, 0, 0,
                        GB_FP64_code, Werk) ;

                    break ;

                case GxB_GLOBAL_CHUNK :         // same as GxB_CHUNK

                    x = GB_Context_chunk_get (NULL) ;
                    info = GB_setElement ((GrB_Matrix) scalar, NULL, &x, 0, 0,
                        GB_FP64_code, Werk) ;
                    break ;

                case GxB_HYPER_HASH : 

                    i64 = GB_Global_hyper_hash_get ( ) ;
                    info = GB_setElement ((GrB_Matrix) scalar, NULL, &i64, 0, 0,
                        GB_INT64_code, Werk) ;
                    break ;

                default : 

                    info = GrB_INVALID_VALUE ;
            }
        }
    }

    ASSERT_SCALAR_OK (scalar, "output Scalar for GrB_Global_get_Scalar", GB0) ;
    return (info) ;
}

//------------------------------------------------------------------------------
// GB_global_string_get: get a string from the global state
//------------------------------------------------------------------------------

static GrB_Info GB_global_string_get (const char **value, int field)
{

    switch ((int) field)
    {

        case GrB_NAME : 
        case GxB_LIBRARY_NAME : 

            (*value) = GxB_IMPLEMENTATION_NAME ;
            break ;

        case GxB_LIBRARY_DATE : 

            (*value) = GxB_IMPLEMENTATION_DATE ;
            break ;

        case GxB_LIBRARY_ABOUT : 

            (*value) = GxB_IMPLEMENTATION_ABOUT ;
            break ;

        case GxB_LIBRARY_LICENSE : 

            (*value) = GxB_IMPLEMENTATION_LICENSE ;
            break ;

        case GxB_LIBRARY_COMPILE_DATE : 

            (*value) = __DATE__ ;
            break ;

        case GxB_LIBRARY_COMPILE_TIME : 

            (*value) = __TIME__ ;
            break ;

        case GxB_LIBRARY_URL : 

            (*value) = "http://faculty.cse.tamu.edu/davis/GraphBLAS" ;
            break ;

        case GxB_API_DATE : 

            (*value) = GxB_SPEC_DATE ;
            break ;

        case GxB_API_ABOUT : 

            (*value) = GxB_SPEC_ABOUT ;
            break ;

        case GxB_API_URL : 

            (*value) = "http://graphblas.org" ;
            break ;

        case GxB_COMPILER_NAME : 

            (*value) = GB_COMPILER_NAME ;
            break ;

        //----------------------------------------------------------------------
        // JIT configuration:
        //----------------------------------------------------------------------

        case GxB_JIT_C_COMPILER_NAME : 

            (*value) = GB_jitifyer_get_C_compiler ( ) ;
            break ;

        case GxB_JIT_C_COMPILER_FLAGS : 

            (*value) = GB_jitifyer_get_C_flags ( ) ;
            break ;

        case GxB_JIT_C_LINKER_FLAGS : 

            (*value) = GB_jitifyer_get_C_link_flags ( ) ;
            break ;

        case GxB_JIT_C_LIBRARIES : 

            (*value) = GB_jitifyer_get_C_libraries ( ) ;
            break ;

        case GxB_JIT_C_CMAKE_LIBS : 

            (*value) = GB_jitifyer_get_C_cmake_libs ( ) ;
            break ;

        case GxB_JIT_C_PREFACE : 

            (*value) = GB_jitifyer_get_C_preface ( ) ;
            break ;

        case GxB_JIT_CUDA_PREFACE : 

            (*value) = GB_jitifyer_get_CUDA_preface ( ) ;
            break ;

        case GxB_JIT_ERROR_LOG : 

            (*value) = GB_jitifyer_get_error_log ( ) ;
            break ;

        case GxB_JIT_CACHE_PATH : 

            (*value) = GB_jitifyer_get_cache_path ( ) ;
            break ;

        default : 

            return (GrB_INVALID_VALUE) ;
    }

    return (GrB_SUCCESS) ;
}

//------------------------------------------------------------------------------
// GrB_Global_get_String
//------------------------------------------------------------------------------

GrB_Info GrB_Global_get_String
(
    GrB_Global g,
    char * value,
    int field
)
{

    //--------------------------------------------------------------------------
    // check inputs
    //--------------------------------------------------------------------------

    GB_CHECK_INIT ;
    GB_RETURN_IF_NULL_OR_FAULTY (g) ;
    GB_RETURN_IF_NULL (value) ;
    (*value) = '\0' ;

    //--------------------------------------------------------------------------
    // get the field
    //--------------------------------------------------------------------------

    GrB_Info info = GrB_NO_VALUE ;

    #pragma omp critical (GB_global_get_set)
    {
        const char *s ;
        info = GB_global_string_get (&s, field) ;
        if (info == GrB_SUCCESS)
        { 
            strcpy (value, s) ;
        }
    }

    #pragma omp flush
    return (info) ;
}

//------------------------------------------------------------------------------
// GrB_Global_get_INT32
//------------------------------------------------------------------------------

GrB_Info GrB_Global_get_INT32
(
    GrB_Global g,
    int32_t * value,
    int field
)
{ 

    //--------------------------------------------------------------------------
    // check inputs
    //--------------------------------------------------------------------------

    GB_CHECK_INIT ;
    GB_RETURN_IF_NULL_OR_FAULTY (g) ;
    GB_RETURN_IF_NULL (value) ;

    //--------------------------------------------------------------------------
    // get the field
    //--------------------------------------------------------------------------

    GrB_Info info = GrB_NO_VALUE ;

    #pragma omp critical (GB_global_get_set)
    {
        info = GB_global_enum_get (value, field) ;
    }

    return (info) ;
}

//------------------------------------------------------------------------------
// GrB_Global_get_SIZE
//------------------------------------------------------------------------------

GrB_Info GrB_Global_get_SIZE
(
    GrB_Global g,
    size_t * value,
    int field
)
{ 

    //--------------------------------------------------------------------------
    // check inputs
    //--------------------------------------------------------------------------

    GB_CHECK_INIT ;
    GB_RETURN_IF_NULL_OR_FAULTY (g) ;
    GB_RETURN_IF_NULL (value) ;
    (*value) = 0 ;

    //--------------------------------------------------------------------------
    // get the size of the field
    //--------------------------------------------------------------------------

    const char *s ;
    GrB_Info info = GrB_NO_VALUE ;

    #pragma omp critical (GB_global_get_set)
    {
        info = GB_global_string_get (&s, field) ;
        if (info == GrB_SUCCESS)
        { 
            (*value) = GB_STRLEN (s) + 1 ;
        }
        else
        { 
            switch ((int) field)
            {

                case GxB_BITMAP_SWITCH : 

                    (*value) = sizeof (double) * GxB_NBITMAP_SWITCH ;
                    info = GrB_SUCCESS ;
                    break ;

                case GxB_COMPILER_VERSION : 

                    (*value) = sizeof (int32_t) * 3 ;
                    info = GrB_SUCCESS ;
                    break ;

                case GxB_MALLOC_FUNCTION : 
                case GxB_CALLOC_FUNCTION : 
                case GxB_REALLOC_FUNCTION : 
                case GxB_FREE_FUNCTION : 

                    (*value) = sizeof (void *) ;
                    info = GrB_SUCCESS ;
                    break ;

                default : 

                    info = GrB_INVALID_VALUE ;
            }
        }
    }

    #pragma omp flush
    return (info) ;
}

//------------------------------------------------------------------------------
// GrB_Global_get_VOID
//------------------------------------------------------------------------------

GrB_Info GrB_Global_get_VOID
(
    GrB_Global g,
    void * value,
    int field
)
{

    //--------------------------------------------------------------------------
    // check inputs
    //--------------------------------------------------------------------------

    GB_CHECK_INIT ;
    GB_RETURN_IF_NULL_OR_FAULTY (g) ;
    GB_RETURN_IF_NULL (value) ;

    //--------------------------------------------------------------------------
    // get the field
    //--------------------------------------------------------------------------

    GrB_Info info = GrB_NO_VALUE ;

    #pragma omp critical (GB_global_get_set)
    {
        switch ((int) field)
        {

            case GxB_BITMAP_SWITCH : 

                {
                    double *dvalue = (double *) value ;
                    for (int k = 0 ; k < GxB_NBITMAP_SWITCH ; k++)
                    {
                        dvalue [k] = (double) GB_Global_bitmap_switch_get (k) ;
                    }
                }
                info = GrB_SUCCESS ;
                break ;

            case GxB_COMPILER_VERSION : 

                {
                    int32_t *ivalue = (int32_t *) value ;
                    ivalue [0] = GB_COMPILER_MAJOR ;
                    ivalue [1] = GB_COMPILER_MINOR ;
                    ivalue [2] = GB_COMPILER_SUB ;
                }
                info = GrB_SUCCESS ;
                break ;

            case GxB_MALLOC_FUNCTION : 
                {
                    void **func = (void **) value ;
                    (*func) = GB_Global_malloc_function_get ( ) ;
                }
                info = GrB_SUCCESS ;
                break ;

            case GxB_CALLOC_FUNCTION : 
                {
                    void **func = (void **) value ;
                    (*func) = GB_Global_calloc_function_get ( ) ;
                }
                info = GrB_SUCCESS ;
                break ;

            case GxB_REALLOC_FUNCTION : 
                {
                    void **func = (void **) value ;
                    (*func) = GB_Global_realloc_function_get ( ) ;
                }
                info = GrB_SUCCESS ;
                break ;

            case GxB_FREE_FUNCTION : 
                {
                    void **func = (void **) value ;
                    (*func) = GB_Global_free_function_get ( ) ;
                }
                info = GrB_SUCCESS ;
                break ;

            default : 

                info = GrB_INVALID_VALUE ;
        }
    }

    #pragma omp flush
    return (info) ;
}