Skip to content

Commit

Permalink
Remake of "fix: Fixed race condition in action server between is_read…
Browse files Browse the repository at this point in the history
…y and take" (#2495)

Some background information: is_ready, take_data and execute data
may be called from different threads in any order. The code in the old
state expected them to be called in series, without interruption.
This lead to multiple race conditions, as the state of the pimpl objects
was altered by the three functions in a non thread safe way.

Signed-off-by: Janosch Machowinski <[email protected]>
Signed-off-by: William Woodall <[email protected]>
Signed-off-by: Janosch Machowinski <[email protected]>
Co-authored-by: Janosch Machowinski <[email protected]>
  • Loading branch information
wjwwood and Janosch Machowinski authored Apr 9, 2024
1 parent bfa7efa commit dd81ef2
Show file tree
Hide file tree
Showing 4 changed files with 422 additions and 247 deletions.
24 changes: 19 additions & 5 deletions rclcpp_action/include/rclcpp_action/server.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
#include <unordered_map>
#include <utility>

#include "action_msgs/srv/cancel_goal.hpp"
#include "rcl/event_callback.h"
#include "rcl_action/action_server.h"
#include "rosidl_runtime_c/action_type_support_struct.h"
Expand Down Expand Up @@ -77,6 +78,7 @@ class ServerBase : public rclcpp::Waitable
GoalService,
ResultService,
CancelService,
Expired,
};

RCLCPP_ACTION_PUBLIC
Expand Down Expand Up @@ -279,19 +281,29 @@ class ServerBase : public rclcpp::Waitable
/// \internal
RCLCPP_ACTION_PUBLIC
void
execute_goal_request_received(const std::shared_ptr<void> & data);
execute_goal_request_received(
rcl_ret_t ret,
rcl_action_goal_info_t goal_info,
rmw_request_id_t request_header,
std::shared_ptr<void> message);

/// Handle a request to cancel goals on the server
/// \internal
RCLCPP_ACTION_PUBLIC
void
execute_cancel_request_received(const std::shared_ptr<void> & data);
execute_cancel_request_received(
rcl_ret_t ret,
std::shared_ptr<action_msgs::srv::CancelGoal::Request> request,
rmw_request_id_t request_header);

/// Handle a request to get the result of an action
/// \internal
RCLCPP_ACTION_PUBLIC
void
execute_result_request_received(const std::shared_ptr<void> & data);
execute_result_request_received(
rcl_ret_t ret,
std::shared_ptr<void> result_request,
rmw_request_id_t request_header);

/// Handle a timeout indicating a completed goal should be forgotten by the server
/// \internal
Expand Down Expand Up @@ -345,7 +357,8 @@ class Server : public ServerBase, public std::enable_shared_from_this<Server<Act

/// Signature of a callback that accepts or rejects goal requests.
using GoalCallback = std::function<GoalResponse(
const GoalUUID &, std::shared_ptr<const typename ActionT::Goal>)>;
const GoalUUID &,
std::shared_ptr<const typename ActionT::Goal>)>;
/// Signature of a callback that accepts or rejects requests to cancel a goal.
using CancelCallback = std::function<CancelResponse(std::shared_ptr<ServerGoalHandle<ActionT>>)>;
/// Signature of a callback that is used to notify when the goal has been accepted.
Expand Down Expand Up @@ -455,7 +468,8 @@ class Server : public ServerBase, public std::enable_shared_from_this<Server<Act
void
call_goal_accepted_callback(
std::shared_ptr<rcl_action_goal_handle_t> rcl_goal_handle,
GoalUUID uuid, std::shared_ptr<void> goal_request_message) override
GoalUUID uuid,
std::shared_ptr<void> goal_request_message) override
{
std::shared_ptr<ServerGoalHandle<ActionT>> goal_handle;
std::weak_ptr<Server<ActionT>> weak_this = this->shared_from_this();
Expand Down
Loading

0 comments on commit dd81ef2

Please sign in to comment.