graphengine/inc/graph/detail/attributes_holder.h

/**
 * Copyright 2019-2020 Huawei Technologies Co., Ltd
 *
 * 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.
 */

#ifndef INC_GRAPH_DETAIL_ATTRIBUTES_HOLDER_H_
#define INC_GRAPH_DETAIL_ATTRIBUTES_HOLDER_H_

#include <map>
#include <memory>
#include <string>
#include <unordered_set>
#include <utility>
#include <vector>

#include "graph/detail/any_map.h"
#include "graph/ge_error_codes.h"
#include "graph/types.h"

namespace google {
namespace protobuf {
class Message;
template <typename Key, typename T>
class Map;
}  // namespace protobuf
}  // namespace google

namespace ge {
using std::string;
class GeAttrValue;

namespace proto {
class AttrDef;
class TensorDef;
class TensorDescriptor;
class ShapeDef;
class NamedAttrs;
class ModelDef;
class OpDef;
class GraphDef;
}  // namespace proto

using ProtoAttrMap = ::google::protobuf::Map<::std::string, ::ge::proto::AttrDef>;
using ProtoMsgOwner = std::shared_ptr<::google::protobuf::Message>;

template <class ProtoType>
class GeIrProtoHelper {
 public:
  GeIrProtoHelper(const ProtoMsgOwner &protoOwner, ProtoType *protoMsg)
      : protoOwner_(protoOwner), protoMsg_(protoMsg) {}

  GeIrProtoHelper() {
    protoOwner_ = std::shared_ptr<::google::protobuf::Message>(nullptr);
    protoMsg_ = nullptr;
  }
  virtual ~GeIrProtoHelper() = default;

  template <typename T>
  GeIrProtoHelper(const GeIrProtoHelper<T> &other) {
    protoOwner_ = other.protoOwner_;
    protoMsg_ = other.protoMsg_;
  }
  template <typename T>
  GeIrProtoHelper &operator=(const GeIrProtoHelper<T> &other) {
    protoOwner_ = other.protoOnwer_;
    protoMsg_ = other.protoMsg_;
    return *this;
  }
  void InitDefault();
  template <typename T>
  bool operator==(const GeIrProtoHelper<T> &other) const {
    return protoOwner_ == other.protoOwner_ && protoMsg_ == other.protoMsg_;
  }

  inline const ProtoMsgOwner &GetProtoOwner() const { return protoOwner_; }
  inline ProtoType *GetProtoMsg() const { return protoMsg_; }
  void CopyValueFrom(const GeIrProtoHelper<const ProtoType> &other) {
    if (other.protoMsg_ != nullptr && protoMsg_ != nullptr) {
      *protoMsg_ = *other.protoMsg_;
    }
  }
  void MoveValueFrom(GeIrProtoHelper<ProtoType> &&other) {
    if (other.protoMsg_ != nullptr && protoMsg_ != nullptr) {
      *protoMsg_ = std::move(*other.protoMsg_);
    }
  }

  // protoMsg_ is part of protoOwner_ and they have the same runtime
  ProtoMsgOwner protoOwner_ = nullptr;
  ProtoType *protoMsg_ = nullptr;
  friend class GeIrProtoHelper<typename std::conditional<
    std::is_const<ProtoType>::value, typename std::remove_const<ProtoType>::type, const ProtoType>::type>;
};

using ProtoAttrMapHelper = GeIrProtoHelper<ProtoAttrMap>;
using ConstProtoAttrMapHelper = GeIrProtoHelper<const ProtoAttrMap>;

class GE_FUNC_DEV_VISIBILITY GE_FUNC_HOST_VISIBILITY AttrHolder {
 public:
  AttrHolder() = default;
  virtual ~AttrHolder() = default;

  graphStatus SetAttr(const string &name, const GeAttrValue &value);

  graphStatus GetAttr(const string &name, GeAttrValue &value) const;

  bool HasAttr(const string &name) const;

  graphStatus DelAttr(const string &name);

  void CopyAttrsFrom(const AttrHolder &holder);

  template <class T>
  bool SetExtAttr(const string &name, const T &value) {
    return extAttrs_.Set(name, value);
  }
  template <class T>
  T TryGetExtAttr(const string &name, T defaultValue) const {
    T ret(defaultValue);
    (void)extAttrs_.Get(name, ret);
    return ret;
  }

 protected:
  graphStatus AddRequiredAttr(const std::string &name);
  const std::unordered_set<string> GetAllAttrNames() const;
  const std::map<string, GeAttrValue> GetAllAttrs() const;

  virtual ProtoAttrMapHelper MutableAttrMap() = 0;
  virtual ConstProtoAttrMapHelper GetAttrMap() const = 0;

  friend class ModelSerializeImp;
  friend class AttrUtils;
  friend class AttrUtilsHelper;

  std::vector<string> requiredAttrs_;

 private:
  AnyMap extAttrs_;
};
}  // namespace ge

#endif  // INC_GRAPH_DETAIL_ATTRIBUTES_HOLDER_H_