深度学习caffe数据结构（五）—— blob数据结构blob.cpp文件详细解读

        在caffe中，Blob类实现的源码位于caffe根目录下的src/caffe/路径中的blob.cpp文件中，本文对这个文件进行详细解读。

#include <climits>
#include <vector>

#include "caffe/blob.hpp"
#include "caffe/common.hpp"
#include "caffe/syncedmem.hpp"
#include "caffe/util/math_functions.hpp"

这几行代码是blob.cpp文件包含的头文件。

namespace caffe {

这一行定义caffe命名空间

template <typename Dtype>
void Blob<Dtype>::Reshape(const int num, const int channels, const int height,
    const int width) {
  vector<int> shape(4);
  shape[0] = num;
  shape[1] = channels;
  shape[2] = height;
  shape[3] = width;
  Reshape(shape);
}

这个函数的是Blob的变形函数，使用num、channels、height、width这四个维度信息对Blob进行变形。在函数中，将这四个维度信息保存到shape向量中，根据shape向量来改变Blob形状。

template <typename Dtype>
void Blob<Dtype>::Reshape(const vector<int>& shape) {
  CHECK_LE(shape.size(), kMaxBlobAxes);
  count_ = 1;
  shape_.resize(shape.size());
  if (!shape_data_ || shape_data_->size() < shape.size() * sizeof(int)) {
    shape_data_.reset(new SyncedMemory(shape.size() * sizeof(int)));
  }
  int* shape_data = static_cast<int*>(shape_data_->mutable_cpu_data());
  for (int i = 0; i < shape.size(); ++i) {
    CHECK_GE(shape[i], 0);
    if (count_ != 0) {
      CHECK_LE(shape[i], INT_MAX / count_) << "blob size exceeds INT_MAX";
    }
    count_ *= shape[i];
    shape_[i] = shape[i];
    shape_data[i] = shape[i];
  }
  if (count_ > capacity_) {
    capacity_ = count_;
    data_.reset(new SyncedMemory(capacity_ * sizeof(Dtype)));
    diff_.reset(new SyncedMemory(capacity_ * sizeof(Dtype)));
  }
}

        这个函数是Reshape函数的落实函数，通过shape向量来改变Blob的形状。在这个函数中，还对类的成员函数进行赋值，为数据分配内存空间。

        函数中先是判断shape的尺寸是否小于或等于最大的Blob尺寸，然后将成员变量shape_的尺寸赋值为shape的尺寸。

        接下来shape_data_.reset(new SyncedMemory(shape.size() * sizeof(int)));为shape_data_分配内存空间。int* shape_data = static_cast<int*>(shape_data_->mutable_cpu_data());的作用是定义一个指向shape_data_的指针shape_data。

        接下来在一个for循环中，对shape的每个维度进行遍历，先判断每个shape[i]是否大于等于0，然后判断shape[i]是否小于允许的最大值（即整数的最大值/count_），然后将每个shape[i]累乘到count_上，并将shape[i]赋值给shape_[i]，再将shape[i]赋值给shape_data指向的内存空间数据。

        在函数的最后，判断Blob的元素数量count_是否大于Blob的容量capacity_。如果大于，将容量修改为与元素数相等，最后为data_和diff_分配内存空间。

template <typename Dtype>
void Blob<Dtype>::Reshape(const BlobShape& shape) {
  CHECK_LE(shape.dim_size(), kMaxBlobAxes);
  vector<int> shape_vec(shape.dim_size());
  for (int i = 0; i < shape.dim_size(); ++i) {
    shape_vec[i] = shape.dim(i);
  }
  Reshape(shape_vec);
}

上面这个函数也是一个Reshape函数，它的输入为BlobShape类型变量shape，在函数中，先判断shape的维度数是否小于等于最大的维度数。然后将shape每个维度的尺寸赋值给shape_vec向量，并依据shape_vec来调用相应的Reshape函数来改变blob的形状。

template <typename Dtype>
void Blob<Dtype>::ReshapeLike(const Blob<Dtype>& other) {
  Reshape(other.shape());
}

上面这个函数的作用是将本类的Blob尺寸改变为与other相同的尺寸，函数中调用Reshape函数实现。

template <typename Dtype>
Blob<Dtype>::Blob(const int num, const int channels, const int height,
    const int width)
  // capacity_ must be initialized before calling Reshape
  : capacity_(0) {
  Reshape(num, channels, height, width);
}

这个函数是Blob的构造函数，输入为num、channels、height、width这四个维度信息，调用Reshape函数来实现。

template <typename Dtype>
Blob<Dtype>::Blob(const vector<int>& shape)
  // capacity_ must be initialized before calling Reshape
  : capacity_(0) {
  Reshape(shape);
}

这个函数是Blob的另一个构造函数，它的输入为shape向量。

template <typename Dtype>
const int* Blob<Dtype>::gpu_shape() const {
  CHECK(shape_data_);
  return (const int*)shape_data_->gpu_data();
}

这个函数是读取gpu_shape地址的函数，函数返回指向shape_data_的指针。

template <typename Dtype>
const Dtype* Blob<Dtype>::cpu_data() const {
  CHECK(data_);
  return (const Dtype*)data_->cpu_data();
}

这个函数返回指向cpu_data的指针。

template <typename Dtype>
void Blob<Dtype>::set_cpu_data(Dtype* data) {
  CHECK(data);
  // Make sure CPU and GPU sizes remain equal
  size_t size = count_ * sizeof(Dtype);
  if (data_->size() != size) {
    data_.reset(new SyncedMemory(size));
    diff_.reset(new SyncedMemory(size));
  }
  data_->set_cpu_data(data);
}

这个函数用来设置cpu_data，用data指向的数据替代data_所指向的cpu数据。

template <typename Dtype>
const Dtype* Blob<Dtype>::gpu_data() const {
  CHECK(data_);
  return (const Dtype*)data_->gpu_data();
}

这个函数返回指向gpu_data的指针。

template <typename Dtype>
void Blob<Dtype>::set_gpu_data(Dtype* data) {
  CHECK(data);
  // Make sure CPU and GPU sizes remain equal
  size_t size = count_ * sizeof(Dtype);
  if (data_->size() != size) {
    data_.reset(new SyncedMemory(size));
    diff_.reset(new SyncedMemory(size));
  }
  data_->set_gpu_data(data);
}

这个函数用来设置gpu_data，用data指向的数据替代data_所指向的gpu数据。

template <typename Dtype>
const Dtype* Blob<Dtype>::cpu_diff() const {
  CHECK(diff_);
  return (const Dtype*)diff_->cpu_data();
}

这个函数返回指向cpu_diff的指针。

template <typename Dtype>
const Dtype* Blob<Dtype>::gpu_diff() const {
  CHECK(diff_);
  return (const Dtype*)diff_->gpu_data();
}

这个函数返回指向gpu_diff的指针。

template <typename Dtype>
Dtype* Blob<Dtype>::mutable_cpu_data() {
  CHECK(data_);
  return static_cast<Dtype*>(data_->mutable_cpu_data());
}

这个函数返回指向可以读写的cpu_data的指针。

template <typename Dtype>
Dtype* Blob<Dtype>::mutable_gpu_data() {
  CHECK(data_);
  return static_cast<Dtype*>(data_->mutable_gpu_data());
}

这个函数返回指向可以读写的gpu_data的指针。

template <typename Dtype>
Dtype* Blob<Dtype>::mutable_cpu_diff() {
  CHECK(diff_);
  return static_cast<Dtype*>(diff_->mutable_cpu_data());
}

这个函数返回指向可以读写的cpu_diff的指针。

template <typename Dtype>
Dtype* Blob<Dtype>::mutable_gpu_diff() {
  CHECK(diff_);
  return static_cast<Dtype*>(diff_->mutable_gpu_data());
}

这个函数返回指向可以读写的gpu_diff的指针。

template <typename Dtype>
void Blob<Dtype>::ShareData(const Blob& other) {
  CHECK_EQ(count_, other.count());
  data_ = other.data();
}

这个函数的作用是分享另一个Blob的数据data，在函数中如果other与本类Blob的元素数相等，则将other中的data复制到data_中。

template <typename Dtype>
void Blob<Dtype>::ShareDiff(const Blob& other) {
  CHECK_EQ(count_, other.count());
  diff_ = other.diff();
}

这个函数的作用是分享另一个Blob的数据diff，在函数中，如果other与本类Blob的元素数相等，则将other中的diff复制到diff_中。

template <> void Blob<unsigned int>::Update() { NOT_IMPLEMENTED; }
template <> void Blob<int>::Update() { NOT_IMPLEMENTED; }

这两行声明了两个Blob的更新函数。

template <typename Dtype>
void Blob<Dtype>::Update() {
  // We will perform update based on where the data is located.
  switch (data_->head()) {
  case SyncedMemory::HEAD_AT_CPU:
    // perform computation on CPU
    caffe_axpy<Dtype>(count_, Dtype(-1),
        static_cast<const Dtype*>(diff_->cpu_data()),
        static_cast<Dtype*>(data_->mutable_cpu_data()));
    break;
  case SyncedMemory::HEAD_AT_GPU:
  case SyncedMemory::SYNCED:
#ifndef CPU_ONLY
    // perform computation on GPU
    caffe_gpu_axpy<Dtype>(count_, Dtype(-1),
        static_cast<const Dtype*>(diff_->gpu_data()),
        static_cast<Dtype*>(data_->mutable_gpu_data()));
#else
    NO_GPU;
#endif
    break;
  default:
    LOG(FATAL) << "Syncedmem not initialized.";
  }
}

这个函数是更新函数Update的详细定义。首先通过一个switch语句判断data_位于哪里，如果在CPU中，则调用caffe_axpy函数计算法diff_和data_各元素的和。如果数据在GPU或者在CPU和GPU中同步，则调用caffe_gpu_axpy来计算diff_和data_各元素的和。需要注意的是，如果caffe编译时使能了CPU_ONLY选项，则不进行GPU相关的计算。其中caffe_axpy和caffe_gpu_axpy函数在math_functions.hpp文件中定义，这个文件位于caffe根目录下的include/caffe/util/路径中，有兴趣可以自己研究一下这个函数的实现过程。

template <> unsigned int Blob<unsigned int>::asum_data() const {
  NOT_IMPLEMENTED;
  return 0;
}

template <> int Blob<int>::asum_data() const {
  NOT_IMPLEMENTED;
  return 0;
}

这几行代码，声明了两个计算data元素绝对值和（L1范数）的函数。

template <typename Dtype>
Dtype Blob<Dtype>::asum_data() const {
  if (!data_) { return 0; }
  switch (data_->head()) {
  case SyncedMemory::HEAD_AT_CPU:
    return caffe_cpu_asum(count_, cpu_data());
  case SyncedMemory::HEAD_AT_GPU:
  case SyncedMemory::SYNCED:
#ifndef CPU_ONLY
  {
    Dtype asum;
    caffe_gpu_asum(count_, gpu_data(), &asum);
    return asum;
  }
#else
    NO_GPU;
#endif
  case SyncedMemory::UNINITIALIZED:
    return 0;
  default:
    LOG(FATAL) << "Unknown SyncedMemory head state: " << data_->head();
  }
  return 0;
}

上面的函数是计算data元素绝对值和的详细定义。这个函数使用的方法与更新函数类似，也是使用一个switch语句判断data_位于哪里，如果在CPU中，则调用caffe_cpu_asum函数计算法data_各元素的绝对值和。如果数据在GPU或者在CPU和GPU中同步，则调用caffe_gpu_asum函数计算法data_各元素的绝对值和。如果caffe编译时使能了CPU_ONLY选项，则不进行GPU相关的计算。其中，caffe_cpu_asum和caffe_gpu_asum函数也是在math_functions.hpp文件中定义。

template <> unsigned int Blob<unsigned int>::asum_diff() const {
  NOT_IMPLEMENTED;
  return 0;
}

template <> int Blob<int>::asum_diff() const {
  NOT_IMPLEMENTED;
  return 0;
}

这几行代码，声明了两个计算diff元素绝对值和（L1范数）的函数。

template <typename Dtype>
Dtype Blob<Dtype>::asum_diff() const {
  if (!diff_) { return 0; }
  switch (diff_->head()) {
  case SyncedMemory::HEAD_AT_CPU:
    return caffe_cpu_asum(count_, cpu_diff());
  case SyncedMemory::HEAD_AT_GPU:
  case SyncedMemory::SYNCED:
#ifndef CPU_ONLY
  {
    Dtype asum;
    caffe_gpu_asum(count_, gpu_diff(), &asum);
    return asum;
  }
#else
    NO_GPU;
#endif
  case SyncedMemory::UNINITIALIZED:
    return 0;
  default:
    LOG(FATAL) << "Unknown SyncedMemory head state: " << diff_->head();
  }
  return 0;
}

上面的函数是计算diff元素绝对值和的详细定义。与计算data元素绝对值和的函数实现是完全一样的，大家可以自行分析。

template <> unsigned int Blob<unsigned int>::sumsq_data() const {
  NOT_IMPLEMENTED;
  return 0;
}

template <> int Blob<int>::sumsq_data() const {
  NOT_IMPLEMENTED;
  return 0;
}

这几行代码，声明了两个计算data元素平方和（L2范数）的函数。

template <typename Dtype>
Dtype Blob<Dtype>::sumsq_data() const {
  Dtype sumsq;
  const Dtype* data;
  if (!data_) { return 0; }
  switch (data_->head()) {
  case SyncedMemory::HEAD_AT_CPU:
    data = cpu_data();
    sumsq = caffe_cpu_dot(count_, data, data);
    break;
  case SyncedMemory::HEAD_AT_GPU:
  case SyncedMemory::SYNCED:
#ifndef CPU_ONLY
    data = gpu_data();
    caffe_gpu_dot(count_, data, data, &sumsq);
#else
    NO_GPU;
#endif
    break;
  case SyncedMemory::UNINITIALIZED:
    return 0;
  default:
    LOG(FATAL) << "Unknown SyncedMemory head state: " << data_->head();
  }
  return sumsq;
}

上面的函数是计算data元素平方和的详细定义。这个函数也是使用一个switch语句判断data_位于哪里，如果在CPU中，则调用caffe_cpu_dot函数计算法data_各元素的平方和。如果数据在GPU或者在CPU和GPU中同步，则调用caffe_gpu_dot函数计算法data_各元素的平方和。如果caffe编译时使能了CPU_ONLY选项，则不进行GPU相关的计算。其中，caffe_cpu_dot和caffe_gpu_dot函数也是在math_functions.hpp文件中定义。

template <> unsigned int Blob<unsigned int>::sumsq_diff() const {
  NOT_IMPLEMENTED;
  return 0;
}

template <> int Blob<int>::sumsq_diff() const {
  NOT_IMPLEMENTED;
  return 0;
}

这几行代码，声明了两个计算diff元素平方和（L2范数）的函数。

template <typename Dtype>
Dtype Blob<Dtype>::sumsq_diff() const {
  Dtype sumsq;
  const Dtype* diff;
  if (!diff_) { return 0; }
  switch (diff_->head()) {
  case SyncedMemory::HEAD_AT_CPU:
    diff = cpu_diff();
    sumsq = caffe_cpu_dot(count_, diff, diff);
    break;
  case SyncedMemory::HEAD_AT_GPU:
  case SyncedMemory::SYNCED:
#ifndef CPU_ONLY
    diff = gpu_diff();
    caffe_gpu_dot(count_, diff, diff, &sumsq);
    break;
#else
    NO_GPU;
#endif
  case SyncedMemory::UNINITIALIZED:
    return 0;
  default:
    LOG(FATAL) << "Unknown SyncedMemory head state: " << data_->head();
  }
  return sumsq;
}

上面的函数是计算diff元素绝平方和的详细定义。与计算data元素平方和的函数实现是完全一样的，大家可以自行分析。