README.md



    1 # Leak-utils README
    2 
    3 This is a collection of leaky utilities for the purpose of testing. These could
    4 be used for testing things like for example, some automation's response to a
    5 program growing in memory usage, or a monitoring tool for leaked file
    6 descriptors.
    7 
    8 ## Utilities
    9 
   10 ### fdleak
   11 
   12 The `fdleak` utility leaks dead file descriptors. At runtime, it opens the
   13 specified number of files, not closing any of them, and deletes (unlinks) the
   14 files on disk while keeping the file descriptor open, leaving a dead file
   15 descriptor behind. Pressing `Ctrl + c` causes the program to clean up after
   16 itself.
   17 
   18 ### balloon
   19 
   20 The `balloon` utility balloons up quickly in memory usage to the specified
   21 maximum and stays at that much memory usage until `Ctrl + c` is pressed, at
   22 which point it frees the used memory and exits.
   23 
   24 ### memleak
   25 
   26 The `memleak` utility is a bit more dangerous than the others. It reserves
   27 memory at the specified rate (eg: 10 MB per second), with no upper limit. If
   28 left to continue running, it can crash your system, so be careful with this
   29 one.