memory.h

Go to the documentation of this file.

/*******************************************************
 * Copyright (c) 2019, ArrayFire
 * All rights reserved.
 *
 * This file is distributed under 3-clause BSD license.
 * The complete license agreement can be obtained at:
 * http://arrayfire.com/licenses/BSD-3-Clause
 ********************************************************/

#pragma once

#include <af/defines.h>
#include <af/event.h>

#include <stddef.h>

#if AF_API_VERSION >= 37

typedef void* af_memory_manager;

#ifdef __cplusplus
extern "C" {
#endif  // __cplusplus

typedef af_err (*af_memory_manager_initialize_fn)(af_memory_manager handle);

typedef af_err (*af_memory_manager_shutdown_fn)(af_memory_manager handle);

typedef af_err (*af_memory_manager_alloc_fn)(af_memory_manager handle,
                                             void** ptr,
                                             /* bool */ int user_lock,
                                             const unsigned ndims, dim_t* dims,
                                             const unsigned element_size);

typedef af_err (*af_memory_manager_allocated_fn)(af_memory_manager handle,
                                                 size_t* size, void* ptr);

typedef af_err (*af_memory_manager_unlock_fn)(af_memory_manager handle,
                                              void* ptr, /* bool */ int user_unlock);

typedef af_err (*af_memory_manager_signal_memory_cleanup_fn)(
    af_memory_manager handle);

typedef af_err (*af_memory_manager_print_info_fn)(af_memory_manager handle,
                                                  char* buffer, int id);

typedef af_err (*af_memory_manager_user_lock_fn)(af_memory_manager handle,
                                                 void* ptr);

typedef af_err (*af_memory_manager_user_unlock_fn)(af_memory_manager handle,
                                                   void* ptr);

typedef af_err (*af_memory_manager_is_user_locked_fn)(af_memory_manager handle,
                                                      int* out, void* ptr);

typedef af_err (*af_memory_manager_get_memory_pressure_fn)(
    af_memory_manager handle, float* pressure);

typedef af_err (*af_memory_manager_jit_tree_exceeds_memory_pressure_fn)(
    af_memory_manager handle, int* out, size_t size);

typedef void (*af_memory_manager_add_memory_management_fn)(
    af_memory_manager handle, int id);

typedef void (*af_memory_manager_remove_memory_management_fn)(
    af_memory_manager handle, int id);

AFAPI af_err af_create_memory_manager(af_memory_manager* out);

AFAPI af_err af_release_memory_manager(af_memory_manager handle);

AFAPI af_err af_set_memory_manager(af_memory_manager handle);

AFAPI af_err af_set_memory_manager_pinned(af_memory_manager handle);

AFAPI af_err af_unset_memory_manager();

AFAPI af_err af_unset_memory_manager_pinned();

AFAPI af_err af_memory_manager_get_payload(af_memory_manager handle,
                                           void** payload);

AFAPI af_err af_memory_manager_set_payload(af_memory_manager handle,
                                           void* payload);

AFAPI af_err af_memory_manager_set_initialize_fn(
    af_memory_manager handle, af_memory_manager_initialize_fn fn);

AFAPI af_err af_memory_manager_set_shutdown_fn(
    af_memory_manager handle, af_memory_manager_shutdown_fn fn);

AFAPI af_err af_memory_manager_set_alloc_fn(af_memory_manager handle,
                                            af_memory_manager_alloc_fn fn);

AFAPI af_err af_memory_manager_set_allocated_fn(
    af_memory_manager handle, af_memory_manager_allocated_fn fn);

AFAPI af_err af_memory_manager_set_unlock_fn(af_memory_manager handle,
                                             af_memory_manager_unlock_fn fn);

AFAPI af_err af_memory_manager_set_signal_memory_cleanup_fn(
    af_memory_manager handle, af_memory_manager_signal_memory_cleanup_fn fn);

AFAPI af_err af_memory_manager_set_print_info_fn(
    af_memory_manager handle, af_memory_manager_print_info_fn fn);

AFAPI af_err af_memory_manager_set_user_lock_fn(
    af_memory_manager handle, af_memory_manager_user_lock_fn fn);

AFAPI af_err af_memory_manager_set_user_unlock_fn(
    af_memory_manager handle, af_memory_manager_user_unlock_fn fn);

AFAPI af_err af_memory_manager_set_is_user_locked_fn(
    af_memory_manager handle, af_memory_manager_is_user_locked_fn fn);

AFAPI af_err af_memory_manager_set_get_memory_pressure_fn(
    af_memory_manager handle, af_memory_manager_get_memory_pressure_fn fn);

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);

AFAPI af_err af_memory_manager_set_add_memory_management_fn(
    af_memory_manager handle, af_memory_manager_add_memory_management_fn fn);

AFAPI af_err af_memory_manager_set_remove_memory_management_fn(
    af_memory_manager handle, af_memory_manager_remove_memory_management_fn fn);


AFAPI af_err af_memory_manager_get_active_device_id(af_memory_manager handle,
                                                    int* id);

AFAPI af_err af_memory_manager_native_alloc(af_memory_manager handle,
                                            void** ptr, size_t size);

AFAPI af_err af_memory_manager_native_free(af_memory_manager handle, void* ptr);

AFAPI af_err af_memory_manager_get_max_memory_size(af_memory_manager handle,
                                                   size_t* size, int id);

AFAPI af_err af_memory_manager_get_memory_pressure_threshold(
    af_memory_manager handle, float* value);

AFAPI af_err af_memory_manager_set_memory_pressure_threshold(
    af_memory_manager handle, float value);

#ifdef __cplusplus
}
#endif  // __cplusplus
#endif  // AF_API_VERSION >= 37