Add example code and related end-to-end tests.

17 files changed, 392 insertions, 1 deletions

diff --git a/example/__init__.py b/example/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/example/__init__.py
diff --git a/example/__main__.py b/example/__main__.py
new file mode 100644
index 0000000..f74ba55
--- /dev/null
+++ b/example/__main__.py
@@ -0,0 +1,12 @@
+#Necessary includes and stuff
+
+from example.driver import nolock_example, lock_example, \
+                           generate_random_nolock_sets, \
+                           generate_random_lock_sets, print_bounds
+
+if __name__ == '__main__':
+    #Actually run examples when this script is executed
+    print "Running non-lock example"
+    print_bounds(nolock_example(generate_random_nolock_sets()))
+    print "Running lock example"
+    print_bounds(lock_example(generate_random_lock_sets()))
diff --git a/example/driver.py b/example/driver.py
new file mode 100644
index 0000000..6c4c296
--- /dev/null
+++ b/example/driver.py
@@ -0,0 +1,66 @@
+#Necessary includes and stuff
+
+from example.generator import generate_taskset_files, \
+                              generate_lock_taskset_files
+from example.mapping import partition_tasks
+from example.overheads import get_oh_object, bound_cfl_with_oh
+from example.locking import bound_cfl_with_locks
+
+from schedcat.model.serialize import load
+
+import os
+
+def get_script_dir():
+    return os.path.dirname(os.path.realpath(__file__))
+
+def example_overheads():
+    script_dir = get_script_dir()
+    return get_oh_object(
+        script_dir + "/oh_host=ludwig_scheduler=C-FL-L2-RM_stat=avg.csv",
+        script_dir +
+        "/oh_host=ludwig_scheduler=C-FL-L2-RM_locks=MX-Q_stat=avg.csv",
+        script_dir + "/pmo_host=ludwig_background=load_stat=avg.csv",
+        "L2")
+
+def nolock_example(task_files):
+    oheads = example_overheads()
+    for task_file in task_files:
+        ts = load(task_file)
+        for task in ts:
+            task.wss = 256
+        clusts = partition_tasks(2, 12, True, ts)
+        if clusts and bound_cfl_with_oh(oheads, True, clusts):
+            yield (task_file, clusts)
+        else:
+            yield (task_file, None)
+
+def lock_example(task_files):
+    oheads = example_overheads()
+    for task_file in task_files:
+        ts = load(task_file)
+        for task in ts:
+            task.wss = 256
+        clusts = partition_tasks(2, 12, True, ts)
+        if clusts:
+            clusts2 = bound_cfl_with_locks(ts, clusts, oheads, 2)
+            if clusts2:
+                yield (task_file, clusts2)
+            else:
+                yield (task_file, None)
+        else:
+            yield (task_file, None)
+
+def generate_random_nolock_sets():
+    return generate_taskset_files("uni-medium", "uni-moderate", 12, 2)
+
+def generate_random_lock_sets():
+    return generate_lock_taskset_files("uni-medium", "uni-moderate", 6,
+                                       "medium", 6, 0.1, 2)
+
+def print_bounds(results_list):
+    for task_file, clusts in results_list:
+        print "Processed {}".format(task_file)
+        if clusts is not None:
+            for clust in clusts:
+                for task in clust:
+                    print task.response_time - task.deadline
diff --git a/example/generator.py b/example/generator.py
new file mode 100644
index 0000000..41a4ed2
--- /dev/null
+++ b/example/generator.py
@@ -0,0 +1,48 @@
+#Necessary includes and stuff
+
+from schedcat.model.serialize import write
+from schedcat.generator.tasksets import mkgen, \
+                                        NAMED_UTILIZATIONS, \
+                                        NAMED_PERIODS
+from schedcat.util.time import ms2us
+import schedcat.model.resources as resources
+import os
+import random
+
+CSLENGTH = { 'short'  : lambda: random.randint(1,   15),
+             'medium' : lambda: random.randint(1,  100),
+             'long'   : lambda: random.randint(5, 1280), }
+
+def generate_taskset_files(util_name, period_name, cap, number):
+    generator = mkgen(NAMED_UTILIZATIONS[util_name],
+                      NAMED_PERIODS[period_name])
+    generated_sets = []
+    for i in range(number):
+        taskset = generator(max_util=cap, time_conversion=ms2us)
+        filename = "{0}_{1}_{2}_{3}".format(util_name,
+                                            period_name, cap, i)
+        write(taskset, filename)
+        generated_sets.append(filename)
+    return generated_sets
+
+def generate_lock_taskset_files(util_name, period_name, cap,
+                                cslength, nres, pacc, number):
+    generator = mkgen(NAMED_UTILIZATIONS[util_name],
+                      NAMED_PERIODS[period_name])
+    generated_sets = []
+    for i in range(number):
+        taskset = generator(max_util=cap, time_conversion=ms2us)
+        resources.initialize_resource_model(taskset)
+        for task in taskset:
+            for res_id in range(nres):
+                if random.random() < pacc:
+                    nreqs = random.randint(1, 5)
+                    length = CSLENGTH[cslength]
+                    for j in range(nreqs):
+                       task.resmodel[res_id].add_request(length())
+        filename = "{0}_{1}_{2}_{3}_{4}_{5}_{6}".format(
+                util_name, period_name, cap, cslength, nres, pacc,
+                i)
+        write(taskset, filename)
+        generated_sets.append(filename)
+    return generated_sets
diff --git a/example/lock_example_1 b/example/lock_example_1
new file mode 100644
index 0000000..2839265
--- /dev/null
+++ b/example/lock_example_1
@@ -0,0 +1 @@
+<taskset><properties count="11" density="7.85158993665" density_q="92233435393882371160571/11747102961070953840000" hyperperiod="11747102961070953840000" utilization="7.85158993665" utilization_q="92233435393882371160571/11747102961070953840000" /><task period="221000" wcet="175446"><resources /></task><task period="249000" wcet="143983"><resources><requirement max_read_length="0" max_reads="0" max_write_length="14" max_writes="4" res_id="5" /></resources></task><task period="67000" wcet="56926"><resources><requirement max_read_length="0" max_reads="0" max_write_length="7" max_writes="4" res_id="2" /></resources></task><task period="105000" wcet="60381"><resources><requirement max_read_length="0" max_reads="0" max_write_length="15" max_writes="5" res_id="0" /></resources></task><task period="123000" wcet="69329"><resources /></task><task period="177000" wcet="144666"><resources /></task><task period="211000" wcet="142041"><resources /></task><task period="236000" wcet="167824"><resources><requirement max_read_length="0" max_reads="0" max_write_length="7" max_writes="3" res_id="4" /></resources></task><task period="240000" wcet="184243"><resources><requirement max_read_length="0" max_reads="0" max_write_length="15" max_writes="4" res_id="1" /></resources></task><task period="157000" wcet="109222"><resources><requirement max_read_length="0" max_reads="0" max_write_length="11" max_writes="5" res_id="4" /></resources></task><task period="71000" wcet="58656"><resources><requirement max_read_length="0" max_reads="0" max_write_length="15" max_writes="1" res_id="5" /></resources></task></taskset>
\ No newline at end of file
diff --git a/example/lock_example_2 b/example/lock_example_2
new file mode 100644
index 0000000..b49377a
--- /dev/null
+++ b/example/lock_example_2
@@ -0,0 +1 @@
+<taskset><properties count="22" density="5.7599727736" density_q="1604904754577192741/278630614702440000" hyperperiod="1114522458809760000" utilization="5.7599727736" utilization_q="1604904754577192741/278630614702440000" /><task period="10000" wcet="2382"><resources><requirement max_read_length="0" max_reads="0" max_write_length="99" max_writes="3" res_id="1" /></resources></task><task period="45000" wcet="17247"><resources><requirement max_read_length="0" max_reads="0" max_write_length="74" max_writes="3" res_id="5" /></resources></task><task period="78000" wcet="17960"><resources><requirement max_read_length="0" max_reads="0" max_write_length="96" max_writes="4" res_id="1" /></resources></task><task period="60000" wcet="10573"><resources /></task><task period="32000" wcet="8164"><resources /></task><task period="39000" wcet="9989"><resources /></task><task period="33000" wcet="11992"><resources /></task><task period="42000" wcet="12914"><resources /></task><task period="46000" wcet="12877"><resources /></task><task period="46000" wcet="13775"><resources /></task><task period="74000" wcet="20500"><resources><requirement max_read_length="0" max_reads="0" max_write_length="97" max_writes="5" res_id="2" /></resources></task><task period="72000" wcet="7975"><resources /></task><task period="65000" wcet="20947"><resources /></task><task period="88000" wcet="18770"><resources /></task><task period="53000" wcet="12232"><resources /></task><task period="28000" wcet="9137"><resources><requirement max_read_length="0" max_reads="0" max_write_length="28" max_writes="1" res_id="1" /></resources></task><task period="98000" wcet="32868"><resources><requirement max_read_length="0" max_reads="0" max_write_length="63" max_writes="3" res_id="4" /></resources></task><task period="31000" wcet="11490"><resources><requirement max_read_length="0" max_reads="0" max_write_length="93" max_writes="1" res_id="3" /></resources></task><task period="16000" wcet="4587"><resources /></task><task period="63000" wcet="7244"><resources /></task><task period="80000" wcet="10495"><resources><requirement max_read_length="0" max_reads="0" max_write_length="75" max_writes="4" res_id="2" /></resources></task><task period="79000" wcet="19842"><resources /></task></taskset>
\ No newline at end of file
diff --git a/example/locking.py b/example/locking.py
new file mode 100644
index 0000000..8414dc3
--- /dev/null
+++ b/example/locking.py
@@ -0,0 +1,68 @@
+#Necessary includes and stuff
+
+from schedcat.locking.bounds import apply_task_fair_mutex_bounds, \
+                                    assign_prio_pt_locking_prios
+
+from schedcat.overheads.jlfp import charge_scheduling_overheads, \
+                                    quantize_params
+
+from schedcat.sched.edf.gel_pl import \
+    bound_gfl_response_times, has_bounded_tardiness
+
+from schedcat.overheads.locking import charge_spinlock_overheads
+
+def copy_ts(ts, clusts):
+    new_ts = []
+    new_clusts = []
+    for clust in clusts:
+        new_clust = clust.copy()
+        new_clust.cpus = clust.cpus
+        new_clusts.append(new_clust)
+        new_ts += new_clust
+    return (new_ts, new_clusts)
+
+def preprocess_ts(taskset, clusts, oheads):
+    for clust in clusts:
+        charge_spinlock_overheads(oheads, clust)
+        for task in clust:
+            #Initially assume completion by deadline and use G-FL
+            task.response_time = task.deadline
+            task.prio_pt = task.deadline - \
+                           (clust.cpus - 1) / (clust.cpus) * task.cost
+    assign_prio_pt_locking_prios(taskset)
+
+def post_blocking_term_oh_inflation(oheads, clusts):
+    for clust in clusts:
+        inflation = oheads.syscall_in(len(clust))
+        for t in clust:
+            if t.arrival_blocked:
+                t.cost += inflation
+                t.arrival_blocked += inflation
+        if not charge_scheduling_overheads(oheads, clust.cpus,
+                                           True, clust):
+            return False
+        quantize_params(clust)
+    return True