Name change
authorbdemsky <bdemsky@uci.edu>
Tue, 23 Jul 2019 00:22:36 +0000 (17:22 -0700)
committerbdemsky <bdemsky@uci.edu>
Tue, 23 Jul 2019 00:22:36 +0000 (17:22 -0700)
Doxyfile
README.md
main.cc

index 742c729..67160eb 100644 (file)
--- a/Doxyfile
+++ b/Doxyfile
@@ -26,7 +26,7 @@ DOXYFILE_ENCODING      = UTF-8
 # identify the project. Note that if you do not use Doxywizard you need
 # to put quotes around the project name if it contains spaces.
 
-PROJECT_NAME           = "C11Fuzzer: A Fuzzer for C11/C++11 Atomics"
+PROJECT_NAME           = "C11Tester: A Fuzzer for C11/C++11 Atomics"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
 # This could be handy for archiving the generated documentation or
index c9f3b45..005f512 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,14 +1,14 @@
-C11Fuzzer: A Fuzzer for C11 and C++11 Atomics
+C11Tester: A Fuzzer for C11 and C++11 Atomics
 =====================================================
 
-C11Fuzzer is a fuzzer for C11/C++11 which randomly explores the
+C11Tester is a fuzzer for C11/C++11 which randomly explores the
 behaviors of code under the C/C++ memory model.
 
-C11Fuzzer is constructed as a dynamically-linked shared library which
+C11Tester is constructed as a dynamically-linked shared library which
 implements the C and C++ atomic types and portions of the other thread-support
 libraries of C/C++ (e.g., std::atomic, std::mutex, etc.).
 
-C11Fuzzer should compile on Linux OSX.  Instrumenting programs
+C11Tester should compile on Linux OSX.  Instrumenting programs
 requires using our LLVM pass.  It likely can be ported to other \*NIX
 flavors.
 
@@ -16,7 +16,7 @@ flavors.
 Getting Started
 ---------------
 
-If you haven't done so already, you may download C11Fuzzer using git:
+If you haven't done so already, you may download C11Tester using git:
 
       git clone git://demsky.eecs.uci.edu/c11fuzzer.git
 
@@ -28,7 +28,7 @@ Compile the fuzzer:
 
       make
 
-To see the help message on how to run C11Fuzzer, execute:
+To see the help message on how to run C11Tester, execute:
 
       ./run.sh -h
 
@@ -51,7 +51,7 @@ Benchmarks
 
 Many simple tests are located in the `tests/` directory. You may also want to
 try the larger benchmarks (distributed separately), which can be placed under
-the `benchmarks/` directory. After building C11Fuzzer, you can build and run
+the `benchmarks/` directory. After building C11Tester, you can build and run
 the benchmarks as follows:
 
 >     make benchmarks
@@ -73,17 +73,17 @@ Running your own code
 You likely want to test your own code, not just our simple tests. To do so, you
 need to perform a few steps.
 
-First, because C11Fuzzer executes your program dozens (if not hundreds or
+First, because C11Tester executes your program dozens (if not hundreds or
 thousands) of times, you will have the most success if your code is written as a
 unit test and not as a full-blown program.
 
-Second, because C11Fuzzer must be able to manage your program for you, your
+Second, because C11Tester must be able to manage your program for you, your
 program should declare its main entry point as `user_main(int, char**)` rather
 than `main(int, char**)`.
 
 Third, test programs must use the standard C11/C++11 library headers (see below
 for supported APIs) and must compile against the versions provided in
-C11Fuzzer's `include/` directory. Notably, we only support C11 thread syntax
+C11Tester's `include/` directory. Notably, we only support C11 thread syntax
 (`thrd_t`, etc. from `<thread.h>`).
 
 Test programs may also use our included happens-before race detector by
@@ -91,9 +91,9 @@ including <librace.h> and utilizing the appropriate functions
 (`store_{8,16,32,64}()` and `load_{8,16,32,64}()`) for storing/loading data
 to/from non-atomic shared memory.
 
-C11Fuzzer can also check boolean assertions in your test programs. Just
+C11Tester can also check boolean assertions in your test programs. Just
 include `<model-assert.h>` and use the `MODEL_ASSERT()` macro in your test program.
-C11Fuzzer will report a bug in any possible execution in which the argument to
+C11Tester will report a bug in any possible execution in which the argument to
 `MODEL_ASSERT()` evaluates to false (that is, 0).
 
 Test programs should be compiled against our shared library (libmodel.so) using
@@ -104,7 +104,7 @@ variable, for instance.
 
 ### Supported C11/C++11 APIs ###
 
-To model-check multithreaded code properly, C11Fuzzer needs to instrument any
+To model-check multithreaded code properly, C11Tester needs to instrument any
 concurrency-related API calls made in your code. Currently, we support parts of
 the following thread-support libraries. The C versions can be used in either C
 or C++.
@@ -121,11 +121,11 @@ C++ `<thread>`).
 Reading an execution trace
 --------------------------
 
