Read locations of binary files from path instead of config.py.

14 files changed, 86 insertions, 77 deletions

diff --git a/.gitignore b/.gitignore
index 5d257d4..dfe8620 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,3 @@
-config/config.py
 *~
 \#*#
 *.pyc
diff --git a/common.py b/common.py
index 984f584..0990cfe 100644
--- a/common.py
+++ b/common.py
@@ -2,6 +2,29 @@ import sys
 from collections import defaultdict
 from textwrap import dedent
 
+def get_executable(prog, hint, optional=False):
+    import os
+    def is_exe(fpath):
+        return os.path.isfile(fpath) and os.access(fpath, os.X_OK)
+
+    fpath, fname = os.path.split(prog)
+    if fpath:
+        if is_exe(prog):
+            return prog
+    else:
+        for path in os.environ["PATH"].split(os.pathsep):
+            exe_file = os.path.join(path, prog)
+            if is_exe(exe_file):
+                return exe_file
+
+    if not optional:
+        sys.stderr.write("Cannot find executable '%s' in PATH. This is a part "
+                         "of '%s' which should be added to PATH to run." %
+                         (prog, hint))
+        sys.exit(1)
+    else:
+        return None
+
 def recordtype(typename, field_names, default=0):
     ''' Mutable namedtuple. Recipe from George Sakkis of MIT.'''
     field_names = tuple(map(str, field_names))
@@ -87,5 +110,3 @@ def load_params(fname):
         raise IOError("Invalid param file: %s\n%s" % (fname, e))
 
     return params
-
-
diff --git a/config/config.example.py b/config/config.example.py
deleted file mode 100644
index 9f24097..0000000
--- a/config/config.example.py
+++ /dev/null
@@ -1,58 +0,0 @@
-from __future__ import print_function
-import os
-import sys
-import itertools
-
-'''
-These are paths to repository directories.
-
-'''
-REPOS = {'liblitmus'   : '/home/hermanjl/git/liblitmus',
-         'sched_trace' : '/home/hermanjl/git/sched_trace',
-         'ft_tools'    : '/home/hermanjl/git/feather-trace-tools',
-         'trace-cmd'   : '/home/hermanjl/git/trace-cmd'}
-
-BINS = {'rtspin'    : '{}/rtspin'.format(REPOS['liblitmus']),
-        'release'   : '{}/release_ts'.format(REPOS['liblitmus']),
-        'ftcat'     : '{}/ftcat'.format(REPOS['ft_tools']),
-        'ftsplit'   : '{}/ft2csv'.format(REPOS['ft_tools']),
-        'ftsort'    : '{}/ftsort'.format(REPOS['ft_tools']),
-        'st_trace'  : '{}/st_trace'.format(REPOS['ft_tools']),
-        'trace-cmd' : '{}/trace-cmd'.format(REPOS['trace-cmd']),
-        'st_show'   : '{}/st_show'.format(REPOS['sched_trace'])}
-
-DEFAULTS = {'params_file' : 'params.py',
-            'sched_file'  : 'sched.py',
-            'exps_file'   : 'exps.py',
-            'duration'    : 10,
-            'spin'                : 'rtspin',
-            'cycles'      : 2000}
-
-FILES = {'ft_data'    : 'ft.bin',
-         'linux_data' : 'trace.dat',
-         'sched_data' : 'st-{}.bin',
-         'log_data'   : 'trace.slog',}
-
-PARAMS = {'sched' : 'scheduler',
-          'dur'   : 'duration',
-          'kernel': 'uname',
-          'cycles' : 'cpu-frequency'}
-
-SCHED_EVENTS = range(501, 513)
-BASE_EVENTS  = ['SCHED', 'RELEASE', 'SCHED2', 'TICK', 'CXS']
-ALL_EVENTS   = ["%s_%s" % (e, t) for (e,t) in
-                itertools.product(BASE_EVENTS, ["START","END"])]
-ALL_EVENTS  += ['RELEASE_LATENCY']
-BASE_EVENTS += ['RELEASE_LATENCY']
-
-valid = True
-for repo, loc in REPOS.items():
-    if not os.path.isdir(loc):
-        valid = False
-        print("Cannot access repo '%s' at '%s'" % (repo, loc), file=sys.stderr)
-for prog, loc in BINS.items():
-    if not os.path.isfile(loc):
-        valid = False
-        print("Cannot access program '%s' at '%s'" % (prog, loc), file=sys.stderr)
-if not valid:
-    print("Errors in config file", file=sys.stderr)
diff --git a/config/config.py b/config/config.py
new file mode 100644
index 0000000..3282705
--- /dev/null
+++ b/config/config.py
@@ -0,0 +1,45 @@
+from __future__ import print_function
+import itertools
+from common import get_executable
+
+'''Paths to binaries.'''
+BINS = {'rtspin'    : get_executable('rtspin', 'liblitmus'),
+        'release'   : get_executable('release_ts', 'liblitmus'),
+        'ftcat'     : get_executable('ftcat', 'feather-trace-tools'),
+        'ftsplit'   : get_executable('ft2csv', 'feather-trace-tools'),
+        'ftsort'    : get_executable('ftsort', 'feather-trace-tools'),
+        'st_trace'  : get_executable('st_trace', 'feather-trace-tools'),
+        'trace-cmd' : get_executable('trace-cmd', 'rt-kernelshark'),
+                # Optional, as sched_trace is not a publically supported repository
+        'st_show'   : get_executable('st_show', 'sched_trace', True)}
+
+'''Names of output files.'''
+FILES = {'ft_data'    : 'ft.bin',
+         'linux_data' : 'trace.dat',
+         'sched_data' : 'st-{}.bin',
+         'log_data'   : 'trace.slog',}
+
+'''Default parameter names in params.py.'''
+PARAMS = {'sched'  : 'scheduler',
+          'dur'    : 'duration',
+          'kernel' : 'uname',
+          'cycles' : 'cpu-frequency'}
+
+'''Default values for program parameters.'''
+DEFAULTS = {'params_file' : 'params.py',
+            'sched_file'  : 'sched.py',
+            'exps_file'   : 'exps.py',
+            'duration'    : 10,
+            'spin'                : 'rtspin',
+            'cycles'      : 2000}
+
+'''Default sched_trace events (this is all of them).'''
+SCHED_EVENTS = range(501, 513)
+
+'''Overhead events.'''
+OVH_BASE_EVENTS  = ['SCHED', 'RELEASE', 'SCHED2', 'TICK', 'CXS']
+OVH_ALL_EVENTS   = ["%s_%s" % (e, t) for (e,t) in
+                    itertools.product(OVH_BASE_EVENTS, ["START","END"])]
+OVH_ALL_EVENTS  += ['RELEASE_LATENCY']
+# This event doesn't have a START and END
+OVH_BASE_EVENTS += ['RELEASE_LATENCY']
diff --git a/parse/ft.py b/parse/ft.py
index fea246a..a6596b7 100644
--- a/parse/ft.py
+++ b/parse/ft.py
@@ -71,7 +71,7 @@ def extract_ft_data(result, data_dir, work_dir, cycles):
     with open("%s/%s" % (work_dir, FT_ERR_NAME), 'w') as err_file:
         sorted_bin = sort_ft(bin_file, err_file, work_dir)
 
