Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add scope guard for better resource releasing #35103

Merged
merged 1 commit into from
Aug 24, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions paddle/fluid/framework/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -447,3 +447,5 @@ cc_library(paddle_framework DEPS ${FLUID_FRAMEWORK_MODULES})
if(WITH_TESTING AND TEST selected_rows_test)
set_tests_properties(selected_rows_test PROPERTIES TIMEOUT 120)
endif()

cc_test(scope_guard_test SRCS scope_guard_test.cc)
52 changes: 52 additions & 0 deletions paddle/fluid/framework/scope_guard.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
// Copyright (c) 2021 PaddlePaddle Authors. All Rights Reserved.
//
// 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

#include <type_traits>
#include <utility>
#include "paddle/fluid/platform/macros.h"

namespace paddle {
namespace framework {

template <typename ReleaseCallback>
class ScopeGuard {
public:
explicit ScopeGuard(const ReleaseCallback &callback) : callback_(callback) {}

~ScopeGuard() { callback_(); }

private:
DISABLE_COPY_AND_ASSIGN(ScopeGuard);

private:
ReleaseCallback callback_;
};

// Two macros are needed here.
// See:
// https://stackoverflow.com/questions/10379691/creating-macro-using-line-for-different-variable-names
#define _PADDLE_CONCAT_TOKEN(x, y) x##y
#define PADDLE_CONCAT_TOKEN(x, y) _PADDLE_CONCAT_TOKEN(x, y)

#define DEFINE_PADDLE_SCOPE_GUARD(...) \
auto PADDLE_CONCAT_TOKEN(__scope_guard_func, __LINE__) = __VA_ARGS__; \
::paddle::framework::ScopeGuard<typename std::remove_reference<decltype( \
PADDLE_CONCAT_TOKEN(__scope_guard_func, __LINE__))>::type> \
PADDLE_CONCAT_TOKEN(__scope_guard, __LINE__)( \
PADDLE_CONCAT_TOKEN(__scope_guard_func, __LINE__))

} // namespace framework
} // namespace paddle
37 changes: 37 additions & 0 deletions paddle/fluid/framework/scope_guard_test.cc
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
// Copyright (c) 2021 PaddlePaddle Authors. All Rights Reserved.
//
// 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.

#include "paddle/fluid/framework/scope_guard.h"
#include "gtest/gtest.h"

namespace paddle {
namespace framework {

TEST(scope_guard, scope_guard_test) {
int n = 10;
{
DEFINE_PADDLE_SCOPE_GUARD([&n] { ++n; });
}
EXPECT_EQ(n, 11);
try {
DEFINE_PADDLE_SCOPE_GUARD([&] { --n; });
DEFINE_PADDLE_SCOPE_GUARD([&] { --n; });
throw std::runtime_error("any exception");
} catch (std::runtime_error &) {
EXPECT_EQ(n, 9);
}
}

} // namespace framework
} // namespace paddle