a6dbe3721e
per Intel policy to include file commit date using git cmd below. The policy does not apply to non-Intel (C) notices. git log --follow -C90% --format=%ad --date default <file> | tail -1 and then pull just the 4 digit year from the result. Intel copyrights were not added to files where Intel either had no contribution ot the contribution lacked substance (ie license header updates, formatting changes, etc). Contribution date used "--follow -C95%" to get the most accurate date. Note that several files in this patch didn't end the license/(c) block with a blank comment line so these were added as the vast majority of files do have this last blank line. Simply there for consistency. Signed-off-by: paul luse <paul.e.luse@intel.com> Change-Id: Id5b7ce4f658fe87132f14139ead58d6e285c04d4 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/15192 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> Community-CI: Mellanox Build Bot
129 lines
3.5 KiB
C
129 lines
3.5 KiB
C
/* SPDX-License-Identifier: BSD-3-Clause
|
|
* Copyright (C) 2021 Intel Corporation. All rights reserved.
|
|
*/
|
|
|
|
/**
|
|
* \file
|
|
* Trace parser library
|
|
*/
|
|
|
|
#ifndef SPDK_TRACE_PARSER_H
|
|
#define SPDK_TRACE_PARSER_H
|
|
|
|
#include "spdk/stdinc.h"
|
|
#include "spdk/trace.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/** Trace parser object used as a context for the parsing functions */
|
|
struct spdk_trace_parser;
|
|
|
|
enum spdk_trace_parser_mode {
|
|
/** Regular file */
|
|
SPDK_TRACE_PARSER_MODE_FILE,
|
|
/** Shared memory */
|
|
SPDK_TRACE_PARSER_MODE_SHM,
|
|
};
|
|
|
|
/** Describes trace file and options to use when parsing it */
|
|
struct spdk_trace_parser_opts {
|
|
/** Either file name or shared memory name depending on mode */
|
|
const char *filename;
|
|
/** Trace file type, either regular file or shared memory */
|
|
int mode;
|
|
/** Logical core number to parse the traces from (or SPDK_TRACE_MAX_LCORE) for all cores */
|
|
uint16_t lcore;
|
|
};
|
|
|
|
/**
|
|
* Initialize the parser using a specified trace file. This results in parsing the traces, merging
|
|
* entries from multiple cores together and sorting them by their tsc, so it can take a significant
|
|
* amount of time to complete.
|
|
*
|
|
* \param opts Describes the trace file to parse.
|
|
*
|
|
* \return Parser object or NULL in case of any failures.
|
|
*/
|
|
struct spdk_trace_parser *spdk_trace_parser_init(const struct spdk_trace_parser_opts *opts);
|
|
|
|
/**
|
|
* Free any resources tied to a parser object.
|
|
*
|
|
* \param parser Parser to clean up.
|
|
*/
|
|
void spdk_trace_parser_cleanup(struct spdk_trace_parser *parser);
|
|
|
|
/**
|
|
* Return trace flags describing the traces.
|
|
*
|
|
* \param parser Parser object to be used.
|
|
*
|
|
* \return Pointer to the trace flags.
|
|
*/
|
|
const struct spdk_trace_flags *spdk_trace_parser_get_flags(const struct spdk_trace_parser *parser);
|
|
|
|
/**
|
|
* Return the highest tsc out of first entries across all specified cores. This value can be used
|
|
* to select entries from the subset of time we have the data from all reactors.
|
|
*
|
|
* \param parser Parser object to be used.
|
|
*
|
|
* \return Offset in tsc.
|
|
*/
|
|
uint64_t spdk_trace_parser_get_tsc_offset(const struct spdk_trace_parser *parser);
|
|
|
|
/** Describes a parsed trace entry */
|
|
struct spdk_trace_parser_entry {
|
|
/** Pointer to trace entry */
|
|
struct spdk_trace_entry *entry;
|
|
/**
|
|
* Index of an object this entry is a part of. It's only available for tracepoints with
|
|
* object_type != OBJECT_NONE. If unavailable, it'll be assigned to UINT64_MAX.
|
|
*/
|
|
uint64_t object_index;
|
|
/** The tsc of when the object tied to this entry was created */
|
|
uint64_t object_start;
|
|
/** Logical core number */
|
|
uint16_t lcore;
|
|
/** Related object index */
|
|
uint64_t related_index;
|
|
/** Related object type */
|
|
uint8_t related_type;
|
|
/** Tracepoint arguments */
|
|
union {
|
|
uint64_t integer;
|
|
void *pointer;
|
|
char string[UINT8_MAX + 1];
|
|
} args[SPDK_TRACE_MAX_ARGS_COUNT];
|
|
};
|
|
|
|
/**
|
|
* Return next parsed trace entry. Once no more traces are available, this will return false and
|
|
* entry won't be touched.
|
|
*
|
|
* \param parser Parser object to be used.
|
|
* \param entry Tracepoint entry.
|
|
*
|
|
* \return True if a trace entry was available, false otherwise.
|
|
*/
|
|
bool spdk_trace_parser_next_entry(struct spdk_trace_parser *parser,
|
|
struct spdk_trace_parser_entry *entry);
|
|
|
|
/**
|
|
* Return the number of entries recorded on a given core.
|
|
*
|
|
* \param parser Parser object to be used.
|
|
* \param lcore Logical core number.
|
|
*
|
|
* \return Number of entries.
|
|
*/
|
|
uint64_t spdk_trace_parser_get_entry_count(const struct spdk_trace_parser *parser, uint16_t lcore);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* SPDK_TRACE_PARSER_H */
|