trace-cruncher: Add support for event probes
PATCH 1/1 trace-cruncher: Add support for event probes
Event probe (eprobe) is a new type of ftrace dynamic events, introduced in the Linux kernel 5.15 version. It is useful to have support for it in trace-cruncher, as it allows more flexibility when printing event's data.
--- src/ftracepy-utils.c | 34 ++++++++++++++++ src/ftracepy-utils.h | 3 ++ src/ftracepy.c | 5 +++ .../tests/1_unit/test_01_ftracepy_unit.py | 39 +++++++++++++++++++ 4 files changed, 81 insertions(+)
src/ftracepy-utils.c +34 -0
@@ -2064,6 +2064,40 @@ PyObject *PyFtrace_register_kretprobe(PyObject *self, PyObject *args,return PyDynevent_New (kprobe); } +PyObject *PyFtrace_register_eprobe (PyObject *self,PyObject *args, +PyObject *kwargs) +{ +static char *kwlist[] = {"event" ,"target_system" ,"target_event" ,"fetchargs" ,NULL }; +const char *event, *target_system, *target_event, *fetchargs; +struct tracefs_dynevent *eprobe; + +if (!PyArg_ParseTupleAndKeywords (args, + kwargs, +"ssss" , + kwlist, + &event, + &target_system, + &target_event, + &fetchargs)) { +return NULL ; + } + + eprobe =tracefs_eprobe_alloc (TC_SYS , event, target_system, target_event, fetchargs); +if (!eprobe) { +MEM_ERROR ; +return NULL ; + } + +if (tracefs_dynevent_create (eprobe) <0 ) { +TfsError_fmt (NULL ,"Failed to create eprobe '%s'" , event); +tracefs_dynevent_free (eprobe); +return NULL ; + } + +return PyDynevent_New (eprobe); +} + +PyObject *PyDynevent_set_filter (PyDynevent *self,PyObject *args,PyObject *kwargs) {
src/ftracepy-utils.h +3 -0
@@ -207,6 +207,9 @@ PyObject *PyFtrace_register_kprobe(PyObject *self, PyObject *args,PyObject *PyFtrace_register_kretprobe (PyObject *self,PyObject *args,PyObject *kwargs); +PyObject *PyFtrace_register_eprobe (PyObject *self,PyObject *args, +PyObject *kwargs); +PyObject *PyFtrace_hist (PyObject *self,PyObject *args,PyObject *kwargs);
src/ftracepy.c +5 -0
@@ -377,6 +377,11 @@ static PyMethodDef ftracepy_methods[] = {METH_VARARGS |METH_KEYWORDS ,"Define a kretprobe." }, + {"register_eprobe", + (PyCFunction ) PyFtrace_register_eprobe, +METH_VARARGS |METH_KEYWORDS , +"Define an eprobe." + }, {"hist", (PyCFunction ) PyFtrace_hist, METH_VARARGS | METH_KEYWORDS,
tracecruncher/tests/1_unit/test_01_ftracepy_unit.py +39 -0
@@ -457,6 +457,45 @@ class KprobeTestCase(unittest.TestCase): ret = kp1.is_enabled(instance=inst) self.assertEqual(ret, '0') +class EprobeTestCase(unittest.TestCase): + def test_register_eprobe(self): + evt1 = 'sopen_in' + evt1_tsys = 'syscalls' + evt1_tevent = 'sys_enter_openat' + evt1_args = 'file=+0($filename):ustring' + evt2 = 'sopen_out' + evt2_tsys = 'syscalls' + evt2_tevent = 'sys_exit_openat' + evt2_args = 'res=$ret:u64' + + ep1 = ft.register_eprobe(event=evt1, target_system=evt1_tsys, target_event=evt1_tevent, + fetchargs=evt1_args) + self.assertEqual(evt1, ep1.event()) + self.assertEqual("{}.{}".format(evt1_tsys, evt1_tevent), ep1.address()) + self.assertEqual(evt1_args, ep1.probe()) + + ep2 = ft.register_eprobe(event=evt2, target_system=evt2_tsys, target_event=evt2_tevent, + fetchargs=evt2_args) + self.assertEqual(evt2, ep2.event()) + self.assertEqual("{}.{}".format(evt2_tsys, evt2_tevent), ep2.address()) + self.assertEqual(evt2_args, ep2.probe()) + + def test_enable_eprobe(self): + evt1 = 'sopen_out' + evt1_tsys = 'syscalls' + evt1_tevent = 'sys_exit_openat' + evt1_args = 'res=$ret:u64' + + ep1 = ft.register_eprobe(event=evt1, target_system=evt1_tsys, target_event=evt1_tevent, + fetchargs=evt1_args) + inst = ft.create_instance(instance_name) + ep1.enable(instance=inst) + ret = ep1.is_enabled(instance=inst) + self.assertEqual(ret, '1') + + ep1.disable(instance=inst) + ret = ep1.is_enabled(instance=inst) + self.assertEqual(ret, '0') class TracingOnTestCase(unittest.TestCase): def test_ON_OF(self):
Signature · 1 line
2.34.1
Quoted 18 lines · Tzvetomir Stoyanov (VMware)
Event probe (eprobe) is a new type of ftrace dynamic events, introduced in the Linux kernel 5.15 version. It is useful to have support for it in trace-cruncher, as it allows more flexibility when printing event's data.
Signed-off-by Tzvetomir Stoyanov (VMware) <[email protected]>--- src/ftracepy-utils.c | 34 ++++++++++++++++ src/ftracepy-utils.h | 3 ++ src/ftracepy.c | 5 +++ .../tests/1_unit/test_01_ftracepy_unit.py | 39 +++++++++++++++++++ 4 files changed, 81 insertions(+)src/ftracepy-utils.c +0
-0
src/ftracepy-utils.c PyObject *PyFtrace_register_kretprobe(PyObject *self, PyObject *args, · line 2069
Quoted 6 lines
src/ftracepy-utils.c +3
-0@@ -2064,6 +2064,40 @@ PyObject *PyFtrace_register_kretprobe(PyObject *self, PyObject *args,return PyDynevent_New (kprobe); } +PyObject *PyFtrace_register_eprobe (PyObject *self,PyObject *args, +PyObject *kwargs) +{
It seems that we have an inconsistency in the naming convention of the 'constructor' methods. The 'constructor' for kprobes is called 'register_kprobe', while for histograms and synthetic events we have just 'hist' and 'synth'. Lets use the short naming here (just 'eprobe') and you can remove the 'register' prefix from the constructor for kprobes in another patch.
tracecruncher/tests/1_unit/test_01_ftracepy_unit.py
Quoted 68 lines
src/ftracepy-utils.c +31
-0+static char *kwlist[] = {"event" ,"target_system" ,"target_event" ,"fetchargs" ,NULL }; +const char *event, *target_system, *target_event, *fetchargs; +struct tracefs_dynevent *eprobe; + +if (!PyArg_ParseTupleAndKeywords (args, + kwargs, +"ssss" , + kwlist, + &event, + &target_system, + &target_event, + &fetchargs)) { +return NULL ; + } + + eprobe =tracefs_eprobe_alloc (TC_SYS , event, target_system, target_event, fetchargs); +if (!eprobe) { +MEM_ERROR ; +return NULL ; + } + +if (tracefs_dynevent_create (eprobe) <0 ) { +TfsError_fmt (NULL ,"Failed to create eprobe '%s'" , event); +tracefs_dynevent_free (eprobe); +return NULL ; + } + +return PyDynevent_New (eprobe); +} + +PyObject *PyDynevent_set_filter (PyDynevent *self,PyObject *args,PyObject *kwargs) {src/ftracepy-utils.h +3
-0@@ -207,6 +207,9 @@ PyObject *PyFtrace_register_kprobe(PyObject *self, PyObject *args,PyObject *PyFtrace_register_kretprobe (PyObject *self,PyObject *args,PyObject *kwargs); +PyObject *PyFtrace_register_eprobe (PyObject *self,PyObject *args, +PyObject *kwargs); +PyObject *PyFtrace_hist (PyObject *self,PyObject *args,PyObject *kwargs);src/ftracepy.c +5
-0@@ -377,6 +377,11 @@ static PyMethodDef ftracepy_methods[] = {METH_VARARGS |METH_KEYWORDS ,"Define a kretprobe." }, + {"register_eprobe", + (PyCFunction ) PyFtrace_register_eprobe, +METH_VARARGS |METH_KEYWORDS , +"Define an eprobe." + }, {"hist", (PyCFunction ) PyFtrace_hist, METH_VARARGS | METH_KEYWORDS,tracecruncher/tests/1_unit/test_01_ftracepy_unit.py +0
-0
Please move the tests in separate patch!
tracecruncher/tests/1_unit/test_01_ftracepy_unit.py class KprobeTestCase(unittest.TestCase): · line 461
Quoted 6 lines
tracecruncher/tests/1_unit/test_01_ftracepy_unit.py +2
-0@@ -457,6 +457,45 @@ class KprobeTestCase(unittest.TestCase): ret = kp1.is_enabled(instance=inst) self.assertEqual(ret, '0') +class EprobeTestCase(unittest.TestCase): + def test_register_eprobe(self):
This fails on my machine, because I am still on the 5.13 kernel. Maybe somewhere up in the file you can add a global variable defined like this:
kernel_version = tuple(map(int, (os.uname()[2].split('.')[:2])))
and here you can check the kernel version
if kernel_version < (5, 15): return
Quoted 12 lines
tracecruncher/tests/1_unit/test_01_ftracepy_unit.py +12
-0+ evt1 = 'sopen_in' + evt1_tsys = 'syscalls' + evt1_tevent = 'sys_enter_openat' + evt1_args = 'file=+0($filename):ustring' + evt2 = 'sopen_out' + evt2_tsys = 'syscalls' + evt2_tevent = 'sys_exit_openat' + evt2_args = 'res=$ret:u64' + + ep1 = ft.register_eprobe(event=evt1, target_system=evt1_tsys, target_event=evt1_tevent, + fetchargs=evt1_args) + self.assertEqual(evt1, ep1.event())
tracecruncher/tests/1_unit/test_01_ftracepy_unit.py class KprobeTestCase(unittest.TestCase): · line 483
Quoted 10 lines
tracecruncher/tests/1_unit/test_01_ftracepy_unit.py +10
-0+ self.assertEqual("{}.{}".format(evt1_tsys, evt1_tevent), ep1.address()) + self.assertEqual(evt1_args, ep1.probe()) + + ep2 = ft.register_eprobe(event=evt2, target_system=evt2_tsys, target_event=evt2_tevent, + fetchargs=evt2_args) + self.assertEqual(evt2, ep2.event()) + self.assertEqual("{}.{}".format(evt2_tsys, evt2_tevent), ep2.address()) + self.assertEqual(evt2_args, ep2.probe()) + + def test_enable_eprobe(self):
Another kernel version check
Quoted 9 lines
tracecruncher/tests/1_unit/test_01_ftracepy_unit.py +8
-0+ evt1 = 'sopen_out' + evt1_tsys = 'syscalls' + evt1_tevent = 'sys_exit_openat' + evt1_args = 'res=$ret:u64' + + ep1 = ft.register_eprobe(event=evt1, target_system=evt1_tsys, target_event=evt1_tevent, + fetchargs=evt1_args) + inst = ft.create_instance(instance_name)
tracecruncher/tests/1_unit/test_01_ftracepy_unit.py class KprobeTestCase(unittest.TestCase): · line 501
Quoted 10 lines
tracecruncher/tests/1_unit/test_01_ftracepy_unit.py +7
-0+ ep1.enable(instance=inst) + ret = ep1.is_enabled(instance=inst) + self.assertEqual(ret, '1') + + ep1.disable(instance=inst) + ret = ep1.is_enabled(instance=inst) + self.assertEqual(ret, '0') class TracingOnTestCase(unittest.TestCase): def test_ON_OF(self):
Ideally, there must be one more patch that will add an example. Thanks!
Yordan