org.nd4j.jita.memory.MemoryProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nd4j-cuda-9.1 Show documentation

The newest version!

package org.nd4j.jita.memory;

import org.nd4j.jita.allocator.enums.AllocationStatus;
import org.nd4j.jita.allocator.impl.AllocationPoint;
import org.nd4j.jita.allocator.impl.AllocationShape;
import org.nd4j.jita.allocator.pointers.PointersPair;

/**
 * This interface describes 2 basic methods to work with memory: malloc and free.
 *
 * @author [email protected]
 */
public interface MemoryProvider {
    /**
     * This method provides PointersPair to memory chunk specified by AllocationShape
     *
     * @param shape shape of desired memory chunk
     * @param point target AllocationPoint structure
     * @param location either HOST or DEVICE
     * @return
     */
    PointersPair malloc(AllocationShape shape, AllocationPoint point, AllocationStatus location);

    /**
     * This method frees specific chunk of memory, described by AllocationPoint passed in
     *
     * @param point
     */
    void free(AllocationPoint point);

    /**
     * This method checks specified device for specified amount of memory
     *
     * @param deviceId
     * @param requiredMemory
     * @return
     */
    boolean pingDeviceForFreeMemory(Integer deviceId, long requiredMemory);


    void purgeCache();
}