From 4f0f0dbbeb4a965ac5fb8e6e30d8fcc1cd99eff6 Mon Sep 17 00:00:00 2001 From: Brian Norris Date: Tue, 13 Aug 2013 23:29:20 -0700 Subject: [PATCH] README.md: add more fairness notes --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c85a727..023a737 100644 --- a/README.md +++ b/README.md @@ -85,7 +85,9 @@ Useful Options `-f num` - > Turns on alternative fairness support (less desirable than `-y`). + > Turns on alternative fairness support (less desirable than `-y`). A + > necessary alternative for some programs that do not support yield-based + > fairness properly. `-v` @@ -324,6 +326,12 @@ Now, we can examine the end-of-execution summary of one test program: Other Notes and Pitfalls ------------------------ +* Many programs require some form of fairness in order to terminate in a finite + amount of time. CDSChecker supports the `-y num` and `-f num` flags for these + cases. The `-y` option (yield-based fairness) is preferable, but it requires + careful usage of yields (i.e., `thrd_yield()`) in the test program. For + programs without proper `thrd_yield()`, you may consider using `-f` instead. + * Deadlock detection: CDSChecker can detect deadlocks. For instance, try the following test program. -- 2.34.1