tensor.h 5.5 KB
Newer Older
Y
Yi Wang 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/* Copyright (c) 2016 PaddlePaddle Authors. 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. */

Y
Yi Wang 已提交
15 16
#pragma once

17
#include <cstdint>
18
#include <cstring>
F
fengjiayi 已提交
19
#include <memory>
Y
Yu Yang 已提交
20
#include <typeindex>
21 22
#include <vector>

F
fengjiayi 已提交
23 24
#include "paddle/framework/ddim.h"
#include "paddle/memory/memory.h"
L
liaogang 已提交
25
#include "paddle/platform/device_context.h"
L
liaogang 已提交
26
#include "paddle/platform/enforce.h"
F
fengjiayi 已提交
27
#include "paddle/platform/place.h"
Q
init  
qijun 已提交
28
#include "unsupported/Eigen/CXX11/Tensor"
F
fengjiayi 已提交
29

Y
Yi Wang 已提交
30
namespace paddle {
L
liaogang 已提交
31

32
namespace framework {
Y
Yi Wang 已提交
33 34

class Tensor {
L
liaogang 已提交
35
 public:
36
  template <typename T, size_t D, int MajorType, typename IndexType>
Y
Yi Wang 已提交
37 38
  friend struct EigenTensor;

39
  template <typename T, int MajorType, typename IndexType>
F
WIP  
fengjiayi 已提交
40 41
  friend struct EigenMatrix;

42
  template <typename T, int MajorType, typename IndexType>
Y
Yi Wang 已提交
43 44
  friend struct EigenVector;

Y
Yi Wang 已提交
45
 public:
46
  Tensor() : offset_(0) {}
47

L
liaogang 已提交
48
  /*! Return a pointer to mutable memory block. */
Y
Yi Wang 已提交
49
  template <typename T>
L
liaogang 已提交
50
  inline T* data();
Y
Yi Wang 已提交
51

L
liaogang 已提交
52
  /*! Return a pointer to constant memory block. */
Q
qijun 已提交
53
  template <typename T>
L
liaogang 已提交
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
  inline const T* data() const;

  /**
   * @brief   Return a pointer to mutable memory block.
   * @note    If not exist, then allocation.
   */
  template <typename T>
  inline T* mutable_data(platform::Place place);

  /**
   * @brief     Return a pointer to mutable memory block.
   *
   * @param[in] dims    The dimensions of the memory block.
   * @param[in] place   The place of the memory block.
   *
   * @note      If not exist, then allocation.
   */
  template <typename T>
  inline T* mutable_data(DDim dims, platform::Place place);
Y
Yi Wang 已提交
73

L
liaogang 已提交
74 75 76
  /*! Return the dimensions of the memory block. */
  inline const DDim& dims() const;

77 78 79
  /*! Return the numel of the memory block. */
  inline int64_t numel() const;

L
liaogang 已提交
80
  /*! Resize the dimensions of the memory block. */
S
Superjom 已提交
81
  inline Tensor& Resize(const DDim& dims);
L
liaogang 已提交
82 83 84

  /*! The internal of two tensors share the same memory block. */
  template <typename T>
S
Superjom 已提交
85
  inline Tensor& ShareDataWith(const Tensor& src);
L
liaogang 已提交
86 87 88 89 90 91 92 93 94

