tensor.h 6.1 KB
Newer Older
1
/* Copyright (c) 2016 PaddlePaddle Authors. All Rights Reserved.
Y
Yi Wang 已提交
2 3 4 5 6 7 8 9 10 11 12 13 14

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

Y
Yu Yang 已提交
17
#include <paddle/fluid/framework/framework.pb.h>
18
#include <cstdint>
19
#include <cstring>
F
fengjiayi 已提交
20
#include <memory>
Y
Yu Yang 已提交
21
#include <typeindex>
22 23
#include <vector>

Y
Yi Wang 已提交
24 25 26 27 28 29
#include "paddle/fluid/framework/data_layout.h"
#include "paddle/fluid/framework/ddim.h"
#include "paddle/fluid/memory/memory.h"
#include "paddle/fluid/platform/device_context.h"
#include "paddle/fluid/platform/enforce.h"
#include "paddle/fluid/platform/place.h"
F
fengjiayi 已提交
30

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

33
namespace framework {
Y
Yi Wang 已提交
34

35 36
class LoDTensor;

Y
Yi Wang 已提交
37
class Tensor {
M
mozga-intel 已提交
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
#ifdef PADDLE_WITH_MKLDNN

 public:
  inline mkldnn::memory::format format() const { return format_; }

  inline void set_format(const mkldnn::memory::format format) {
    format_ = format;
  }

 protected:
  /**
   * @brief the detail format of memory block which have layout as kMKLDNN
   *
   * @note MKLDNN lib support various memory format like nchw, nhwc, nChw8C,
   *       nChw16c, etc. For a MKLDNN memory block, layout will be set as
   *       DataLayout::kMKLDNN meanwhile detail memory format will be kept in
   *       this field.
   */

  mkldnn::memory::format format_ = mkldnn::memory::format::format_undef;
#endif

L
liaogang 已提交
60
 public:
61
  template <typename T, size_t D, int MajorType, typename IndexType>
Y
Yi Wang 已提交
62 63
  friend struct EigenTensor;

64
  template <typename T, int MajorType, typename IndexType>
F
WIP  
fengjiayi 已提交
65 66
  friend struct EigenMatrix;

67
  template <typename T, int MajorType, typename IndexType>
Y
Yi Wang 已提交
68 69
  friend struct EigenVector;

Y
Yi Wang 已提交
70
 public:
Y
Yu Yang 已提交
71
  Tensor() : type_(proto::VarType::FP32), offset_(0) {}
D
dzhwinter 已提交
72

L
liaogang 已提交
73
  /*! Return a pointer to mutable memory block. */
Y
Yi Wang 已提交
74
  template <typename T>
75
  T* data();
Y
Yi Wang 已提交
76

L
liaogang 已提交
77
  /*! Return a pointer to constant memory block. */
Q
qijun 已提交
78
  template <typename T>
79
  const T* data() const;
L
liaogang 已提交
80

M
minqiyang 已提交
81
  inline bool IsInitialized() const;
Y
Yang Yang 已提交
82

L
liaogang 已提交
83 84 85 86 87
  /**
   * @brief   Return a pointer to mutable memory block.
   * @note    If not exist, then allocation.
   */
  template <typename T>
Y
Yu Yang 已提交
88 89 90
  T* mutable_data(platform::Place place,
                  memory::Allocator::Attr attr = memory::Allocator::kDefault,
                  size_t requested_size = 0);
L
liaogang 已提交
91

Y
Yu Yang 已提交
92
  void* mutable_data(platform::Place place, proto::VarType::Type type,
Y
Yu Yang 已提交
93
                     memory::Allocator::Attr attr = memory::Allocator::kDefault,
94
                     size_t requested_size = 0);
95

Y
Yu Yang 已提交
96 97 98
  void* mutable_data(platform::Place place,
                     memory::Allocator::Attr attr = memory::Allocator::kDefault,
                     size_t requested_size = 0);
99

L
liaogang 已提交
100 101 102
  /**
   * @brief     Return a pointer to mutable memory block.
   *
103 104 105
   * @param[in] dims           The dimensions of the memory block.
   * @param[in] place          The place of the memory block.
   * @param[in] requested_size The size of the block in bytes.
L
liaogang 已提交
106 107 108 109
   *
   * @note      If not exist, then allocation.
   */
  template <typename T>
