A CTF2 metadata representation. More...

#include <stdbool.h>
#include <stdint.h>
#include <unistd.h>
#include "fld.h"
#include "fld_cls.h"
#include "types.h"

Typedefs
typedef struct actf_metadata	actf_metadata
	A CTF2 metadata.
typedef struct actf_preamble	actf_preamble
	A preamble.
typedef struct actf_trace_cls	actf_trace_cls
	A trace class.
typedef struct actf_clk_cls	actf_clk_cls
	A clock class.
typedef struct actf_clk_origin	actf_clk_origin
	A clock class origin.
typedef struct actf_clk_offset	actf_clk_offset
	A clock class offset.
typedef struct actf_fld_cls_alias	actf_fld_cls_alias
	A field class alias.
typedef struct actf_dstream_cls	actf_dstream_cls
	A data stream class.
typedef struct actf_event_cls	actf_event_cls
	An event class.

Enumerations
enum	actf_clk_origin_type { ACTF_CLK_ORIGIN_TYPE_NONE , ACTF_CLK_ORIGIN_TYPE_UNIX_EPOCH , ACTF_CLK_ORIGIN_TYPE_CUSTOM , ACTF_CLK_ORIGIN_N_TYPES }
	Clock origin types.

Functions
actf_metadata *	actf_metadata_init (void)
	Initialize a metadata.
int	actf_metadata_parse_file (actf_metadata metadata, const char path)
	Parse the metadata of a file.
int	actf_metadata_parse_fd (actf_metadata *metadata, int fd)
	Parse the metadata from a file descriptor.
int	actf_metadata_parse (actf_metadata metadata, const char str)
	Parse the metadata from a string.
int	actf_metadata_nparse (struct actf_metadata metadata, const char str, size_t len)
	Parse the metadata from a string with explicit length.
const char *	actf_metadata_last_error (actf_metadata *metadata)
	Get the last error message of the metadata A metadata method returning an error can store an error message which is returned by this function.
void	actf_metadata_free (actf_metadata *metadata)
	Free a metadata.
const actf_preamble *	actf_metadata_preamble (const actf_metadata *metadata)
	Get the preamble of a metadata.
const struct actf_uuid *	actf_preamble_uuid (const actf_preamble *preamble)
	Get the UUID of a preamble.
const actf_fld *	actf_preamble_attributes (const actf_preamble *preamble)
	Get the attributes of a preamble.
const actf_fld *	actf_preamble_extensions (const actf_preamble *preamble)
	Get the extensions of a preamble.
const actf_trace_cls *	actf_metadata_trace_cls (const actf_metadata *metadata)
	Get the trace class of a metadata.
const char *	actf_trace_cls_namespace (const actf_trace_cls *tc)
	Get the namespace of a trace class.
const char *	actf_trace_cls_name (const actf_trace_cls *tc)
	Get the name of a trace class.
const char *	actf_trace_cls_uid (const actf_trace_cls *tc)
	Get the uid of a trace class.
const actf_fld_cls *	actf_trace_cls_pkt_hdr (const actf_trace_cls *tc)
	Get the packet header field class of a trace class.
const actf_fld *	actf_trace_cls_environment (const actf_trace_cls *tc)
	Get the environment of a trace class.
const actf_fld *	actf_trace_cls_attributes (const actf_trace_cls *tc)
	Get the attributes of a trace class.
const actf_fld *	actf_trace_cls_extensions (const actf_trace_cls *tc)
	Get the extensions of a trace class.
size_t	actf_metadata_fld_cls_aliases_len (const actf_metadata *metadata)
	Get the number of field class aliases of the metadata.
const actf_fld_cls_alias *	actf_metadata_fld_cls_aliases_idx (const actf_metadata *metadata, size_t i)
	Get the ith field class alias of the metadata.
const char *	actf_fld_cls_alias_name (const actf_fld_cls_alias *fc_alias)
	Get the field class alias name.
const actf_fld_cls *	actf_fld_cls_alias_fld_cls (const actf_fld_cls_alias *fc_alias)
	Get the aliased field class of a field class alias.
const actf_fld *	actf_fld_cls_alias_attributes (const actf_fld_cls_alias *fc_alias)
	Get the field class alias attributes.
