Refactor tracing and debugging filenames + CONFIG macros

Tracing and Debugging filenames in Litmus were a bit clumsy. Particularly
it was not immediate to tell the content of a tracing/debugging file from
its name, and it was not intuitive to navigate through the CONFIG
macros. This commit refactors tracing/debugging filenames and the
corresponging CONFIG macros to more intuitive names.

Overhead Tracing (employs Feather Trace):
renamed: include/litmus/trace.h -> include/litmus/sched_trace_ohead.h
renamed: litmus/trace.c -> litmus/sched_trace_ohead.c

Scheduling-related tracing (employs Feather Trace):
renamed: include/litmus/sched_trace.h -> include/litmus/sched_trace_task.h
renamed: litmus/sched_task_trace.c -> litmus/sched_trace_task.c

Debugging (TRACE() macro):
renamed: litmus/sched_trace.c -> litmus/debug_trace.c

21 files changed, 57 insertions, 54 deletions

diff --git a/arch/x86/kernel/smp.c b/arch/x86/kernel/smp.c
index ed4c4f54e2ae..f120f4806457 100644
--- a/arch/x86/kernel/smp.c
+++ b/arch/x86/kernel/smp.c
@@ -25,7 +25,7 @@
 
 #include <litmus/preempt.h>
 #include <litmus/debug_trace.h>
-#include <litmus/trace.h>
+#include <litmus/sched_trace_ohead.h>
 
 #include <asm/mtrr.h>
 #include <asm/tlbflush.h>
diff --git a/include/litmus/debug_trace.h b/include/litmus/debug_trace.h
index 48d086d5a44c..bcf5a47f47cc 100644
--- a/include/litmus/debug_trace.h
+++ b/include/litmus/debug_trace.h
@@ -1,7 +1,7 @@
 #ifndef LITMUS_DEBUG_TRACE_H
 #define LITMUS_DEBUG_TRACE_H
 
-#ifdef CONFIG_SCHED_DEBUG_TRACE
+#ifdef CONFIG_LITMUS_DEBUG_TRACE
 void sched_trace_log_message(const char* fmt, ...);
 void dump_trace_buffer(int max);
 #else
@@ -12,7 +12,7 @@ void dump_trace_buffer(int max);
 
 extern atomic_t __log_seq_no;
 
-#ifdef CONFIG_SCHED_DEBUG_TRACE_CALLER
+#ifdef CONFIG_LITMUS_DEBUG_TRACE_CALLER
 #define TRACE_PREFIX "%d P%d [%s@%s:%d]: "
 #define TRACE_ARGS  atomic_add_return(1, &__log_seq_no),        \
                 raw_smp_processor_id(),                         \
diff --git a/include/litmus/litmus.h b/include/litmus/litmus.h
index 12af22266331..3f47d496870a 100644
--- a/include/litmus/litmus.h
+++ b/include/litmus/litmus.h
@@ -6,6 +6,7 @@
 #ifndef _LINUX_LITMUS_H_
 #define _LINUX_LITMUS_H_
 
+#include <linux/sched.h>
 #include <litmus/debug_trace.h>
 
 #ifdef CONFIG_RELEASE_MASTER
