memory.h (2022-02-24 14:07:56 -0500, (build 8c2561559))
Go to the documentation of this file.
1/*******************************************************
2 * Copyright (c) 2019, ArrayFire
3 * All rights reserved.
4 *
5 * This file is distributed under 3-clause BSD license.
6 * The complete license agreement can be obtained at:
7 * http://arrayfire.com/licenses/BSD-3-Clause
8 ********************************************************/
9
10#pragma once
11
12#include <af/defines.h>
13#include <af/event.h>
14
15#include <stddef.h>
16
17#if AF_API_VERSION >= 37
18
22typedef void* af_memory_manager;
23
24#ifdef __cplusplus
25extern "C" {
26#endif // __cplusplus
27
37
47
67 void** ptr,
68 /* bool */ int user_lock,
69 const unsigned ndims, dim_t* dims,
70 const unsigned element_size);
71
83 size_t* size, void* ptr);
84
96 void* ptr, /* bool */ int user_unlock);
97
110 af_memory_manager handle);
111
128 char* buffer, int id);
129
140 void* ptr);
141
152 void* ptr);
153
165 int* out, void* ptr);
166
177 af_memory_manager handle, float* pressure);
178
204 af_memory_manager handle, int* out, size_t size);
205
216 af_memory_manager handle, int id);
217
228 af_memory_manager handle, int id);
229
240
252
266
280
296
312
323 void** payload);
324
339 void* payload);
340
352
364
376
388
400
413
425
437
449
461
474
487 af_memory_manager handle,
489
502
515
517
528 int* id);
529
543 void** ptr, size_t size);
544
555
565 size_t* size, int id);
566
577 af_memory_manager handle, float* value);
578
594 af_memory_manager handle, float value);
595
596#ifdef __cplusplus
597}
598#endif // __cplusplus
599#endif // AF_API_VERSION >= 37
long long dim_t
Definition: defines.h:56
af_err
Definition: defines.h:71
#define AFAPI
Definition: defines.h:38
af_err(* af_memory_manager_is_user_locked_fn)(af_memory_manager handle, int *out, void *ptr)
Queries if a buffer is user locked.
Definition: memory.h:164
void * af_memory_manager
Definition: memory.h:22
af_err(* af_memory_manager_unlock_fn)(af_memory_manager handle, void *ptr, int user_unlock)
Unlocks memory from use.
Definition: memory.h:95
af_err(* af_memory_manager_print_info_fn)(af_memory_manager handle, char *buffer, int id)
Populates a character array with human readable information about the current state of the memory man...
Definition: memory.h:127
void(* af_memory_manager_remove_memory_management_fn)(af_memory_manager handle, int id)
Removes a device from the memory manager (OpenCL only)
Definition: memory.h:227
af_err(* af_memory_manager_get_memory_pressure_fn)(af_memory_manager handle, float *pressure)
Gets memory pressure for a memory manager.
Definition: memory.h:176
af_err(* af_memory_manager_allocated_fn)(af_memory_manager handle, size_t *size, void *ptr)
Checks the amount of allocated memory for a pointer.
Definition: memory.h:82
void(* af_memory_manager_add_memory_management_fn)(af_memory_manager handle, int id)
Adds a new device to the memory manager (OpenCL only)
Definition: memory.h:215
af_err(* af_memory_manager_jit_tree_exceeds_memory_pressure_fn)(af_memory_manager handle, int *out, size_t size)
Called to query if additions to the JIT tree would exert too much memory pressure.
Definition: memory.h:203
af_err(* af_memory_manager_user_lock_fn)(af_memory_manager handle, void *ptr)
Called to lock a buffer as user-owned memory.
Definition: memory.h:139
af_err(* af_memory_manager_shutdown_fn)(af_memory_manager handle)
Called after a memory manager is unset and becomes unused.
Definition: memory.h:46
af_err(* af_memory_manager_signal_memory_cleanup_fn)(af_memory_manager handle)
Called to signal the memory manager should free memory if possible.
Definition: memory.h:109
af_err(* af_memory_manager_initialize_fn)(af_memory_manager handle)
Called after a memory manager is set and becomes active.
Definition: memory.h:36
af_err(* af_memory_manager_alloc_fn)(af_memory_manager handle, void **ptr, int user_lock, const unsigned ndims, dim_t *dims, const unsigned element_size)
Function pointer that will be called by ArrayFire to allocate memory.
Definition: memory.h:66
af_err(* af_memory_manager_user_unlock_fn)(af_memory_manager handle, void *ptr)
Called to unlock a buffer from user-owned memory.
Definition: memory.h:151
AFAPI af_err af_memory_manager_set_initialize_fn(af_memory_manager handle, af_memory_manager_initialize_fn fn)
Sets an af_memory_manager_initialize_fn for a memory manager.
AFAPI af_err af_memory_manager_set_jit_tree_exceeds_memory_pressure_fn(af_memory_manager handle, af_memory_manager_jit_tree_exceeds_memory_pressure_fn fn)
Sets an af_memory_manager_jit_tree_exceeds_memory_pressure_fn for a memory manager.
AFAPI af_err af_memory_manager_set_user_lock_fn(af_memory_manager handle, af_memory_manager_user_lock_fn fn)
Sets an af_memory_manager_user_lock_fn for a memory manager.
AFAPI af_err af_create_memory_manager(af_memory_manager *out)
Creates an af_memory_manager handle.
AFAPI af_err af_memory_manager_get_payload(af_memory_manager handle, void **payload)
Gets the payload ptr from an af_memory_manager.
AFAPI af_err af_memory_manager_set_signal_memory_cleanup_fn(af_memory_manager handle, af_memory_manager_signal_memory_cleanup_fn fn)
Sets an af_memory_manager_signal_memory_cleanup_fn for a memory manager.
AFAPI af_err af_memory_manager_set_alloc_fn(af_memory_manager handle, af_memory_manager_alloc_fn fn)
Sets an af_memory_manager_alloc_fn for a memory manager.
AFAPI af_err af_memory_manager_set_payload(af_memory_manager handle, void *payload)
Sets the payload ptr from an af_memory_manager.
AFAPI af_err af_memory_manager_set_add_memory_management_fn(af_memory_manager handle, af_memory_manager_add_memory_management_fn fn)
Sets an af_memory_manager_add_memory_management_fn for a memory manager.
AFAPI af_err af_memory_manager_set_get_memory_pressure_fn(af_memory_manager handle, af_memory_manager_get_memory_pressure_fn fn)
Sets an af_memory_manager_get_memory_pressure_fn for a memory manager.
AFAPI af_err af_set_memory_manager(af_memory_manager handle)
Sets an af_memory_manager to be the default memory manager for non-pinned memory allocations in Array...
AFAPI af_err af_memory_manager_set_user_unlock_fn(af_memory_manager handle, af_memory_manager_user_unlock_fn fn)
Sets an af_memory_manager_user_unlock_fn for a memory manager.
AFAPI af_err af_memory_manager_set_is_user_locked_fn(af_memory_manager handle, af_memory_manager_is_user_locked_fn fn)
Sets an af_memory_manager_is_user_locked_fn for a memory manager.
AFAPI af_err af_memory_manager_set_shutdown_fn(af_memory_manager handle, af_memory_manager_shutdown_fn fn)
Sets an af_memory_manager_shutdown_fn for a memory manager.
AFAPI af_err af_unset_memory_manager_pinned()
Reset the pinned memory manager being used in ArrayFire to the default memory manager,...
AFAPI af_err af_set_memory_manager_pinned(af_memory_manager handle)
Sets an af_memory_manager to be the default memory manager for pinned memory allocations in ArrayFire...
AFAPI af_err af_release_memory_manager(af_memory_manager handle)
Destroys an af_memory_manager handle.
AFAPI af_err af_memory_manager_set_print_info_fn(af_memory_manager handle, af_memory_manager_print_info_fn fn)
Sets an af_memory_manager_print_info_fn for a memory manager.
AFAPI af_err af_memory_manager_set_unlock_fn(af_memory_manager handle, af_memory_manager_unlock_fn fn)
Sets an af_memory_manager_unlock_fn for a memory manager.
AFAPI af_err af_memory_manager_set_remove_memory_management_fn(af_memory_manager handle, af_memory_manager_remove_memory_management_fn fn)
Sets an af_memory_manager_remove_memory_management_fn for a memory manager.
AFAPI af_err af_unset_memory_manager()
Reset the memory manager being used in ArrayFire to the default memory manager, shutting down the exi...
AFAPI af_err af_memory_manager_set_allocated_fn(af_memory_manager handle, af_memory_manager_allocated_fn fn)
Sets an af_memory_manager_allocated_fn for a memory manager.
AFAPI af_err af_memory_manager_native_alloc(af_memory_manager handle, void **ptr, size_t size)
Allocates memory with a native memory function for the active backend.
AFAPI af_err af_memory_manager_get_max_memory_size(af_memory_manager handle, size_t *size, int id)
Gets the maximum memory size for a managed device.
AFAPI af_err af_memory_manager_get_memory_pressure_threshold(af_memory_manager handle, float *value)
Gets the memory pressure threshold for a memory manager.
AFAPI af_err af_memory_manager_get_active_device_id(af_memory_manager handle, int *id)
Gets the id of the currently-active device.
AFAPI af_err af_memory_manager_native_free(af_memory_manager handle, void *ptr)
Frees a pointer with a native memory function for the active backend.
AFAPI af_err af_memory_manager_set_memory_pressure_threshold(af_memory_manager handle, float value)
Sets the memory pressure threshold for a memory manager.