const actf_fld *	actf_fld_cls_alias_extensions (const actf_fld_cls_alias *fc_alias)
	Get the field class alias extensions.
size_t	actf_metadata_clk_clses_len (const actf_metadata *metadata)
	Get the number of clock classes of the metadata.
const actf_clk_cls *	actf_metadata_clk_clses_idx (const actf_metadata *metadata, size_t i)
	Get the ith clock class of the metadata.
const char *	actf_clk_cls_id (const actf_clk_cls *clkc)
	Get the clock class id.
const char *	actf_clk_cls_namespace (const actf_clk_cls *clkc)
	Get the clock class namespace.
const char *	actf_clk_cls_name (const actf_clk_cls *clkc)
	Get the clock class name.
const char *	actf_clk_cls_uid (const actf_clk_cls *clkc)
	Get the clock class uid.
uint64_t	actf_clk_cls_frequency (const actf_clk_cls *clkc)
	Get the clock class frequency.
const actf_clk_origin *	actf_clk_cls_origin (const actf_clk_cls *clkc)
	Get the clock class origin.
const actf_clk_offset *	actf_clk_cls_offset (const actf_clk_cls *clkc)
	Get the clock class offset.
uint64_t	actf_clk_cls_precision (const actf_clk_cls *clkc)
	Get the clock class precision.
bool	actf_clk_cls_has_precision (const actf_clk_cls *clkc)
	Check whether the clock class has a precision.
uint64_t	actf_clk_cls_accuracy (const struct actf_clk_cls *clkc)
	Get the clock class accuracy.
bool	actf_clk_cls_has_accuracy (const struct actf_clk_cls *clkc)
	Check whether the clock class has an accuracy.
const char *	actf_clk_cls_description (const actf_clk_cls *clkc)
	Get the clock class description.
const actf_fld *	actf_clk_cls_attributes (const actf_clk_cls *clkc)
	Get the clock class attributes.
const actf_fld *	actf_clk_cls_extensions (const actf_clk_cls *clkc)
	Get the clock class extensions.
bool	actf_clk_cls_eq_identities (const struct actf_clk_cls clkc1, const struct actf_clk_cls clkc2)
	Check whether two clock classes have the same identity.
bool	actf_clk_cls_eq_identities_strict (const struct actf_clk_cls clkc1, const struct actf_clk_cls clkc2)
	Check whether two clock classes have the same identity in a stricter fashion than actf_clk_cls_eq_identities().
int64_t	actf_clk_cls_cc_to_ns_from_origin (const struct actf_clk_cls *clkc, uint64_t tstamp_cc)
	Convert a timestamp in cycles to nanoseconds from origin.
enum actf_clk_origin_type	actf_clk_origin_type (const actf_clk_origin *origin)
	Get the clock origin type.
const char *	actf_clk_origin_custom_namespace (const actf_clk_origin *origin)
	Get the clock origin custom namespace.
const char *	actf_clk_origin_custom_name (const actf_clk_origin *origin)
	Get the clock origin custom name.
const char *	actf_clk_origin_custom_uid (const actf_clk_origin *origin)
	Get the clock origin custom uid.
int64_t	actf_clk_offset_seconds (const actf_clk_offset *offset)
	Get the seconds component of the clock offset.
uint64_t	actf_clk_offset_cycles (const actf_clk_offset *offset)
	Get the cycles component of the clock offset.
size_t	actf_metadata_dstream_clses_len (const actf_metadata *metadata)
	Get the number of data stream classes of the metadata.
const actf_dstream_cls *	actf_metadata_dstream_clses_next (const actf_metadata metadata, actf_it it)
	Iterate over the data stream classes.
uint64_t	actf_dstream_cls_id (const actf_dstream_cls *dsc)
	Get the data stream class id.
const char *	actf_dstream_cls_namespace (const actf_dstream_cls *dsc)
	Get the data stream class namespace.
const char *	actf_dstream_cls_name (const actf_dstream_cls *dsc)
	Get the data stream class name.
const char *	actf_dstream_cls_uid (const actf_dstream_cls *dsc)
	Get the data stream class uid.
