block_desc.h 2.9 KB
Newer Older
F
fengjiayi 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
/* 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. */

#pragma once

F
fengjiayi 已提交
17
#include <deque>
Y
Fix CI  
Yu Yang 已提交
18
#include <memory>
Y
Yu Yang 已提交
19
#include <set>
F
fengjiayi 已提交
20 21
#include <unordered_map>
#include <vector>
Y
Yu Yang 已提交
22

Y
Yi Wang 已提交
23 24 25 26
#include "paddle/fluid/framework/op_desc.h"
#include "paddle/fluid/framework/proto_desc.h"
#include "paddle/fluid/framework/var_desc.h"
#include "paddle/fluid/platform/macros.h"
F
fengjiayi 已提交
27 28 29 30

namespace paddle {
namespace framework {

Y
Yu Yang 已提交
31
class ProgramDesc;
F
fengjiayi 已提交
32 33 34 35 36

// Each Protobuf Message, we provide a XXXBind class. In that class, we optimize
// read/write speed. Only when we want the protobuf message, the local changes
// will be synchronized (by `Sync` method).

Y
Yu Yang 已提交
37
class BlockDesc {
F
fengjiayi 已提交
38
 public:
Y
Yu Yang 已提交
39
  BlockDesc(ProgramDesc *prog, proto::BlockDesc *desc);
F
fengjiayi 已提交
40

Y
Yu Yang 已提交
41
  BlockDesc(const BlockDesc &other, proto::BlockDesc *desc, ProgramDesc *prog);
Y
Yu Yang 已提交
42

Y
Yu Yang 已提交
43
  ~BlockDesc() {
44 45 46 47
    this->ClearPBVars();
    this->ClearPBOps();
  }

F
fengjiayi 已提交
48 49 50 51
  int32_t ID() const { return desc_->idx(); }

  int32_t Parent() const { return desc_->parent_idx(); }

Y
Yu Yang 已提交
52
  VarDesc *Var(const std::string &name_bytes);
F
fengjiayi 已提交
53

Y
Yu Yang 已提交
54
  VarDesc *FindVar(const std::string &name_bytes) const;
F
fengjiayi 已提交
55

Q
qiaolongfei 已提交
56 57
  bool HasVar(const std::string &var_name) const;

T
wip  
typhoonzero 已提交
58
  VarDesc *RenameVar(const std::string &old_name, const std::string &new_name);
T
typhoonzero 已提交
59

Y
Yu Yang 已提交
60
  VarDesc *FindVarRecursive(const std::string &name_bytes) const;
61

Y
Yang Yu 已提交
62
  VarDesc &FindRecursiveOrCreateVar(const std::string &name_bytes);
Y
Yang Yang(Tony) 已提交
63

64 65
  bool HasVarRecursive(const std::string &var_name) const;

Y
Yu Yang 已提交
66 67 68 69 70 71 72 73
  std::set<std::string> LocalVarNames() const {
    std::set<std::string> var_names;
    for (auto &var : vars_) {
      var_names.insert(var.first);
    }
    return var_names;
  }

Y
Yu Yang 已提交
74
  std::vector<VarDesc *> AllVars() const;
F
fengjiayi 已提交
75

Y
Yu Yang 已提交
76
  BlockDesc *ParentBlock() const;
F
fengjiayi 已提交
77

Y
Yu Yang 已提交
78
  OpDesc *AppendOp();
F
fengjiayi 已提交
79

Y
Yu Yang 已提交
80
  void AppendAllocatedOp(std::unique_ptr<OpDesc> &&op_desc);
81

Y
Yu Yang 已提交
82
  OpDesc *PrependOp();
F
fengjiayi 已提交
83

T
typhoonzero 已提交
84 85
  void RemoveOp(size_t s, size_t e);

Y
Yu Yang 已提交
86
  std::vector<OpDesc *> AllOps() const;
F
fengjiayi 已提交
87

88 89
  size_t OpSize() const { return ops_.size(); }

Y
Yu Yang 已提交
90
  OpDesc *Op(int idx) { return ops_.at(idx).get(); }
91

92
  void Flush();
F
fengjiayi 已提交
93

94
  proto::BlockDesc *Proto();
F
fengjiayi 已提交
95

Y
Yu Yang 已提交
96
  ProgramDesc *Program() { return this->prog_; }
Y
Yu Yang 已提交
97

98 99 100 101
 private:
  void ClearPBOps();
  void ClearPBVars();

102
 private:
Y
Yu Yang 已提交
103
  ProgramDesc *prog_;       // not_own
104
  proto::BlockDesc *desc_;  // not_own
F
fengjiayi 已提交
105 106
  bool need_update_;

Y
Yu Yang 已提交
107 108
  std::deque<std::unique_ptr<OpDesc>> ops_;
  std::unordered_map<std::string, std::unique_ptr<VarDesc>> vars_;
D
format  
dongzhihong 已提交
109

Y
Yu Yang 已提交
110
  DISABLE_COPY_AND_ASSIGN(BlockDesc);
F
fengjiayi 已提交
111
};
F
fengjiayi 已提交
112 113
}  // namespace framework
}  // namespace paddle