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

Add class for thread management of async hw interfaces #981

Merged
merged 14 commits into from
May 17, 2023
3 changes: 2 additions & 1 deletion controller_manager/src/controller_manager.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,8 @@ ControllerManager::ControllerManager(
std::shared_ptr<rclcpp::Executor> executor, const std::string & manager_node_name,
const std::string & namespace_, const rclcpp::NodeOptions & options)
: rclcpp::Node(manager_node_name, namespace_, options),
resource_manager_(std::make_unique<hardware_interface::ResourceManager>()),
resource_manager_(std::make_unique<hardware_interface::ResourceManager>(
this->get_node_clock_interface(), update_rate_)),
diagnostics_updater_(this),
executor_(executor),
loader_(std::make_shared<pluginlib::ClassLoader<controller_interface::ControllerInterface>>(
Expand Down
103 changes: 103 additions & 0 deletions hardware_interface/include/hardware_interface/async_components.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
// Copyright 2023 Open Source Robotics Foundation, Inc.
bmagyar marked this conversation as resolved.
Show resolved Hide resolved
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef HARDWARE_INTERFACE__ASYNC_COMPONENTS_HPP_
#define HARDWARE_INTERFACE__ASYNC_COMPONENTS_HPP_

#include <atomic>
#include <thread>
#include <type_traits>

#include "hardware_interface/actuator.hpp"
#include "hardware_interface/sensor.hpp"
#include "hardware_interface/system.hpp"
#include "lifecycle_msgs/msg/state.hpp"
#include "rclcpp/duration.hpp"
#include "rclcpp/node.hpp"
#include "rclcpp/time.hpp"

namespace hardware_interface
{

template <typename HardwareT>
class AsyncComponentThread
{
public:
static_assert(
std::is_same<hardware_interface::Actuator, HardwareT>::value ||
std::is_same<hardware_interface::System, HardwareT>::value ||
std::is_same<hardware_interface::Sensor, HardwareT>::value,
Copy link
Member

Choose a reason for hiding this comment

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

Does this means if someone extends a component type, they will not be able to use this async implementation?

Can we enable this to all types that have mentioned types as base class?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Actually that wouldn't work since all component type classes are final. Maybe I don't understand the use case here.

"Async component has to have a valid hardware type.");

explicit AsyncComponentThread(
HardwareT & component, unsigned int update_rate,
VX792 marked this conversation as resolved.
Show resolved Hide resolved
rclcpp::node_interfaces::NodeClockInterface::SharedPtr clock_interface)
: async_component_(component), cm_update_rate_(update_rate), clock_interface_(clock_interface)
{
}

AsyncComponentThread(const AsyncComponentThread & t) = delete;
AsyncComponentThread(AsyncComponentThread && t) = default;

~AsyncComponentThread()
{
terminated_.store(true, std::memory_order_seq_cst);
if (write_and_read_.joinable())
{
write_and_read_.join();
}
}

void activate() { write_and_read_ = std::thread(&AsyncComponentThread::write_and_read, this); }

void write_and_read()
{
using TimePoint = std::chrono::system_clock::time_point;

auto previous_time = clock_interface_->get_clock()->now();
while (!terminated_.load(std::memory_order_relaxed))
{
auto const period = std::chrono::nanoseconds(1'000'000'000 / cm_update_rate_);
TimePoint next_iteration_time =
TimePoint(std::chrono::nanoseconds(clock_interface_->get_clock()->now().nanoseconds()));

if (async_component_.get_state().id() == lifecycle_msgs::msg::State::PRIMARY_STATE_ACTIVE)
{
auto current_time = clock_interface_->get_clock()->now();
auto measured_period = current_time - previous_time;
previous_time = current_time;

if constexpr (!std::is_same_v<hardware_interface::Sensor, HardwareT>)
{
VX792 marked this conversation as resolved.
Show resolved Hide resolved
// write
}
// read
}
next_iteration_time += period;
std::this_thread::sleep_until(next_iteration_time);
VX792 marked this conversation as resolved.
Show resolved Hide resolved
}
}

private:
std::atomic<bool> terminated_{false};
HardwareT & async_component_;
VX792 marked this conversation as resolved.
Show resolved Hide resolved
std::thread write_and_read_{};

rclcpp::node_interfaces::NodeClockInterface::SharedPtr clock_interface_;
unsigned int cm_update_rate_;
};

}; // namespace hardware_interface

#endif // HARDWARE_INTERFACE__ASYNC_COMPONENTS_HPP_
18 changes: 12 additions & 6 deletions hardware_interface/include/hardware_interface/resource_manager.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,25 +16,28 @@
#define HARDWARE_INTERFACE__RESOURCE_MANAGER_HPP_

#include <memory>
#include <mutex>
#include <string>
#include <unordered_map>
#include <vector>

#include "hardware_interface/actuator.hpp"
#include "hardware_interface/hardware_component_info.hpp"
#include "hardware_interface/hardware_info.hpp"
#include "hardware_interface/loaned_command_interface.hpp"
#include "hardware_interface/loaned_state_interface.hpp"
#include "hardware_interface/sensor.hpp"
#include "hardware_interface/system.hpp"
#include "hardware_interface/types/hardware_interface_return_values.hpp"
#include "hardware_interface/types/lifecycle_state_names.hpp"
#include "lifecycle_msgs/msg/state.hpp"
#include "rclcpp/duration.hpp"
#include "rclcpp/node.hpp"
#include "rclcpp/time.hpp"

namespace hardware_interface
{
class ActuatorInterface;
class SensorInterface;
class SystemInterface;
class ResourceStorage;
class ControllerManager;

struct HardwareReadWriteStatus
{
Expand All @@ -46,7 +49,9 @@ class HARDWARE_INTERFACE_PUBLIC ResourceManager
{
public:
/// Default constructor for the Resource Manager.
ResourceManager();
ResourceManager(
rclcpp::node_interfaces::NodeClockInterface::SharedPtr clock_interface = nullptr,
VX792 marked this conversation as resolved.
Show resolved Hide resolved
unsigned int update_rate = 100);

/// Constructor for the Resource Manager.
/**
Expand All @@ -65,7 +70,8 @@ class HARDWARE_INTERFACE_PUBLIC ResourceManager
* "autostart_components" and "autoconfigure_components" instead.
*/
explicit ResourceManager(
const std::string & urdf, bool validate_interfaces = true, bool activate_all = false);
const std::string & urdf, bool validate_interfaces = true, bool activate_all = false,
rclcpp::node_interfaces::NodeClockInterface::SharedPtr clock_interface = nullptr);

ResourceManager(const ResourceManager &) = delete;

Expand Down
Loading