const char *	actf_dstream_cls_clk_cls_id (const actf_dstream_cls *dsc)
	Get the data stream class clock class id.
const actf_clk_cls *	actf_dstream_cls_clk_cls (const actf_dstream_cls *dsc)
	Get the data stream class clock class.
const actf_fld_cls *	actf_dstream_cls_pkt_ctx (const actf_dstream_cls *dsc)
	Get the data stream class packet context.
const actf_fld_cls *	actf_dstream_cls_event_hdr (const actf_dstream_cls *dsc)
	Get the data stream class event header.
const actf_fld_cls *	actf_dstream_cls_event_common_ctx (const actf_dstream_cls *dsc)
	Get the data stream class event common context.
const actf_fld *	actf_dstream_cls_attributes (const actf_dstream_cls *dsc)
	Get the data stream class attributes.
const actf_fld *	actf_dstream_cls_extensions (const actf_dstream_cls *dsc)
	Get the data stream class extensions.
size_t	actf_dstream_cls_event_clses_len (const actf_dstream_cls *dsc)
	Get the number of event classes of the data stream class.
const actf_event_cls *	actf_dstream_cls_event_clses_next (const actf_dstream_cls dsc, actf_it it)
	Iterate over the event classes.
const actf_metadata *	actf_dstream_cls_metadata (const actf_dstream_cls *dsc)
	Get the metadata of the data stream class.
uint64_t	actf_event_cls_id (const actf_event_cls *evc)
	Get the event class id.
uint64_t	actf_event_cls_dstream_cls_id (const actf_event_cls *evc)
	Get the event class data stream class id.
const actf_dstream_cls *	actf_event_cls_dstream_cls (const actf_event_cls *evc)
	Get the event class data stream class.
const char *	actf_event_cls_namespace (const actf_event_cls *evc)
	Get the event class namespace.
const char *	actf_event_cls_name (const actf_event_cls *evc)
	Get the event class name.
const char *	actf_event_cls_uid (const actf_event_cls *evc)
	Get the event class uid.
const actf_fld_cls *	actf_event_cls_spec_ctx (const actf_event_cls *evc)
	Get the event class specific context.
const actf_fld_cls *	actf_event_cls_payload (const actf_event_cls *evc)
	Get the event class payload.
const actf_fld *	actf_event_cls_attributes (const actf_event_cls *evc)
	Get the event class attributes.
const actf_fld *	actf_event_cls_extensions (const actf_event_cls *evc)
	Get the event class extensions.

Detailed Description

A CTF2 metadata representation.

Provides metadata based on the CTF2-SPEC-2.0rA specification: https://diamon.org/ctf/files/CTF2-SPEC-2.0rA.html

How events and packets are linked to metadata-classes:

* event --> event class --> data stream class --> clock class
*                                            \--> metadata
*
* packet --> data stream class --> clock class
*                             \--> metadata
*

Function Documentation

◆ actf_metadata_init()

actf_metadata * actf_metadata_init ( void )

Initialize a metadata.

Returns: a metadata or NULL with errno set. A returned metadata should be freed with actf_metadata_free().

◆ actf_metadata_parse_file()

int actf_metadata_parse_file	(	actf_metadata *	metadata,
		const char *	path )

Parse the metadata of a file.

Parameters

metadata	the metadata
path	the path to a file containing metadata.

Returns: ACTF_OK on success or an error code. On error, see actf_metadata_last_error().

◆ actf_metadata_parse_fd()

int actf_metadata_parse_fd	(	actf_metadata *	metadata,
		int	fd )

Parse the metadata from a file descriptor.

Parameters

metadata	the metadata
fd	the fd to read for metadata.

Returns: ACTF_OK on success or an error code. On error, see actf_metadata_last_error().

◆ actf_metadata_parse()

int actf_metadata_parse	(	actf_metadata *	metadata,
		const char *	str )

Parse the metadata from a string.

Parameters

metadata	the metadata
str	the string containing metadata. Must be null-terminated.

Returns: ACTF_OK on success or an error code. On error, see actf_metadata_last_error().

◆ actf_metadata_nparse()

int actf_metadata_nparse	(	struct actf_metadata *	metadata,
		const char *	str,
		size_t	len )