-When C11Fuzzer detects a bug in your program (or when run with the `--verbose`
+When C11Tester detects a bug in your program (or when run with the `--verbose`
 flag), it prints the output of the program run (STDOUT) along with some summary
 trace information for the execution in question. The trace is given as a
 sequence of lines, where each line represents an operation in the execution
-trace. These lines are ordered by the order in which they were run by C11Fuzzer
+trace. These lines are ordered by the order in which they were run by C11Tester
 (i.e., the "execution order"), which does not necessarily align with the "order"
 of the values observed (i.e., the modification order or the reads-from
 relation).
@@ -133,7 +133,7 @@ relation).
 The following list describes each of the columns in the execution trace output:
 
  * \#: The sequence number within the execution. That is, sequence number "9"
-   means the operation was the 9th operation executed by C11Fuzzer. Note that
+   means the operation was the 9th operation executed by C11Tester. Note that
    this represents the execution order, not necessarily any other order (e.g.,
    modification order or reads-from).
 
@@ -146,11 +146,11 @@ The following list describes each of the columns in the execution trace output:
 
  * Location: The memory location on which this operation is operating. This is
    well-defined for atomic write/read/RMW, but other operations are subject to
-   C11Fuzzer implementation details.
+   C11Tester implementation details.
 
  * Value: For reads/writes/RMW, the value returned by the operation. Note that
    for RMW, this is the value that is *read*, not the value that was *written*.
-   For other operations, 'value' may have some C11Fuzzer-internal meaning, or
+   For other operations, 'value' may have some C11Tester-internal meaning, or
    it may simply be a don't-care (such as `0xdeadbeef`).
 
  * Rf: For reads, the sequence number of the operation from which it reads.
@@ -169,7 +169,7 @@ The following list describes each of the columns in the execution trace output:
 
    So for any thread i, we say CV[i] is the sequence number of the most recent
    operation in thread i such that operation i happens-before this operation.
-   Notably, thread 0 is reserved as a dummy thread for certain C11Fuzzer
+   Notably, thread 0 is reserved as a dummy thread for certain C11Tester
    operations.
 
 See the following example trace:
@@ -208,7 +208,7 @@ vector consists of the following values:
 End of Execution Summary
 ------------------------
 
-C11Fuzzer prints summary statistics at the end of each execution. These
+C11Tester prints summary statistics at the end of each execution. These
 summaries are based off of a few different properties of an execution, which we
 will break down here:
 
@@ -216,15 +216,15 @@ will break down here:
   memory model. Such an execution can be considered overhead for the
   model-checker, since it should never appear in practice.
 
-* A _buggy_ execution is an execution in which C11Fuzzer has found a real
+* A _buggy_ execution is an execution in which C11Tester has found a real
   bug: a data race, a deadlock, failure of a user-provided assertion, or an
-  uninitialized load, for instance. C11Fuzzer will only report bugs in feasible
+  uninitialized load, for instance. C11Tester will only report bugs in feasible
   executions.
 
 * A _redundant_ execution is a feasible execution that is exploring the same
   state space explored by a previous feasible execution. Such exploration is
-  another instance of overhead, so C11Fuzzer terminates these executions as
-  soon as they are detected. C11Fuzzer is mostly able to avoid such executions
+  another instance of overhead, so C11Tester terminates these executions as
+  soon as they are detected. C11Tester is mostly able to avoid such executions
   but may encounter them if a fairness option is enabled.
 
 Now, we can examine the end-of-execution summary of one test program:
@@ -243,7 +243,7 @@ Now, we can examine the end-of-execution summary of one test program:
   can expect to see in practice.
 
 * _Number of redundant executions:_ these are feasible but redundant executions
-  that were terminated as soon as C11Fuzzer noticed the redundancy.
+  that were terminated as soon as C11Tester noticed the redundancy.
 
 * _Number of buggy executions:_ these are feasible, buggy executions. These are
   the trouble spots where your program is triggering a bug or assertion.
