tools/rv: Add dot2k

	$(INSTALL) automata.py -D -m 644 $(DESTDIR)$(PYLIB)/dot2/automata.py

	$(INSTALL) dot2c.py -D -m 644 $(DESTDIR)$(PYLIB)/dot2/dot2c.py

	$(INSTALL) dot2c -D -m 755 $(DESTDIR)$(bindir)/

	$(INSTALL) dot2k.py -D -m 644 $(DESTDIR)$(PYLIB)/dot2/dot2k.py

	$(INSTALL) dot2k -D -m 755 $(DESTDIR)$(bindir)/

	mkdir -p ${miscdir}/

	cp -rp dot2k_templates $(DESTDIR)$(miscdir)/

#!/usr/bin/env python3

# SPDX-License-Identifier: GPL-2.0-only

#

# Copyright (C) 2019-2022 Red Hat, Inc. Daniel Bristot de Oliveira <bristot@kernel.org>

#

# dot2k: transform dot files into a monitor for the Linux kernel.

if __name__ == '__main__':

    from dot2.dot2k import dot2k

    import argparse

    import ntpath

    import os

    import platform

    import sys

    import sys

    import argparse

    parser = argparse.ArgumentParser(description='transform .dot file into kernel rv monitor')

    parser.add_argument('-d', "--dot", dest="dot_file", required=True)

    parser.add_argument('-t', "--monitor_type", dest="monitor_type", required=True)

    parser.add_argument('-n', "--model_name", dest="model_name", required=False)

    parser.add_argument("-D", "--description", dest="description", required=False)

    params = parser.parse_args()

    print("Opening and parsing the dot file %s" % params.dot_file)

    try:

        monitor=dot2k(params.dot_file, params.monitor_type)

    except Exception as e:

        print('Error: '+ str(e))

        print("Sorry : :-(")

        sys.exit(1)

    # easier than using argparse action.

    if params.model_name != None:

        print(params.model_name)

    print("Writing the monitor into the directory %s" % monitor.name)

    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")

#!/usr/bin/env python3

# SPDX-License-Identifier: GPL-2.0-only

#

# Copyright (C) 2019-2022 Red Hat, Inc. Daniel Bristot de Oliveira <bristot@kernel.org>

#

# dot2k: transform dot files into a monitor for the Linux kernel.

from dot2.dot2c import Dot2c

import platform

import os

