Skip to content

test/osd/types.cc: fix memory leak in pg_pool_t encodeDecode test#63820

Closed
tchaikov wants to merge 1 commit intoceph:mainfrom
tchaikov:wip-test-types-fix-leaks
Closed

test/osd/types.cc: fix memory leak in pg_pool_t encodeDecode test#63820
tchaikov wants to merge 1 commit intoceph:mainfrom
tchaikov:wip-test-types-fix-leaks

Conversation

@tchaikov
Copy link
Contributor

@tchaikov tchaikov commented Jun 9, 2025

Fix a memory leak where test instances created by
pg_pool_t::generate_test_instances() were not being freed after use.

The generate_test_instances() method follows the convention of returning raw pointers (used by ceph-dencoder for encoder/decoder verification), but the test was not cleaning up these allocated instances.

ASan reported a 712-byte leak traced to the test instance allocation.

Direct leak of 712 byte(s) in 1 object(s) allocated from:
    #0 0x555e7e3d94cd in operator new(unsigned long) (/home/jenkins-build/build/workspace/ceph-pull-requests/build/bin/unittest_osd_types+0x29a4cd) (BuildId: e6de649d
bc3dc2f253818f12b47cae5ff3507a89)
    #1 0x7fdd87bb9bd7 in pg_pool_t::generate_test_instances(std::__cxx11::list<pg_pool_t*, std::allocator<pg_pool_t*>>&) /home/jenkins-build/build/workspace/ceph-pull-requests/src/osd/osd_types.cc:2349:15
    #2 0x555e7e3e3759 in pg_pool_t_encodeDecode_Test::TestBody() /home/jenkins-build/build/workspace/ceph-pull-requests/src/test/osd/types.cc:124:5
    #3 0x555e7e5fd3dd in void testing::internal::HandleSehExceptionsInMethodIfSupported<testing::Test, void>(testing::Test*, void (testing::Test::*)(), char const*) /home/jenkins-build/build/workspace/ceph-pull-requests/src/googletest/googletest/src/gtest.cc:2653:10
    #4 0x555e7e5c1a35 in void testing::internal::HandleExceptionsInMethodIfSupported<testing::Test, void>(testing::Test*, void (testing::Test::*)(), char const*) /home/jenkins-build/build/workspace/ceph-pull-requests/src/googletest/googletest/src/gtest.cc:2689:14`

This change adds proper cleanup by deleting the test instances after the encode/decode verification is complete.

Contribution Guidelines

  • To sign and title your commits, please refer to Submitting Patches to Ceph.

  • If you are submitting a fix for a stable branch (e.g. "quincy"), please refer to Submitting Patches to Ceph - Backports for the proper workflow.

  • When filling out the below checklist, you may click boxes directly in the GitHub web UI. When entering or editing the entire PR message in the GitHub web UI editor, you may also select a checklist item by adding an x between the brackets: [x]. Spaces and capitalization matter when checking off items this way.

Checklist

  • Tracker (select at least one)
    • References tracker ticket
    • Very recent bug; references commit where it was introduced
    • New feature (ticket optional)
    • Doc update (no ticket needed)
    • Code cleanup (no ticket needed)
  • Component impact
    • Affects Dashboard, opened tracker ticket
    • Affects Orchestrator, opened tracker ticket
    • No impact that needs to be tracked
  • Documentation (select at least one)
    • Updates relevant documentation
    • No doc update is appropriate
  • Tests (select at least one)
Show available Jenkins commands

Fix a memory leak where test instances created by
pg_pool_t::generate_test_instances() were not being freed after use.

The generate_test_instances() method follows the convention of returning
raw pointers (used by ceph-dencoder for encoder/decoder verification),
but the test was not cleaning up these allocated instances.

ASan reported a 712-byte leak traced to the test instance allocation.

```
Direct leak of 712 byte(s) in 1 object(s) allocated from:
    #0 0x555e7e3d94cd in operator new(unsigned long) (/home/jenkins-build/build/workspace/ceph-pull-requests/build/bin/unittest_osd_types+0x29a4cd) (BuildId: e6de649d
bc3dc2f253818f12b47cae5ff3507a89)
    #1 0x7fdd87bb9bd7 in pg_pool_t::generate_test_instances(std::__cxx11::list<pg_pool_t*, std::allocator<pg_pool_t*>>&) /home/jenkins-build/build/workspace/ceph-pull-requests/src/osd/osd_types.cc:2349:15
    #2 0x555e7e3e3759 in pg_pool_t_encodeDecode_Test::TestBody() /home/jenkins-build/build/workspace/ceph-pull-requests/src/test/osd/types.cc:124:5
    #3 0x555e7e5fd3dd in void testing::internal::HandleSehExceptionsInMethodIfSupported<testing::Test, void>(testing::Test*, void (testing::Test::*)(), char const*) /home/jenkins-build/build/workspace/ceph-pull-requests/src/googletest/googletest/src/gtest.cc:2653:10
    #4 0x555e7e5c1a35 in void testing::internal::HandleExceptionsInMethodIfSupported<testing::Test, void>(testing::Test*, void (testing::Test::*)(), char const*) /home/jenkins-build/build/workspace/ceph-pull-requests/src/googletest/googletest/src/gtest.cc:2689:14`
```

This change adds proper cleanup by deleting the test instances after
the encode/decode verification is complete.

Signed-off-by: Kefu Chai <tchaikov@gmail.com>
@tchaikov tchaikov requested a review from a team as a code owner June 9, 2025 12:45
@tchaikov
Copy link
Contributor Author

tchaikov commented Jun 9, 2025

i will consider a more intrusive way to return, for instance std::list<shared_ptr<T>> from generate_test_instances() later.

created #63910

@tchaikov
Copy link
Contributor Author

tchaikov commented Jun 9, 2025

jenkins test make check arm64

@tchaikov tchaikov mentioned this pull request Jun 10, 2025
14 tasks
@tchaikov
Copy link
Contributor Author

jenkins test submodules

1 similar comment
@tchaikov
Copy link
Contributor Author

jenkins test submodules

@tchaikov
Copy link
Contributor Author

jenkins test make check arm64

@tchaikov
Copy link
Contributor Author

closing in favor of #63910

@tchaikov tchaikov closed this Jun 18, 2025
@tchaikov tchaikov reopened this Jun 18, 2025
@tchaikov tchaikov closed this Jun 18, 2025
@tchaikov tchaikov deleted the wip-test-types-fix-leaks branch June 18, 2025 03:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant