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
|
//------------------------------------------------------------------------------
// GxB_init: initialize GraphBLAS and declare malloc/calloc/realloc/free to use
//------------------------------------------------------------------------------
// SuiteSparse:GraphBLAS, Timothy A. Davis, (c) 2017-2022, All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
//------------------------------------------------------------------------------
// GrB_init (or GxB_init) must called before any other GraphBLAS operation.
// GrB_finalize must be called as the last GraphBLAS operation. GxB_init is
// identical to GrB_init, except that it allows the user application to define
// the malloc/calloc/realloc/free functions that SuiteSparse:GraphBLAS will
// use. The functions cannot be modified once GraphBLAS starts.
// The calloc and realloc function pointers are optional and can be NULL. If
// calloc is NULL, it is not used, and malloc/memset are used instead. If
// realloc is NULL, it is not used, and malloc/memcpy/free are used instead.
// Examples:
//
// To use GraphBLAS with the ANSI C11 functions (or to another library
// linked in that replaces them):
//
// // either use:
// GrB_init (mode) ;
// // or use this (but not both):
// GxB_init (mode, malloc, calloc, realloc, free) ;
//
// To use GraphBLAS from within a mexFunction:
//
// #include "mex.h"
// GxB_init (mode, mxMalloc, mxCalloc, mxRealloc, mxFree) ;
//
// To use the C interface to the Intel TBB scalable allocators:
//
// #include "tbb/scalable_allocator.h"
// GxB_init (mode, scalable_malloc, scalable_calloc, scalable_realloc,
// scalable_free) ;
//
// To use CUDA and its RMM memory manager:
//
// GxB_init (mode, rmm_malloc, rmm_calloc, rmm_realloc, rmm_free) ;
//
// where mode is GxB_BLOCKING_GPU or GxB_NONBLOCKING_GPU
//
// To use user-provided malloc and free functions, but not calloc/realloc:
//
// GxB_init (mode, my_malloc, NULL, NULL, my_free) ;
#include "GB.h"
GrB_Info GxB_init // start up GraphBLAS and also define malloc, etc
(
GrB_Mode mode, // blocking or non-blocking mode, GPU or not
// pointers to memory management functions
void * (* user_malloc_function ) (size_t), // required
void * (* user_calloc_function ) (size_t, size_t), // no longer used
void * (* user_realloc_function ) (void *, size_t), // optional, can be NULL
void (* user_free_function ) (void *) // required
)
{
//--------------------------------------------------------------------------
// check inputs
//--------------------------------------------------------------------------
GB_CONTEXT ("GxB_init (mode, malloc, calloc, realloc, free)") ;
if (user_malloc_function == NULL || user_free_function == NULL)
{
// only malloc and free are required. calloc and/or realloc may be
// NULL
return (GrB_NULL_POINTER) ;
}
//--------------------------------------------------------------------------
// initialize GraphBLAS
//--------------------------------------------------------------------------
return (GB_init
(mode, // blocking or non-blocking mode
user_malloc_function, // user-defined malloc, required
user_realloc_function, // user-defined realloc, may be NULL
user_free_function, // user-defined free, required
Context)) ;
}
|
