cl_buffer.hpp

Go to the documentation of this file.

//============================================================================
// vSMC/include/vsmc/opencl/cl_buffer.hpp
//----------------------------------------------------------------------------
//                         vSMC: Scalable Monte Carlo
//----------------------------------------------------------------------------
// Copyright (c) 2013,2014, Yan Zhou
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//   Redistributions of source code must retain the above copyright notice,
//   this list of conditions and the following disclaimer.
//
//   Redistributions in binary form must reproduce the above copyright notice,
//   this list of conditions and the following disclaimer in the documentation
//   and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS AS IS
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//============================================================================

#ifndef VSMC_OPENCL_CL_BUFFER_HPP
#define VSMC_OPENCL_CL_BUFFER_HPP

#include <vsmc/internal/common.hpp>
#include <vsmc/opencl/cl_manager.hpp>
#include <vsmc/opencl/internal/cl_wrapper.hpp>

namespace vsmc {

template <typename T, typename ID = CLDefault>
class CLBuffer
{
    public :

    typedef T value_type;
    typedef std::size_t size_type;
    typedef CLManager<ID> manager_type;

    CLBuffer () :
        size_(0), flag_(CL_MEM_READ_WRITE), host_ptr_(VSMC_NULLPTR) {}

    CLBuffer (size_type N, ::cl_mem_flags flag = CL_MEM_READ_WRITE,
            void *host_ptr = VSMC_NULLPTR) :
        size_(N), flag_(flag), host_ptr_(host_ptr),
        data_(manager().template
                create_buffer<value_type>(size_, flag_, host_ptr_)) {}

    CLBuffer (const CLBuffer<T, ID> &other) :
        size_(other.size_), flag_(other.flag_), host_ptr_(other.host_ptr_),
        data_(manager().template
                create_buffer<value_type>(size_, flag_, host_ptr_))
    {
            if (size_ != 0
#if VSMC_OPENCL_VERSION >= 120
                    && (flag_ & CL_MEM_HOST_WRITE_ONLY) != 0
                    && (flag_ & CL_MEM_HOST_READ_ONLY) != 0
#endif
                    ) {
                manager().template copy_buffer<value_type>(
                        other.data_, data_, size_);
            }
    }

    CLBuffer<T, ID> &operator= (const CLBuffer<T, ID> &other)
    {
        if (this != &other) {
            resize(other.size_, other.flag_, other.host_ptr_);
            if (size_ != 0
#if VSMC_OPENCL_VERSION >= 120
                    && (flag_ & CL_MEM_HOST_WRITE_ONLY) != 0
                    && (flag_ & CL_MEM_HOST_READ_ONLY) != 0
#endif
                    ) {
                manager().template copy_buffer<value_type>(
                        other.data_, data_, size_);
            }
        }

        return *this;
    }

#if VSMC_HAS_CXX11_RVALUE_REFERENCES
    CLBuffer (CLBuffer<T, ID> &&other) :
        size_(other.size_), flag_(other.flag_), host_ptr_(other.host_ptr_),
        data_(cxx11::move(other.data_))
    {
        other.size_ = 0;
        other.flag_ = CL_MEM_READ_WRITE;
        other.host_ptr_ = VSMC_NULLPTR;
        other.data_ = ::cl::Buffer();
    }

    CLBuffer<T, ID> &operator= (CLBuffer<T, ID> &&other)
    {
        using std::swap;

        if (this != &other) {
            swap(size_, other.size_);
            swap(flag_, other.flag_);
            swap(host_ptr_, other.host_ptr_);
            swap(data_, other.data_);
        }

        return *this;
    }
#endif

    ~CLBuffer () {}

    static manager_type &manager () {return manager_type::instance();}

    size_type size () const {return size_;}

    ::cl_mem_flags flag () const {return flag_;}

    void *host_ptr () const {return host_ptr_;}

    const ::cl::Buffer &data () const {return data_;}

    void resize (size_type N)
    {
        if (N == size_)
            return;

        size_ = N;
        data_ = manager().template create_buffer<value_type>(
                size_, flag_, host_ptr_);
    }

    void resize (size_type N, ::cl_mem_flags flag)
    {
        if (N == size_ && flag == flag_)
            return;

        size_ = N;
        flag_ = flag;
        data_ = manager().template create_buffer<value_type>(
                size_, flag_, host_ptr_);
    }

    void resize (size_type N, ::cl_mem_flags flag, void *host_ptr)
    {
        if (N == size_ && flag == flag_ && host_ptr == host_ptr_)
            return;

        size_ = N;
        flag_ = flag;
        host_ptr_ = host_ptr;
        data_ = manager().template create_buffer<value_type>(
                size_, flag_, host_ptr_);
    }

    private :

    size_type size_;
    ::cl_mem_flags flag_;
    void *host_ptr_;
    ::cl::Buffer data_;
}; // class CLBuffer

} // namespace vsmc

#endif // VSMC_OPENCL_CL_BUFFER_HPP