scope.h 4.0 KB
Newer Older
1
/* Copyright (c) 2016 PaddlePaddle Authors. All Rights Reserved.
Q
qiaolongfei 已提交
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. */

Q
qiaolongfei 已提交
15 16
#pragma once

Y
Yi Wang 已提交
17
#include <list>
Y
Yancey1989 已提交
18
#include <mutex>  // NOLINT
Q
qiaolongfei 已提交
19
#include <string>
Y
Yu Yang 已提交
20
#include <unordered_map>
21
#include <vector>
Q
qiaolongfei 已提交
22

Y
Yi Wang 已提交
23 24
#include "paddle/fluid/framework/variable.h"
#include "paddle/fluid/platform/macros.h"
Q
qiaolongfei 已提交
25 26 27 28

namespace paddle {
namespace framework {

S
sneaxiy 已提交
29 30
int64_t GetEagerDeletionThreshold();

Q
Qiao Longfei 已提交
31 32
class Scope;

Q
qiaolongfei 已提交
33
/**
34 35
 * @brief Scope that manage all variables.
 *
36
 * Scope is an association of a name to Variable. All variables belong to
37
 * Scope. You need to specify a scope to run a Net, i.e., `net.Run(&scope)`.
38 39
 * One net can run in different scopes and update different variable in the
 * scope.
Q
qiaolongfei 已提交
40 41
 */
class Scope {
Q
qiaolongfei 已提交
42
 public:
43
  Scope() {}
Y
Yi Wang 已提交
44
  ~Scope();
45

Y
Yu Yang 已提交
46 47 48 49 50 51
  /// Create a sub-scope. Returns a reference other than a pointer so
  /// to prevent from manual deletion.
  /// Mark it to const because that new kid scope cannot change parent scope.
  Scope& NewScope() const;

  /// Create a variable with given name if it doesn't exist.
52
  /// Caller doesn't own the returned Variable.
D
dongzhihong 已提交
53
  Variable* Var(const std::string& name);
Y
Yi Wang 已提交
54

Y
Yu Yang 已提交
55
  /// Create a variable with a scope-unique name.
56
  /// Caller doesn't own the returned Variable.
Y
Yu Yang 已提交
57
  Variable* Var(std::string* name = nullptr);
Y
Yi Wang 已提交
58

Y
Yancey1989 已提交
59
  void EraseVars(const std::vector<std::string>& var_names);
60

Y
Yu Yang 已提交
61 62
  /// Find a variable in the scope or any of its ancestors.  Returns
  /// nullptr if cannot find.
63
  /// Caller doesn't own the returned Variable.
Y
Yi Wang 已提交
64 65
  Variable* FindVar(const std::string& name) const;

S
sneaxiy 已提交
66 67 68 69 70
  /// Find a variable in the current scope.
  /// Return nullptr if cannot find.
  /// Caller doesn't own the returned Variable.
  Variable* FindLocalVar(const std::string& name) const;

71
  const Scope* parent() const { return parent_; }
Y
Yan Chunwei 已提交
72

Y
Yu Yang 已提交
73 74 75
  /// Find the scope or an ancestor scope that contains the given variable.
  const Scope* FindScope(const Variable* var) const;

76
  void DeleteScope(Scope* scope) const;
Y
Yu Yang 已提交
77

Y
Yu Yang 已提交
78 79
  /// Drop all kids scopes belonged to this scope.
  void DropKids();
80

M
minqiyang 已提交
81 82 83
  /// Find if a scope exists in the kid scopes
  bool HasKid(const Scope* scope) const;

84 85
  const std::list<Scope*>& kids() const { return kids_; }

86
  // enumerate all the variables current contains.
Y
Yang Yu 已提交
87
  std::vector<std::string> LocalVarNames() const;
88

Y
Yu Yang 已提交
89 90 91 92 93 94 95
  // Rename variable to a new name
  void Rename(const std::string& origin_name,
              const std::string& new_name) const;

  // Rename variable to a new name and return the new name
  std::string Rename(const std::string& origin_name) const;

96 97 98
 protected:
  mutable std::unordered_map<std::string, std::unique_ptr<Variable>> vars_;

99
 private:
Y
Yi Wang 已提交
100
  // Call Scope::NewScope for a sub-scope.
Y
Yu Yang 已提交
101
  explicit Scope(Scope const* parent) : parent_(parent) {}
Y
Yi Wang 已提交
102

T
tensor-tang 已提交
103 104 105 106 107 108 109 110 111 112
  // Called by Var.
  Variable* VarInternal(const std::string& name);

  // Called by FindScope.
  const Scope* FindScopeInternal(const Variable* var) const;

  // Called by Rename.
  void RenameInternal(const std::string& origin_name,
                      const std::string& new_name) const;

T
tensor-tang 已提交
113
  // Called by FindVar recursively.
T
tensor-tang 已提交
114 115
  Variable* FindVarInternal(const std::string& name) const;

T
tensor-tang 已提交
116
  // Called by FindVarInternal and Var.
T
tensor-tang 已提交
117 118
  Variable* FindVarLocally(const std::string& name) const;

119
  // Scope in `kids_` are owned by this class.
Y
Yu Yang 已提交
120
  mutable std::list<Scope*> kids_;
121
  const Scope* parent_{nullptr};
D
format  
dongzhihong 已提交
122 123

  DISABLE_COPY_AND_ASSIGN(Scope);
Y
Yancey1989 已提交
124 125 126

 private:
  mutable std::mutex mutex_;
Q
qiaolongfei 已提交
127
};
128 129 130 131 132

// Generate some debug string about the inherience structure of scope, quite
// naive.
std::string GenScopeTreeDebugInfo(Scope*);

Q
qiaolongfei 已提交
133 134
}  // namespace framework
}  // namespace paddle