Add explanatory comments to filesys tests.
authorBen Pfaff <blp@cs.stanford.edu>
Sun, 8 Jan 2006 18:59:11 +0000 (18:59 +0000)
committerBen Pfaff <blp@cs.stanford.edu>
Sun, 8 Jan 2006 18:59:11 +0000 (18:59 +0000)
44 files changed:
src/tests/filesys/base/child-syn-read.c
src/tests/filesys/base/child-syn-wrt.c
src/tests/filesys/base/lg-create.c
src/tests/filesys/base/lg-full.c
src/tests/filesys/base/lg-random.c
src/tests/filesys/base/lg-seq-block.c
src/tests/filesys/base/lg-seq-random.c
src/tests/filesys/base/sm-create.c
src/tests/filesys/base/sm-full.c
src/tests/filesys/base/sm-random.c
src/tests/filesys/base/sm-seq-block.c
src/tests/filesys/base/sm-seq-random.c
src/tests/filesys/base/syn-read.c
src/tests/filesys/base/syn-remove.c
src/tests/filesys/base/syn-write.c
src/tests/filesys/extended/child-syn-rw.c
src/tests/filesys/extended/dir-empty-name.c
src/tests/filesys/extended/dir-lsdir.c
src/tests/filesys/extended/dir-mk-tree.c
src/tests/filesys/extended/dir-mk-vine.c
src/tests/filesys/extended/dir-mkdir.c
src/tests/filesys/extended/dir-open.c
src/tests/filesys/extended/dir-over-file.c
src/tests/filesys/extended/dir-rm-cwd-cd.c
src/tests/filesys/extended/dir-rm-cwd.c
src/tests/filesys/extended/dir-rm-parent.c
src/tests/filesys/extended/dir-rm-root.c
src/tests/filesys/extended/dir-rm-tree.c
src/tests/filesys/extended/dir-rm-vine.c
src/tests/filesys/extended/dir-rmdir.c
src/tests/filesys/extended/dir-under-file.c
src/tests/filesys/extended/grow-create.c
src/tests/filesys/extended/grow-dir-lg.c
src/tests/filesys/extended/grow-file-size.c
src/tests/filesys/extended/grow-root-lg.c
src/tests/filesys/extended/grow-root-sm.c
src/tests/filesys/extended/grow-seq-lg.c
src/tests/filesys/extended/grow-seq-sm.c
src/tests/filesys/extended/grow-sparse.c
src/tests/filesys/extended/grow-tell.c
src/tests/filesys/extended/grow-too-big.c
src/tests/filesys/extended/grow-two-files.c
src/tests/filesys/extended/mk-tree.c
src/tests/filesys/extended/syn-rw.c

index 8f3ccc4017b1493e9cc5df4d9a76068ca2d223e4..a7801d4774e21673661053e89681bc56e96325a2 100644 (file)
@@ -1,3 +1,9 @@
+/* Child process for syn-read test.
+   Reads the contents of a test file a byte at a time, in the
+   hope that this will take long enough that we can get a
+   significant amount of contention in the kernel filesystem
+   code. */
+
 #include <random.h>
 #include <stdio.h>
 #include <stdlib.h>
index 43ca2a33f03d425d12783c7c0fb9ddbf15dd9b70..48f1640e1922602654c624af7652d62a48cd5be4 100644 (file)
@@ -1,3 +1,7 @@
+/* Child process for syn-read test.
+   Writes into part of a test file.  Other processes will be
+   writing into other parts at the same time. */
+
 #include <random.h>
 #include <stdlib.h>
 #include <syscall.h>
index e84866ee6d2bc4462353f6df47e3d192768e983d..5c45eee49ee562832e9fc7d365ab33a8e1c23ab1 100644 (file)
@@ -1,2 +1,5 @@
+/* Tests that create properly zeros out the contents of a fairly
+   large file. */
+
 #define TEST_SIZE 75678
 #include "tests/filesys/create.inc"
index 50a7ffaf6d851750e46742f1f4c184a32d8f12d3..5f7234d087b742a4ae153abcd7a5f478f8c40501 100644 (file)
@@ -1,2 +1,6 @@
+/* Writes out the contents of a fairly large file all at once,
+   and then reads it back to make sure that it was written
+   properly. */
+
 #define TEST_SIZE 75678
 #include "tests/filesys/base/full.inc"