Parse the metadata from a string with explicit length.

Parameters

metadata	the metadata
str	the string containing metadata. No null-termination needed.
len	the length of the string

Returns: ACTF_OK on success or an error code. On error, see actf_metadata_last_error().

◆ actf_metadata_last_error()

const char * actf_metadata_last_error ( actf_metadata * metadata )

Get the last error message of the metadata A metadata method returning an error can store an error message which is returned by this function.

The returned string's memory is handled internally and should not be freed, and it might be overwritten or freed on subsequent API calls.

Parameters

metadata the metadata

Returns: the last error message or NULL

◆ actf_metadata_free()

void actf_metadata_free ( actf_metadata * metadata )

Free a metadata.

Parameters

metadata the metadata

◆ actf_metadata_preamble()

const actf_preamble * actf_metadata_preamble ( const actf_metadata * metadata )

Get the preamble of a metadata.

Parameters

metadata the metadata

Returns: the preamble

◆ actf_preamble_uuid()

const struct actf_uuid * actf_preamble_uuid ( const actf_preamble * preamble )

Get the UUID of a preamble.

Parameters

preamble the preamble

Returns: the UUID

◆ actf_preamble_attributes()

const actf_fld * actf_preamble_attributes ( const actf_preamble * preamble )

Get the attributes of a preamble.

Parameters

preamble the preamble

Returns: the attributes

◆ actf_preamble_extensions()

const actf_fld * actf_preamble_extensions ( const actf_preamble * preamble )

Get the extensions of a preamble.

Parameters

preamble the preamble

Returns: the extensions

◆ actf_metadata_trace_cls()

const actf_trace_cls * actf_metadata_trace_cls ( const actf_metadata * metadata )

Get the trace class of a metadata.

Parameters

metadata the metadata

Returns: the trace class

◆ actf_trace_cls_namespace()

const char * actf_trace_cls_namespace ( const actf_trace_cls * tc )

Get the namespace of a trace class.

Parameters

tc	the trace class

Returns: the namespace

◆ actf_trace_cls_name()

const char * actf_trace_cls_name ( const actf_trace_cls * tc )

Get the name of a trace class.

Parameters

tc	the trace class

Returns: the name

◆ actf_trace_cls_uid()

const char * actf_trace_cls_uid ( const actf_trace_cls * tc )

Get the uid of a trace class.

Parameters

tc	the trace class

Returns: the uid

◆ actf_trace_cls_pkt_hdr()

const actf_fld_cls * actf_trace_cls_pkt_hdr ( const actf_trace_cls * tc )

Get the packet header field class of a trace class.

Parameters

tc	the trace class

Returns: the packet header field class

◆ actf_trace_cls_environment()

const actf_fld * actf_trace_cls_environment ( const actf_trace_cls * tc )

Get the environment of a trace class.

Parameters

tc	the trace class

Returns: the environment

◆ actf_trace_cls_attributes()

const actf_fld * actf_trace_cls_attributes ( const actf_trace_cls * tc )

Get the attributes of a trace class.

Parameters

tc	the trace class

Returns: the attributes

◆ actf_trace_cls_extensions()

const actf_fld * actf_trace_cls_extensions ( const actf_trace_cls * tc )

Get the extensions of a trace class.

Parameters

tc	the trace class

Returns: the extensions

◆ actf_metadata_fld_cls_aliases_len()

size_t actf_metadata_fld_cls_aliases_len ( const actf_metadata * metadata )

Get the number of field class aliases of the metadata.

Parameters

metadata the metadata

Returns: the number of field class aliases

◆ actf_metadata_fld_cls_aliases_idx()

const actf_fld_cls_alias * actf_metadata_fld_cls_aliases_idx	(	const actf_metadata *	metadata,
		size_t	i )

Get the ith field class alias of the metadata.

Parameters

metadata	the metadata
i	the index

Returns: the field class alias

◆ actf_fld_cls_alias_name()

const char * actf_fld_cls_alias_name ( const actf_fld_cls_alias * fc_alias )

Get the field class alias name.

Parameters

fc_alias the field class alias

Returns: the name

◆ actf_fld_cls_alias_fld_cls()

