Commit 9c6cfe80 authored by Gabriele Monaco's avatar Gabriele Monaco Committed by Steven Rostedt (Google)
Browse files

verification/dot2k: Simplify manual steps in monitor creation 

This patch reduces and simplifies the manual steps still needed in
creating a new RV monitor.

It extends the dot2k script to create a tracepoint snippet and a
Kconfig file for the newly generated monitor. Those files can be kept
in the monitor's directory but shall be included in the main tracepoint
header and Kconfig.
Together with the checklist, dot2k now suggests the lines to add to
those files for inclusion and the Makefile line to compile the new
monitor:

 Writing the monitor into the directory monitor_name
 Almost done, checklist
   - Edit the monitor_name/monitor_name.c to add the instrumentation
   - Edit kernel/trace/rv/rv_trace.h:
 Add this line where other tracepoints are included and DA_MON_EVENTS_ID is defined:
 #include <monitors/monitor_name/monitor_name_trace.h>

   - Edit kernel/trace/rv/Makefile:
 Add this line where other monitors are included:
 obj-$(CONFIG_RV_MON_MONITOR_NAME) += monitors/monitor_name/monitor_name.o

   - Edit kernel/trace/rv/Kconfig:
 Add this line where other monitors are included:
 source "kernel/trace/rv/monitors/monitor_name/Kconfig"

   - Move monitor_name/ to the kernel's monitor directory (kernel/trace/rv/monitors)

Cc: Juri Lelli <juri.lelli@redhat.com>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: John Kacur <jkacur@redhat.com>
Link: https://lore.kernel.org/20241227144752.362911-7-gmonaco@redhat.com


Signed-off-by: default avatarGabriele Monaco <gmonaco@redhat.com>
Signed-off-by: default avatarSteven Rostedt (Google) <rostedt@goodmis.org>
parent bc3d482d

tools/verification/dot2/dot2k

+4 −4
Original line number Diff line number Diff line
@@ -35,7 +35,7 @@ if __name__ == '__main__': 
    monitor.print_files()

    print("Almost done, checklist")

    print("  - Edit the %s/%s.c to add the instrumentation" % (monitor.name, monitor.name))

    print("  - Edit include/trace/events/rv.h to add the tracepoint entry")

    print("  - Move it to the kernel's monitor directory")

    print("  - Edit kernel/trace/rv/Makefile")

    print("  - Edit kernel/trace/rv/Kconfig")
 
    print(monitor.fill_tracepoint_tooltip())

    print(monitor.fill_makefile_tooltip())

    print(monitor.fill_kconfig_tooltip())

    print("  - Move %s/ to the kernel's monitor directory (%s/monitors)" % (monitor.name, monitor.rv_dir))

tools/verification/dot2/dot2k.py

+86 −0
Original line number Diff line number Diff line
@@ -15,6 +15,7 @@ import os 
class dot2k(Dot2c):

    monitor_types = { "global" : 1, "per_cpu" : 2, "per_task" : 3 }

    monitor_templates_dir = "dot2/dot2k_templates/"

    rv_dir = "kernel/trace/rv"

    monitor_type = "per_cpu"



    def __init__(self, file_path, MonitorType, extra_params={}):
@@ -27,6 +28,8 @@ class dot2k(Dot2c): 
        self.monitor_type = MonitorType

        self.__fill_rv_templates_dir()

        self.main_c = self.__open_file(self.monitor_templates_dir + "main.c")

        self.trace_h = self.__open_file(self.monitor_templates_dir + "trace.h")

        self.kconfig = self.__open_file(self.monitor_templates_dir + "Kconfig")

        self.enum_suffix = "_%s" % self.name

        self.description = extra_params.get("description", self.name) or "auto-generated"
@@ -144,6 +147,82 @@ class dot2k(Dot2c): 


        return self.__buff_to_string(buff)



    def fill_monitor_class_type(self):

        if self.monitor_type == "per_task":

            return "DA_MON_EVENTS_ID"

        return "DA_MON_EVENTS_IMPLICIT"



    def fill_monitor_class(self):

        if self.monitor_type == "per_task":

            return "da_monitor_id"

        return "da_monitor"



    def fill_tracepoint_args_skel(self, tp_type):

        buff = []

        tp_args_event = [

                ("char *", "state"),

                ("char *", "event"),

                ("char *", "next_state"),

                ("bool ",  "final_state"),

                ]

        tp_args_error = [

                ("char *", "state"),

                ("char *", "event"),

                ]

        tp_args_id = ("int ", "id")

        tp_args = tp_args_event if tp_type == "event" else tp_args_error

        if self.monitor_type == "per_task":

            tp_args.insert(0, tp_args_id)

        tp_proto_c = ", ".join([a+b for a,b in tp_args])

        tp_args_c = ", ".join([b for a,b in tp_args])

        buff.append("	     TP_PROTO(%s)," % tp_proto_c)

        buff.append("	     TP_ARGS(%s)" % tp_args_c)

        return self.__buff_to_string(buff)



    def fill_trace_h(self):

        trace_h = self.trace_h

        monitor_class = self.fill_monitor_class()

        monitor_class_type = self.fill_monitor_class_type()

        tracepoint_args_skel_event = self.fill_tracepoint_args_skel("event")

        tracepoint_args_skel_error = self.fill_tracepoint_args_skel("error")

        trace_h = trace_h.replace("%%MODEL_NAME%%", self.name)

        trace_h = trace_h.replace("%%MODEL_NAME_UP%%", self.name.upper())

        trace_h = trace_h.replace("%%MONITOR_CLASS%%", monitor_class)

        trace_h = trace_h.replace("%%MONITOR_CLASS_TYPE%%", monitor_class_type)

        trace_h = trace_h.replace("%%TRACEPOINT_ARGS_SKEL_EVENT%%", tracepoint_args_skel_event)

        trace_h = trace_h.replace("%%TRACEPOINT_ARGS_SKEL_ERROR%%", tracepoint_args_skel_error)

        return trace_h



    def fill_kconfig(self):

        kconfig = self.kconfig

        monitor_class_type = self.fill_monitor_class_type()

        kconfig = kconfig.replace("%%MODEL_NAME%%", self.name)

        kconfig = kconfig.replace("%%MODEL_NAME_UP%%", self.name.upper())

        kconfig = kconfig.replace("%%MONITOR_CLASS_TYPE%%", monitor_class_type)

        kconfig = kconfig.replace("%%DESCRIPTION%%", self.description)

        return kconfig



    def fill_tracepoint_tooltip(self):

        monitor_class_type = self.fill_monitor_class_type()

        return """  - Edit %s/rv_trace.h:

Add this line where other tracepoints are included and %s is defined:

#include <monitors/%s/%s_trace.h>

""" % (self.rv_dir, monitor_class_type, self.name, self.name)



    def fill_kconfig_tooltip(self):

        return """  - Edit %s/Kconfig:

Add this line where other monitors are included:

source \"kernel/trace/rv/monitors/%s/Kconfig\"

""" % (self.rv_dir, self.name)



    def fill_makefile_tooltip(self):

        name = self.name

        name_up = name.upper()

        return """  - Edit %s/Makefile:

Add this line where other monitors are included:

obj-$(CONFIG_RV_MON_%s) += monitors/%s/%s.o

""" % (self.rv_dir, name_up, name, name)



    def __create_directory(self):

        try:

            os.mkdir(self.name)
@@ -182,3 +261,10 @@ class dot2k(Dot2c): 


        path = "%s.h" % self.name

        self.__create_file(path, model_h)



        trace_h = self.fill_trace_h()

        path = "%s_trace.h" % self.name

        self.__create_file(path, trace_h)



        kconfig = self.fill_kconfig()

        self.__create_file("Kconfig", kconfig)

tools/verification/dot2/dot2k_templates/Kconfig

0 → 100644
+6 −0
Original line number Diff line number Diff line 
config RV_MON_%%MODEL_NAME_UP%%

	depends on RV

	select %%MONITOR_CLASS_TYPE%%

	bool "%%MODEL_NAME%% monitor"

	help

	  %%DESCRIPTION%%

tools/verification/dot2/dot2k_templates/main.c

+1 −1
Original line number Diff line number Diff line
@@ -14,7 +14,7 @@ 
 * XXX: include required tracepoint headers, e.g.,

 * #include <trace/events/sched.h>

 */

#include <trace/events/rv.h>

#include <rv_trace.h>



/*

 * This is the self-generated part of the monitor. Generally, there is no need

tools/verification/dot2/dot2k_templates/trace.h

0 → 100644
+13 −0
Original line number Diff line number Diff line 
/* SPDX-License-Identifier: GPL-2.0 */



/*

 * Snippet to be included in rv_trace.h

 */



#ifdef CONFIG_RV_MON_%%MODEL_NAME_UP%%

DEFINE_EVENT(event_%%MONITOR_CLASS%%, event_%%MODEL_NAME%%,

%%TRACEPOINT_ARGS_SKEL_EVENT%%);



DEFINE_EVENT(error_%%MONITOR_CLASS%%, error_%%MODEL_NAME%%,

%%TRACEPOINT_ARGS_SKEL_ERROR%%);

#endif /* CONFIG_RV_MON_%%MODEL_NAME_UP%% */