MemoryHandle.h

/* Copyright (c) 2016 Baidu, Inc. All Rights Reserve.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License. */


#pragma once

#include <memory>
#include "PoolAllocator.h"

namespace paddle {

class MemoryHandle {
protected:
  explicit MemoryHandle(size_t size);
  virtual ~MemoryHandle() {}

public:
  void* getBuf() const { return buf_; }
  size_t getSize() const { return size_; }
  size_t getAllocSize() const { return allocSize_; }

protected:
  PoolAllocator* allocator_;
  size_t size_;         // the requested size
  size_t allocSize_;    // the allocated size
  int deviceId_;        // the device id of memory if gpu memory
  void* buf_;
};

/**
 * Wrapper class for raw gpu memory handle.
 *
 * The raw handle will be released at destructor
 */
class GpuMemoryHandle : public MemoryHandle {
public:
  explicit GpuMemoryHandle(size_t size);
  virtual ~GpuMemoryHandle();
};

/**
 * Wrapper class for raw cpu memory handle.
 *
 * The raw handle will be released at destructor
 */
class CpuMemoryHandle : public MemoryHandle {
public:
  explicit CpuMemoryHandle(size_t size);
  virtual ~CpuMemoryHandle();
};

typedef std::shared_ptr<MemoryHandle> MemoryHandlePtr;
typedef std::shared_ptr<CpuMemoryHandle> CpuMemHandlePtr;
typedef std::shared_ptr<GpuMemoryHandle> GpuMemHandlePtr;
}  // namespace paddle