index c3027cc89ffb0a5b143e1d77852efbec04ea212e..b6f887351a0ad8b007d20e863cd85faf60792a8f 100644 (file)
@@ -1,3 +1,7 @@
+/* Writes out the content of a fairly large file in random order,
+   then reads it back in random order to verify that it was
+   written properly. */
+
 #define BLOCK_SIZE 512
 #define TEST_SIZE (512 * 150)
 #include "tests/filesys/base/random.inc"
index 568fbb7e39b72efa0f48e70df38c547528a951e2..580c30bd9040a9bbcc8195022dd48363ad558926 100644 (file)
@@ -1,3 +1,7 @@
+/* Writes out a fairly large file sequentially, one fixed-size
+   block at a time, then reads it back to verify that it was
+   written properly. */
+
 #define TEST_SIZE 75678
 #define BLOCK_SIZE 513
 #include "tests/filesys/base/seq-block.inc"
index 2840c7f9a0a77671d63317b8051bc928b49ce613..fbb6bba1f86767d19fd34960a3d878864da45fc5 100644 (file)
@@ -1,2 +1,6 @@
+/* Writes out a fairly large file sequentially, one random-sized
+   block at a time, then reads it back to verify that it was
+   written properly. */
+
 #define TEST_SIZE 75678
 #include "tests/filesys/base/seq-random.inc"
index 522dbd0427aacd41381639921ae118543a99bea1..6b97ac1eb8843bb4d4d53e175e2f52bc1aa678cb 100644 (file)
@@ -1,2 +1,5 @@
+/* Tests that create properly zeros out the contents of a fairly
+   small file. */
+
 #define TEST_SIZE 5678
 #include "tests/filesys/create.inc"
index 10b57038bda15925fef5bf1dc47bdea313f4f5b2..23ff3d4dc9a9417e0650553b6a8efc768e61eabe 100644 (file)
@@ -1,2 +1,6 @@
+/* Writes out the contents of a fairly small file all at once,
+   and then reads it back to make sure that it was written
+   properly. */
+
 #define TEST_SIZE 5678
 #include "tests/filesys/base/full.inc"
index 3639a1666341c939b87706c73fe68a8170822f8e..42d670f5d3a150643d598e77c8e2239a46e89953 100644 (file)
@@ -1,3 +1,7 @@
+/* Writes out the content of a fairly small file in random order,
+   then reads it back in random order to verify that it was
+   written properly. */
+
 #define BLOCK_SIZE 13
 #define TEST_SIZE (13 * 123)
 #include "tests/filesys/base/random.inc"
index 5196eac86020145f536bcbdf1843f66a43f99ac3..e3683277048168cbff3c0d3f8a63dd6789271af4 100644 (file)
@@ -1,3 +1,7 @@
+/* Writes out a fairly small file sequentially, one fixed-size
+   block at a time, then reads it back to verify that it was
+   written properly. */
+
 #define TEST_SIZE 5678
 #define BLOCK_SIZE 513
 #include "tests/filesys/base/seq-block.inc"
index 84b6bd3a6919807b11c80c26dd65d08d160d084a..89e5b719fa98106066245972038a04854e5abee5 100644 (file)
@@ -1,2 +1,6 @@
+/* Writes out a fairly large file sequentially, one random-sized
+   block at a time, then reads it back to verify that it was
+   written properly. */
+
 #define TEST_SIZE 5678
 #include "tests/filesys/base/seq-random.inc"
index 27154db154b48de8de6ae06d4b7d948f4134eb8f..27db47152f49b62f092ae4952ae51cf0d7a3c47f 100644 (file)
@@ -1,3 +1,7 @@
+/* Spawns 10 child processes, all of which read from the same
+   file and make sure that the contents are what they should
+   be. */
+
 #include <random.h>
 #include <stdio.h>
 #include <syscall.h>