class dot2k(Dot2c):

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

    monitor_templates_dir = "dot2k/rv_templates/"

    monitor_type = "per_cpu"

    def __init__(self, file_path, MonitorType):

        super().__init__(file_path)

        self.monitor_type = self.monitor_types.get(MonitorType)

        if self.monitor_type == None:

            raise Exception("Unknown monitor type: %s" % MonitorType)

        self.monitor_type = MonitorType

        self.__fill_rv_templates_dir()

        self.main_c = self.__open_file(self.monitor_templates_dir + "main_" + MonitorType + ".c")

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

    def __fill_rv_templates_dir(self):

        if os.path.exists(self.monitor_templates_dir) == True:

            return

        if platform.system() != "Linux":

            raise Exception("I can only run on Linux.")

        kernel_path = "/lib/modules/%s/build/tools/verification/dot2/dot2k_templates/" % (platform.release())

        if os.path.exists(kernel_path) == True:

            self.monitor_templates_dir = kernel_path

            return

        if os.path.exists("/usr/share/dot2/dot2k_templates/") == True:

            self.monitor_templates_dir = "/usr/share/dot2/dot2k_templates/"

            return

        raise Exception("Could not find the template directory, do you have the kernel source installed?")

    def __open_file(self, path):

        try:

            fd = open(path)

        except OSError:

            raise Exception("Cannot open the file: %s" % path)

        content = fd.read()

        return content

    def __buff_to_string(self, buff):

        string = ""

        for line in buff:

            string = string + line + "\n"

        # cut off the last \n

        return string[:-1]

    def fill_tracepoint_handlers_skel(self):

        buff = []

        for event in self.events:

            buff.append("static void handle_%s(void *data, /* XXX: fill header */)" % event)

            buff.append("{")

            if self.monitor_type == "per_task":

                buff.append("\tstruct task_struct *p = /* XXX: how do I get p? */;");

                buff.append("\tda_handle_event_%s(p, %s%s);" % (self.name, event, self.enum_suffix));

            else:

                buff.append("\tda_handle_event_%s(%s%s);" % (self.name, event, self.enum_suffix));

            buff.append("}")

            buff.append("")

        return self.__buff_to_string(buff)

    def fill_tracepoint_attach_probe(self):

        buff = []

        for event in self.events:

            buff.append("\trv_attach_trace_probe(\"%s\", /* XXX: tracepoint */, handle_%s);" % (self.name, event))

        return self.__buff_to_string(buff)

    def fill_tracepoint_detach_helper(self):

        buff = []

        for event in self.events:

            buff.append("\trv_detach_trace_probe(\"%s\", /* XXX: tracepoint */, handle_%s);" % (self.name, event))

        return self.__buff_to_string(buff)

    def fill_main_c(self):

        main_c = self.main_c

        min_type = self.get_minimun_type()

        nr_events = self.events.__len__()

        tracepoint_handlers = self.fill_tracepoint_handlers_skel()

        tracepoint_attach = self.fill_tracepoint_attach_probe()

        tracepoint_detach = self.fill_tracepoint_detach_helper()

        main_c = main_c.replace("MIN_TYPE", min_type)

        main_c = main_c.replace("MODEL_NAME", self.name)

        main_c = main_c.replace("NR_EVENTS", str(nr_events))

        main_c = main_c.replace("TRACEPOINT_HANDLERS_SKEL", tracepoint_handlers)

        main_c = main_c.replace("TRACEPOINT_ATTACH", tracepoint_attach)

        main_c = main_c.replace("TRACEPOINT_DETACH", tracepoint_detach)

        return main_c

    def fill_model_h_header(self):

        buff = []

        buff.append("/*")

        buff.append(" * Automatically generated C representation of %s automaton" % (self.name))

        buff.append(" * For further information about this format, see kernel documentation:")

        buff.append(" *   Documentation/trace/rv/deterministic_automata.rst")

        buff.append(" */")

        buff.append("")

        return buff

    def fill_model_h(self):

        #

        # Adjust the definition names

        #

        self.enum_states_def = "states_%s" % self.name

        self.enum_events_def = "events_%s" % self.name

        self.struct_automaton_def = "automaton_%s" % self.name

        self.var_automaton_def = "automaton_%s" % self.name

        buff = self.fill_model_h_header()

        buff += self.format_model()

        return self.__buff_to_string(buff)

    def __create_directory(self):

        try:

            os.mkdir(self.name)

        except FileExistsError:

            return

        except:

            print("Fail creating the output dir: %s" % self.name)

    def __create_file(self, file_name, content):

        path = "%s/%s" % (self.name, file_name)

        try:

            file = open(path, 'w')

        except FileExistsError:

            return

        except:

            print("Fail creating file: %s" % path)

        file.write(content)

        file.close()

    def __get_main_name(self):

        path = "%s/%s" % (self.name, "main.c")

        if os.path.exists(path) == False:

           return "main.c"

        return "__main.c"

    def print_files(self):

        main_c = self.fill_main_c()

        model_h = self.fill_model_h()

        self.__create_directory()

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

        self.__create_file(path, main_c)

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

        self.__create_file(path, model_h)

// SPDX-License-Identifier: GPL-2.0

#include <linux/ftrace.h>

#include <linux/tracepoint.h>

#include <linux/kernel.h>

#include <linux/module.h>

#include <linux/init.h>

#include <linux/rv.h>

#include <rv/instrumentation.h>

#include <rv/da_monitor.h>

#define MODULE_NAME "MODEL_NAME"

/*

 * XXX: include required tracepoint headers, e.g.,

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

 */

#include <trace/events/rv.h>

/*

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

 * to touch this section.

 */

#include "MODEL_NAME.h"

