.\" Man page derived from README.IN . .TH rt\-app 1 "2014-07-17" "rt\-app" .SH NAME rt\-app \- Test application for simulating a real\-time periodic load . .SH SYNOPSIS .B rt\-app .RI .sp .B rt\-app .RI [options]\ -t\ :[:policy[:CPU\ affinity[:prio[:deadline]]]] -t\ ... .PP .SH INTRODUCTION .B rt\-app is a test application that starts multiple periodic threads in order to simulate a real\-time periodic load. It supports SCHED_OTHER, SCHED_FIFO, SCHED_RR as well as the AQuoSA framework and SCHED_DEADLINE. .PP Code is currently maintained on GitHub: \fI\%https://github.com/gbagnoli/rt\-app\fP . .SH REQUIREMENTS . rt\-app runs on GNU/Linux. It needs autoconf, automake, libtool and a recent compiler (mainly: gcc) for basic features. . For advanced usage, the following optional libraries are needed: \- qreslib for AQuoSA support (and, obviously a GENS_SCHED patched kernel) . \- a SCHED_DEADLINE patched kernel to support SCHED_DEADLINE policy. . \- json\-c installed for reading config files. In case libjson is not available for your target, you can download and compile json\-c from \fI\%http://oss.metaparadigm.com/json\-c/\fP .SH USAGE rt\-app .BR where config file is a full/relative path to a json file (look under doc/ for an example config file) or "\-" (without quotes) to read JSON data from stdin. .PP The python merge script (/usr/share/doc/rt-app/examples/merge.py) can be used to combine json snippets into the config file: e.g: .B \./merge.py \-o combined.json global.json resources.json thread0.json thread1.json thread2.json thread3.json .PP OR you can use commandline to define the taskset. .PP Keep in mind that on commandline it will never be possible to define resources and how tasks access them. .PP rt\-app\ [options]\ \-t\ :[:cpu\ affinity[:policy[:deadline[:prio]]]] .sp br POLICY: f=SCHED_FIFO, r=SCHED_RR, o=SCHED_OTHER, q=AQuoSA br AFFINITY: comma\-separated cpu index (starting from 0) i.e. 0,2,3 for first, third and fourth CPU .PP Note: when using AQuoSA scheduling, priority is used as percent increment for budget over exec time .PP .SH OPTIONS .TP .B \-h\fP,\fB \-\-help show this help .TP .B \-f\fP,\fB \-\-fifo set default policy for threads to SCHED_FIFO .TP .B \-r\fP,\fB \-\-rr set default policy fior threads to SCHED_RR .TP .B \-s\fP,\fB \-\-spacing msec to wait beetween thread starts .TP .B \-l\fP,\fB \-\-logdir save logs to different directory .TP .B \-b\fP,\fB \-\-baselog basename for logs (implies \-l . if not set) .TP .B \-G\fP,\fB \-\-gnuplot generate gnuplot script (needs \-l) .TP .B \-D\fP,\fB \-\-duration time (in seconds) before stopping threads .TP .B \-K\fP,\fB \-\-no\-mlock Do not lock pages in memory .TP .B \-q\fP,\fB \-\-qos create AQuoSA reservation .TP .B \-g\fP,\fB \-\-frag fragment for the reservation .TP .B \-\-fifo,\-\-rr,\-\-qos sets the default scheduling policy for all threads. \-\-qos is available only when compiled with AQuoSA support enabled. .TP .B \-\-logdir,\-\-baselog control log output (rt\-app creates one log for each thread). If \-\-logdir is not present, rt\-app logs everything to stdout. When logging to file and \-D (see below) is present, the file is written at the end of execution, during which all logging data is kept in memory. .TP .B \-\-gnuplot if it is present then rt\-app outputs sample gnuplot scripts to $logdir (which must be passed too .TP .B \-\-spacing,\-\-duration control the spacing between threads and their duration of execution, i.e. each thread is started every $spacing ms and the total runtime is $duration. .TP .B \-\-frag\ (AQuoSA only) fragments the reservation period by $fragmentation, i.e. reservation period is $frag times smaller than thread\(aqs period. .TP .B \-\-no\-mlock do not lock threads\(aq memory pages when using realtime scheduling classes .PP Each thread is specified by .PP \-\-thread :[:$POLICY[:deadline[:prio]]]: .PP .TP .B period : thread period in microseconds .TP .B exec : thread WCET in microseconds .TP .B policy : one of f=SCHED_FIFO, r=SCHED_RR, o=SCHED_OTHER, q=AQuoSA (if enabled) .TP .B affinity : comma\-separated cpu index (starting from 0) i.e. 0,2,3 for first, third and fourth CPU .TP .B prio : thread priority in SCHED_FIFO/SCHED_RR/SCHED_OTHER, percentile increment for AQuoSA reservation budget w.r.t. WCET. .TP .B deadline : deadline in microseconds (used ONLY for plotting!)