index 7f0cb61e96805c681781e511947c8ca148ec3d0a..7f6cd9f3ae2248e6307075a46f9f03d05b2eac64 100644 (file)
@@ -1,3 +1,6 @@
+/* Verifies that a deleted file may still be written to and read
+   from. */
+
 #include <random.h>
 #include <string.h>
 #include <syscall.h>
index 5147a571888f3220b47d5dc403594ae8373951f2..19e9d592207cfa464758742cc3f2d319fc260eee 100644 (file)
@@ -1,3 +1,7 @@
+/* Spawns several child processes to write out different parts of
+   the contents of a file and waits for them to finish.  Then
+   reads back the file and verifies its contents. */
+
 #include <random.h>
 #include <stdio.h>
 #include <string.h>
index 6334bda0b1077d97707df098c44a9f30b87d277c..434a542e25a58cf4491aafb1b2bcc1c72ec10b5d 100644 (file)
@@ -1,3 +1,12 @@
+/* Child process for syn-rw.
+   Reads from a file created by our parent process, which is
+   growing it.  We loop until we've read the whole file
+   successfully.  Many iterations through the loop will return 0
+   bytes, because the file has not grown in the meantime.  That
+   is, we are "busy waiting" for the file to grow.
+   (This test could be improved by adding a "yield" system call
+   and calling yield whenever we receive a 0-byte read.) */
+
 #include <random.h>
 #include <stdlib.h>
 #include <syscall.h>
index d1f5132c7f54b6671f9c435a03e1e4dc2bd995e7..43bc5e6489d6cd072caea8bf2ab975dd860a9f56 100644 (file)
@@ -1,3 +1,6 @@
+/* Tries to create a directory named as the empty string,
+   which must return failure. */
+
 #include <syscall.h>
 #include "tests/lib.h"
 #include "tests/main.h"
index 1896de32d884b07628331e2918e570ce7f90cb32..091fec589c7b628d47dd83deb795d8cf5a1a28a0 100644 (file)
@@ -1,3 +1,5 @@
+/* Just runs lsdir(). */
+
 #include <syscall.h>
 #include "tests/lib.h"
 #include "tests/main.h"
index 2b5907d4bc7b40ab18dceefb02588f9d787bf96d..a714ff379a28254e16d1b918a6a8141a62543875 100644 (file)
@@ -1,3 +1,6 @@
+/* Creates directories /0/0/0 through /3/2/2 and creates files in
+   the leaf directories. */
+
 #include "tests/filesys/extended/mk-tree.h"
 #include "tests/main.h"
 
index e873238f4ddb93664682342dcf57382e70d5d3d6..7ac18a143543908319146376705392c75a74cc5e 100644 (file)
@@ -1,3 +1,8 @@
+/* Creates a "vine" of directories /0/1/2/3/4/5/6/7/8/9
+   and changes directory into each of them,
+   then creates a test file in the bottommost
+   and verifies that it can be opened by absolute name. */
+
 #include <syscall.h>
 #include "tests/lib.h"
 #include "tests/main.h"
index a031ba061b144ae693830cfa3c8368c28a105d4a..994f41ce967bb5336732175555f6f22ed78f97e1 100644 (file)
@@ -1,3 +1,5 @@
+/* Tests mkdir(). */
+
 #include <syscall.h>
 #include "tests/lib.h"
 #include "tests/main.h"
index 9bfe2e02a0efa8323fd02ba42dd7ac824e72147b..c1f6da5f6a1cb0a1ca010b7f47054812bf9d441c 100644 (file)
@@ -1,3 +1,7 @@
+/* Tries to open a directory.
+   This is allowed to succeed or fail,
+   but if it succeeds then attempts to write to it must fail. */
+
 #include <syscall.h>
 #include "tests/lib.h"
 #include "tests/main.h"
index a7866f72335d7c276b705bc863b4fbf346520476..cdd2c62a27b30fcd4a647f679bb47c16caf3c584 100644 (file)
@@ -1,3 +1,6 @@
+/* Tries to create a file with the same name as an existing
+   directory, which must return failure. */
+
 #include <syscall.h>
 #include "tests/lib.h"
 #include "tests/main.h"
