README.md

   1 CDSChecker: A Model Checker for C11 and C++11 Atomics
   2 =====================================================
   3
   4 Copyright &copy; 2013 Regents of the University of California. All rights reserved.
   5
   6 CDSChecker is distributed under the GPL v2. See the LICENSE file for details.
   7
   8
   9 Overview
  10 --------
  11
  12 CDSChecker is a model checker for C11/C++11 which exhaustively explores the
  13 behaviors of code under the C/C++ memory model. It uses partial order reduction
  14 as well as a few other novel techniques to eliminate time spent on redundant
  15 execution behaviors and to significantly shrink the state space. The model
  16 checking algorithm is described in more detail in this paper (published in
  17 OOPSLA '13):
  18
  19 >   <http://demsky.eecs.uci.edu/publications/c11modelcheck.pdf>
  20
  21 It is designed to support unit tests on concurrent data structure written using
  22 C/C++ atomics.
  23
  24 CDSChecker is constructed as a dynamically-linked shared library which
  25 implements the C and C++ atomic types and portions of the other thread-support
  26 libraries of C/C++ (e.g., std::atomic, std::mutex, etc.). Notably, we only
  27 support the C version of threads (i.e., `thrd_t` and similar, from `<threads.h>`),
  28 because C++ threads require features which are only available to a C++11
  29 compiler (and we want to support others, at least for now).
  30
  31 CDSChecker should compile on Linux and Mac OSX with no dependencies and has been
  32 tested with LLVM (clang/clang++) and GCC. It likely can be ported to other \*NIX
  33 flavors. We have not attempted to port to Windows.
  34
  35
  36 Getting Started
  37 ---------------
  38
  39 If you haven't done so already, you may download CDSChecker using
  40 [git](http://git-scm.com/) (for those without git, snapshots can be found at the
  41 Gitweb URLs below):
  42
  43       git clone git://demsky.eecs.uci.edu/model-checker.git
  44
  45 Get the benchmarks (not required; distributed separately):
  46
  47       cd model-checker
  48       git clone git://demsky.eecs.uci.edu/model-checker-benchmarks.git benchmarks
  49
  50 Compile the model checker:
  51
  52       make
  53
  54 Compile the benchmarks:
  55
  56       make benchmarks
  57
  58 Run a simple example (the `run.sh` script does some very minimal processing for
  59 you):
  60
  61       ./run.sh test/userprog.o
  62
  63 To see the help message on how to run CDSChecker, execute:
  64
  65       ./run.sh -h
  66
  67
  68 Useful Options
  69 --------------
  70
  71 `-m num`
  72
  73   > Controls the liveness of the memory system. Note that multithreaded programs
  74   > often rely on memory liveness for termination, so this parameter is
  75   > necessary for such programs.
  76   >
  77   > Liveness is controlled by `num`: the number of times a load is allowed to
  78   > see the same store when a newer store exists---one that is ordered later in
  79   > the modification order.
  80
  81 `-y`
  82
  83   > Turns on CHESS-like yield-based fairness support (requires `thrd_yield()`
  84   > instrumentation in test program).
  85
  86 `-f num`
  87
  88   > Turns on alternative fairness support (less desirable than `-y`).
  89
  90 `-v`
  91
  92   > Verbose: show all executions and not just buggy ones.
  93
  94 `-s num`
  95
  96   > Constrain how long we will run to wait for a future value past when it is
  97   > expected
  98
  99 `-u num`
 100
 101   > Value to provide to atomics loads from uninitialized memory locations. The
 102   > default is 0, but this may cause some programs to throw exceptions
 103   > (segfault) before the model checker prints a trace.
 104
 105 Suggested options:
 106
 107 >     -m 2 -y
 108
 109 or
 110
 111 >     -m 2 -f 10
 112
 113
 114 Benchmarks
 115 -------------------
 116
 117 Many simple tests are located in the `tests/` directory. You may also want to
 118 try the larger benchmarks (distributed separately), which can be placed under
 119 the `benchmarks/` directory. After building CDSChecker, you can build and run
 120 the benchmarks as follows:
 121
 122 >     make benchmarks
 123 >     cd benchmarks
 124 >
 125 >     # run barrier test with fairness/memory liveness
 126 >     ./run.sh barrier/barrier -y -m 2
 127 >
 128 >     # Linux reader/write lock test with fairness/memory liveness
 129 >     ./run.sh linuxrwlocks/linuxrwlocks -y -m 2
 130 >
 131 >     # run all benchmarks and provide timing results
 132 >     ./bench.sh
 133
 134
 135 Running your own code
 136 ---------------------
 137
 138 You likely want to test your own code, not just our simple tests. To do so, you
 139 need to perform a few steps.
 140
 141 First, because CDSChecker executes your program dozens (if not hundreds or
 142 thousands) of times, you will have the most success if your code is written as a
 143 unit test and not as a full-blown program.
 144
 145 Second, because CDSChecker must be able to manage your program for you, your
 146 program should declare its main entry point as `user_main(int, char**)` rather
 147 than `main(int, char**)`.
 148
 149 Third, test programs should use the standard C11/C++11 library headers
 150 (`<atomic>`/`<stdatomic.h>`, `<mutex>`, `<condition_variable>`, `<thread.h>`).
 151 As of now, we only support C11 thread syntax (`thrd_t`, etc. from
 152 `<thread.h>`).
 153
 154 Test programs may also use our included happens-before race detector by
 155 including <librace.h> and utilizing the appropriate functions
 156 (`store_{8,16,32,64}()` and `load_{8,16,32,64}()`) for loading/storing data from/to
 157 non-atomic shared memory.
 158
 159 CDSChecker can also check boolean assertions in your test programs. Just
 160 include `<model-assert.h>` and use the `MODEL_ASSERT()` macro in your test program.
 161 CDSChecker will report a bug in any possible execution in which the argument to
 162 `MODEL_ASSERT()` evaluates to false (that is, 0).
 163
 164 Test programs should be compiled against our shared library (libmodel.so) using
 165 the headers in the `include/` directory. Then the shared library must be made
 166 available to the dynamic linker, using the `LD_LIBRARY_PATH` environment
 167 variable, for instance.
 168
 169
 170 Reading an execution trace
 171 --------------------------
 172
 173 When CDSChecker detects a bug in your program (or when run with the `--verbose`
 174 flag), it prints the output of the program run (STDOUT) along with some summary
 175 trace information for the execution in question. The trace is given as a
 176 sequence of lines, where each line represents an operation in the execution
 177 trace. These lines are ordered by the order in which they were run by CDSChecker
 178 (i.e., the "execution order"), which does not necessarily align with the "order"
 179 of the values observed (i.e., the modification order or the reads-from
 180 relation).
 181
 182 The following list describes each of the columns in the execution trace output:
 183
 184  * \#: The sequence number within the execution. That is, sequence number "9"
 185    means the operation was the 9th operation executed by CDSChecker. Note that
 186    this represents the execution order, not necessarily any other order (e.g.,
 187    modification order or reads-from).
 188
 189  * t: The thread number
 190
 191  * Action type: The type of operation performed
 192
 193  * MO: The memory-order for this operation (i.e., `memory_order_XXX`, where `XXX` is
 194    `relaxed`, `release`, `acquire`, `rel_acq`, or `seq_cst`)
 195
 196  * Location: The memory location on which this operation is operating. This is
 197    well-defined for atomic write/read/RMW, but other operations are subject to
 198    CDSChecker implementation details.
 199
 200  * Value: For reads/writes/RMW, the value returned by the operation. Note that
 201    for RMW, this is the value that is *read*, not the value that was *written*.
 202    For other operations, 'value' may have some CDSChecker-internal meaning, or
 203    it may simply be a don't-care (such as `0xdeadbeef`).
 204
 205  * Rf: For reads, the sequence number of the operation from which it reads.
 206    [Note: If the execution is a partial, infeasible trace (labeled INFEASIBLE),
 207    as printed during `--verbose` execution, reads may not be resolved and so may
 208    have Rf=? or Rf=Px, where x is a promised future value.]
 209
 210  * CV: The clock vector, encapsulating the happens-before relation (see our
 211    paper, or the C/C++ memory model itself). We use a Lamport-style clock vector
 212    similar to [1]. The "clock" is just the sequence number (#). The clock vector
 213    can be read as follows:
 214
 215    Each entry is indexed as CV[i], where
 216
 217             i = 0, 1, 2, ..., <number of threads>
 218
 219    So for any thread i, we say CV[i] is the sequence number of the most recent
 220    operation in thread i such that operation i happens-before this operation.
 221    Notably, thread 0 is reserved as a dummy thread for certain CDSChecker
 222    operations.
 223
 224 See the following example trace:
 225
 226 <pre>
 227 ------------------------------------------------------------------------------------
 228 #    t    Action type     MO       Location         Value               Rf  CV
 229 ------------------------------------------------------------------------------------
 230 1    1    thread start    seq_cst  0x7f68ff11e7c0   0xdeadbeef              ( 0,  1)
 231 2    1    init atomic     relaxed        0x601068   0                       ( 0,  2)
 232 3    1    init atomic     relaxed        0x60106c   0                       ( 0,  3)
 233 4    1    thread create   seq_cst  0x7f68fe51c710   0x7f68fe51c6e0          ( 0,  4)
 234 5    2    thread start    seq_cst  0x7f68ff11ebc0   0xdeadbeef              ( 0,  4,  5)
 235 6    2    atomic read     relaxed        0x60106c   0                   3   ( 0,  4,  6)
 236 7    1    thread create   seq_cst  0x7f68fe51c720   0x7f68fe51c6e0          ( 0,  7)
 237 8    3    thread start    seq_cst  0x7f68ff11efc0   0xdeadbeef              ( 0,  7,  0,  8)
 238 9    2    atomic write    relaxed        0x601068   0                       ( 0,  4,  9)
 239 10   3    atomic read     relaxed        0x601068   0                   2   ( 0,  7,  0, 10)
 240 11   2    thread finish   seq_cst  0x7f68ff11ebc0   0xdeadbeef              ( 0,  4, 11)
 241 12   3    atomic write    relaxed        0x60106c   0x2a                    ( 0,  7,  0, 12)
 242 13   1    thread join     seq_cst  0x7f68ff11ebc0   0x2                     ( 0, 13, 11)
 243 14   3    thread finish   seq_cst  0x7f68ff11efc0   0xdeadbeef              ( 0,  7,  0, 14)
 244 15   1    thread join     seq_cst  0x7f68ff11efc0   0x3                     ( 0, 15, 11, 14)
 245 16   1    thread finish   seq_cst  0x7f68ff11e7c0   0xdeadbeef              ( 0, 16, 11, 14)
 246 HASH 4073708854
 247 ------------------------------------------------------------------------------------
 248 </pre>
 249
 250 Now consider, for example, operation 10:
 251
 252 This is the 10th operation in the execution order. It is an atomic read-relaxed
 253 operation performed by thread 3 at memory address `0x601068`. It reads the value
 254 "0", which was written by the 2nd operation in the execution order. Its clock
 255 vector consists of the following values:
 256
 257         CV[0] = 0, CV[1] = 7, CV[2] = 0, CV[3] = 10
 258
 259
 260 Other Notes
 261 -----------
 262
 263 * Deadlock detection: CDSChecker can detect deadlocks. For instance, try the
 264   following test program.
 265
 266   >     ./run.sh test/deadlock.o
 267
 268   Deadlock detection currently detects when a thread is about to step into a
 269   deadlock, without actually including the final step in the trace. But you can
 270   examine the program to see the next step.
 271
 272 * CDSChecker has to speculatively explore many execution behaviors due to the
 273   relaxed memory model, and many of these turn out to be infeasible (that is,
 274   they cannot be legally produced by the memory model). CDSChecker discards
 275   these executions as soon as it identifies them (see the "Number of infeasible
 276   executions" statistic); however, the speculation can occasionally cause
 277   CDSChecker to hit unexpected parts of the unit test program (causing a
 278   division by 0, for instance). In such programs, you might consider running
 279   CDSChecker with the `-u num` option.
 280
 281
 282 See Also
 283 --------
 284
 285 The CDSChecker project page:
 286
 287 >   <http://demsky.eecs.uci.edu/c11modelchecker.php>
 288
 289 The CDSChecker source and accompanying benchmarks on Gitweb:
 290
 291 >   <http://demsky.eecs.uci.edu/git/?p=model-checker.git>
 292 >
 293 >   <http://demsky.eecs.uci.edu/git/?p=model-checker-benchmarks.git>
 294
 295
 296 Contact
 297 -------
 298
 299 Please feel free to contact us for more information. Bug reports are welcome,
 300 and we are happy to hear from our users. We are also very interested to know if
 301 CDSChecker catches bugs in your programs.
 302
 303 Contact Brian Norris at <banorris@uci.edu> or Brian Demsky at <bdemsky@uci.edu>.
 304
 305
 306 References
 307 ----------
 308
 309 [1] L. Lamport. Time, clocks, and the ordering of events in a distributed
 310     system. CACM, 21(7):558-565, July 1978.