linux-trace-devel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Tzvetomir Stoyanov (VMware)" <tz.stoyanov@gmail.com>
To: rostedt@goodmis.org
Cc: linux-trace-devel@vger.kernel.org
Subject: [PATCH v4 03/29] trace-cmd: Check if file version is supported
Date: Thu, 20 May 2021 06:19:33 +0300	[thread overview]
Message-ID: <20210520031959.346165-4-tz.stoyanov@gmail.com> (raw)
In-Reply-To: <20210520031959.346165-1-tz.stoyanov@gmail.com>

When reading a trace file, version of the file is ignored. This could
case problems when bumping the version number because of changes in
in the structure of the file. The old code should detect unsupported
file version and should not try to read it.
A new trace-cmd library API is added to check if version is supported:
 tracecmd_is_version_supported()
Checks are added in the code to ensure not trying to read trace file
from unsupported version.

Signed-off-by: Tzvetomir Stoyanov (VMware) <tz.stoyanov@gmail.com>
---
 lib/trace-cmd/include/private/trace-cmd-private.h |  2 ++
 lib/trace-cmd/trace-input.c                       | 10 ++++++++++
 lib/trace-cmd/trace-util.c                        |  7 +++++++
 tracecmd/trace-dump.c                             |  7 +++++++
 4 files changed, 26 insertions(+)

diff --git a/lib/trace-cmd/include/private/trace-cmd-private.h b/lib/trace-cmd/include/private/trace-cmd-private.h
index ecd172ca..136057b4 100644
--- a/lib/trace-cmd/include/private/trace-cmd-private.h
+++ b/lib/trace-cmd/include/private/trace-cmd-private.h
@@ -42,6 +42,8 @@ void tracecmd_record_ref(struct tep_record *record);
 void tracecmd_set_debug(bool set_debug);
 bool tracecmd_get_debug(void);
 
+bool tracecmd_is_version_supported(unsigned int version);
+
 struct tracecmd_output;
 struct tracecmd_recorder;
 struct hook_list;
diff --git a/lib/trace-cmd/trace-input.c b/lib/trace-cmd/trace-input.c
index 5ee69b14..97ad0a5d 100644
--- a/lib/trace-cmd/trace-input.c
+++ b/lib/trace-cmd/trace-input.c
@@ -131,6 +131,7 @@ struct tracecmd_input {
 	bool			use_trace_clock;
 	bool			read_page;
 	bool			use_pipe;
+	int			file_version;
 	struct cpu_data 	*cpu_data;
 	long long		ts_offset;
 	struct tsc2nsec		tsc_calc;
@@ -3269,6 +3270,7 @@ struct tracecmd_input *tracecmd_alloc_fd(int fd, int flags)
 	unsigned int page_size;
 	char *version;
 	char buf[BUFSIZ];
+	unsigned long ver;
 
 	handle = malloc(sizeof(*handle));
 	if (!handle)
@@ -3293,6 +3295,14 @@ struct tracecmd_input *tracecmd_alloc_fd(int fd, int flags)
 	if (!version)
 		goto failed_read;
 	tracecmd_info("version = %s\n", version);
+	ver = strtol(version, NULL, 10);
+	if (!ver && errno)
+		goto failed_read;
+	if (!tracecmd_is_version_supported(ver)) {
+		tracecmd_warning("Unsupported file version %lu", ver);
+		goto failed_read;
+	}
+	handle->file_version = ver;
 	free(version);
 
 	if (do_read_check(handle, buf, 1))
diff --git a/lib/trace-cmd/trace-util.c b/lib/trace-cmd/trace-util.c
index b65f9dec..b0c98c72 100644
--- a/lib/trace-cmd/trace-util.c
+++ b/lib/trace-cmd/trace-util.c
@@ -617,3 +617,10 @@ unsigned long long tracecmd_generate_traceid(void)
 	free(str);
 	return hash;
 }
+
+bool tracecmd_is_version_supported(unsigned int version)
+{
+	if (version <= FILE_VERSION)
+		return true;
+	return false;
+}
diff --git a/tracecmd/trace-dump.c b/tracecmd/trace-dump.c
index 98425b98..03cc82b4 100644
--- a/tracecmd/trace-dump.c
+++ b/tracecmd/trace-dump.c
@@ -10,6 +10,7 @@
 #include <getopt.h>
 #include <sys/stat.h>
 #include <fcntl.h>
+#include <errno.h>
 
 #include "trace-local.h"
 
@@ -145,6 +146,7 @@ static void dump_initial_format(int fd)
 	char magic[] = TRACECMD_MAGIC;
 	char buf[DUMP_SIZE];
 	int val4;
+	unsigned long ver;
 
 	do_print(SUMMARY, "\t[Initial format]\n");
 
@@ -166,6 +168,11 @@ static void dump_initial_format(int fd)
 		die("no version string");
 
 	do_print(SUMMARY, "\t\t%s\t[Version]\n", buf);
+	ver = strtol(buf, NULL, 10);
+	if (!ver && errno)
+		die("Invalid file version string %s", buf);
+	if (!tracecmd_is_version_supported(ver))
+		die("Unsupported file version %lu", ver);
 
 	/* get file endianness*/
 	if (read_file_bytes(fd, buf, 1))
