2017-04-15 21:22:19 +02:00
|
|
|
/* Wrapper around queue that uses POSIX CV's for signalling writes.
|
|
|
|
*
|
|
|
|
* Author: Georg Martin Reinke <georg.reinke@rwth-aachen.de>
|
2022-03-15 09:28:57 -04:00
|
|
|
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
|
2022-07-04 18:20:03 +02:00
|
|
|
* SPDX-License-Identifier: Apache-2.0
|
2017-04-15 21:22:19 +02:00
|
|
|
*/
|
|
|
|
|
2017-04-07 12:18:08 +02:00
|
|
|
#pragma once
|
|
|
|
|
|
|
|
#include <pthread.h>
|
|
|
|
|
2021-08-10 10:12:48 -04:00
|
|
|
#include <villas/node/config.hpp>
|
2023-09-07 11:46:39 +02:00
|
|
|
#include <villas/queue.h>
|
2021-08-10 10:12:48 -04:00
|
|
|
|
|
|
|
namespace villas {
|
|
|
|
namespace node {
|
2017-04-07 12:18:08 +02:00
|
|
|
|
2019-06-23 16:13:23 +02:00
|
|
|
enum class QueueSignalledMode {
|
2023-09-07 11:46:39 +02:00
|
|
|
AUTO, // We will choose the best method available on the platform
|
|
|
|
PTHREAD,
|
|
|
|
POLLING,
|
2018-06-21 09:37:30 +02:00
|
|
|
#ifdef HAS_EVENTFD
|
2023-09-07 11:46:39 +02:00
|
|
|
EVENTFD,
|
2022-03-14 19:37:29 -04:00
|
|
|
|
2017-08-30 12:35:47 +02:00
|
|
|
#endif
|
2019-06-23 16:13:23 +02:00
|
|
|
};
|
2018-05-23 09:06:29 +02:00
|
|
|
|
2023-09-07 11:46:39 +02:00
|
|
|
enum class QueueSignalledFlags { PROCESS_SHARED = (1 << 4) };
|
2017-08-30 12:35:47 +02:00
|
|
|
|
2017-04-07 12:18:08 +02:00
|
|
|
// Wrapper around queue that uses POSIX CV's for signalling writes.
|
2021-08-10 10:12:48 -04:00
|
|
|
struct CQueueSignalled {
|
2023-09-07 11:46:39 +02:00
|
|
|
struct CQueue queue; // Actual underlying queue.
|
2018-05-23 09:06:29 +02:00
|
|
|
|
2023-09-07 11:46:39 +02:00
|
|
|
enum QueueSignalledMode mode;
|
|
|
|
enum QueueSignalledFlags flags;
|
2018-05-23 09:06:29 +02:00
|
|
|
|
2023-09-07 11:46:39 +02:00
|
|
|
union {
|
|
|
|
struct {
|
|
|
|
pthread_cond_t ready; // Condition variable to signal writes to the queue.
|
|
|
|
pthread_mutex_t mutex; // Mutex for ready.
|
|
|
|
} pthread;
|
2017-08-30 12:35:47 +02:00
|
|
|
#ifdef __linux__
|
2023-09-07 11:46:39 +02:00
|
|
|
int eventfd;
|
2017-08-30 12:35:47 +02:00
|
|
|
#endif
|
2023-09-07 11:46:39 +02:00
|
|
|
};
|
2017-04-07 12:18:08 +02:00
|
|
|
};
|
|
|
|
|
2017-04-15 23:14:02 +02:00
|
|
|
#define queue_signalled_available(q) queue_available(&((q)->queue))
|
|
|
|
|
2023-09-07 11:46:39 +02:00
|
|
|
int queue_signalled_init(
|
|
|
|
struct CQueueSignalled *qs, size_t size = DEFAULT_QUEUE_LENGTH,
|
|
|
|
struct memory::Type *mem = memory::default_type,
|
|
|
|
enum QueueSignalledMode mode = QueueSignalledMode::AUTO, int flags = 0)
|
|
|
|
__attribute__((warn_unused_result));
|
2017-04-07 12:18:08 +02:00
|
|
|
|
2023-09-07 11:46:39 +02:00
|
|
|
int queue_signalled_destroy(struct CQueueSignalled *qs)
|
|
|
|
__attribute__((warn_unused_result));
|
2017-04-07 12:18:08 +02:00
|
|
|
|
2023-09-07 11:46:39 +02:00
|
|
|
int queue_signalled_push(struct CQueueSignalled *qs, void *ptr)
|
|
|
|
__attribute__((warn_unused_result));
|
2017-04-15 23:14:02 +02:00
|
|
|
|
2023-09-07 11:46:39 +02:00
|
|
|
int queue_signalled_pull(struct CQueueSignalled *qs, void **ptr)
|
|
|
|
__attribute__((warn_unused_result));
|
2017-04-15 23:14:02 +02:00
|
|
|
|
2023-09-07 11:46:39 +02:00
|
|
|
int queue_signalled_push_many(struct CQueueSignalled *qs, void *ptr[],
|
|
|
|
size_t cnt) __attribute__((warn_unused_result));
|
2017-04-07 12:18:08 +02:00
|
|
|
|
2023-09-07 11:46:39 +02:00
|
|
|
int queue_signalled_pull_many(struct CQueueSignalled *qs, void *ptr[],
|
|
|
|
size_t cnt) __attribute__((warn_unused_result));
|
2017-05-12 13:08:34 +02:00
|
|
|
|
2023-09-07 11:46:39 +02:00
|
|
|
int queue_signalled_close(struct CQueueSignalled *qs)
|
|
|
|
__attribute__((warn_unused_result));
|
2017-08-30 12:35:47 +02:00
|
|
|
|
|
|
|
// Returns a file descriptor which can be used with poll / select to wait for new data
|
2021-08-10 10:12:48 -04:00
|
|
|
int queue_signalled_fd(struct CQueueSignalled *qs);
|
|
|
|
|
2023-08-28 09:34:02 +02:00
|
|
|
} // namespace node
|
|
|
|
} // namespace villas
|