@@ -252,7 +252,7 @@ Now, we can examine the end-of-execution summary of one test program:
 * _Number of infeasible executions:_ these are infeasible executions,
   representing some of the overhead of model-checking.
 
-* _Total executions:_ the total number of executions explored by C11Fuzzer.
+* _Total executions:_ the total number of executions explored by C11Tester.
   Should be the sum of the above categories, since they are mutually exclusive.
 
 
@@ -260,12 +260,12 @@ Other Notes and Pitfalls
 ------------------------
 
 * Many programs require some form of fairness in order to terminate in a finite
-  amount of time. C11Fuzzer supports the `-y num` and `-f num` flags for these
+  amount of time. C11Tester 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: C11Fuzzer can detect deadlocks. For instance, try the
+* Deadlock detection: C11Tester can detect deadlocks. For instance, try the
   following test program.
 
   >     ./run.sh test/deadlock.o
@@ -274,19 +274,19 @@ Other Notes and Pitfalls
   deadlock, without actually including the final step in the trace. But you can
   examine the program to see the next step.
 
-* C11Fuzzer has to speculatively explore many execution behaviors due to the
+* C11Tester has to speculatively explore many execution behaviors due to the
   relaxed memory model, and many of these turn out to be infeasible (that is,
-  they cannot be legally produced by the memory model). C11Fuzzer discards
+  they cannot be legally produced by the memory model). C11Tester discards
   these executions as soon as it identifies them (see the "Number of infeasible
   executions" statistic); however, the speculation can occasionally cause
-  C11Fuzzer to hit unexpected parts of the unit test program (causing a
+  C11Tester to hit unexpected parts of the unit test program (causing a
   division by 0, for instance). In such programs, you might consider running
-  C11Fuzzer with the `-u num` option.
+  C11Tester with the `-u num` option.
 
-* Related to the previous point, C11Fuzzer may report more than one bug for a
+* Related to the previous point, C11Tester may report more than one bug for a
   particular candidate execution. This is because some bugs may not be
-  reportable until C11Fuzzer has explored more of the program, and in the
-  time between initial discovery and final assessment of the bug, C11Fuzzer may
+  reportable until C11Tester has explored more of the program, and in the
+  time between initial discovery and final assessment of the bug, C11Tester may
   discover another bug.
 
 * Data races may be reported as multiple bugs, one for each byte-address of the
@@ -312,11 +312,11 @@ Other Notes and Pitfalls
 See Also
 --------
 
-The C11Fuzzer project page:
+The C11Tester project page:
 
 >   <http://demsky.eecs.uci.edu/c11modelchecker.html>
 
-The C11Fuzzer source and accompanying benchmarks on Gitweb:
+The C11Tester source and accompanying benchmarks on Gitweb:
 
 >   <http://demsky.eecs.uci.edu/git/?p=model-checker.git>
 >
@@ -328,7 +328,7 @@ Contact
 
 Please feel free to contact us for more information. Bug reports are welcome,
 and we are happy to hear from our users. We are also very interested to know if
-C11Fuzzer catches bugs in your programs.
+C11Tester catches bugs in your programs.
 
 Contact Weiyu Luo at <weiyul7@uci.edu> or Brian Demsky at <bdemsky@uci.edu>.
 
@@ -338,7 +338,7 @@ Copyright
 
 Copyright &copy; 2013 and 2019 Regents of the University of California. All rights reserved.
 
-C11Fuzzer is distributed under the GPL v2. See the LICENSE file for details.
+C11Tester is distributed under the GPL v2. See the LICENSE file for details.
 
 
 References
diff --git a/main.cc b/main.cc
index bcdafc4..12fc3e1 100644 (file)
--- a/main.cc
+++ b/main.cc
@@ -171,13 +171,13 @@ int main(int argc, char **argv)
        main_argv = argv;
 
        /*
-        * If this printf statement is removed, C11Fuzzer will fail on an
+        * If this printf statement is removed, C11Tester will fail on an
         * assert on some versions of glibc.  The first time printf is
         * called, it allocated internal buffers.  We can't easily snapshot
         * libc since we also use it.
         */
 
-       printf("C11Fuzzer\n"
+       printf("C11Tester\n"
                                 "Copyright (c) 2013 and 2019 Regents of the University of California. All rights reserved.\n"
                                 "Distributed under the GPLv2\n"
                                 "Written by Weiyu Luo, Brian Norris, and Brian Demsky\n\n");