-- 
2.31.1


  parent reply	other threads:[~2021-05-20  3:20 UTC|newest]

Thread overview: 30+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-20  3:19 [PATCH v4 00/29] Add trace file compression Tzvetomir Stoyanov (VMware)
2021-05-20  3:19 ` [PATCH v4 01/29] trace-cmd library: Remove unused private APIs for creating trace files Tzvetomir Stoyanov (VMware)
2021-05-20  3:19 ` [PATCH v4 02/29] trace-cmd library: Remove unused API tracecmd_update_option Tzvetomir Stoyanov (VMware)
2021-05-20  3:19 ` Tzvetomir Stoyanov (VMware) [this message]
2021-05-20  3:19 ` [PATCH v4 04/29] trace-cmd library: Add new API to get file version of input handler Tzvetomir Stoyanov (VMware)
2021-05-20  3:19 ` [PATCH v4 05/29] trace-cmd library: Select the file version when writing trace file Tzvetomir Stoyanov (VMware)
2021-05-20  3:19 ` [PATCH v4 06/29] trace-cmd: Add APIs for library initialization and free Tzvetomir Stoyanov (VMware)
2021-05-20  3:19 ` [PATCH v4 07/29] trace-cmd library: Add support for compression algorithms Tzvetomir Stoyanov (VMware)
2021-05-20  3:19 ` [PATCH v4 08/29] trace-cmd list: Show supported " Tzvetomir Stoyanov (VMware)
2021-05-20  3:19 ` [PATCH v4 09/29] trace-cmd library: Bump the trace file version to 7 Tzvetomir Stoyanov (VMware)
2021-05-20  3:19 ` [PATCH v4 10/29] trace-cmd library: Compress part of the trace file Tzvetomir Stoyanov (VMware)
2021-05-20  3:19 ` [PATCH v4 11/29] trace-cmd library: Read compressed " Tzvetomir Stoyanov (VMware)
2021-05-20  3:19 ` [PATCH v4 12/29] trace-cmd library: Add new API to get compression of input handler Tzvetomir Stoyanov (VMware)
2021-05-20  3:19 ` [PATCH v4 13/29] trace-cmd library: Inherit compression algorithm from input file Tzvetomir Stoyanov (VMware)
2021-05-20  3:19 ` [PATCH v4 14/29] trace-cmd library: Extend the create file APIs to support different compression Tzvetomir Stoyanov (VMware)
2021-05-20  3:19 ` [PATCH v4 15/29] trace-cmd record: Add new parameter --compression Tzvetomir Stoyanov (VMware)
2021-05-20  3:19 ` [PATCH v4 16/29] trace-cmd dump: Add support for trace files version 7 Tzvetomir Stoyanov (VMware)
2021-05-20  3:19 ` [PATCH v4 17/29] trace-cmd library: Add support for zlib compression library Tzvetomir Stoyanov (VMware)
2021-05-20  3:19 ` [PATCH v4 18/29] trace-cmd library: Hide the logic for updating buffer offset Tzvetomir Stoyanov (VMware)
2021-05-20  3:19 ` [PATCH v4 19/29] trace-cmd: Move buffers description outside of options Tzvetomir Stoyanov (VMware)
2021-05-20  3:19 ` [PATCH v4 20/29] trace-cmd library: Track the offset in the option section in the trace file Tzvetomir Stoyanov (VMware)
2021-05-20  3:19 ` [PATCH v4 21/29] trace-cmd library: Add compression of the option section of " Tzvetomir Stoyanov (VMware)
2021-05-20  3:19 ` [PATCH v4 22/29] trace-cmd library: Refactor the logic for writing trace data in the file Tzvetomir Stoyanov (VMware)
2021-05-20  3:19 ` [PATCH v4 23/29] trace-cmd library: Add APIs for read and write compressed data in chunks Tzvetomir Stoyanov (VMware)
2021-05-20  3:19 ` [PATCH v4 24/29] trace-cmd: Compress trace data Tzvetomir Stoyanov (VMware)
2021-05-20  3:19 ` [PATCH v4 25/29] trace-cmd: Read compressed " Tzvetomir Stoyanov (VMware)
2021-05-20  3:19 ` [PATCH v4 26/29] trace-cmd library: Reuse within the library the function that checks file state Tzvetomir Stoyanov (VMware)
2021-05-20  3:19 ` [PATCH v4 27/29] trace-cmd library: New internal API to set file state of output handler Tzvetomir Stoyanov (VMware)
2021-05-20  3:19 ` [PATCH v4 28/29] trace-cmd library: Make tracecmd_copy_headers() to work with " Tzvetomir Stoyanov (VMware)
2021-05-20  3:19 ` [PATCH v4 29/29] trace-cmd: Do not use trace file compression with streams Tzvetomir Stoyanov (VMware)

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210520031959.346165-4-tz.stoyanov@gmail.com \
    --to=tz.stoyanov@gmail.com \
    --cc=linux-trace-devel@vger.kernel.org \
    --cc=rostedt@goodmis.org \
    --subject='Re: [PATCH v4 03/29] trace-cmd: Check if file version is supported' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).