diff --git a/include/spdk/trace_parser.h b/include/spdk/trace_parser.h new file mode 100644 index 000000000..3aefd9f55 --- /dev/null +++ b/include/spdk/trace_parser.h @@ -0,0 +1,90 @@ +/*- + * BSD LICENSE + * + * Copyright (c) Intel Corporation. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * * Neither the name of Intel Corporation nor the names of its + * contributors may be used to endorse or promote products derived + * from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** + * \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); + +#ifdef __cplusplus +} +#endif + +#endif /* SPDK_TRACE_PARSER_H */ diff --git a/lib/Makefile b/lib/Makefile index 78a27bba2..197fc63a6 100644 --- a/lib/Makefile +++ b/lib/Makefile @@ -37,7 +37,7 @@ include $(SPDK_ROOT_DIR)/mk/spdk.lib_deps.mk DIRS-y += bdev blob blobfs conf dma accel event json jsonrpc \ log lvol rpc sock thread trace util nvme vmd nvmf scsi \ - ioat ut_mock iscsi notify init + ioat ut_mock iscsi notify init trace_parser ifeq ($(OS),Linux) DIRS-y += nbd ftl endif diff --git a/lib/trace_parser/Makefile b/lib/trace_parser/Makefile new file mode 100644 index 000000000..67690cc70 --- /dev/null +++ b/lib/trace_parser/Makefile @@ -0,0 +1,47 @@ +# +# BSD LICENSE +# +# Copyright (c) Intel Corporation. +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# * Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in +# the documentation and/or other materials provided with the +# distribution. +# * Neither the name of Intel Corporation nor the names of its +# contributors may be used to endorse or promote products derived +# from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# + +SPDK_ROOT_DIR := $(abspath $(CURDIR)/../..) + +include $(SPDK_ROOT_DIR)/mk/spdk.common.mk + +SO_VER := 1 +SO_MINOR := 0 + +CXX_SRCS = trace.cpp +LIBNAME = trace_parser +LOCAL_SYS_LIBS = -lrt + +SPDK_MAP_FILE = $(abspath $(CURDIR)/spdk_trace_parser.map) + +include $(SPDK_ROOT_DIR)/mk/spdk.lib.mk diff --git a/lib/trace_parser/spdk_trace_parser.map b/lib/trace_parser/spdk_trace_parser.map new file mode 100644 index 000000000..1f1c1c569 --- /dev/null +++ b/lib/trace_parser/spdk_trace_parser.map @@ -0,0 +1,9 @@ +{ + global: + + # public functions + spdk_trace_parser_init; + spdk_trace_parser_cleanup; + + local: *; +}; diff --git a/lib/trace_parser/trace.cpp b/lib/trace_parser/trace.cpp new file mode 100644 index 000000000..839444844 --- /dev/null +++ b/lib/trace_parser/trace.cpp @@ -0,0 +1,45 @@ +/*- + * BSD LICENSE + * + * Copyright (c) Intel Corporation. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * * Neither the name of Intel Corporation nor the names of its + * contributors may be used to endorse or promote products derived + * from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#include "spdk/stdinc.h" +#include "spdk/trace_parser.h" + +struct spdk_trace_parser * +spdk_trace_parser_init(const struct spdk_trace_parser_opts *opts) +{ + return NULL; +} + +void +spdk_trace_parser_cleanup(struct spdk_trace_parser *parser) +{}