/*

 * Declare the deterministic automata monitor.

 *

 * The rv monitor reference is needed for the monitor declaration.

 */

struct rv_monitor rv_MODEL_NAME;

DECLARE_DA_MON_GLOBAL(MODEL_NAME, MIN_TYPE);

/*

 * This is the instrumentation part of the monitor.

 *

 * This is the section where manual work is required. Here the kernel events

 * are translated into model's event.

 *

 */

TRACEPOINT_HANDLERS_SKEL

static int enable_MODEL_NAME(void)

{

	int retval;

	retval = da_monitor_init_MODEL_NAME();

	if (retval)

		return retval;

TRACEPOINT_ATTACH

	return 0;

}

static void disable_MODEL_NAME(void)

{

	rv_MODEL_NAME.enabled = 0;

TRACEPOINT_DETACH

	da_monitor_destroy_MODEL_NAME();

}

/*

 * This is the monitor register section.

 */

struct rv_monitor rv_MODEL_NAME = {

	.name = "MODEL_NAME",

	.description = "auto-generated MODEL_NAME",

	.enable = enable_MODEL_NAME,

	.disable = disable_MODEL_NAME,

	.reset = da_monitor_reset_all_MODEL_NAME,

	.enabled = 0,

};

static int register_MODEL_NAME(void)

{

	rv_register_monitor(&rv_MODEL_NAME);

	return 0;

}

static void unregister_MODEL_NAME(void)

{

	rv_unregister_monitor(&rv_MODEL_NAME);

}

module_init(register_MODEL_NAME);

module_exit(unregister_MODEL_NAME);

MODULE_LICENSE("GPL");

MODULE_AUTHOR("dot2k: auto-generated");

MODULE_DESCRIPTION("MODEL_NAME");

// SPDX-License-Identifier: GPL-2.0

#include <linux/ftrace.h>

#include <linux/tracepoint.h>

#include <linux/kernel.h>

#include <linux/module.h>

#include <linux/init.h>

#include <linux/rv.h>

#include <rv/instrumentation.h>

#include <rv/da_monitor.h>

#define MODULE_NAME "MODEL_NAME"

/*

 * XXX: include required tracepoint headers, e.g.,

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

 */

#include <trace/events/rv.h>

/*

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

 * to touch this section.

 */

#include "MODEL_NAME.h"

/*

 * Declare the deterministic automata monitor.

 *

 * The rv monitor reference is needed for the monitor declaration.

 */

struct rv_monitor rv_MODEL_NAME;

DECLARE_DA_MON_PER_CPU(MODEL_NAME, MIN_TYPE);

/*

 * This is the instrumentation part of the monitor.

 *

 * This is the section where manual work is required. Here the kernel events

 * are translated into model's event.

 *

 */

TRACEPOINT_HANDLERS_SKEL

static int enable_MODEL_NAME(void)

{

	int retval;

	retval = da_monitor_init_MODEL_NAME();

	if (retval)

		return retval;

TRACEPOINT_ATTACH

	return 0;

}

static void disable_MODEL_NAME(void)

{

	rv_MODEL_NAME.enabled = 0;

TRACEPOINT_DETACH

	da_monitor_destroy_MODEL_NAME();

}

/*

 * This is the monitor register section.

 */

struct rv_monitor rv_MODEL_NAME = {

	.name = "MODEL_NAME",

	.description = "auto-generated MODEL_NAME",

	.enable = enable_MODEL_NAME,

	.disable = disable_MODEL_NAME,

	.reset = da_monitor_reset_all_MODEL_NAME,

	.enabled = 0,

};

static int register_MODEL_NAME(void)

{

	rv_register_monitor(&rv_MODEL_NAME);

	return 0;

}

static void unregister_MODEL_NAME(void)

{

	rv_unregister_monitor(&rv_MODEL_NAME);

}

module_init(register_MODEL_NAME);

module_exit(unregister_MODEL_NAME);

MODULE_LICENSE("GPL");

MODULE_AUTHOR("dot2k: auto-generated");

MODULE_DESCRIPTION("MODEL_NAME");