Add explanatory comments to threads tests.

[pintos-anon] / src / tests / threads / mlfqs-fair.c

diff --git a/src/tests/threads/mlfqs-fair.c b/src/tests/threads/mlfqs-fair.c
index fd8ab86369c497038af4553034a24134ff900db6..30282c36e32d15b0da44d074aa99093c69d3815c 100644 (file)
--- a/src/tests/threads/mlfqs-fair.c
+++ b/src/tests/threads/mlfqs-fair.c
@@ -1,3 +1,19 @@
+/* Measures the correctness of the "nice" implementation.
+
+   The "fair" tests run either 2 or 20 threads all niced to 0.
+   The threads should all receive approximately the same number
+   of ticks.
+
+   The mlfqs-nice-2 test runs 2 threads, one with nice 0, the
+   other with nice 5, which should receive 1,904 and 1,096 ticks,
+   respectively, over 30 seconds.
+
+   The mlfqs-nice-10 test runs 10 threads with nice 0 through 9.
+   They should receive 672, 588, 492, 408, 316, 232, 152, 92, 40,
+   and 8 ticks, respectively, over 30 seconds.
+
+   (The above are computed via simulation in mlfqs.pm.) */
+
 #include <stdio.h>
 #include <inttypes.h>
 #include "tests/threads/tests.h"