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

141 lines
5.5 KiB
C
Raw Permalink Normal View History

/** The internal datastructure for a sample of simulation data.
*
* @file
* @author Steffen Vogel <stvogel@eonerc.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-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-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-02-16 09:04:12 -03:00
#pragma once
2019-04-23 13:05:31 +02:00
#include <atomic>
#include <cstddef>
#include <cstdlib>
#include <cstdio>
#include <ctime>
2021-02-16 14:15:14 +01:00
#include <villas/log.hpp>
2018-08-06 11:24:49 +02:00
#include <villas/signal.h>
/* Forward declarations */
struct pool;
/** The length of a sample datastructure with \p values values in bytes. */
#define SAMPLE_LENGTH(len) (sizeof(struct sample) + SAMPLE_DATA_LENGTH(len))
/** The length of a sample data portion of a sample datastructure with \p values values in bytes. */
#define SAMPLE_DATA_LENGTH(len) ((len) * sizeof(double))
/** The number of values in a sample datastructure. */
#define SAMPLE_NUMBER_OF_VALUES(len) ((len) / sizeof(double))
/** The offset to the beginning of the data section. */
#define SAMPLE_DATA_OFFSET(smp) ((char *) (smp) + offsetof(struct sample, data))
/** Parts of a sample that can be serialized / de-serialized by the IO formats */
2019-06-23 16:13:23 +02:00
enum class SampleFlags {
HAS_TS_ORIGIN = (1 << 0), /**< Include origin timestamp in output. */
HAS_TS_RECEIVED = (1 << 1), /**< Include receive timestamp in output. */
HAS_OFFSET = (1 << 2), /**< Include offset (received - origin timestamp) in output. */
HAS_SEQUENCE = (1 << 3), /**< Include sequence number in output. */
HAS_DATA = (1 << 4), /**< Include values in output. */
2021-02-22 23:16:53 +01:00
HAS_TS = HAS_TS_ORIGIN | HAS_TS_RECEIVED, /**< Include origin timestamp in output. */
2019-06-23 16:13:23 +02:00
HAS_ALL = (1 << 5) - 1, /**< Enable all output options. */
IS_FIRST = (1 << 16), /**< This sample is the first of a new simulation case */
IS_LAST = (1 << 17) /**< This sample is the last of a running simulation case */
};
struct sample {
2018-07-21 13:01:42 +02:00
uint64_t sequence; /**< The sequence number of this sample. */
unsigned length; /**< The number of values in sample::values which are valid. */
unsigned capacity; /**< The number of values in sample::values for which memory is reserved. */
int flags; /**< Flags are used to store binary properties of a sample. */
2019-01-07 10:28:55 +01:00
struct vlist *signals; /**< The list of signal descriptors. */
2019-04-23 13:05:31 +02:00
std::atomic<int> refcnt; /**< Reference counter. */
ptrdiff_t pool_off; /**< This sample belongs to this memory pool (relative pointer). See sample_pool(). */
/** All timestamps are seconds / nano seconds after 1.1.1970 UTC */
struct {
struct timespec origin; /**< The point in time when this data was sampled. */
struct timespec received; /**< The point in time when this data was received. */
} ts;
/** The sample signal values.
*
* This variable length array (VLA) extends over the end of struct sample.
* Make sure that pointers to struct sample point to memory blocks of adequate size.
* Use the SAMPLE_LENGTH() macro to calculate the required size.
*
* Metadata describing the details of signal values (such as name, unit, data type and more)
* are stored in the struct sample::signals list. Each entry in this list corresponedents
* to an entry in the struct sample::data array.
*/
union signal_data data[];
};
#define SAMPLE_NON_POOL PTRDIFF_MIN
/** Get the address of the pool to which the sample belongs. */
2019-06-23 16:58:28 +02:00
#define sample_pool(s) ((s)->pool_off == SAMPLE_NON_POOL ? nullptr : (struct pool *) ((char *) (s) + (s)->pool_off))
struct sample * sample_alloc(struct pool *p);
struct sample * sample_alloc_mem(int capacity);
struct sample * sample_clone(struct sample *smp);
void sample_free(struct sample *s);
2016-10-22 20:47:36 -04:00
/** Request \p cnt samples from memory pool \p p and initialize them.
* The reference count will already be set to 1.
* Use the sample_incref() function to increase it. */
int sample_alloc_many(struct pool *p, struct sample *smps[], int cnt);
2016-10-22 20:47:36 -04:00
/** Release an array of samples back to their pools */
void sample_free_many(struct sample *smps[], int cnt);
/** Increase reference count of sample */
int sample_incref(struct sample *s);
/** Decrease reference count and release memory if last reference was held. */
int sample_decref(struct sample *s);
int sample_copy(struct sample *dst, struct sample *src);
/** Dump all details about a sample to debug log */
2021-02-16 14:15:14 +01:00
void sample_dump(villas::Logger logger, struct sample *s);
2017-09-04 16:19:43 +02:00
/** Compare two samples */
int sample_cmp(struct sample *a, struct sample *b, double epsilon, int flags);
int sample_clone_many(struct sample *clones[], struct sample *origs[], int cnt);
int sample_copy_many(struct sample *dsts[], struct sample *srcs[], int cnt);
int sample_incref_many(struct sample *smps[], int cnt);
int sample_decref_many(struct sample *smps[], int cnt);
2019-06-23 16:13:23 +02:00
enum SignalType sample_format(const struct sample *s, unsigned idx);
2018-08-06 11:26:25 +02:00
void sample_data_insert(struct sample *smp, const union signal_data *src, size_t offset, size_t len);
void sample_data_remove(struct sample *smp, size_t offset, size_t len);