31  * == Runtime monitor interface ==
33  * A monitor is the central part of the runtime verification of a system.
35  * The monitor stands in between the formal specification of the desired
39  * inside the "RV monitor" abstraction. A RV monitor includes a reference
40  * model of the system, a set of instances of the monitor (per-cpu monitor,
41  * per-task monitor, and so on), and the helper functions that glue the
42  * monitor to the system via trace. Generally, a monitor includes some form
46  * Linux  +----- RV Monitor ----------------------------------+ Formal
49  *  |   Linux kernel    |     |     Monitor    |     |     Reference   |
70  * a verification session. For instance, when a given monitor is enabled,
75  * A RV monitor is registered via:
76  *   int rv_register_monitor(struct rv_monitor *monitor);
78  *   int rv_unregister_monitor(struct rv_monitor *monitor);
95  *    - Writing to it enables a given monitor;
96  *    - Writing a monitor name with a '!' prefix disables it;
113  *    Note that more than one monitor can be enabled concurrently.
123  *    Each monitor will have its own directory inside "monitors/". There
124  *    the monitor specific files will be presented.
133  *      auto-generated wakeup in preemptive monitor.
163  * Interface for the monitor register.
210  * This section collects the monitor/ files and folders.
218 	buff = mdef->monitor->enabled ? "1\n" : "0\n";  in monitor_enable_read_data()
224  * __rv_disable_monitor - disabled an enabled monitor
230 	if (mdef->monitor->enabled) {  in __rv_disable_monitor()
231 		mdef->monitor->enabled = 0;  in __rv_disable_monitor()
232 		mdef->monitor->disable();  in __rv_disable_monitor()
236 		 * Otherwise, the data used by the monitor could  in __rv_disable_monitor()
237 		 * be inconsistent. i.e., if the monitor is re-enabled.  in __rv_disable_monitor()
247  * rv_disable_monitor - disable a given runtime monitor
248  * @mdef: Pointer to the monitor definition structure.
259  * rv_enable_monitor - enable a given runtime monitor
260  * @mdef: Pointer to the monitor definition structure.
270 	if (mdef->monitor->enabled)  in rv_enable_monitor()
273 	retval = mdef->monitor->enable();  in rv_enable_monitor()
276 		mdef->monitor->enabled = 1;  in rv_enable_monitor()
282  * interface for enabling/disabling a monitor.
324 	snprintf(buff, sizeof(buff), "%s\n", mdef->monitor->description);  in monitor_desc_read_data()
335  * During the registration of a monitor, this function creates
336  * the monitor dir, where the specific options of the monitor
342 	const char *name = mdef->monitor->name;  in create_monitor_dir()
374  * Available/Enable monitor shared seq functions.
380 	seq_printf(m, "%s\n", mon_def->monitor->name);  in monitors_show()
394  * Available monitor seq functions.
408  * Enable monitor seq functions.
417 		if (m_def->monitor->enabled)  in enabled_monitors_next()
493 		 * Otherwise, the data used by the monitor could  in disable_all_monitors()
494 		 * be inconsistent. i.e., if the monitor is re-enabled.  in disable_all_monitors()
545 		if (strcmp(ptr, mdef->monitor->name) != 0)  in enabled_monitors_write()
549 		 * Monitor found!  in enabled_monitors_write()
616 		if (mdef->monitor->enabled)  in reset_all_monitors()
617 			mdef->monitor->reset();  in reset_all_monitors()
686  * rv_register_monitor - register a rv monitor.
687  * @monitor:    The rv_monitor to be registered.
691 int rv_register_monitor(struct rv_monitor *monitor)  in rv_register_monitor()  argument
696 	if (strlen(monitor->name) >= MAX_RV_MONITOR_NAME_SIZE) {  in rv_register_monitor()
697 		pr_info("Monitor %s has a name longer than %d\n", monitor->name,  in rv_register_monitor()
705 		if (strcmp(monitor->name, r->monitor->name) == 0) {  in rv_register_monitor()
706 			pr_info("Monitor %s is already registered\n", monitor->name);  in rv_register_monitor()
718 	r->monitor = monitor;  in rv_register_monitor()
734  * rv_unregister_monitor - unregister a rv monitor.
735  * @monitor:    The rv_monitor to be unregistered.
739 int rv_unregister_monitor(struct rv_monitor *monitor)  in rv_unregister_monitor()  argument
746 		if (strcmp(monitor->name, ptr->monitor->name) == 0) {  in rv_unregister_monitor()