summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAaron Ball <nullspoon@oper.io>2022-10-31 18:01:38 -0600
committerAaron Ball <nullspoon@oper.io>2022-10-31 18:01:38 -0600
commit3dc64d80d7c1f1a0475665e0cdcefe2eff9b3036 (patch)
treea88d4b5ba2da84389bbefdf1311bfd071b20fe3e
parent0e0fb17e26612caeea11600e2f17a54cecf651db (diff)
downloadleak-utils-3dc64d80d7c1f1a0475665e0cdcefe2eff9b3036.tar.gz
leak-utils-3dc64d80d7c1f1a0475665e0cdcefe2eff9b3036.tar.xz
Add README file detailing all of the current utilities
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c64aa31
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# Leak-utils README
+
+This is a collection of leaky utilities for the purpose of testing. These could
+be used for testing things like for example, some automation's response to a
+program growing in memory usage, or a monitoring tool for leaked file
+descriptors.
+
+## Utilities
+
+### fdleak
+
+The `fdleak` utility leaks dead file descriptors. At runtime, it opens the
+specified number of files, not closing any of them, and deletes (unlinks) the
+files on disk while keeping the file descriptor open, leaving a dead file
+descriptor behind. Pressing `Ctrl + c` causes the program to clean up after
+itself.
+
+### balloon
+
+The `balloon` utility balloons up quickly in memory usage to the specified
+maximum and stays at that much memory usage until `Ctrl + c` is pressed, at
+which point it frees the used memory and exits.
+
+### memleak
+
+The `memleak` utility is a bit more dangerous than the others. It reserves
+memory at the specified rate (eg: 10 MB per second), with no upper limit. If
+left to continue running, it can crash your system, so be careful with this
+one.

Generated by cgit