workgen(1)

📦 version 1.0, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ NAME ✨

workgen — an rt-app wrapper that simulates a real-time periodic load 🎯

(it's workgen(1), from the General Commands Manual, bestie — yes we're doing the whole manpage vibe 💅)

🌸 SYNOPSIS 🌸

workgen <config-file>

💖 INTRODUCTION 💖

okay so workgen is a test application that literally starts multiple periodic threads to simulate a real-time periodic load. it's giving "workload simulator" and honestly it ate 🔥

it's a wrapper for the rt-app program — so it sanitises and preprocesses the JSON files that describe the workload, and then it runs rt-app. preprocessing queen 👑

the code is currently maintained on GitHub at:

https://github.com/scheduler-tools/rt-app

🦋 REQUIREMENTS 🦋

workgen runs on GNU/Linux. it needs python and json-c to run, plus a 3.14 or later linux kernel that supports the SCHED_DEADLINE policy — unless it was built without the optional libdl. so yeah, check ur kernel bestie, no cap 🌈

💅 USAGE 💅

workgen <config_file>

where config file is a full or relative path to a JSON file — or "-" (without quotes, ok, literally just the dash) to read JSON data straight from stdin 🫶

workgen will parse, check and update the JSON-like file so it strictly matches the JSON grammar, and then it calls rt-app to execute the sequence described in it. glow-up for ur config file, fr fr ✨

workgen enables some freedom compared to stricter json grammar rules. for example:

  • You don't have to ensure uniqueness of key in json object — workgen will check the file and ensure that each key is unique by appending an index if necessary. this is so useful when you describe a sequence made of similar events, e.g. a sequence of multiple sleep and run events. like yes, duplicate keys, we don't know her 🙈
  • Some values can be omitted and workgen will add them when it parses the file before starting the use case. it's giving "I'll fill in the blanks, don't even worry about it" 💖
👀 See /usr/share/doc/rt-app/tutorial.txt for details of the JSON config file format. read it, bestie, it's the lore 📖

🌈 SEE ALSO 🌈

  • rt-app <config_file> can be used directly — like, no wrapper, just raw. do with that what you will 💀
  • 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:
./merge.py -o combined.json global.json resources.json thread0.json thread1.json thread2.json thread3.json

merge queen, she's combining everything, iconic 🧚

🎀 FILES 🎀

Numerous example workloads and building blocks can be found in:

/usr/share/doc/rt-app/examples/*.json

go look, there's so much inspo in there, you're gonna be obsessed ⭐

okay that's the whole page, ily, go simulate some periodic load 💜

this lil masterpiece is from rt-app, dated 2016-01-25 — and it's the workgen(1) page, periodt. 🫶✨

📦 where this page comes from