Skip to contentSkip to conversation

perf tools: Merge trace.info content into perf.data

RFC PATCH In review Frederic Weisbecker 3 participants 8 messages Oct 6, 2009 – Oct 7, 2009 perf events

lore
Share & tools
lore
#0 lore raw

RFC PATCH 1/1 perf tools: Merge trace.info content into perf.data

Hi,

Here is an attempt to remove the trace.info file. It works well for me, the reason for it to be an RFC is that I have doubts about the backward compatibility.

A file created by perf after his patch is unsupported by previous version because the size of the headers have increased.

That said, it's two new fields that have been added in the end of the headers, and those could be ignored by previous versions if they just handled the dynamic header size and then ignore the unknow part. The offsets guarantee the compatibility.
But previous versions handle the header size using its static size, not dynamic, then it's not backward compatible.

Anyway, I'm not sure exactly how to handle that.

Thanks.

---
From: Frederic Weisbecker <[email protected]>
Date: Tue, 6 Oct 2009 23:14:25 +0200
Subject: [RFC][PATCH] perf tools: Merge trace.info content into perf.data

This drops the trace.info file and move its contents into the common perf.data file.

This is done by creating a new trace_info section into this file. A user of perf headers needs to call perf_header__set_trace_info() to save the trace meta informations into the perf.data file.

Cc Peter Zijlstra <[email protected]>
Cc Arnaldo Carvalho de Melo <[email protected]>
Cc Mike Galbraith <[email protected]>
Cc Paul Mackerras <[email protected]>
---
 tools/perf/builtin-record.c        |    7 ++---
 tools/perf/builtin-trace.c         |    1 -
 tools/perf/util/header.c           |   42 ++++++++++++++++++++++++++++++++++++
 tools/perf/util/header.h           |    4 ++-
 tools/perf/util/trace-event-info.c |    6 +---
 tools/perf/util/trace-event-read.c |    7 +----
 tools/perf/util/trace-event.h      |    4 +-
 7 files changed, 54 insertions(+), 17 deletions(-)
tools/perf/builtin-record.c +3 -4
index 494f8c7..59af03d 100644
@@ -17,7 +17,6 @@
 #include "util/header.h"
 #include "util/event.h"
 #include "util/debug.h"
-#include "util/trace-event.h"
 
 #include <unistd.h>
 #include <sched.h>
@@ -566,17 +565,17 @@ static int __cmd_record(int argc, const char **argv)
 	else
 		header = perf_header__new();
 
-
 	if (raw_samples) {
-		read_tracing_data(attrs, nr_counters);
+		perf_header__set_trace_info();
 	} else {
 		for (i = 0; i < nr_counters; i++) {
 			if (attrs[i].sample_type & PERF_SAMPLE_RAW) {
-				read_tracing_data(attrs, nr_counters);
+				perf_header__set_trace_info();
 				break;
 			}
 		}
 	}
+
 	atexit(atexit_header);
 
 	if (!system_wide) {
tools/perf/builtin-trace.c +0 -1
index d573d4e..d9abb4a 100644
@@ -149,7 +149,6 @@ static int __cmd_trace(void)
 	uint32_t size;
 	char *buf;
 
-	trace_report();
 	register_idle_thread(&threads, &last_match);
 
 	input = open(input_name, O_RDONLY);
tools/perf/util/header.c +42 -0

80 lines not on this page · raw message

tools/perf/util/header.h +3 -1
index a2916b6..30aee51 100644
@@ -21,6 +21,8 @@ struct perf_header {
 	u64 data_size;
 	u64 event_offset;
 	u64 event_size;
+	u64 trace_info_offset;
+	u64 trace_info_size;
 };
 
 struct perf_header *perf_header__read(int fd);
@@ -40,7 +42,7 @@ void perf_header_attr__add_id(struct perf_header_attr *self, u64 id);
 u64 perf_header__sample_type(struct perf_header *header);
 struct perf_event_attr *
 perf_header__find_attr(u64 id, struct perf_header *header);
-
+void perf_header__set_trace_info(void);
 
 struct perf_header *perf_header__new(void);
 
tools/perf/util/trace-event-info.c +2 -4
index af4b057..831052d 100644
@@ -496,14 +496,12 @@ get_tracepoints_path(struct perf_event_attr *pattrs, int nb_events)
 
 	return path.next;
 }
