Add more documentation to decay.c

It took me a while to understand why some things are implemented the way they are, so hopefully it will help future readers.
2021-07-20 13:22:05 -07:00
parent 4b633b9a81
commit aaea4fd1e6
2 changed files with 23 additions and 1 deletions
--- a/include/jemalloc/internal/decay.h
+++ b/include/jemalloc/internal/decay.h
@@ -149,7 +149,8 @@ bool decay_maybe_advance_epoch(decay_t *decay, nstime_t *new_time,
    size_t current_npages);

 /*
- * Calculates wait time until at least npages_threshold pages should be purged.
+ * Calculates wait time until a number of pages in the interval
+ * [0.5 * npages_threshold .. 1.5 * npages_threshold] should be purged.
 *
 * Returns number of nanoseconds or DECAY_UNBOUNDED_TIME_TO_PURGE in case of
 * indefinite wait.