-        for event in conf.BASE_EVENTS:
+        for event in conf.OVH_BASE_EVENTS:
             parse_overhead(result, sorted_bin, event, cycles,
                            work_dir, err_file)
 
diff --git a/parse/sched.py b/parse/sched.py
index ffc6224..512ac73 100644
--- a/parse/sched.py
+++ b/parse/sched.py
@@ -32,8 +32,8 @@ class TimeTracker:
         self.job   = record.job
 
 # Data stored for each task
-TaskParams  = namedtuple('TaskParams',  ['wcet', 'period', 'cpu'])
-TaskData    = recordtype('TaskData',    ['params', 'jobs', 'blocks', 'misses'])
+TaskParams = namedtuple('TaskParams',  ['wcet', 'period', 'cpu'])
+TaskData   = recordtype('TaskData',    ['params', 'jobs', 'blocks', 'misses'])
 
 # Map of event ids to corresponding class, binary format, and processing methods
 RecordInfo = namedtuple('RecordInfo', ['clazz', 'fmt', 'method'])
@@ -151,10 +151,12 @@ def extract_sched_data(result, data_dir, work_dir):
         return
 
     # Save an in-english version of the data for debugging
-    cmd_arr = [conf.BINS['st_show']]
-    cmd_arr.extend(bins)
-    with open(output_file, "w") as f:
-        subprocess.call(cmd_arr, cwd=data_dir, stdout=f)
+    # This is optional and will only be done if 'st_show' is in PATH
+    if conf.BINS['st_show']:
+        cmd_arr = [conf.BINS['st_show']]
+        cmd_arr.extend(bins)
+        with open(output_file, "w") as f:
+            subprocess.call(cmd_arr, cwd=data_dir, stdout=f)
 
     task_dict = defaultdict(lambda :
                             TaskData(0, 0, TimeTracker(), TimeTracker()))