Y
Yu Yang 已提交
110 111 112
  T* mutable_data(DDim dims, platform::Place place,
                  memory::Allocator::Attr attr = memory::Allocator::kDefault,
                  size_t requested_size = 0);
Y
Yi Wang 已提交
113

L
liaogang 已提交
114
  /*! Return the dimensions of the memory block. */
115
  const DDim& dims() const;
L
liaogang 已提交
116

117
  /*! Return the numel of the memory block. */
118
  int64_t numel() const;
119

L
liaogang 已提交
120
  /*! Resize the dimensions of the memory block. */
121
  Tensor& Resize(const DDim& dims);
L
liaogang 已提交
122 123

  /*! The internal of two tensors share the same memory block. */
124
  Tensor& ShareDataWith(const Tensor& src);
L
liaogang 已提交
125 126

  /**
127
   * @brief  Return a sub-tensor of the given tensor.
L
liaogang 已提交
128
   *
129 130 131 132
   * @param[in] begin_idx   The index of the start row(inclusive) to slice.
   *                        The index number begins from 0.
   * @param[in] end_idx     The index of the end row(exclusive) to slice.
   *                        The index number begins from 0.
L
liaogang 已提交
133
   */
134
  Tensor Slice(int begin_idx, int end_idx) const;
135

Y
Yu Yang 已提交
136
  platform::Place place() const {
137
    PADDLE_ENFORCE_NOT_NULL(
Q
Qiao Longfei 已提交
138
        holder_, "Tensor not initialized yet when Tensor::place() is called.");
Y
Yu Yang 已提交
139 140
    return holder_->place();
  }
Q
qijun 已提交
141

Y
Yu Yang 已提交
142
  proto::VarType::Type type() const {
Q
Qiao Longfei 已提交
143 144
    PADDLE_ENFORCE_NOT_NULL(
        holder_, "Tensor not initialized yet when Tensor::type() is called.");
145
    return type_;
Q
Qiao Longfei 已提交
146
  }
Y
Yu Yang 已提交
147

Y
Yu Yang 已提交
148
  // memory size returns the holding memory size in byte.
Y
Yu Yang 已提交
149
  size_t memory_size() const;
Y
Yu Yang 已提交
150

151
  void check_memory_size() const;
L
liaogang 已提交
152

153
  DataLayout layout() const { return layout_; }
D
dzhwinter 已提交
154

155
  void set_layout(const DataLayout layout) { layout_ = layout; }
D
dzhwinter 已提交
156

S
sneaxiy 已提交
157 158
  void clear() { holder_ = nullptr; }

Y
Yu Yang 已提交
159
  const std::shared_ptr<memory::Allocation>& Holder() const { return holder_; }
Y
Yu Yang 已提交
160
  size_t offset() const { return offset_; }
Y
Yu Yang 已提交
161

L
liaogang 已提交
162 163
 private:
  /*! holds the memory block if allocated. */
164
  std::shared_ptr<memory::Allocation> holder_;
Y
Yu Yang 已提交
165
  proto::VarType::Type type_;
166 167 168 169 170 171
  /**
   * @brief points to elements dimensions.
   *
   * @note dims_ do not indicate the memory block size.
   */

172
  DDim dims_;
L
liaogang 已提交
173

D
dzhwinter 已提交
174
  /**
D
dzhwinter 已提交
175
   * @brief the layout of memory block, default is NHWC.
D
dzhwinter 已提交
176 177 178 179 180 181 182 183
   *
   * @note the memory allocation order, describe how weight/data is stored
   *       For example, in 4-D Tensor(rank=4), there are three commonly
   *       used layout. They are
   *            NCHW, NHWC, CHWN.
   *       N,C,H,W for respectively the batch size, the number of
   *       feature maps, the height.
   */
M
mozga-intel 已提交
184 185 186 187
  // Fix me: here just change the default layout to kNCHW
  // it doesn't fix the real issue, i.e. feeder should set up tensor layout
  // according to actual input data
  DataLayout layout_ = DataLayout::kNCHW;
D
dzhwinter 已提交
188

L
liaogang 已提交
189 190 191 192 193 194 195
  /**
   * @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 已提交
196
  size_t offset_;
197
};
Y
Yi Wang 已提交
198 199 200

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

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