-void read_tracing_data(struct perf_event_attr *pattrs, int nb_events)
+void read_tracing_data(int fd, struct perf_event_attr *pattrs, int nb_events)
 {
 	char buf[BUFSIZ];
 	struct tracepoint_path *tps;
 
-	output_fd = open(output_file, O_WRONLY | O_CREAT | O_TRUNC | O_LARGEFILE, 0644);
-	if (output_fd < 0)
-		die("creating file '%s'", output_file);
+	output_fd = fd;
 
 	buf[0] = 23;
 	buf[1] = 8;
tools/perf/util/trace-event-read.c +2 -5
index 1b5c847..44292e0 100644
@@ -458,9 +458,8 @@ struct record *trace_read_data(int cpu)
 	return data;
 }
 
-void trace_report(void)
+void trace_report(int fd)
 {
-	const char *input_file = "trace.info";
 	char buf[BUFSIZ];
 	char test[] = { 23, 8, 68 };
 	char *version;
@@ -468,9 +467,7 @@ void trace_report(void)
 	int show_funcs = 0;
 	int show_printk = 0;
 
-	input_fd = open(input_file, O_RDONLY);
-	if (input_fd < 0)
-		die("opening '%s'\n", input_file);
+	input_fd = fd;
 
 	read_or_die(buf, 3);
 	if (memcmp(buf, test, 3) != 0)
tools/perf/util/trace-event.h +2 -2
index 5f59a39..da77e07 100644
@@ -158,7 +158,7 @@ struct record *trace_read_data(int cpu);
 
 void parse_set_info(int nr_cpus, int long_sz);
 
-void trace_report(void);
+void trace_report(int fd);
 
 void *malloc_or_die(unsigned int size);
 
@@ -244,6 +244,6 @@ unsigned long long
 raw_field_value(struct event *event, const char *name, void *data);
 void *raw_field_ptr(struct event *event, const char *name, void *data);
 
-void read_tracing_data(struct perf_event_attr *pattrs, int nb_events);
+void read_tracing_data(int fd, struct perf_event_attr *pattrs, int nb_events);
 
 #endif /* __PERF_TRACE_EVENTS_H */
Signature · 1 line
1.6.2.3
#1 lore raw
Quoted 8 lines · Frederic Weisbecker

Hi,

Here is an attempt to remove the trace.info file. It works well for me, the reason for it to be an RFC is that I have doubts about the backward compatibility.

A file created by perf after his patch is unsupported by previous version because the size of the headers have increased.

That's OK i think in terms of trace.info - trace.info was a temporary hack to begin with.

Quoted 4 lines

That said, it's two new fields that have been added in the end of the headers, and those could be ignored by previous versions if they just handled the dynamic header size and then ignore the unknow part. The offsets guarantee the compatibility.

Yes, that's how it should work.

Quoted 4 lines

But previous versions handle the header size using its static size, not dynamic, then it's not backward compatible.

Anyway, I'm not sure exactly how to handle that.

That's a bug in the previous version - mind doing a standalone fix for that so we can mark it Cc: stable?

Thanks,

Ingo

#2 lore raw
Quoted 21 lines · Ingo Molnar
Quoted 8 lines · Frederic Weisbecker

Hi,

Here is an attempt to remove the trace.info file. It works well for me, the reason for it to be an RFC is that I have doubts about the backward compatibility.

A file created by perf after his patch is unsupported by previous version because the size of the headers have increased.

That's OK i think in terms of trace.info - trace.info was a temporary hack to begin with.

Quoted 4 lines

That said, it's two new fields that have been added in the end of the headers, and those could be ignored by previous versions if they just handled the dynamic header size and then ignore the unknow part. The offsets guarantee the compatibility.

Yes, that's how it should work.

Quoted 7 lines
Quoted 4 lines

But previous versions handle the header size using its static size, not dynamic, then it's not backward compatible.

Anyway, I'm not sure exactly how to handle that.

That's a bug in the previous version - mind doing a standalone fix for that so we can mark it Cc: stable?

Meanwhile i've applied your two patches - they are clear steps forward. We'll need the -stable fix so that the new perf.data can be read. (and even that only affects -R afaics - so normal perf record / perf report is compatible.)

Btw., we also need a patch for new perf to read older perf.data files [non-trace.info ones], as those are not working either:

 $ perf report
   Fatal: incompatible file format

( We dont want to push it - i.e. i dont think we need to support old
perf.data + trace.info combos. )

Ingo

#3 lore raw
Quoted 4 lines · Ingo Molnar

Meanwhile i've applied your two patches - they are clear steps forward. We'll need the -stable fix so that the new perf.data can be read. (and even that only affects -R afaics - so normal perf record / perf report is compatible.)

That affects every new perf.data
We have a new trace_info offset/size pair even if we haven't any trace.info, these will just be zero in that case. This new pair has grown the header, making it uncompatible.

But the stable patch should solve this.

Quoted 10 lines

Btw., we also need a patch for new perf to read older perf.data files [non-trace.info ones], as those are not working either:

 $ perf report
   Fatal: incompatible file format

( We dont want to push it - i.e. i dont think we need to support old
perf.data + trace.info combos. )

Ingo

Ok.

#4 lore raw
In reply to Ingo Molnar
Quoted 9 lines · Ingo Molnar
Quoted 6 lines · Frederic Weisbecker

Hi,

Here is an attempt to remove the trace.info file. It works well for me, the reason for it to be an RFC is that I have doubts about the backward compatibility.

Quoted 5 lines
Quoted 2 lines

A file created by perf after his patch is unsupported by previous version because the size of the headers have increased.

That's OK i think in terms of trace.info - trace.info was a temporary hack to begin with.

Ok.

Quoted 7 lines
Quoted 4 lines

That said, it's two new fields that have been added in the end of the headers, and those could be ignored by previous versions if they just handled the dynamic header size and then ignore the unknow part. The offsets guarantee the compatibility.

Yes, that's how it should work.

Quoted 8 lines
Quoted 4 lines

But previous versions handle the header size using its static size, not dynamic, then it's not backward compatible.

Anyway, I'm not sure exactly how to handle that.

That's a bug in the previous version - mind doing a standalone fix for that so we can mark it Cc: stable?

Ok, preparing this.

Thanks.

maintainer
#5 lore raw
In reply to Frederic Weisbecker
Quoted 18 lines · Frederic Weisbecker

Hi,

Here is an attempt to remove the trace.info file. It works well for me, the reason for it to be an RFC is that I have doubts about the backward compatibility.

A file created by perf after his patch is unsupported by previous version because the size of the headers have increased.

That said, it's two new fields that have been added in the end of the headers, and those could be ignored by previous versions if they just handled the dynamic header size and then ignore the unknow part. The offsets guarantee the compatibility.
But previous versions handle the header size using its static size, not dynamic, then it's not backward compatible.

Quoted 1 line

Anyway, I'm not sure exactly how to handle that.

If we're still able to read 'regular' old perf.data files after this. That is, allow to read short headers and assume the tail is 0 we'll be good. (this will break trace files that rely on the now removed trace.info, but that's unavoidable I guess).

So backwards compatible, but no fwd compat for the old perf.

#6 lore raw
Quoted 19 lines · Peter Zijlstra
Quoted 18 lines · Frederic Weisbecker

Hi,

Here is an attempt to remove the trace.info file. It works well for me, the reason for it to be an RFC is that I have doubts about the backward compatibility.

A file created by perf after his patch is unsupported by previous version because the size of the headers have increased.

That said, it's two new fields that have been added in the end of the headers, and those could be ignored by previous versions if they just handled the dynamic header size and then ignore the unknow part. The offsets guarantee the compatibility.
But previous versions handle the header size using its static size, not dynamic, then it's not backward compatible.

Quoted 8 lines
Quoted 1 line

Anyway, I'm not sure exactly how to handle that.

If we're still able to read 'regular' old perf.data files after this. That is, allow to read short headers and assume the tail is 0 we'll be good. (this will break trace files that rely on the now removed trace.info, but that's unavoidable I guess).

So backwards compatible, but no fwd compat for the old perf.

Hmm, but forward is possible. It will just ignore the trace.info part.

#7 lore raw
In reply to Frederic Weisbecker
Commit-ID:  03456a158d9067d2f657bec170506009db81756d
Gitweb:     http://git.kernel.org/tip/03456a158d9067d2f657bec170506009db81756d
Author:     Frederic Weisbecker <[email protected]>
AuthorDate: Tue, 6 Oct 2009 23:36:47 +0200
Committer:  Ingo Molnar <[email protected]>
CommitDate: Wed, 7 Oct 2009 08:36:10 +0200

perf tools: Merge trace.info content into perf.data

This drops the trace.info file and move its contents into the common perf.data file.

This is done by creating a new trace_info section into this file. A user of perf headers needs to call perf_header__set_trace_info() to save the trace meta informations into the perf.data file.

A file created by perf after his patch is unsupported by previous version because the size of the headers have increased.

That said, it's two new fields that have been added in the end of the headers, and those could be ignored by previous versions if they just handled the dynamic header size and then ignore the unknow part. The offsets guarantee the compatibility. We'll do a -stable fix for that.

But current previous versions handle the header size using its static size, not dynamic, then it's not backward compatible with trace records.

Cc Peter Zijlstra <[email protected]>
Cc Arnaldo Carvalho de Melo <[email protected]>
Cc Paul Mackerras <[email protected]>
Cc Mike Galbraith <[email protected]>
Cc Paul Mackerras <[email protected]>

LKML-Reference: <20091006213643.GA5343@nowhere>

---
 tools/perf/builtin-record.c        |    7 ++---
 tools/perf/builtin-sched.c         |    1 -
 tools/perf/builtin-trace.c         |    1 -
 tools/perf/util/header.c           |   42 ++++++++++++++++++++++++++++++++++++
 tools/perf/util/header.h           |    4 ++-
 tools/perf/util/trace-event-info.c |    6 +---
 tools/perf/util/trace-event-read.c |    7 +----
 tools/perf/util/trace-event.h      |    4 +-
 8 files changed, 54 insertions(+), 18 deletions(-)
tools/perf/builtin-record.c +3 -4
index 494f8c7..59af03d 100644
@@ -17,7 +17,6 @@
 #include "util/header.h"
 #include "util/event.h"
 #include "util/debug.h"
-#include "util/trace-event.h"
 
 #include <unistd.h>
 #include <sched.h>
@@ -566,17 +565,17 @@ static int __cmd_record(int argc, const char **argv)
 	else
 		header = perf_header__new();
 
-
 	if (raw_samples) {
-		read_tracing_data(attrs, nr_counters);
+		perf_header__set_trace_info();
 	} else {
 		for (i = 0; i < nr_counters; i++) {
 			if (attrs[i].sample_type & PERF_SAMPLE_RAW) {
-				read_tracing_data(attrs, nr_counters);
+				perf_header__set_trace_info();
 				break;
 			}
 		}
 	}
+
 	atexit(atexit_header);
 
 	if (!system_wide) {
tools/perf/builtin-sched.c +0 -1
index 4470f25..1887138 100644
@@ -1634,7 +1634,6 @@ static int read_events(void)
 	uint32_t size;
 	char *buf;
 
-	trace_report();
 	register_idle_thread(&threads, &last_match);
 
 	input = open(input_name, O_RDONLY);
tools/perf/builtin-trace.c +0 -1
index d573d4e..d9abb4a 100644
@@ -149,7 +149,6 @@ static int __cmd_trace(void)
 	uint32_t size;
 	char *buf;
 
-	trace_report();
 	register_idle_thread(&threads, &last_match);
 
 	input = open(input_name, O_RDONLY);
tools/perf/util/header.c +42 -0

80 lines not on this page · raw message

tools/perf/util/header.h +3 -1
index a2916b6..30aee51 100644
@@ -21,6 +21,8 @@ struct perf_header {
 	u64 data_size;
 	u64 event_offset;
 	u64 event_size;
+	u64 trace_info_offset;
+	u64 trace_info_size;
 };
 
 struct perf_header *perf_header__read(int fd);
@@ -40,7 +42,7 @@ void perf_header_attr__add_id(struct perf_header_attr *self, u64 id);
 u64 perf_header__sample_type(struct perf_header *header);
 struct perf_event_attr *
 perf_header__find_attr(u64 id, struct perf_header *header);
-
+void perf_header__set_trace_info(void);
 
 struct perf_header *perf_header__new(void);
 
tools/perf/util/trace-event-info.c +2 -4
index af4b057..831052d 100644
@@ -496,14 +496,12 @@ get_tracepoints_path(struct perf_event_attr *pattrs, int nb_events)
 
 	return path.next;
 }
-void read_tracing_data(struct perf_event_attr *pattrs, int nb_events)
+void read_tracing_data(int fd, struct perf_event_attr *pattrs, int nb_events)
 {
 	char buf[BUFSIZ];
 	struct tracepoint_path *tps;
 
-	output_fd = open(output_file, O_WRONLY | O_CREAT | O_TRUNC | O_LARGEFILE, 0644);
-	if (output_fd < 0)
-		die("creating file '%s'", output_file);
+	output_fd = fd;
 
 	buf[0] = 23;
 	buf[1] = 8;
tools/perf/util/trace-event-read.c +2 -5
index 1b5c847..44292e0 100644
@@ -458,9 +458,8 @@ struct record *trace_read_data(int cpu)
 	return data;
 }
 
-void trace_report(void)
+void trace_report(int fd)
 {
-	const char *input_file = "trace.info";
 	char buf[BUFSIZ];
 	char test[] = { 23, 8, 68 };
 	char *version;
@@ -468,9 +467,7 @@ void trace_report(void)
 	int show_funcs = 0;
 	int show_printk = 0;
 
-	input_fd = open(input_file, O_RDONLY);
-	if (input_fd < 0)
-		die("opening '%s'\n", input_file);
+	input_fd = fd;
 
 	read_or_die(buf, 3);
 	if (memcmp(buf, test, 3) != 0)
tools/perf/util/trace-event.h +2 -2
index 5f59a39..da77e07 100644
@@ -158,7 +158,7 @@ struct record *trace_read_data(int cpu);
 
 void parse_set_info(int nr_cpus, int long_sz);
 
-void trace_report(void);
+void trace_report(int fd);
 
 void *malloc_or_die(unsigned int size);
 
@@ -244,6 +244,6 @@ unsigned long long
 raw_field_value(struct event *event, const char *name, void *data);
 void *raw_field_ptr(struct event *event, const char *name, void *data);
 
-void read_tracing_data(struct perf_event_attr *pattrs, int nb_events);
+void read_tracing_data(int fd, struct perf_event_attr *pattrs, int nb_events);
 
 #endif /* __PERF_TRACE_EVENTS_H */