diff --git a/experiment/__init__.py b/run/__init__.py
index e69de29..e69de29 100644
--- a/experiment/__init__.py
+++ b/run/__init__.py
diff --git a/experiment/executable/__init__.py b/run/executable/__init__.py
index e69de29..e69de29 100644
--- a/experiment/executable/__init__.py
+++ b/run/executable/__init__.py
diff --git a/experiment/executable/executable.py b/run/executable/executable.py
index 628f711..628f711 100644
--- a/experiment/executable/executable.py
+++ b/run/executable/executable.py
diff --git a/experiment/executable/ftcat.py b/run/executable/ftcat.py
index 5da8fa7..5da8fa7 100644
--- a/experiment/executable/ftcat.py
+++ b/run/executable/ftcat.py
diff --git a/experiment/experiment.py b/run/experiment.py
index 4bd47c6..4bd47c6 100644
--- a/experiment/experiment.py
+++ b/run/experiment.py
diff --git a/experiment/litmus_util.py b/run/litmus_util.py
index fb2b341..fb2b341 100644
--- a/experiment/litmus_util.py
+++ b/run/litmus_util.py
diff --git a/experiment/proc_entry.py b/run/proc_entry.py
index 0b7f9ce..0b7f9ce 100644
--- a/experiment/proc_entry.py
+++ b/run/proc_entry.py
diff --git a/experiment/tracer.py b/run/tracer.py
index 4949927..5d00e86 100644
--- a/experiment/tracer.py
+++ b/run/tracer.py
@@ -19,24 +19,24 @@ class Tracer(object):
         map(methodcaller('terminate'), self.bins)
         map(methodcaller('wait'), self.bins)
 
-        
+
 class LinuxTracer(Tracer):
     EVENT_ROOT = "/sys/kernel/debug/tracing"
     LITMUS_EVENTS = "%s/events/litmus" % EVENT_ROOT
 
     def __init__(self, output_dir):
         super(LinuxTracer, self).__init__("trace-cmd", output_dir)
-        
+
         extra_args = ["record", # "-e", "sched:sched_switch",
                       "-e", "litmus:*",
                       "-o", "%s/%s" % (output_dir, conf.FILES['linux_data'])]
         stdout = open('%s/trace-cmd-stdout.txt' % self.output_dir, 'w')
         stderr = open('%s/trace-cmd-stderr.txt' % self.output_dir, 'w')
-        
+
         execute = Executable(conf.BINS['trace-cmd'], extra_args, stdout, stderr)
         execute.cwd = output_dir
         self.bins.append(execute)
-        
+
     @staticmethod
     def enabled():
         return os.path.exists(LinuxTracer.LITMUS_EVENTS)
@@ -45,13 +45,13 @@ class LinuxTracer(Tracer):
         map(methodcaller('interrupt'), self.bins)
         map(methodcaller('wait'), self.bins)
 
-    
+
 class LogTracer(Tracer):
     DEVICE_STR = '/dev/litmus/log'
 
     def __init__(self, output_dir):
         super(LogTracer, self).__init__("Logger", output_dir)
-        
+
         out_file = open("%s/%s" % (self.output_dir, conf.FILES['log_data']), 'w')
 
         cat = (Executable("/bin/cat", [LogTracer.DEVICE_STR]))
@@ -62,7 +62,7 @@ class LogTracer(Tracer):
     @staticmethod
     def enabled():
         return litmus_util.is_device(LogTracer.DEVICE_STR)
-    
+
 
 class SchedTracer(Tracer):
     DEVICE_STR = '/dev/litmus/sched_trace'
@@ -84,7 +84,7 @@ class SchedTracer(Tracer):
     def enabled():
                 return litmus_util.is_device("%s%d" % (SchedTracer.DEVICE_STR, 0))
 
-    
+
 class OverheadTracer(Tracer):
     DEVICE_STR = '/dev/litmus/ft_trace0'
 
@@ -94,7 +94,7 @@ class OverheadTracer(Tracer):
         stdout_f = open('{0}/{1}'.format(self.output_dir, conf.FILES['ft_data']), 'w')
         stderr_f = open('{0}/{1}.stderr.txt'.format(self.output_dir, conf.FILES['ft_data']), 'w')
         ftc = FTcat(conf.BINS['ftcat'], stdout_f, stderr_f,
-                OverheadTracer.DEVICE_STR, conf.ALL_EVENTS)
+                OverheadTracer.DEVICE_STR, conf.OVH_ALL_EVENTS)
 
         self.bins.append(ftc)