index 7c362ae09ce541d1fc827f38207f2c1fce28a3b4..c9a6e61a16a7e214508f909e95e53bbc033e30ff 100644 (file)
@@ -1,3 +1,10 @@
+/* Tries to remove the current directory.
+   This is allowed to succeed or fail.
+   If it succeeds, then it must not be possible to chdir back to
+   the current directory by name (because it's been deleted).
+   If it fails, then it must be possible to chdir back to the
+   current directory by name (because it still exists). */
+
 #include <syscall.h>
 #include "tests/lib.h"
 #include "tests/main.h"
index 3e6fc443807c8340e5d53f58a386331da2361665..7f81a0bef234c5e18030fda20dd0f34b77309f54 100644 (file)
@@ -1,3 +1,8 @@
+/* Tries to remove the current directory.
+   This is allowed to succeed or fail.
+   Then creates a file in the root to make sure that we haven't
+   corrupted any directory state. */
+
 #include <syscall.h>
 #include "tests/lib.h"
 #include "tests/main.h"
index e18d6fdadc57cf721ac85bd4d73bad2e02a030e6..9db212a8f5ca58b0020922096dc1f214c6fe7818 100644 (file)
@@ -1,3 +1,7 @@
+/* Tries to remove the change of parents of the current
+   directory.
+   This can succeed or fail as long as it doesn't crash. 8/
+
 #include <syscall.h>
 #include "tests/lib.h"
 #include "tests/main.h"
index d44b8806913b2a959fe457738f79c5c68058ece1..5f9cb61509da6c04867e7246342e95c3f918a69e 100644 (file)
@@ -1,3 +1,6 @@
+/* Try to remove the root directory.
+   This must return failure. */
+
 #include <syscall.h>
 #include "tests/lib.h"
 #include "tests/main.h"
index c4186f9633ad56734fd0ada1c878c2add47852b0..bab41a66d184670f79bdd7e64c7840a0a42f52dc 100644 (file)
@@ -1,3 +1,6 @@
+/* Creates directories /0/0/0 through /3/2/2 and files in the
+   leaf directories, then removes them. */
+
 #include <stdarg.h>
 #include <stdio.h>
 #include <syscall.h>
index 990bcb42b6eb20a4831f21c7c42fe61fd18b9641..c424c049b14bd2141cadd39e79b37abef26d159a 100644 (file)
@@ -1,3 +1,7 @@
+/* Creates a "vine" of directories /0/1/2/3/4/5/6/7/8/9
+   and changes directory into each of them,
+   then remove them. */
+
 #include <string.h>
 #include <syscall.h>
 #include "tests/lib.h"
index 38317dc7bcaad797a8e669483a33ca12d7118dc0..b3cbc6f2699af9f74a24419cf00796656095c7dc 100644 (file)
@@ -1,3 +1,6 @@
+/* Creates and removes a directory, then makes sure that it's
+   really gone. */
+
 #include <syscall.h>
 #include "tests/lib.h"
 #include "tests/main.h"
index 88a633b8ee2789c5785d5a2edc5db96698b8c67c..973a8b1e9b3703db11aba83071d2d3f2c79bdfb4 100644 (file)
@@ -1,3 +1,6 @@
+/* Tries to create a directory with the same name as an existing
+   file, which must return failure. */
+
 #include <syscall.h>
 #include "tests/lib.h"
 #include "tests/main.h"
index 45d8d54c6534ac887a8e0587b9f2535b498e4054..9ccc4ea31b6a775634b1ca52d818602dbe7d39bd 100644 (file)
@@ -1,2 +1,4 @@
+/* Create a file of size 0. */
+
 #define TEST_SIZE 0
 #include "tests/filesys/create.inc"
index bd05dad8ccc2f3a3fc39d2095b1840fa79277b08..20a194b32fda248e66b0e33f6b301bf9dfac0d71 100644 (file)
@@ -1,3 +1,6 @@
+/* Creates a directory,
+   then creates 50 files in that directory. */
+
 #define FILE_CNT 50
 #define DIRECTORY "/x"
 #include "tests/filesys/extended/grow-dir.inc"