  /**
   * @brief   Copy the content of external tensor to a new place.
   *
   * @param[in] src   The external tensor.
   * @param[in] ctx   The device context contains place where to store.
   *
   * @note    CopyFrom supports CPU <-> GPU, GPU <-> GPU.
   */
F
fengjiayi 已提交
95
  template <typename T>
Q
qijun 已提交
96
  inline void CopyFrom(const Tensor& src, const platform::Place& dst_place);
97

98 99 100 101 102 103 104 105 106 107 108 109 110
  /**
   * @brief   Copy the content of an external vector to a tensor.
   *
   * @param[in] src   The external vector.
   * @param[in] ctx   The device context contains place where to store.
   *
   * * @note    CopyFromVector assumes that the tensor has been resized
   *            before invoking.
   */
  template <typename T>
  inline void CopyFromVector(const std::vector<T>& src,
                             const platform::Place& dst_place);

L
liaogang 已提交
111 112 113 114 115 116
  /**
   * @brief   Return the slice of the tensor.
   *
   * @param[in] begin_idx   The begin index of the slice.
   * @param[in] end_idx     The end index of the slice.
   */
F
fengjiayi 已提交
117
  template <typename T>
L
liaogang 已提交
118
  inline Tensor Slice(const int& begin_idx, const int& end_idx) const;
119

Y
Yu Yang 已提交
120 121 122 123
  platform::Place place() const {
    PADDLE_ENFORCE_NOT_NULL(holder_, "Tensor get place() must contains holder");
    return holder_->place();
  }
Q
qijun 已提交
124

Y
Yu Yang 已提交
125 126
  std::type_index type() const { return holder_->type(); }

Y
Yi Wang 已提交
127
 private:
L
liaogang 已提交
128 129 130 131 132 133 134 135
  template <typename T>
  inline void check_memory_size() const;

 private:
  /**
   * @note    Placeholder hides type T, so it doesn't appear as a template
   *          parameter of Variable.
   */
Y
Yi Wang 已提交
136 137
  struct Placeholder {
    virtual ~Placeholder() {}
F
fengjiayi 已提交
138 139
    virtual void* ptr() const = 0;
    virtual size_t size() const = 0;
Y
Yu Yang 已提交
140
    virtual std::type_index type() const = 0;
L
liaogang 已提交
141
    virtual platform::Place place() const = 0;
Y
Yi Wang 已提交
142 143
  };

L
liaogang 已提交
144
  template <typename T, typename Place>
Y
Yi Wang 已提交
145
  struct PlaceholderImpl : public Placeholder {
L
liaogang 已提交
146
    PlaceholderImpl(Place place, size_t size)
L
liaogang 已提交
147 148 149 150
        : ptr_(static_cast<T*>(memory::Alloc(place, size)),
               memory::PODDeleter<T, Place>(place)),
          place_(place),
          size_(size) {
Y
Yan Chunwei 已提交
151 152
      PADDLE_ENFORCE_NOT_NULL(ptr_, "Insufficient %s memory to allocation.",
                              (is_cpu_place(place_) ? "CPU" : "GPU"));
L
liaogang 已提交
153
    }
Y
Yi Wang 已提交
154

F
fengjiayi 已提交
155
    virtual size_t size() const { return size_; }
L
liaogang 已提交
156 157
    virtual platform::Place place() const { return place_; }
    virtual void* ptr() const { return static_cast<void*>(ptr_.get()); }
Y
Yu Yang 已提交
158
    virtual std::type_index type() const { return std::type_index(typeid(T)); }
Y
Yi Wang 已提交
159

L
liaogang 已提交
160
    /*! the pointer of memory block. */
L
liaogang 已提交
161
    std::unique_ptr<T, memory::PODDeleter<T, Place>> ptr_;
L
liaogang 已提交
162 163 164 165 166 167

    /*! the place of memory block. */
    platform::Place place_;

    /*! the size of memory block. */
    size_t size_;
Y
Yi Wang 已提交
168 169
  };

L
liaogang 已提交
170 171 172 173
  /*! holds the memory block if allocated. */
  std::shared_ptr<Placeholder> holder_;

  /*! points to dimensions of memory block. */
174
  DDim dims_;
L
liaogang 已提交
175 176 177 178 179 180 181 182

  /**
   * @brief   A PlaceHolder may be shared by more than one tensor.
   *
   * @note    Some of them may be slices of the others. So the offset_
   *          is introduced here to indicate the byte offset between
   *          PlaceHolder::ptr_ and where the tensor data really begins.
   */
F
fengjiayi 已提交
183
  size_t offset_;
184
};
Y
Yi Wang 已提交
185 186 187

}  // namespace framework
}  // namespace paddle
L
liaogang 已提交
188

Y
Yi Wang 已提交
189
#include "paddle/framework/tensor_impl.h"