Skip to content

Fix XNNWorkspaceManager cleanup tests by using unique IDs instead of raw pointers #16675

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.

Sign up for GitHub

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

Open
mergennachin wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix XNNWorkspaceManager cleanup tests by using unique IDs instead of raw pointers #16675

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 12 additions & 1 deletion backends/xnnpack/runtime/XNNWorkspace.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
#include <executorch/runtime/core/result.h>
#include <xnnpack.h>

#include <atomic>
#include <memory>
#include <mutex>
#include <utility>
Expand All @@ -24,7 +25,8 @@ using WorkspacePtr =
/// with appropriate synchronization.
class XNNWorkspace {
public:
XNNWorkspace(WorkspacePtr workspace) : workspace_(std::move(workspace)){};
XNNWorkspace(WorkspacePtr workspace)
: id_(next_id_++), workspace_(std::move(workspace)){};
XNNWorkspace(const XNNWorkspace&) = delete;
XNNWorkspace& operator=(const XNNWorkspace&) = delete;
// Not moveable due to std::mutex.
Expand All @@ -43,6 +45,13 @@ class XNNWorkspace {
return workspace_.get();
}

// Returns a unique ID for this workspace instance. This can be used to
// distinguish between different workspace objects even if they happen to
// have the same raw pointer due to memory reuse.
uint64_t id() const {
return id_;
}

static runtime::Result<std::shared_ptr<XNNWorkspace>> create() {
// Because this class can't be moved, we need to construct it in-place.
xnn_workspace_t workspace = nullptr;
Expand All @@ -60,7 +69,9 @@ class XNNWorkspace {
}

private:
static inline std::atomic<uint64_t> next_id_{0};
std::mutex mutex_;
uint64_t id_;
WorkspacePtr workspace_;
};

Expand Down
20 changes: 12 additions & 8 deletions backends/xnnpack/test/runtime/test_workspace_manager.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ TEST_F(XNNWorkspaceManagerTest, PerModelModeCleanup) {
workspace_manager_->set_sharing_mode(WorkspaceSharingMode::PerModel);

uintptr_t program_id = 12345;
xnn_workspace_t raw_workspace1 = nullptr;
uint64_t workspace1_id = 0;

// Create a scope to control the lifetime of workspace1
{
Expand All @@ -175,8 +175,8 @@ TEST_F(XNNWorkspaceManagerTest, PerModelModeCleanup) {
ASSERT_TRUE(workspace1_result.ok());
auto workspace1 = workspace1_result.get();

// Store the raw pointer for later comparison
raw_workspace1 = workspace1->unsafe_get_workspace();
// Store the unique ID for later comparison
workspace1_id = workspace1->id();

// Let workspace1 go out of scope and be destroyed
}
Expand All @@ -188,7 +188,9 @@ TEST_F(XNNWorkspaceManagerTest, PerModelModeCleanup) {
auto workspace2 = workspace2_result.get();

// Since the previous workspace was destroyed, we should get a new one.
EXPECT_NE(workspace2->unsafe_get_workspace(), raw_workspace1);
// We compare IDs instead of raw pointers because memory allocators may
// reuse addresses after deallocation.
EXPECT_NE(workspace2->id(), workspace1_id);
}

TEST_F(XNNWorkspaceManagerTest, GlobalModeCleanup) {
Expand All @@ -197,7 +199,7 @@ TEST_F(XNNWorkspaceManagerTest, GlobalModeCleanup) {
workspace_manager_->set_sharing_mode(WorkspaceSharingMode::Global);

uintptr_t program_id = 12345;
xnn_workspace_t raw_workspace1 = nullptr;
uint64_t workspace1_id = 0;

// Create a scope to control the lifetime of workspace1
{
Expand All @@ -206,8 +208,8 @@ TEST_F(XNNWorkspaceManagerTest, GlobalModeCleanup) {
ASSERT_TRUE(workspace1_result.ok());
auto workspace1 = workspace1_result.get();

// Store the raw pointer for later comparison
raw_workspace1 = workspace1->unsafe_get_workspace();
// Store the unique ID for later comparison
workspace1_id = workspace1->id();

// Let workspace1 go out of scope and be destroyed
}
Expand All @@ -219,7 +221,9 @@ TEST_F(XNNWorkspaceManagerTest, GlobalModeCleanup) {
auto workspace2 = workspace2_result.get();

// Since the previous workspace was destroyed, we should get a new one.
EXPECT_NE(workspace2->unsafe_get_workspace(), raw_workspace1);
// We compare IDs instead of raw pointers because memory allocators may
// reuse addresses after deallocation.
EXPECT_NE(workspace2->id(), workspace1_id);
}

TEST_F(XNNWorkspaceManagerTest, SwitchingModes) {
Expand Down
Loading