const actf_fld_cls * actf_fld_cls_alias_fld_cls ( const actf_fld_cls_alias * fc_alias )

Get the aliased field class of a field class alias.

Parameters

fc_alias the field class alias

Returns: the aliased field class

◆ actf_fld_cls_alias_attributes()

const actf_fld * actf_fld_cls_alias_attributes ( const actf_fld_cls_alias * fc_alias )

Get the field class alias attributes.

Parameters

fc_alias the field class alias

Returns: the attributes

◆ actf_fld_cls_alias_extensions()

const actf_fld * actf_fld_cls_alias_extensions ( const actf_fld_cls_alias * fc_alias )

Get the field class alias extensions.

Parameters

fc_alias the field class alias

Returns: the extensions

◆ actf_metadata_clk_clses_len()

size_t actf_metadata_clk_clses_len ( const actf_metadata * metadata )

Get the number of clock classes of the metadata.

Parameters

metadata the metadata

Returns: the number of clock classes

◆ actf_metadata_clk_clses_idx()

const actf_clk_cls * actf_metadata_clk_clses_idx	(	const actf_metadata *	metadata,
		size_t	i )

Get the ith clock class of the metadata.

Parameters

metadata	the metadata
i	the index

Returns: the clock class

◆ actf_clk_cls_id()

const char * actf_clk_cls_id ( const actf_clk_cls * clkc )

Get the clock class id.

Parameters

clkc	the clock class

Returns: the id

◆ actf_clk_cls_namespace()

const char * actf_clk_cls_namespace ( const actf_clk_cls * clkc )

Get the clock class namespace.

Parameters

clkc	the clock class

Returns: the namespace

◆ actf_clk_cls_name()

const char * actf_clk_cls_name ( const actf_clk_cls * clkc )

Get the clock class name.

Parameters

clkc	the clock class

Returns: the name

◆ actf_clk_cls_uid()

const char * actf_clk_cls_uid ( const actf_clk_cls * clkc )

Get the clock class uid.

Parameters

clkc	the clock class

Returns: the uid

◆ actf_clk_cls_frequency()

uint64_t actf_clk_cls_frequency ( const actf_clk_cls * clkc )

Get the clock class frequency.

Parameters

clkc	the clock class

Returns: the frequency

◆ actf_clk_cls_origin()

const actf_clk_origin * actf_clk_cls_origin ( const actf_clk_cls * clkc )

Get the clock class origin.

Parameters

clkc	the clock class

Returns: the origin

◆ actf_clk_cls_offset()

const actf_clk_offset * actf_clk_cls_offset ( const actf_clk_cls * clkc )

Get the clock class offset.

Parameters

clkc	the clock class

Returns: the offset

◆ actf_clk_cls_precision()

uint64_t actf_clk_cls_precision ( const actf_clk_cls * clkc )

Get the clock class precision.

Parameters

clkc	the clock class

Returns: the precision or zero if no specified precision

◆ actf_clk_cls_has_precision()

bool actf_clk_cls_has_precision ( const actf_clk_cls * clkc )

Check whether the clock class has a precision.

Parameters

clkc	the clock class

Returns: true if the clock class has a precision

◆ actf_clk_cls_accuracy()

uint64_t actf_clk_cls_accuracy ( const struct actf_clk_cls * clkc )

Get the clock class accuracy.

Parameters

clkc	the clock class

Returns: the accuracy or zero if no specified accuracy

◆ actf_clk_cls_has_accuracy()

bool actf_clk_cls_has_accuracy ( const struct actf_clk_cls * clkc )

Check whether the clock class has an accuracy.

Parameters

clkc	the clock class

Returns: true if the clock class has an accuracy

◆ actf_clk_cls_description()

const char * actf_clk_cls_description ( const actf_clk_cls * clkc )

Get the clock class description.

Parameters

clkc	the clock class

Returns: the description

◆ actf_clk_cls_attributes()

const actf_fld * actf_clk_cls_attributes ( const actf_clk_cls * clkc )

Get the clock class attributes.

Parameters

clkc	the clock class

Returns: the attributes

◆ actf_clk_cls_extensions()

const actf_fld * actf_clk_cls_extensions ( const actf_clk_cls * clkc )

