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

Stateful allocator support for concurrent_queue and concurrent_bounde… #1520

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

YexuanXiao
Copy link

@YexuanXiao YexuanXiao commented Sep 23, 2024

…d_queue

Description

Add support for allocator propagation to concurrent_queue and concurrent_bounded_queue, and use the allocator’s construct function instead of placement new.

Type of change

  • bug fix - change that fixes an issue
  • new feature - change that adds functionality
  • tests - change in tests
  • infrastructure - change in infrastructure and CI
  • documentation - documentation update

Tests

  • added - required for new features and some bug fixes
  • not needed

Documentation

  • updated in # - add PR number
  • needs to be updated
  • not needed

Breaks backward compatibility

  • Yes
  • No
  • Unknown

Copy link
Contributor

@kboyarinov kboyarinov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@YexuanXiao, many thanks for working on this gap in our containers!

include/oneapi/tbb/concurrent_queue.h Outdated Show resolved Hide resolved
include/oneapi/tbb/concurrent_queue.h Outdated Show resolved Hide resolved
clear();
if (queue_allocator_traits::propagate_on_container_move_assignment::value) {
my_allocator = std::move(other.my_allocator);
internal_swap(other);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am afraid that with the full support for stateful allocators, propagation and uses-allocator construction, we cannot use internal_swap as an implementation for move semantics anymore:

Consider this->my_allocator to be stateful allocator.
After internal_swap, the memory allocated by *this would be transferred to other but the allocator with the correct state would not be transfered to *this (and it cannot be since the standard requires us to move-construct allocators.
Because of these, we will need a "fair" move semantics for both constructor and the assignment operator

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

my_queue_representation is allocated by r1::cache_aligned_allocate instead of my_allocator and all memory allocated by my_allocator has been deallocated at line 153, so I don’t think this is an issue.

include/oneapi/tbb/concurrent_queue.h Outdated Show resolved Hide resolved
using std::swap;
swap(my_allocator, other.my_allocator);
} else {
__TBB_ASSERT(my_allocator == other.my_allocator, "unequal allocators");
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets move it inside internal_swap

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reviewed all the containers’ internal_swap, which typically have two overloads. I think they can be combined into a single function using if:

void internal_swap(concurrent_queue& src) {
   if (!allocator_traits_type::queue_allocator_traits::propagate_on_container)
        __TBB_ASSERT(my_allocator == src.my_allocator, "Swapping with unequal allocators is not allowed");
    using std::swap;
    swap(my_queue_representation, src.my_queue_representation);
}

The compiler will optimize it and eliminate the unreachable branch.
Allocator helpers have the same pattern. Do we need to perform these cleanups, or should we keep things as they are?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants