All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH] perf util: Add more PMU fields for perf script python
@ 2018-05-30 14:20 Jin Yao
  2018-05-30 17:43 ` Andi Kleen
  0 siblings, 1 reply; 3+ messages in thread
From: Jin Yao @ 2018-05-30 14:20 UTC (permalink / raw)
  To: acme, jolsa, peterz, mingo, alexander.shishkin
  Cc: Linux-kernel, ak, kan.liang, yao.jin, Jin Yao

When doing pmu sampling and then running a script with
perf script -s script.py, the process_event function gets
dictionary with some fields from the perf ring buffer
(like ip, sym, callchain etc).

But we miss quite a few fields we report now, for example,
LBRs,data source,weight,transaction,iregs,uregs,and etc.

This patch reports these fields for perf script python
processing.

New created elements:
---------------------
brstack (from sample->branch_stack, raw value):
    from, to, mispred, predicted, in_tx, abort, cycles.

brstacksym (from sample->branch_stack, converted string):
    from, to, pred, in_tx, abort

datasrc (from sample->datasrc, raw value)

datasrc_decode (from sample->datasrc, decoded string)

iregs (from attr->sample_regs_intr, converted reg name)

uregs (from attr->sample_regs_user, converted reg name)

weight (from sample->weight, raw value)

transaction (from sample->transaction, raw value)

Signed-off-by: Jin Yao <yao.jin@linux.intel.com>
---
 .../util/scripting-engines/trace-event-python.c    | 212 ++++++++++++++++++++-
 1 file changed, 211 insertions(+), 1 deletion(-)

diff --git a/tools/perf/util/scripting-engines/trace-event-python.c b/tools/perf/util/scripting-engines/trace-event-python.c
index 7f8afac..01abb4a 100644
--- a/tools/perf/util/scripting-engines/trace-event-python.c
+++ b/tools/perf/util/scripting-engines/trace-event-python.c
@@ -48,6 +48,7 @@
 #include "cpumap.h"
 #include "print_binary.h"
 #include "stat.h"
+#include "mem-events.h"
 
 #if PY_MAJOR_VERSION < 3
 #define _PyUnicode_FromString(arg) \
@@ -448,6 +449,151 @@ static PyObject *python_process_callchain(struct perf_sample *sample,
 	return pylist;
 }
 
+static PyObject *python_process_brstack(struct perf_sample *sample)
+{
+	struct branch_stack *br = sample->branch_stack;
+	PyObject *pylist;
+	u64 i;
+
+	pylist = PyList_New(0);
+	if (!pylist)
+		Py_FatalError("couldn't create Python list");
+
+	if (!(br && br->nr))
+		goto exit;
+
+	for (i = 0; i < br->nr; i++) {
+		PyObject *pyelem;
+
+		pyelem = PyDict_New();
+		if (!pyelem)
+			Py_FatalError("couldn't create Python dictionary");
+
+		pydict_set_item_string_decref(pyelem, "from",
+		    PyLong_FromUnsignedLongLong(br->entries[i].from));
+		pydict_set_item_string_decref(pyelem, "to",
+		    PyLong_FromUnsignedLongLong(br->entries[i].to));
+		pydict_set_item_string_decref(pyelem, "mispred",
+		    PyLong_FromUnsignedLongLong(br->entries[i].flags.mispred));
+		pydict_set_item_string_decref(pyelem, "predicted",
+		    PyLong_FromUnsignedLongLong(br->entries[i].flags.predicted));
+		pydict_set_item_string_decref(pyelem, "in_tx",
+		    PyLong_FromUnsignedLongLong(br->entries[i].flags.in_tx));
+		pydict_set_item_string_decref(pyelem, "abort",
+		    PyLong_FromUnsignedLongLong(br->entries[i].flags.abort));
+		pydict_set_item_string_decref(pyelem, "cycles",
+		    PyLong_FromUnsignedLongLong(br->entries[i].flags.cycles));
+
+		PyList_Append(pylist, pyelem);
+		Py_DECREF(pyelem);
+	}
+
+exit:
+	return pylist;
+}
+
+static unsigned long get_offset(struct symbol *sym, struct addr_location *al)
+{
+	unsigned long offset;
+
+	if (al->addr < sym->end)
+		offset = al->addr - sym->start;
+	else
+		offset = al->addr - al->map->start - sym->start;
+
+	return offset;
+}
+
+static int get_symoff(struct symbol *sym, struct addr_location *al,
+		      bool print_off, char *bf, int size)
+{
+	unsigned long offset;
+
+	if (!sym || !sym->name)
+		return scnprintf(bf, size, "%s", "[unknown]");
+
+	if (!print_off)
+		return scnprintf(bf, size, "%s", sym->name);
+
+	offset = get_offset(sym, al);
+
+	return scnprintf(bf, size, "%s+0x%x", sym->name, offset);
+}
+
+static int get_br_mspred(struct branch_flags *flags, char *bf, int size)
+{
+	if (!flags->mispred  && !flags->predicted)
+		return scnprintf(bf, size, "%s", "-");
+
+	if (flags->mispred)
+		return scnprintf(bf, size, "%s", "M");
+
+	return scnprintf(bf, size, "%s", "P");
+}
+
+static PyObject *python_process_brstacksym(struct perf_sample *sample,
+					   struct thread *thread)
+{
+	struct branch_stack *br = sample->branch_stack;
+	PyObject *pylist;
+	u64 i;
+	char bf[512];
+	struct addr_location al;
+
+	pylist = PyList_New(0);
+	if (!pylist)
+		Py_FatalError("couldn't create Python list");
+
+	if (!(br && br->nr))
+		goto exit;
+
+	for (i = 0; i < br->nr; i++) {
+		PyObject *pyelem;
+
+		pyelem = PyDict_New();
+		if (!pyelem)
+			Py_FatalError("couldn't create Python dictionary");
+
+		thread__find_symbol(thread, sample->cpumode,
+				    br->entries[i].from, &al);
+		get_symoff(al.sym, &al, true, bf, sizeof(bf));
+		pydict_set_item_string_decref(pyelem, "from",
+					      _PyUnicode_FromString(bf));
+
+		thread__find_symbol(thread, sample->cpumode,
+				    br->entries[i].to, &al);
+		get_symoff(al.sym, &al, true, bf, sizeof(bf));
+		pydict_set_item_string_decref(pyelem, "to",
+					      _PyUnicode_FromString(bf));
+
+		get_br_mspred(&br->entries[i].flags, bf, sizeof(bf));
+		pydict_set_item_string_decref(pyelem, "pred",
+					      _PyUnicode_FromString(bf));
+
+		if (br->entries[i].flags.in_tx) {
+			pydict_set_item_string_decref(pyelem, "in_tx",
+					      _PyUnicode_FromString("X"));
+		} else {
+			pydict_set_item_string_decref(pyelem, "in_tx",
+					      _PyUnicode_FromString("-"));
+		}
+
+		if (br->entries[i].flags.abort) {
+			pydict_set_item_string_decref(pyelem, "abort",
+					      _PyUnicode_FromString("A"));
+		} else {
+			pydict_set_item_string_decref(pyelem, "abort",
+					      _PyUnicode_FromString("-"));
+		}
+
+		PyList_Append(pylist, pyelem);
+		Py_DECREF(pyelem);
+	}
+
+exit:
+	return pylist;
+}
+
 static PyObject *get_sample_value_as_tuple(struct sample_read_value *value)
 {
 	PyObject *t;
@@ -498,12 +644,63 @@ static void set_sample_read_in_dict(PyObject *dict_sample,
 	pydict_set_item_string_decref(dict_sample, "values", values);
 }
 
+static void set_sample_datasrc_in_dict(PyObject *dict,
+				       struct perf_sample *sample)
+{
+	struct mem_info mi = { .data_src.val = sample->data_src };
+	char decode[100];
+
+	pydict_set_item_string_decref(dict, "datasrc",
+			PyLong_FromUnsignedLongLong(sample->data_src));
+
+	perf_script__meminfo_scnprintf(decode, 100, &mi);
+
+	pydict_set_item_string_decref(dict, "datasrc_decode",
+			_PyUnicode_FromString(decode));
+}
+
+static int regs_map(struct regs_dump *regs, uint64_t mask, char *bf, int size)
+{
+	unsigned int i = 0, r;
+	int printed = 0;
+
+	bf[0] = 0;
+
+	for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
+		u64 val = regs->regs[i++];
+
+		printed += scnprintf(bf + printed, size - printed,
+				     "%5s:0x%" PRIx64 " ",
+				     perf_reg_name(r), val);
+	}
+
+	return printed;
+}
+
+static void set_regs_in_dict(PyObject *dict,
+			     struct perf_sample *sample,
+			     struct perf_evsel *evsel)
+{
+	struct perf_event_attr *attr = &evsel->attr;
+	char bf[512];
+
+	regs_map(&sample->intr_regs, attr->sample_regs_intr, bf, sizeof(bf));
+
+	pydict_set_item_string_decref(dict, "iregs",
+			_PyUnicode_FromString(bf));
+
+	regs_map(&sample->user_regs, attr->sample_regs_user, bf, sizeof(bf));
+
+	pydict_set_item_string_decref(dict, "uregs",
+			_PyUnicode_FromString(bf));
+}
+
 static PyObject *get_perf_sample_dict(struct perf_sample *sample,
 					 struct perf_evsel *evsel,
 					 struct addr_location *al,
 					 PyObject *callchain)
 {
-	PyObject *dict, *dict_sample;
+	PyObject *dict, *dict_sample, *brstack, *brstacksym;
 
 	dict = PyDict_New();
 	if (!dict)
@@ -534,6 +731,11 @@ static PyObject *get_perf_sample_dict(struct perf_sample *sample,
 	pydict_set_item_string_decref(dict_sample, "addr",
 			PyLong_FromUnsignedLongLong(sample->addr));
 	set_sample_read_in_dict(dict_sample, sample, evsel);
+	pydict_set_item_string_decref(dict_sample, "weight",
+			PyLong_FromUnsignedLongLong(sample->weight));
+	pydict_set_item_string_decref(dict_sample, "transaction",
+			PyLong_FromUnsignedLongLong(sample->transaction));
+	set_sample_datasrc_in_dict(dict_sample, sample);
 	pydict_set_item_string_decref(dict, "sample", dict_sample);
 
 	pydict_set_item_string_decref(dict, "raw_buf", _PyBytes_FromStringAndSize(
@@ -551,6 +753,14 @@ static PyObject *get_perf_sample_dict(struct perf_sample *sample,
 
 	pydict_set_item_string_decref(dict, "callchain", callchain);
 
+	brstack = python_process_brstack(sample);
+	pydict_set_item_string_decref(dict, "brstack", brstack);
+
+	brstacksym = python_process_brstacksym(sample, al->thread);
+	pydict_set_item_string_decref(dict, "brstacksym", brstacksym);
+
+	set_regs_in_dict(dict, sample, evsel);
+
 	return dict;
 }
 
-- 
2.7.4

^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH] perf util: Add more PMU fields for perf script python
  2018-05-30 14:20 [PATCH] perf util: Add more PMU fields for perf script python Jin Yao
@ 2018-05-30 17:43 ` Andi Kleen
  2018-05-31  5:41   ` Jin, Yao
  0 siblings, 1 reply; 3+ messages in thread
From: Andi Kleen @ 2018-05-30 17:43 UTC (permalink / raw)
  To: Jin Yao
  Cc: acme, jolsa, peterz, mingo, alexander.shishkin, Linux-kernel,
	kan.liang, yao.jin

On Wed, May 30, 2018 at 10:20:45PM +0800, Jin Yao wrote:
> When doing pmu sampling and then running a script with
> perf script -s script.py, the process_event function gets
> dictionary with some fields from the perf ring buffer
> (like ip, sym, callchain etc).
> 
> But we miss quite a few fields we report now, for example,
> LBRs,data source,weight,transaction,iregs,uregs,and etc.
> 
> This patch reports these fields for perf script python
> processing.

We need documentation and an example script using it.

> +		PyObject *pyelem;
> +
> +		pyelem = PyDict_New();
> +		if (!pyelem)
> +			Py_FatalError("couldn't create Python dictionary");
> +

I think we need a field for the dso here.

> +		pydict_set_item_string_decref(pyelem, "from",
> +		    PyLong_FromUnsignedLongLong(br->entries[i].from));
> +		pydict_set_item_string_decref(pyelem, "to",
> +		    PyLong_FromUnsignedLongLong(br->entries[i].to));
> +		pydict_set_item_string_decref(pyelem, "mispred",
> +		    PyLong_FromUnsignedLongLong(br->entries[i].flags.mispred));
> +		pydict_set_item_string_decref(pyelem, "predicted",
> +		    PyLong_FromUnsignedLongLong(br->entries[i].flags.predicted));
> +		pydict_set_item_string_decref(pyelem, "in_tx",
> +		    PyLong_FromUnsignedLongLong(br->entries[i].flags.in_tx));
> +		pydict_set_item_string_decref(pyelem, "abort",


These could be booleans.

> +		    PyLong_FromUnsignedLongLong(br->entries[i].flags.abort));
> +		pydict_set_item_string_decref(pyelem, "cycles",
> +		    PyLong_FromUnsignedLongLong(br->entries[i].flags.cycles));

Would be nice to get access to the binary code too (see how perf script
brstackinsn does it). That could be a followon patch.

Thanks,

-Andi

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] perf util: Add more PMU fields for perf script python
  2018-05-30 17:43 ` Andi Kleen
@ 2018-05-31  5:41   ` Jin, Yao
  0 siblings, 0 replies; 3+ messages in thread
From: Jin, Yao @ 2018-05-31  5:41 UTC (permalink / raw)
  To: Andi Kleen
  Cc: acme, jolsa, peterz, mingo, alexander.shishkin, Linux-kernel,
	kan.liang, yao.jin



On 5/31/2018 1:43 AM, Andi Kleen wrote:
> On Wed, May 30, 2018 at 10:20:45PM +0800, Jin Yao wrote:
>> When doing pmu sampling and then running a script with
>> perf script -s script.py, the process_event function gets
>> dictionary with some fields from the perf ring buffer
>> (like ip, sym, callchain etc).
>>
>> But we miss quite a few fields we report now, for example,
>> LBRs,data source,weight,transaction,iregs,uregs,and etc.
>>
>> This patch reports these fields for perf script python
>> processing.
> 
> We need documentation and an example script using it.
> 

OK, I will add an example with some field explanations to 
Documentation/perf-script-python.txt.

>> +		PyObject *pyelem;
>> +
>> +		pyelem = PyDict_New();
>> +		if (!pyelem)
>> +			Py_FatalError("couldn't create Python dictionary");
>> +
> 
> I think we need a field for the dso here.
>

I will add new fields "from_dsoname" and "to_dsoname" in v2.

>> +		pydict_set_item_string_decref(pyelem, "from",
>> +		    PyLong_FromUnsignedLongLong(br->entries[i].from));
>> +		pydict_set_item_string_decref(pyelem, "to",
>> +		    PyLong_FromUnsignedLongLong(br->entries[i].to));
>> +		pydict_set_item_string_decref(pyelem, "mispred",
>> +		    PyLong_FromUnsignedLongLong(br->entries[i].flags.mispred));
>> +		pydict_set_item_string_decref(pyelem, "predicted",
>> +		    PyLong_FromUnsignedLongLong(br->entries[i].flags.predicted));
>> +		pydict_set_item_string_decref(pyelem, "in_tx",
>> +		    PyLong_FromUnsignedLongLong(br->entries[i].flags.in_tx));
>> +		pydict_set_item_string_decref(pyelem, "abort",
> 
> 
> These could be booleans.
> 
>> +		    PyLong_FromUnsignedLongLong(br->entries[i].flags.abort));
>> +		pydict_set_item_string_decref(pyelem, "cycles",
>> +		    PyLong_FromUnsignedLongLong(br->entries[i].flags.cycles));

I will use PyBool_FromLong() for mispred/predicted/in_tx/abort in v2.

> 
> Would be nice to get access to the binary code too (see how perf script
> brstackinsn does it). That could be a followon patch.
>

OK, fine, I will see how perf script brstackinsn does.

Thanks
Jin Yao

> Thanks,
> 
> -Andi
> 

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2018-05-31  5:41 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-05-30 14:20 [PATCH] perf util: Add more PMU fields for perf script python Jin Yao
2018-05-30 17:43 ` Andi Kleen
2018-05-31  5:41   ` Jin, Yao

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.