Get the clock class extensions.

Parameters

clkc	the clock class

Returns: the extensions

◆ actf_clk_cls_eq_identities()

bool actf_clk_cls_eq_identities	(	const struct actf_clk_cls *	clkc1,
		const struct actf_clk_cls *	clkc2 )

Check whether two clock classes have the same identity.

Two clock classes have the same identity if namespace, name and uid are equal.

Parameters

clkc1	the clock class 1
clkc2	the clock class 2

Returns: whether the identities are equal

◆ actf_clk_cls_eq_identities_strict()

bool actf_clk_cls_eq_identities_strict	(	const struct actf_clk_cls *	clkc1,
		const struct actf_clk_cls *	clkc2 )

Check whether two clock classes have the same identity in a stricter fashion than actf_clk_cls_eq_identities().

Two clock classes have the same identity if namespace, name and uid are equal. In addition, this function verifies that the frequency, precision, accuracy and origin are equal.

Parameters

clkc1	the clock class 1
clkc2	the clock class 2

Returns: whether the identities and specified fields are equal.

◆ actf_clk_cls_cc_to_ns_from_origin()

int64_t actf_clk_cls_cc_to_ns_from_origin	(	const struct actf_clk_cls *	clkc,
		uint64_t	tstamp_cc )

Convert a timestamp in cycles to nanoseconds from origin.

Parameters

clkc	the clock class
tstamp_cc	the timestamp in cycles

Returns: timestamp in nanosecond from origin

◆ actf_clk_origin_type()

enum actf_clk_origin_type actf_clk_origin_type ( const actf_clk_origin * origin )

Get the clock origin type.

Parameters

origin the clock origin

Returns: the type

◆ actf_clk_origin_custom_namespace()

const char * actf_clk_origin_custom_namespace ( const actf_clk_origin * origin )

Get the clock origin custom namespace.

Parameters

origin the clock origin of type ACTF_CLK_ORIGIN_TYPE_CUSTOM

Returns: the namespace

◆ actf_clk_origin_custom_name()

const char * actf_clk_origin_custom_name ( const actf_clk_origin * origin )

Get the clock origin custom name.

Parameters

origin the clock origin of type ACTF_CLK_ORIGIN_TYPE_CUSTOM

Returns: the name

◆ actf_clk_origin_custom_uid()

const char * actf_clk_origin_custom_uid ( const actf_clk_origin * origin )

Get the clock origin custom uid.

Parameters

origin the clock origin of type ACTF_CLK_ORIGIN_TYPE_CUSTOM

Returns: the uid

◆ actf_clk_offset_seconds()

int64_t actf_clk_offset_seconds ( const actf_clk_offset * offset )

Get the seconds component of the clock offset.

Parameters

offset the clock offset

Returns: the seconds

◆ actf_clk_offset_cycles()

uint64_t actf_clk_offset_cycles ( const actf_clk_offset * offset )

Get the cycles component of the clock offset.

Parameters

offset the clock offset

Returns: the cycles

◆ actf_metadata_dstream_clses_len()

size_t actf_metadata_dstream_clses_len ( const actf_metadata * metadata )

Get the number of data stream classes of the metadata.

Parameters

metadata the metadata

Returns: the number of data stream classes

◆ actf_metadata_dstream_clses_next()

const actf_dstream_cls * actf_metadata_dstream_clses_next	(	const actf_metadata *	metadata,
		actf_it *	it )

Iterate over the data stream classes.

Parameters

metadata	the metadata
it	the iterator to use, it must be zero initialized on the first call and then unmodified for subsequent calls.

Returns: the data stream class or NULL if no more

◆ actf_dstream_cls_id()

uint64_t actf_dstream_cls_id ( const actf_dstream_cls * dsc )

Get the data stream class id.

Parameters

dsc	the data stream class

Returns: the id

◆ actf_dstream_cls_namespace()

const char * actf_dstream_cls_namespace ( const actf_dstream_cls * dsc )

Get the data stream class namespace.

Parameters

dsc	the data stream class

Returns: the namespace

◆ actf_dstream_cls_name()

const char * actf_dstream_cls_name ( const actf_dstream_cls * dsc )

