diff options
| author | Bjoern B. Brandenburg <bbb@cs.unc.edu> | 2010-02-02 18:31:23 -0500 |
|---|---|---|
| committer | Bjoern B. Brandenburg <bbb@cs.unc.edu> | 2010-02-02 18:31:23 -0500 |
| commit | fc001302538dea0e8a67afb732f2daa1f18358dd (patch) | |
| tree | e06caa36de30bfbc765734ade3df4563756072cb | |
| parent | 1872bfbc1f4a5b3c4980fae889787ab15ddcc83b (diff) | |
update README
| -rw-r--r-- | README | 46 |
1 files changed, 37 insertions, 9 deletions
| @@ -1,7 +1,7 @@ | |||
| 1 | LITMUS^RT User-Space Library: liblitmus | 1 | LITMUS^RT User-Space Library: liblitmus |
| 2 | ======================================= | 2 | ======================================= |
| 3 | 3 | ||
| 4 | Copyright (c) 2007, 2008 | 4 | Copyright (c) 2007, 2008, 2009, 2010 |
| 5 | The University of North Carolina at Chapel Hill | 5 | The University of North Carolina at Chapel Hill |
| 6 | Department of Computer Science | 6 | Department of Computer Science |
| 7 | Real-Time Systems Group | 7 | Real-Time Systems Group |
| @@ -9,7 +9,7 @@ LITMUS^RT User-Space Library: liblitmus | |||
| 9 | http://www.cs.unc.edu/~anderson/litmus-rt/ | 9 | http://www.cs.unc.edu/~anderson/litmus-rt/ |
| 10 | 10 | ||
| 11 | Released as open source under the terms of the GNU General Public License | 11 | Released as open source under the terms of the GNU General Public License |
| 12 | (GPL2). | 12 | (GPL2). |
| 13 | 13 | ||
| 14 | Overview | 14 | Overview |
| 15 | ======== | 15 | ======== |
| @@ -18,8 +18,8 @@ LITMUS^RT. Real-time tasks should link against this library. The header file | |||
| 18 | "litmus.h" contains all necessary system calls and definitions to interact with | 18 | "litmus.h" contains all necessary system calls and definitions to interact with |
| 19 | the kernel services provided for real-time tasks. | 19 | the kernel services provided for real-time tasks. |
| 20 | 20 | ||
| 21 | Tools | 21 | Tools and Programs |
| 22 | ===== | 22 | ================== |
| 23 | 23 | ||
| 24 | * setsched | 24 | * setsched |
| 25 | Select active scheduler. Must be run as root. | 25 | Select active scheduler. Must be run as root. |
| @@ -28,16 +28,44 @@ Tools | |||
| 28 | Print the name of the currently active scheduler. Schedulers are selected at | 28 | Print the name of the currently active scheduler. Schedulers are selected at |
| 29 | boot time with the "rtsched=<NAME>" kernel parameter. | 29 | boot time with the "rtsched=<NAME>" kernel parameter. |
| 30 | 30 | ||
| 31 | * rt_launch {-p <PROCESSOR>} <WCET> <PERIOD> <PROGRAM> <ARGS>... | 31 | * rt_launch [-p <PARTITION>] <WCET> <PERIOD> <PROGRAM> <ARGS>... |
| 32 | Launch the program <PROGRAM> as a real-time task provisioned with the given | 32 | Launch the program <PROGRAM> as a real-time task provisioned with the given |
| 33 | worst-case execution time and priod. Any additional parameters are passed on | 33 | worst-case execution time and priod. Any additional parameters are passed on |
| 34 | to the real-time task. | 34 | to the real-time task. |
| 35 | 35 | ||
| 36 | * rtspin [-w] [-p <PARTITION>] [-c CLASS] WCET PERIOD DURATION | ||
| 37 | rtspin -l | ||
| 38 | A simple spin loop for emulating purely CPU-bound workloads. | ||
| 39 | Not very realistic, but a good tool for debugging. | ||
| 40 | -l Start a little calibration loop. | ||
| 41 | -w Wait for task-system release. | ||
| 42 | |||
| 43 | * release_ts | ||
| 44 | Release the task system. This allows for synchronous task system releases. | ||
| 45 | |||
| 46 | * measure_syscall | ||
| 47 | A simple tool that measures the cost of a system call. | ||
| 48 | |||
| 49 | * cycles | ||
| 50 | Display cycles per time interval. | ||
| 51 | |||
| 52 | * base_task | ||
| 53 | Example real-time task. Can be used as a basis for the development | ||
| 54 | of single-threaded real-time tasks. | ||
| 55 | |||
| 56 | * base_mt_task | ||
| 57 | Example multi-threaded real-time task. Use as a basis for development. | ||
| 58 | |||
| 59 | |||
| 36 | Install | 60 | Install |
| 37 | ======= | 61 | ======= |
| 38 | The library and the included tools must be compiled from source. Currently, | 62 | The library and the included tools must be compiled from source. |
| 39 | the library and all tools are compiled by issuing the | 63 | Liblitmus uses SCons as the build system. For details see: |
| 40 | command: | 64 | |
| 65 | http://www.scons.org/ | ||
| 41 | 66 | ||
| 42 | $ make | 67 | To compile the library just execute the command 'scons' without |
| 68 | arguments. | ||
| 43 | 69 | ||
| 70 | x86_64->ia32 cross compilation is possible by specifying ARCH=i386 on the | ||
| 71 | command line or in the environment. | ||