/home/adwe/code/actf/metadata.h

Go to the documentation of this file.

/*
 * This file is a part of ACTF.
 *
 * Copyright (C) 2024  Adam Wendelin <adwe live se>
 *
 * ACTF is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * ACTF 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 Lesser General
 * Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with ACTF. If not, see
 * <https://www.gnu.org/licenses/>.
 */

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

typedef struct actf_metadata actf_metadata;
typedef struct actf_preamble actf_preamble;
typedef struct actf_trace_cls actf_trace_cls;
typedef struct actf_clk_cls actf_clk_cls;
typedef struct actf_clk_origin actf_clk_origin;
typedef struct actf_clk_offset actf_clk_offset;
typedef struct actf_fld_cls_alias actf_fld_cls_alias;
typedef struct actf_dstream_cls actf_dstream_cls;
typedef struct actf_event_cls actf_event_cls;

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,
};
 
/*****************************************************************************/
/*                                  Metadata                                 */
/*****************************************************************************/

actf_metadata *actf_metadata_init(void);

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

int actf_metadata_parse_fd(actf_metadata *metadata, int fd);

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

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

const char *actf_metadata_last_error(actf_metadata *metadata);

void actf_metadata_free(actf_metadata *metadata);
 
/*****************************************************************************/
/*                                  Preamble                                 */
/*****************************************************************************/

const actf_preamble *actf_metadata_preamble(const actf_metadata *metadata);

const struct actf_uuid *actf_preamble_uuid(const actf_preamble *preamble);

const actf_fld *actf_preamble_attributes(const actf_preamble *preamble);

const actf_fld *actf_preamble_extensions(const actf_preamble *preamble);
 
/*****************************************************************************/
/*                                Trace Class                                */
/*****************************************************************************/

const actf_trace_cls *actf_metadata_trace_cls(const actf_metadata *metadata);

const char *actf_trace_cls_namespace(const actf_trace_cls *tc);

const char *actf_trace_cls_name(const actf_trace_cls *tc);

const char *actf_trace_cls_uid(const actf_trace_cls *tc);

const actf_fld_cls *actf_trace_cls_pkt_hdr(const actf_trace_cls *tc);

const actf_fld *actf_trace_cls_environment(const actf_trace_cls *tc);

const actf_fld *actf_trace_cls_attributes(const actf_trace_cls *tc);

const actf_fld *actf_trace_cls_extensions(const actf_trace_cls *tc);
 
/*****************************************************************************/
/*                             Field Class Alias                             */
/*****************************************************************************/

size_t actf_metadata_fld_cls_aliases_len(const actf_metadata *metadata);

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

const char *actf_fld_cls_alias_name(const actf_fld_cls_alias *fc_alias);

const actf_fld_cls *actf_fld_cls_alias_fld_cls(const actf_fld_cls_alias *fc_alias);

const actf_fld *actf_fld_cls_alias_attributes(const actf_fld_cls_alias *fc_alias);

const actf_fld *actf_fld_cls_alias_extensions(const actf_fld_cls_alias *fc_alias);
 
/*****************************************************************************/
/*                                Clock Class                                */
/*****************************************************************************/

size_t actf_metadata_clk_clses_len(const actf_metadata *metadata);

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

const char *actf_clk_cls_id(const actf_clk_cls *clkc);

const char *actf_clk_cls_namespace(const actf_clk_cls *clkc);

const char *actf_clk_cls_name(const actf_clk_cls *clkc);

const char *actf_clk_cls_uid(const actf_clk_cls *clkc);

uint64_t actf_clk_cls_frequency(const actf_clk_cls *clkc);

const actf_clk_origin *actf_clk_cls_origin(const actf_clk_cls *clkc);

const actf_clk_offset *actf_clk_cls_offset(const actf_clk_cls *clkc);

uint64_t actf_clk_cls_precision(const actf_clk_cls *clkc);

bool actf_clk_cls_has_precision(const actf_clk_cls *clkc);

uint64_t actf_clk_cls_accuracy(const struct actf_clk_cls *clkc);

bool actf_clk_cls_has_accuracy(const struct actf_clk_cls *clkc);

const char *actf_clk_cls_description(const actf_clk_cls *clkc);

const actf_fld *actf_clk_cls_attributes(const actf_clk_cls *clkc);

const actf_fld *actf_clk_cls_extensions(const actf_clk_cls *clkc);

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

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

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

enum actf_clk_origin_type actf_clk_origin_type(const actf_clk_origin *origin);

const char *actf_clk_origin_custom_namespace(const actf_clk_origin *origin);

const char *actf_clk_origin_custom_name(const actf_clk_origin *origin);

const char *actf_clk_origin_custom_uid(const actf_clk_origin *origin);

int64_t actf_clk_offset_seconds(const actf_clk_offset *offset);

uint64_t actf_clk_offset_cycles(const actf_clk_offset *offset);
 
/*****************************************************************************/
/*                             Data Stream Class                             */
/*****************************************************************************/

size_t actf_metadata_dstream_clses_len(const actf_metadata *metadata);

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

uint64_t actf_dstream_cls_id(const actf_dstream_cls *dsc);

const char *actf_dstream_cls_namespace(const actf_dstream_cls *dsc);

const char *actf_dstream_cls_name(const actf_dstream_cls *dsc);

const char *actf_dstream_cls_uid(const actf_dstream_cls *dsc);

const char *actf_dstream_cls_clk_cls_id(const actf_dstream_cls *dsc);

const actf_clk_cls *actf_dstream_cls_clk_cls(const actf_dstream_cls *dsc);

const actf_fld_cls *actf_dstream_cls_pkt_ctx(const actf_dstream_cls *dsc);

const actf_fld_cls *actf_dstream_cls_event_hdr(const actf_dstream_cls *dsc);

const actf_fld_cls *actf_dstream_cls_event_common_ctx(const actf_dstream_cls *dsc);

const actf_fld *actf_dstream_cls_attributes(const actf_dstream_cls *dsc);

const actf_fld *actf_dstream_cls_extensions(const actf_dstream_cls *dsc);

size_t actf_dstream_cls_event_clses_len(const actf_dstream_cls *dsc);

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

const actf_metadata *actf_dstream_cls_metadata(const actf_dstream_cls *dsc);
 
/*****************************************************************************/
/*                             Event Record Class                            */
/*****************************************************************************/

uint64_t actf_event_cls_id(const actf_event_cls *evc);

uint64_t actf_event_cls_dstream_cls_id(const actf_event_cls *evc);

const actf_dstream_cls *actf_event_cls_dstream_cls(const actf_event_cls *evc);

const char *actf_event_cls_namespace(const actf_event_cls *evc);

const char *actf_event_cls_name(const actf_event_cls *evc);

const char *actf_event_cls_uid(const actf_event_cls *evc);

const actf_fld_cls *actf_event_cls_spec_ctx(const actf_event_cls *evc);

const actf_fld_cls *actf_event_cls_payload(const actf_event_cls *evc);

const actf_fld *actf_event_cls_attributes(const actf_event_cls *evc);

const actf_fld *actf_event_cls_extensions(const actf_event_cls *evc);
 
#endif /* ACTF_METADATA_H */