Get the data stream class name.

Parameters

dsc	the data stream class

Returns: the name

◆ actf_dstream_cls_uid()

const char * actf_dstream_cls_uid ( const actf_dstream_cls * dsc )

Get the data stream class uid.

Parameters

dsc	the data stream class

Returns: the uid

◆ actf_dstream_cls_clk_cls_id()

const char * actf_dstream_cls_clk_cls_id ( const actf_dstream_cls * dsc )

Get the data stream class clock class id.

Parameters

dsc	the data stream class

Returns: the clock class id

◆ actf_dstream_cls_clk_cls()

const actf_clk_cls * actf_dstream_cls_clk_cls ( const actf_dstream_cls * dsc )

Get the data stream class clock class.

Parameters

dsc	the data stream class

Returns: the clock class

◆ actf_dstream_cls_pkt_ctx()

const actf_fld_cls * actf_dstream_cls_pkt_ctx ( const actf_dstream_cls * dsc )

Get the data stream class packet context.

Parameters

dsc	the data stream class

Returns: the packet context

◆ actf_dstream_cls_event_hdr()

const actf_fld_cls * actf_dstream_cls_event_hdr ( const actf_dstream_cls * dsc )

Get the data stream class event header.

Parameters

dsc	the data stream class

Returns: the event header

◆ actf_dstream_cls_event_common_ctx()

const actf_fld_cls * actf_dstream_cls_event_common_ctx ( const actf_dstream_cls * dsc )

Get the data stream class event common context.

Parameters

dsc	the data stream class

Returns: the event common context

◆ actf_dstream_cls_attributes()

const actf_fld * actf_dstream_cls_attributes ( const actf_dstream_cls * dsc )

Get the data stream class attributes.

Parameters

dsc	the data stream class

Returns: the attributes

◆ actf_dstream_cls_extensions()

const actf_fld * actf_dstream_cls_extensions ( const actf_dstream_cls * dsc )

Get the data stream class extensions.

Parameters

dsc	the data stream class

Returns: the extensions

◆ actf_dstream_cls_event_clses_len()

size_t actf_dstream_cls_event_clses_len ( const actf_dstream_cls * dsc )

Get the number of event classes of the data stream class.

Parameters

dsc	the data stream class

Returns: the number of event classes

◆ actf_dstream_cls_event_clses_next()

const actf_event_cls * actf_dstream_cls_event_clses_next	(	const actf_dstream_cls *	dsc,
		actf_it *	it )

Iterate over the event classes.

Parameters

dsc	the data stream class
it	the iterator to use, it must be zero initialized on the first call and then unmodified for subsequent calls.

Returns: the event class or NULL if no more

◆ actf_dstream_cls_metadata()

const actf_metadata * actf_dstream_cls_metadata ( const actf_dstream_cls * dsc )

Get the metadata of the data stream class.

Parameters

dsc	the data stream class

Returns: the metadata

◆ actf_event_cls_id()

uint64_t actf_event_cls_id ( const actf_event_cls * evc )

Get the event class id.

Parameters

evc	the event class

Returns: the id

◆ actf_event_cls_dstream_cls_id()

uint64_t actf_event_cls_dstream_cls_id ( const actf_event_cls * evc )

Get the event class data stream class id.

Parameters

evc	the event class

Returns: the data stream class id

◆ actf_event_cls_dstream_cls()

const actf_dstream_cls * actf_event_cls_dstream_cls ( const actf_event_cls * evc )

Get the event class data stream class.

Parameters

evc	the event class

Returns: the data stream class

◆ actf_event_cls_namespace()

const char * actf_event_cls_namespace ( const actf_event_cls * evc )

Get the event class namespace.

Parameters

evc	the event class

Returns: the namespace

◆ actf_event_cls_name()

const char * actf_event_cls_name ( const actf_event_cls * evc )

Get the event class name.

Parameters

evc	the event class

Returns: the name

◆ actf_event_cls_uid()

const char * actf_event_cls_uid ( const actf_event_cls * evc )

Get the event class uid.

Parameters

evc	the event class

Returns: the uid

◆ actf_event_cls_spec_ctx()