@@ -226,7 +227,7 @@ static inline void clear_exit_np(struct task_struct *t)
 
 static inline int is_np(struct task_struct *t)
 {
-#ifdef CONFIG_SCHED_DEBUG_TRACE
+#ifdef CONFIG_LITMUS_DEBUG_TRACE
         int kernel, user;
         kernel = is_kernel_np(t);
         user   = is_user_np(t);
diff --git a/include/litmus/trace.h b/include/litmus/sched_trace_ohead.h
index e2926a08c2f4..1e743599eb5c 100644
--- a/include/litmus/trace.h
+++ b/include/litmus/sched_trace_ohead.h
@@ -1,7 +1,11 @@
-#ifndef _SYS_TRACE_H_
-#define _SYS_TRACE_H_
+/*
+ * sched_trace_overhead.h - wrappers around feather_trace callbacks
+ * for scheduling overheads tracing.
+ */
+#ifndef _SCHED_TRACE_OVERHEAD_H_
+#define _SCHED_TRACE_OVERHEAD_H_
 
-#ifdef CONFIG_SCHED_OVERHEAD_TRACE
+#ifdef CONFIG_SCHED_TRACE_OVERHEAD
 
 #include <litmus/feather_trace.h>
 #include <litmus/feather_buffer.h>
@@ -43,7 +47,7 @@ feather_callback void save_task_latency(unsigned long event, unsigned long when_
 #define LTIMESTAMP(id, task) \
         ft_event1(id, save_task_latency, (unsigned long) task)
 
-#else /* !CONFIG_SCHED_OVERHEAD_TRACE */
+#else /* !CONFIG_SCHED_TRACE_OVERHEAD */
 
 #define TIMESTAMP(id)        /* no tracing */
 
diff --git a/include/litmus/sched_trace.h b/include/litmus/sched_trace_task.h
index 7ca34cb13881..bfe1fc015d4a 100644
--- a/include/litmus/sched_trace.h
+++ b/include/litmus/sched_trace_task.h
@@ -1,8 +1,8 @@
 /*
- * sched_trace.h -- record scheduler events to a byte stream for offline analysis.
+ * sched_trace_task.h -- record scheduler events to a byte stream for offline analysis.
  */
-#ifndef _LINUX_SCHED_TRACE_H_
-#define _LINUX_SCHED_TRACE_H_
+#ifndef _LINUX_SCHED_TRACE_TASK_H_
+#define _LINUX_SCHED_TRACE_TASK_H_
 
 /* all times in nanoseconds */
 
@@ -123,7 +123,7 @@ struct st_event_record {
 #include <linux/sched.h>
 #include <litmus/feather_trace.h>
 
-#ifdef CONFIG_SCHED_TASK_TRACE
+#ifdef CONFIG_SCHED_TRACE_TASK
 
 #define SCHED_TRACE(id, callback, task) \
         ft_event1(id, callback, task)
diff --git a/kernel/sched.c b/kernel/sched.c
index baaca61bc3a3..05bcd855c38b 100644
--- a/kernel/sched.c
+++ b/kernel/sched.c
@@ -80,8 +80,8 @@
 #include "workqueue_sched.h"
 #include "sched_autogroup.h"
 
-#include <litmus/sched_trace.h>
-#include <litmus/trace.h>
+#include <litmus/sched_trace_task.h>
+#include <litmus/sched_trace_ohead.h>
 
 static void litmus_tick(struct rq*, struct task_struct*);
 
diff --git a/litmus/Kconfig b/litmus/Kconfig
index 94b48e199577..e680382329b6 100644
--- a/litmus/Kconfig
+++ b/litmus/Kconfig
@@ -104,7 +104,7 @@ config FEATHER_TRACE
           you still need to enable SCHED_TASK_TRACE and/or SCHED_OVERHEAD_TRACE to
           actually enable any events.
 
-config SCHED_TASK_TRACE
+config SCHED_TRACE_TASK
         bool "Trace real-time tasks"
         depends on FEATHER_TRACE
         default y
@@ -118,9 +118,9 @@ config SCHED_TASK_TRACE
           Say Yes for debugging.
           Say No for overhead tracing.
 
-config SCHED_TASK_TRACE_SHIFT
+config SCHED_TRACE_TASK_SHIFT
        int "Buffer size for sched_trace_xxx() events"
-       depends on SCHED_TASK_TRACE
+       depends on SCHED_TRACE_TASK
        range 8 13
        default 9
        help
@@ -138,7 +138,7 @@ config SCHED_TASK_TRACE_SHIFT
                    10 =>   1k events
                     8 =>  512 events
 
-config SCHED_OVERHEAD_TRACE
+config SCHED_TRACE_OVERHEAD
         bool "Record timestamps for overhead measurements"
         depends on FEATHER_TRACE
         default n
@@ -146,11 +146,11 @@ config SCHED_OVERHEAD_TRACE
           Export event stream for overhead tracing.
           Say Yes for overhead tracing.
 
-config SCHED_DEBUG_TRACE
+config LITMUS_DEBUG_TRACE
         bool "TRACE() debugging"
         default y
         help
-          Include support for sched_trace_log_messageg(), which is used to
+          Include support for sched_trace_log_messages(), which is used to
           implement TRACE(). If disabled, no TRACE() messages will be included
           in the kernel, and no overheads due to debugging statements will be
           incurred by the scheduler. Disable if the overhead is not acceptable
@@ -159,9 +159,9 @@ config SCHED_DEBUG_TRACE
           Say Yes for debugging.
           Say No for overhead tracing.
 
-config SCHED_DEBUG_TRACE_SHIFT
+config LITMUS_DEBUG_TRACE_SHIFT
        int "Buffer size for TRACE() buffer"
-       depends on SCHED_DEBUG_TRACE
+       depends on LITMUS_DEBUG_TRACE
        range 14 22
        default 18
        help
@@ -184,9 +184,9 @@ config SCHED_DEBUG_TRACE_SHIFT
         character device node should be created at /dev/litmus/log. The buffer
         can be flushed using cat, e.g., 'cat /dev/litmus/log > my_log_file.txt'.
 
-config SCHED_DEBUG_TRACE_CALLER
+config LITMUS_DEBUG_TRACE_CALLER
        bool "Include [function@file:line] tag in TRACE() log"
-       depends on SCHED_DEBUG_TRACE
+       depends on LITMUS_DEBUG_TRACE
        default n
        help
          With this option enabled, TRACE() prepends
diff --git a/litmus/Makefile b/litmus/Makefile
index 7338180f196f..f98d5ee0ce6a 100644
--- a/litmus/Makefile
+++ b/litmus/Makefile
@@ -24,6 +24,6 @@ obj-$(CONFIG_PLUGIN_PFAIR) += sched_pfair.o
 obj-$(CONFIG_SCHED_CPU_AFFINITY) += affinity.o
 
 obj-$(CONFIG_FEATHER_TRACE) += ft_event.o ftdev.o
-obj-$(CONFIG_SCHED_TASK_TRACE) += sched_task_trace.o
-obj-$(CONFIG_SCHED_DEBUG_TRACE) += sched_trace.o
-obj-$(CONFIG_SCHED_OVERHEAD_TRACE) += trace.o
+obj-$(CONFIG_SCHED_TRACE_TASK) += sched_trace_task.o
+obj-$(CONFIG_SCHED_TRACE_OVERHEAD) += sched_trace_ohead.o
+obj-$(CONFIG_LITMUS_DEBUG_TRACE) += debug_trace.o
diff --git a/litmus/sched_trace.c b/litmus/debug_trace.c
index f4171fddbbb1..7ed21d4e7139 100644
--- a/litmus/sched_trace.c
+++ b/litmus/debug_trace.c
@@ -1,5 +1,5 @@
 /*
- * sched_trace.c -- record scheduling events to a byte stream.
+ * debug_trace.c -- record debugging trace events on a bytes stream.
  */
 #include <linux/spinlock.h>
 #include <linux/mutex.h>
@@ -13,13 +13,12 @@
 
 #include <linux/kfifo.h>
 
-#include <litmus/sched_trace.h>
 #include <litmus/litmus.h>
 
-#define SCHED_TRACE_NAME "litmus/log"
+#define LITMUS_TRACE_NAME "litmus/log"
 
 /* Compute size of TRACE() buffer */
-#define LITMUS_TRACE_BUF_SIZE (1 << CONFIG_SCHED_DEBUG_TRACE_SHIFT)
+#define LITMUS_TRACE_BUF_SIZE (1 << CONFIG_LITMUS_DEBUG_TRACE_SHIFT)
 
 /* Max length of one read from the buffer */
 #define MAX_READ_LEN (64 * 1024)
@@ -194,7 +193,7 @@ static struct file_operations log_fops = {
 };
 
 static struct miscdevice litmus_log_dev = {
-        .name    = SCHED_TRACE_NAME,
+        .name    = LITMUS_TRACE_NAME,
         .minor   = MISC_DYNAMIC_MINOR,
         .fops    = &log_fops,
 };
diff --git a/litmus/edf_common.c b/litmus/edf_common.c
index 9b44dc2d8d1e..4d67f4b731ac 100644
--- a/litmus/edf_common.c
+++ b/litmus/edf_common.c
@@ -10,7 +10,6 @@
 
 #include <litmus/litmus.h>
 #include <litmus/sched_plugin.h>
-#include <litmus/sched_trace.h>
 
 #include <litmus/edf_common.h>
 
diff --git a/litmus/litmus.c b/litmus/litmus.c
index 301390148d02..196f2ebc0664 100644
--- a/litmus/litmus.c
+++ b/litmus/litmus.c
@@ -12,10 +12,10 @@
 
 #include <litmus/litmus.h>
 #include <litmus/bheap.h>
-#include <litmus/trace.h>
 #include <litmus/rt_domain.h>
 #include <litmus/litmus_proc.h>
-#include <litmus/sched_trace.h>
+#include <litmus/sched_trace_task.h>
+#include <litmus/sched_trace_ohead.h>
 
 #ifdef CONFIG_SCHED_CPU_AFFINITY
 #include <litmus/affinity.h>
diff --git a/litmus/locking.c b/litmus/locking.c
index 0c1aa6aa40b7..213c68ec6c61 100644
--- a/litmus/locking.c
+++ b/litmus/locking.c
@@ -3,7 +3,7 @@
 #ifdef CONFIG_LITMUS_LOCKING
 
 #include <litmus/sched_plugin.h>
-#include <litmus/trace.h>
+#include <litmus/sched_trace_ohead.h>
 
 static int create_generic_lock(void** obj_ref, obj_type_t type, void* __user arg);
 static int open_generic_lock(struct od_table_entry* entry, void* __user arg);
diff --git a/litmus/rt_domain.c b/litmus/rt_domain.c
index d405854cd39c..3b777d539812 100644
--- a/litmus/rt_domain.c
+++ b/litmus/rt_domain.c
@@ -13,11 +13,11 @@
 
 #include <litmus/litmus.h>
 #include <litmus/sched_plugin.h>
-#include <litmus/sched_trace.h>
+#include <litmus/sched_trace_task.h>
 
 #include <litmus/rt_domain.h>
 
-#include <litmus/trace.h>
+#include <litmus/sched_trace_ohead.h>
 
 #include <litmus/bheap.h>
 
diff --git a/litmus/sched_cedf.c b/litmus/sched_cedf.c
index 480c62bc895b..abc2808f1cdc 100644
--- a/litmus/sched_cedf.c
+++ b/litmus/sched_cedf.c
@@ -37,7 +37,7 @@
 #include <litmus/preempt.h>
 #include <litmus/sched_plugin.h>
 #include <litmus/edf_common.h>
-#include <litmus/sched_trace.h>
+#include <litmus/sched_trace_task.h>
 
 #include <litmus/clustered.h>
 
diff --git a/litmus/sched_gsn_edf.c b/litmus/sched_gsn_edf.c
index 6ed504f4750e..330c26cfcf0a 100644
--- a/litmus/sched_gsn_edf.c
+++ b/litmus/sched_gsn_edf.c
@@ -17,8 +17,8 @@
 #include <litmus/jobs.h>
 #include <litmus/sched_plugin.h>
 #include <litmus/edf_common.h>
-#include <litmus/sched_trace.h>
-#include <litmus/trace.h>
+#include <litmus/sched_trace_task.h>
+#include <litmus/sched_trace_ohead.h>
 
 #include <litmus/preempt.h>
 
diff --git a/litmus/sched_pfair.c b/litmus/sched_pfair.c
index 16f1065bbdca..c97b8d62bba4 100644
--- a/litmus/sched_pfair.c
+++ b/litmus/sched_pfair.c
@@ -20,7 +20,7 @@
 #include <litmus/preempt.h>
 #include <litmus/rt_domain.h>
 #include <litmus/sched_plugin.h>
-#include <litmus/sched_trace.h>
+#include <litmus/sched_trace_task.h>
 
 #include <litmus/bheap.h>
 
diff --git a/litmus/sched_psn_edf.c b/litmus/sched_psn_edf.c
index 8e4a22dd8d6a..ce6981cecb02 100644
--- a/litmus/sched_psn_edf.c
+++ b/litmus/sched_psn_edf.c
@@ -19,8 +19,8 @@
 #include <litmus/preempt.h>
 #include <litmus/sched_plugin.h>
 #include <litmus/edf_common.h>
-#include <litmus/sched_trace.h>
-#include <litmus/trace.h>
+#include <litmus/sched_trace_task.h>
+#include <litmus/sched_trace_ohead.h>
 
 typedef struct {
         rt_domain_t             domain;
diff --git a/litmus/trace.c b/litmus/sched_trace_ohead.c
index 5d77806da647..582b00d216e4 100644
--- a/litmus/trace.c
+++ b/litmus/sched_trace_ohead.c
@@ -4,7 +4,7 @@
 
 #include <litmus/ftdev.h>
 #include <litmus/litmus.h>
-#include <litmus/trace.h>
+#include <litmus/sched_trace_ohead.h>
 
 /******************************************************************************/
 /*                          Allocation                                        */
diff --git a/litmus/sched_task_trace.c b/litmus/sched_trace_task.c
index 5ef8d09ab41f..f142fac54e3b 100644
--- a/litmus/sched_task_trace.c
+++ b/litmus/sched_trace_task.c
@@ -1,5 +1,5 @@
 /*
- * sched_task_trace.c -- record scheduling events to a byte stream
+ * sched_trace_task.c -- record scheduling events to a byte stream
  */
 
 #define NO_TASK_TRACE_DECLS
@@ -11,12 +11,12 @@
 #include <litmus/ftdev.h>
 #include <litmus/litmus.h>
 
-#include <litmus/sched_trace.h>
 #include <litmus/feather_trace.h>
 #include <litmus/ftdev.h>
+#include <litmus/sched_trace_task.h>
 
 
-#define NO_EVENTS               (1 << CONFIG_SCHED_TASK_TRACE_SHIFT)
+#define NO_EVENTS               (1 << CONFIG_SCHED_TRACE_TASK_SHIFT)
 
 #define now() litmus_clock()
 
@@ -35,7 +35,7 @@ static int st_dev_can_open(struct ftdev *dev, unsigned int cpu)
         return cpu_online(cpu) ? 0 : -ENODEV;
 }
 
-static int __init init_sched_task_trace(void)
+static int __init init_sched_trace_task(void)
 {
         struct local_buffer* buf;
         int i, ok = 0, err;
@@ -75,13 +75,13 @@ err_out:
         return err;
 }
 
-static void __exit exit_sched_task_trace(void)
+static void __exit exit_sched_trace_task(void)
 {
         ftdev_exit(&st_dev);
 }
 
-module_init(init_sched_task_trace);
-module_exit(exit_sched_task_trace);
+module_init(init_sched_trace_task);
+module_exit(exit_sched_trace_task);
 
 
 static inline struct st_event_record* get_record(u8 type, struct task_struct* t)
diff --git a/litmus/srp.c b/litmus/srp.c
index 2ed4ec12a9d3..5653870e20e9 100644
--- a/litmus/srp.c
+++ b/litmus/srp.c
@@ -9,7 +9,7 @@
 #include <litmus/litmus.h>
 #include <litmus/sched_plugin.h>
 #include <litmus/fdso.h>
-#include <litmus/trace.h>
+#include <litmus/sched_trace_ohead.h>
 
 
 #ifdef CONFIG_LITMUS_LOCKING
diff --git a/litmus/sync.c b/litmus/sync.c
index bf75fde5450b..bf76d2f778ac 100644
--- a/litmus/sync.c
+++ b/litmus/sync.c
@@ -14,7 +14,7 @@
 #include <litmus/sched_plugin.h>
 #include <litmus/jobs.h>
 
-#include <litmus/sched_trace.h>
+#include <litmus/sched_trace_task.h>
 
 static DECLARE_COMPLETION(ts_release);