1
0
Fork 0
mirror of https://git.rwth-aachen.de/acs/public/villas/node/ synced 2025-03-16 00:00:02 +01:00
VILLASnode/include/villas/queue_signalled.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

79 lines
2.2 KiB
C
Raw Permalink Normal View History

/* 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
*/
#pragma once
#include <pthread.h>
#include <villas/node/config.hpp>
#include <villas/queue.h>
namespace villas {
namespace node {
2019-06-23 16:13:23 +02:00
enum class QueueSignalledMode {
AUTO, // We will choose the best method available on the platform
PTHREAD,
POLLING,
2018-06-21 09:37:30 +02:00
#ifdef HAS_EVENTFD
EVENTFD,
2022-03-14 19:37:29 -04:00
#endif
2019-06-23 16:13:23 +02:00
};
2018-05-23 09:06:29 +02:00
enum class QueueSignalledFlags { PROCESS_SHARED = (1 << 4) };
// Wrapper around queue that uses POSIX CV's for signalling writes.
struct CQueueSignalled {
struct CQueue queue; // Actual underlying queue.
2018-05-23 09:06:29 +02:00
enum QueueSignalledMode mode;
enum QueueSignalledFlags flags;
2018-05-23 09:06:29 +02:00
union {
struct {
pthread_cond_t ready; // Condition variable to signal writes to the queue.
pthread_mutex_t mutex; // Mutex for ready.
} pthread;
#ifdef __linux__
int eventfd;
#endif
};
};
#define queue_signalled_available(q) queue_available(&((q)->queue))
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));
int queue_signalled_destroy(struct CQueueSignalled *qs)
__attribute__((warn_unused_result));
int queue_signalled_push(struct CQueueSignalled *qs, void *ptr)
__attribute__((warn_unused_result));
int queue_signalled_pull(struct CQueueSignalled *qs, void **ptr)
__attribute__((warn_unused_result));
int queue_signalled_push_many(struct CQueueSignalled *qs, void *ptr[],
size_t cnt) __attribute__((warn_unused_result));
int queue_signalled_pull_many(struct CQueueSignalled *qs, void *ptr[],
size_t cnt) __attribute__((warn_unused_result));
int queue_signalled_close(struct CQueueSignalled *qs)
__attribute__((warn_unused_result));
// Returns a file descriptor which can be used with poll / select to wait for new data
int queue_signalled_fd(struct CQueueSignalled *qs);
} // namespace node
} // namespace villas