const actf_fld_cls * actf_event_cls_spec_ctx ( const actf_event_cls * evc )

Get the event class specific context.

Parameters

evc	the event class

Returns: the specific context

◆ actf_event_cls_payload()

const actf_fld_cls * actf_event_cls_payload ( const actf_event_cls * evc )

Get the event class payload.

Parameters

evc	the event class

Returns: the payload

◆ actf_event_cls_attributes()

const actf_fld * actf_event_cls_attributes ( const actf_event_cls * evc )

Get the event class attributes.

Parameters

evc	the event class

Returns: the attributes

◆ actf_event_cls_extensions()

const actf_fld * actf_event_cls_extensions ( const actf_event_cls * evc )

Get the event class extensions.

Parameters

evc	the event class

Returns: the extensions

Typedefs

Enumerations

Functions

Detailed Description

Function Documentation

◆ actf_metadata_init()

◆ actf_metadata_parse_file()

◆ actf_metadata_parse_fd()

◆ actf_metadata_parse()

◆ actf_metadata_nparse()

◆ actf_metadata_last_error()

◆ actf_metadata_free()

◆ actf_metadata_preamble()

◆ actf_preamble_uuid()

◆ actf_preamble_attributes()

◆ actf_preamble_extensions()

◆ actf_metadata_trace_cls()

◆ actf_trace_cls_namespace()

◆ actf_trace_cls_name()

◆ actf_trace_cls_uid()

◆ actf_trace_cls_pkt_hdr()

◆ actf_trace_cls_environment()

◆ actf_trace_cls_attributes()

◆ actf_trace_cls_extensions()

◆ actf_metadata_fld_cls_aliases_len()

◆ actf_metadata_fld_cls_aliases_idx()

◆ actf_fld_cls_alias_name()

◆ actf_fld_cls_alias_fld_cls()

◆ actf_fld_cls_alias_attributes()

◆ actf_fld_cls_alias_extensions()

◆ actf_metadata_clk_clses_len()

◆ actf_metadata_clk_clses_idx()

◆ actf_clk_cls_id()

◆ actf_clk_cls_namespace()

◆ actf_clk_cls_name()

◆ actf_clk_cls_uid()

◆ actf_clk_cls_frequency()

◆ actf_clk_cls_origin()

◆ actf_clk_cls_offset()

◆ actf_clk_cls_precision()

◆ actf_clk_cls_has_precision()

◆ actf_clk_cls_accuracy()

◆ actf_clk_cls_has_accuracy()

◆ actf_clk_cls_description()

◆ actf_clk_cls_attributes()

◆ actf_clk_cls_extensions()

◆ actf_clk_cls_eq_identities()

◆ actf_clk_cls_eq_identities_strict()

◆ actf_clk_cls_cc_to_ns_from_origin()

◆ actf_clk_origin_type()

◆ actf_clk_origin_custom_namespace()

◆ actf_clk_origin_custom_name()

◆ actf_clk_origin_custom_uid()

◆ actf_clk_offset_seconds()

◆ actf_clk_offset_cycles()

◆ actf_metadata_dstream_clses_len()

◆ actf_metadata_dstream_clses_next()

◆ actf_dstream_cls_id()

◆ actf_dstream_cls_namespace()

◆ actf_dstream_cls_name()

◆ actf_dstream_cls_uid()

◆ actf_dstream_cls_clk_cls_id()

◆ actf_dstream_cls_clk_cls()

◆ actf_dstream_cls_pkt_ctx()

◆ actf_dstream_cls_event_hdr()

◆ actf_dstream_cls_event_common_ctx()

◆ actf_dstream_cls_attributes()

◆ actf_dstream_cls_extensions()

◆ actf_dstream_cls_event_clses_len()

◆ actf_dstream_cls_event_clses_next()

◆ actf_dstream_cls_metadata()

◆ actf_event_cls_id()

◆ actf_event_cls_dstream_cls_id()

◆ actf_event_cls_dstream_cls()

◆ actf_event_cls_namespace()

◆ actf_event_cls_name()

◆ actf_event_cls_uid()

◆ actf_event_cls_spec_ctx()

◆ actf_event_cls_payload()

◆ actf_event_cls_attributes()