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

scheduling_group: improve scheduling group creation exception safety #2617

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

Conversation

mlitvk
Copy link
Contributor

@mlitvk mlitvk commented Jan 15, 2025

Improve handling of exceptions during scheduling group and scheduling group key creation, where a user-provided constructor for the keys may fail, for example.

We use a new struct specific_val and smart pointers to manage memory allocation, construction and destruction of scheduling group data in a safe manner.

We also reorder the initialization order to make it safer. For example, when creating a scheduling group, first allocate all data and then swap it into the scheduling group's data structure.

Fixes #2222

@mlitvk mlitvk marked this pull request as ready for review January 15, 2025 13:54
@mlitvk mlitvk requested a review from piodul January 15, 2025 13:54
@mlitvk mlitvk force-pushed the sg_exception_safety branch 4 times, most recently from cb8d016 to 88c4e8a Compare January 15, 2025 18:21
@mlitvk
Copy link
Contributor Author

mlitvk commented Jan 16, 2025

The CI fails in Seastar.unit.rpc with timeout
This is a known issue: #2620

@@ -37,17 +37,66 @@ namespace seastar {
namespace internal {

struct scheduling_group_specific_thread_local_data {
using val_ptr = std::unique_ptr<void, void (*)(void*) noexcept>;
using cfg_ptr = std::shared_ptr<scheduling_group_key_config>;
Copy link
Contributor

Choose a reason for hiding this comment

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

Can it be seastar::lw_shared_ptr<scheduling_group_key_config>?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@@ -37,17 +37,66 @@ namespace seastar {
namespace internal {

struct scheduling_group_specific_thread_local_data {
using val_ptr = std::unique_ptr<void, void (*)(void*) noexcept>;
Copy link
Contributor

Choose a reason for hiding this comment

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

What's the point in making it smart-pointer if you track construction/destruction by hand anyway?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The point is to manage the dynamic memory allocation and free it automatically

inline auto& get_sg_data(unsigned sg_id) {
return _scheduling_group_specific_data.per_scheduling_group_data[sg_id];
}

Copy link
Contributor

Choose a reason for hiding this comment

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

There's no need in those helpers, AFAICS, the existing get_scheduling_group_specific_thread_local_data() (and Co) already provide access to the array of per_scheduling_group_data-s

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I added it because in several places we access the sg data and we do

    auto& sg_data = _scheduling_group_specific_data;
    auto& this_sg = sg_data.per_scheduling_group_data[sg._id];

which I thought is a little cumbersome and I didn't find another method for this

@@ -393,7 +401,6 @@ private:
task_queue* pop_active_task_queue(sched_clock::time_point now);
void insert_activating_task_queues();
void account_runtime(task_queue& tq, sched_clock::duration runtime);
void allocate_scheduling_group_specific_data(scheduling_group sg, unsigned long key_id);
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd appreciate if the change "Move allocate_scheduling_group_specific_data() from reactor class to internal namespace" was made as separate preparational patch (in the same PR)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

Move the function allocate_scheduling_group_specific_data from reactor
class to an internal static function.

Change it to handle only the allocation and construction of the data
object, while the caller handles the assignment of it.
Improve handling of exceptions during scheduling group and scheduling
group key creation, where a user-provided constructor for the keys may
fail, for example.

We use a new struct `specific_val` and smart pointers to manage memory
allocation, construction and destruction of scheduling group data in a
safe manner.

We also reorder the initialization order to make it safer. For
example, when creating a scheduling group, first allocate all data and
then swap it into the scheduling group's data structure.

Fixes scylladb#2222
@mlitvk mlitvk force-pushed the sg_exception_safety branch from 88c4e8a to cd957c2 Compare January 16, 2025 11:48
@mlitvk
Copy link
Contributor Author

mlitvk commented Jan 16, 2025

  • changed to lw_shared_ptr instead of std::shared_ptr
  • split the commit and added a preliminary commit to change allocate_scheduling_group_specific_data into an internal function
  • rebase

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.

create_scheduling_group / scheduling_group_key_create not exception safe when SG key data constructor throws
2 participants