src/gpu/DNNMark/core/include/dnnmark.h

// The MIT License (MIT)
//
// Copyright (c) 2016 Northeastern University
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

#ifndef CORE_INCLUDE_DNNMARK_H_
#define CORE_INCLUDE_DNNMARK_H_

#include <cstdlib>
#include <iostream>
#include <fstream>
#include <string>
#include <list>
#include <map>
#include <memory>
#include <glog/logging.h>

#include "common.h"
#include "utility.h"
#include "timer.h"
#include "gemm_wrapper.h"
#include "dnn_wrapper.h"
#include "dnn_config_keywords.h"
#include "dnn_param.h"
#include "dnn_utility.h"
#include "data_manager.h"
#include "dnn_layer.h"

#include "activation_layer.h"
#include "bn_layer.h"
#include "bypass_layer.h"
#include "conv_layer.h"
#include "dropout_layer.h"
#include "fc_layer.h"
#include "lrn_layer.h"
#include "pool_layer.h"
#include "softmax_layer.h"

namespace dnnmark {

const std::map<std::string, LayerType> layer_type_map = {
{layer_section_keywords[0], CONVOLUTION},
{layer_section_keywords[1], POOLING},
{layer_section_keywords[2], LRN},
{layer_section_keywords[3], ACTIVATION},
{layer_section_keywords[4], FC},
{layer_section_keywords[5], SOFTMAX},
{layer_section_keywords[6], BN},
{layer_section_keywords[7], DROPOUT},
{layer_section_keywords[8], BYPASS}
};

template <typename T>
class DNNMark {
 private:
  RunMode run_mode_;
  Handle handle_;
  // The map is ordered, so we don't need other container to store the layers
  std::map<int, std::shared_ptr<Layer<T>>> layers_map_;
  std::map<std::string, int> name_id_map_;
  int num_layers_added_;

  // Timer
  Timer timer_;

  // Private functions
  void SetLayerParams(LayerType layer_type,
                      int current_layer_id,
                      const std::string &var,
                      const std::string &val);

 public:

  DNNMark(const std::string &mmap_file);
  DNNMark(int num_layers, const std::string &mmap_file);
  void ParseAllConfig(const std::string &config_file);
  int ParseGeneralConfig(const std::string &config_file);
  int ParseLayerConfig(const std::string &config_file);
  int Initialize();
  int RunAll();
  int Forward();
  int Backward();

  int TearDown() {
    DataManager<T>::GetInstance()->DataManager<T>::~DataManager();
    layers_map_.clear();
    return 0;
  };

  Handle *GetHandle() { return &handle_; }
  Layer<T> *GetLayerByID(int layer_id) { return layers_map_[layer_id].get(); }
  Layer<T> *GetLayerByName(const std::string &name) {
    return layers_map_[name_id_map_[name]].get();
  }
  bool isLayerExist(const std::string &name) {
    return name_id_map_.find(name) != name_id_map_.end();
  }
  RunMode getRunMode() { return run_mode_; }

  Timer *GetTimer() { return &timer_; }

};

} // namespace dnnmark

#endif // CORE_INCLUDE_DNNMARK_H_