arm_compute/runtime/CL/CLBufferAllocator.h

/*
 * Copyright (c) 2017-2019 ARM Limited.
 *
 * SPDX-License-Identifier: MIT
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
#ifndef ARM_COMPUTE_CLBUFFERALLOCATOR_H
#define ARM_COMPUTE_CLBUFFERALLOCATOR_H

#include "arm_compute/runtime/IAllocator.h"

#include <cstddef>

namespace arm_compute
{
class CLCoreRuntimeContext;
/** Default OpenCL cl buffer allocator implementation */
class CLBufferAllocator final : public IAllocator
{
public:
    /** Default constructor
     *
     * @param[in] ctx A runtime context.
     */
    CLBufferAllocator(CLCoreRuntimeContext *ctx = nullptr);

    /** Default copy constructor */
    CLBufferAllocator(const CLBufferAllocator &) = default;
    /** Default copy assignment operator */
    CLBufferAllocator &operator=(const CLBufferAllocator &) = default;

    // Inherited methods overridden:
    void *allocate(size_t size, size_t alignment) override;
    void free(void *ptr) override;
    std::unique_ptr<IMemoryRegion> make_region(size_t size, size_t alignment) override;

private:
    CLCoreRuntimeContext *_ctx;
};
} // arm_compute
#endif /*ARM_COMPUTE_CLBUFFERALLOCATOR_H */