CS 180 - Assignment #1

Information

• Handout
• cachelist.h (Text) This is the interface.
• cachelist.c (Text) This is a skeleton to get you started. You'll need to modify it, but be careful not to change the cl_dump function because you won't diff correctly if you do. Also: Make sure you document all functions with Doxygen, even if you didn't write the functions.

• sample-driver.c (Text) This is a sample driver to help you get started testing.
• Random number generator files
  • - Header file (PRNG.h): HTML Text
  • - Implementation (PRNG.c): HTML Text

• Command line to compile the program:

  clang -Werror -Wall -Wextra -ansi -pedantic -g -O2 sample-driver.c cachelist.c PRNG.c -o cachelist
  

• Sample makefile for the project. You should enhance it by adding rules so that you can run the executable and diff the output. You should also add a rule to run Doxygen.
• A sample Doxyfile. Use this as a strarting point. (Remove the .txt extension)
• To run the program, type this at the command line:

  ./cachelist X
  

  where X is the test number to run. See the driver for details.

  To detect memory errors and leaks, run it under valgrind like this:

  valgrind -q --leak-check=full --show-reachable=yes --tool=memcheck ./cachelist X
  

  replace X with the test number to run.

• Sample outputs:
  1. test_add_front
     
  2. test_add_end
     
  3. test_remove1
     
  4. test_remove2
     
  5. test_insert_before1
     
  6. test_insert_after1
     
  7. test_find1
     
  8. test_find2
     
  9. test_find_stress1 (This is without caching and takes about 6 seconds.)
     
  10. test_find_stress2 (This is with caching and takes about .5 seconds.)
      
  11. test_a_lot  (verbose)
      
  12. all tests
      

  ---

• Using script

You need to capture your shell session that shows various things like compiling and running the program, using diff to make sure your output is correct and running with valgrind and then running Doxygen. After you've finished coding and testing everything and are sure everything is correct, use the script command to make a text file of your session. From the bash shell in the directory you've setup to test with, run these commands: (You'll need a proper Doxygen config file called Doxyfile for the doxygen command to work. Make sure you set QUIET=YES in the config file so that you can see any warnings that might be displayed.)

script
date
uptime
echo FIRSTNAME LASTNAME
pwd
whoami
uname -a
cat /proc/cpuinfo
cat /proc/meminfo
clang -g -Werror -Wall -Wextra -ansi -pedantic sample-driver.c cachelist.c PRNG.c -o cachelist
./cachelist | tee output.txt
diff output.txt output-all.txt
valgrind -q --leak-check=full --show-reachable=yes --tool=memcheck ./cachelist > /dev/null
doxygen
ls -al html/
ls -al latex/

Then, press Ctrl-D to end the script session. A file named typescript was created with all of the commands and output. Replace FIRSTNAME and LASTNAME with your real first name and last name. This is how you get your name in the typescript file. Consult the man pages here.if you want more information on script.