index e7c269fae326f6c62da4b892bdf918fe741c2057..3ce858876d3be943978e9cecaf69a1722b12b71f 100644 (file)
@@ -1,3 +1,7 @@
+/* Grows a file from 0 bytes to 2,134 bytes, 37 bytes at a time,
+   and checks that the file's size is reported correctly at each
+   step. */
+
 #include <syscall.h>
 #include "tests/filesys/seq-test.h"
 #include "tests/lib.h"
index b4731b23afdf392477d4137977287f5f345a40f2..d8d6c0900e18476d22ce8c1c2153256de79ca12d 100644 (file)
@@ -1,2 +1,4 @@
+/* Creates 50 files in the root directory. */
+
 #define FILE_CNT 50
 #include "tests/filesys/extended/grow-dir.inc"
index db7d1f3c26ff0f94e7d6b0dd61eeae906070fd8e..ee375d50996ef3eba6bf021b175ae6cb17344341 100644 (file)
@@ -1,2 +1,4 @@
+/* Creates 20 files in the root directory. */
+
 #define FILE_CNT 20
 #include "tests/filesys/extended/grow-dir.inc"
index 4474d504532b8581efa3e7cb169a764c328c8551..3108d172a59dfec78dfcf1e39c4fe731797952d4 100644 (file)
@@ -1,2 +1,5 @@
+/* Grows a file from 0 bytes to 72,943 bytes, 1,234 bytes at a
+   time. */
+
 #define TEST_SIZE 72943
 #include "tests/filesys/extended/grow-seq.inc"
index bf54c64be29cb5b923ee5cd41492e13641d3fd92..3656e2ee13c5c14986a1060f74ae8bb2d39e9b85 100644 (file)
@@ -1,2 +1,5 @@
+/* Grows a file from 0 bytes to 5,678 bytes, 1,234 bytes at a
+   time. */
+
 #define TEST_SIZE 5678
 #include "tests/filesys/extended/grow-seq.inc"
index 11e3b6eabc34cbc455ff2bd2009edb9d9003883e..135a9183fcc8f3d92cfca6f4128dbc4f8145b9df 100644 (file)
@@ -1,3 +1,6 @@
+/* Tests that seeking past the end of a file and writing will
+   properly zero out the region in between. */
+
 #include <syscall.h>
 #include "tests/lib.h"
 #include "tests/main.h"
index 3f1e21122e4e293e549822ad55b98e684ebc8c06..5f5da5b930e88b9a3a9ecc02270cebc1431b1718 100644 (file)
@@ -1,3 +1,6 @@
+/* Checks that growing a file updates the file position
+   correctly. */
+
 #include <syscall.h>
 #include "tests/filesys/seq-test.h"
 #include "tests/lib.h"
index 9d7ddca75f423ec3619481ca54d864400b94ad61..d49fcb24930f01d2ecc8c39744fff6eeaecbe8dc 100644 (file)
@@ -1,3 +1,6 @@
+/* Checks that trying to grow a file beyond the capacity of the
+   file system behaves reasonably (does not crash). */
+
 #include <limits.h>
 #include <syscall.h>
 #include "tests/lib.h"
index 69f17aecbdd30ceefaa95009c19f3937e1d7ae62..cc0f5fa7d447cc609b55e04296e9e5f47a6de63d 100644 (file)
@@ -1,3 +1,6 @@
+/* Grows two files in parallel and checks that their contents are
+   correct. */
+
 #include <random.h>
 #include <syscall.h>
 #include "tests/lib.h"
index 66a3ae3979467797b48d90c81f95427a28fca5ac..a36bb8815d18d2a6674449aada49746330854f36 100644 (file)
@@ -1,3 +1,5 @@
+/* Library function for creating a tree of directories. */
+
 #include <stdio.h>
 #include <syscall.h>
 #include "tests/filesys/extended/mk-tree.h"
index a4c2f5dc7b27aecc3887b013f1c93b1640d841f3..f2900d07e8ebf4c78ac8d9b6da82e0285da46350 100644 (file)
@@ -1,3 +1,6 @@
+/* Grows a file in chunks while subprocesses read the growing
+   file. */
+
 #include <random.h>
 #include <syscall.h>
 #include "tests/filesys/extended/syn-rw.h"