aclrtAllocatorSetAllocAdviseFuncToDesc

Applicability

Product	Supported
Atlas A3 training products/Atlas A3 inference products	√
Atlas A2 training products/Atlas A2 inference products	√
Atlas 200I/500 A2 inference products	√
Atlas inference products	√
Atlas training products	√

Description

Sets the callback function for allocating memory blocks based on recommended addresses when the user-provided allocator is used. This function is generally used in memory overcommitment scenario.

Prototype

aclError aclrtAllocatorSetAllocAdviseFuncToDesc(aclrtAllocatorDesc allocatorDesc, aclrtAllocatorAllocAdviseFunc func)

Parameters

Parameter	Input/Output	Description
allocatorDesc	Input	Pointer to the Allocator descriptor. Call the aclrtAllocatorCreateDesc API to set the Allocator description in advance.
func	Input	Callback function for allocating memory blocks based on the recommended addresses. Callback function definition: typedef void (aclrtAllocatorAllocAdviseFunc)(aclrtAllocator allocator, size_t size, aclrtAllocatorAddr addr);

Parameter

Input/Output

Description

allocatorDesc

Input

Pointer to the Allocator descriptor.

Call the aclrtAllocatorCreateDesc API to set the Allocator description in advance.

func

Input

Callback function for allocating memory blocks based on the recommended addresses.

Callback function definition:

typedef void *(*aclrtAllocatorAllocAdviseFunc)(aclrtAllocator allocator, size_t size, aclrtAllocatorAddr addr);

Returns

0 on success; else, failure. For details, see aclError.

Parent topic: aclrtAllocatorDesc