2017-04-15 21:22:19 +02:00
|
|
|
/** Wrapper around queue that uses POSIX CV's for signalling writes.
|
|
|
|
*
|
|
|
|
* @file
|
|
|
|
* @author Georg Martin Reinke <georg.reinke@rwth-aachen.de>
|
2020-01-20 17:17:00 +01:00
|
|
|
* @copyright 2014-2020, Institute for Automation of Complex Power Systems, EONERC
|
2017-04-27 12:56:43 +02:00
|
|
|
* @license GNU General Public License (version 3)
|
|
|
|
*
|
|
|
|
* VILLASnode
|
|
|
|
*
|
|
|
|
* This program is free software: you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
|
|
* any later version.
|
2017-05-05 19:24:16 +00:00
|
|
|
*
|
2017-04-27 12:56:43 +02:00
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
2017-05-05 19:24:16 +00:00
|
|
|
*
|
2017-04-27 12:56:43 +02:00
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
2017-04-15 21:22:19 +02:00
|
|
|
*********************************************************************************/
|
|
|
|
|
2017-04-07 12:18:08 +02:00
|
|
|
#pragma once
|
|
|
|
|
|
|
|
#include <pthread.h>
|
|
|
|
|
2018-08-06 11:22:52 +02:00
|
|
|
#include <villas/queue.h>
|
2017-04-07 12:18:08 +02:00
|
|
|
|
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
|
2019-06-23 16:13:23 +02:00
|
|
|
EVENTFD,
|
2018-05-23 09:06:29 +02:00
|
|
|
#elif defined(__APPLE__)
|
2019-06-23 16:13:23 +02:00
|
|
|
PIPE,
|
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
|
|
|
|
2019-06-23 16:13:23 +02:00
|
|
|
enum class QueueSignalledFlags {
|
|
|
|
PROCESS_SHARED = (1 << 4)
|
2017-09-25 13:34:32 +02:00
|
|
|
};
|
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. */
|
|
|
|
struct queue_signalled {
|
2017-04-15 23:14:14 +02:00
|
|
|
struct queue queue; /**< Actual underlying queue. */
|
2018-05-23 09:06:29 +02:00
|
|
|
|
2019-06-23 16:13:23 +02:00
|
|
|
enum QueueSignalledMode mode;
|
|
|
|
enum QueueSignalledFlags flags;
|
2018-05-23 09:06:29 +02:00
|
|
|
|
2017-08-30 12:35:47 +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;
|
2018-05-23 09:06:29 +02:00
|
|
|
#elif defined(__APPLE__)
|
|
|
|
int pipe[2];
|
2017-08-30 12:35:47 +02:00
|
|
|
#endif
|
|
|
|
};
|
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))
|
|
|
|
|
2020-09-10 11:11:42 +02:00
|
|
|
int queue_signalled_init(struct queue_signalled *qs, size_t size, struct memory_type *mem = memory_default, enum QueueSignalledMode mode = QueueSignalledMode::AUTO, int flags = 0) __attribute__ ((warn_unused_result));
|
2017-04-07 12:18:08 +02:00
|
|
|
|
2020-09-10 11:11:42 +02:00
|
|
|
int queue_signalled_destroy(struct queue_signalled *qs) __attribute__ ((warn_unused_result));
|
2017-04-07 12:18:08 +02:00
|
|
|
|
2020-09-10 11:11:42 +02:00
|
|
|
int queue_signalled_push(struct queue_signalled *qs, void *ptr) __attribute__ ((warn_unused_result));
|
2017-04-15 23:14:02 +02:00
|
|
|
|
2020-09-10 11:11:42 +02:00
|
|
|
int queue_signalled_pull(struct queue_signalled *qs, void **ptr) __attribute__ ((warn_unused_result));
|
2017-04-15 23:14:02 +02:00
|
|
|
|
2020-09-10 11:11:42 +02:00
|
|
|
int queue_signalled_push_many(struct queue_signalled *qs, void *ptr[], size_t cnt) __attribute__ ((warn_unused_result));
|
2017-04-07 12:18:08 +02:00
|
|
|
|
2020-09-10 11:11:42 +02:00
|
|
|
int queue_signalled_pull_many(struct queue_signalled *qs, void *ptr[], size_t cnt) __attribute__ ((warn_unused_result));
|
2017-05-12 13:08:34 +02:00
|
|
|
|
2020-09-10 11:11:42 +02:00
|
|
|
int queue_signalled_close(struct queue_signalled *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 */
|
|
|
|
int queue_signalled_fd(struct queue_signalled *qs);
|