]> pd.if.org Git - btree/blobdiff - README.md
Fix errors in threadskv1 and threadskv3
[btree] / README.md
index c0de3d65bc6ce030aedd0f1ab3c7f21c3cf34a50..4a81c1ae04abdd60f2e2ed94bb8957196335be74 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,25 +3,27 @@ Btree-source-code
 
 A working project for High-concurrency B-tree source code in C
 
-There are four major code sets in the standard btree source code:
+Here are files in the btree source code:
 
-btree2s.c       Single Threaded/MultiProcess with latching supplied by advisory file locking.  Works with network file systems.  Only deletes leaf level pages.
+btree2s.c       Single Threaded/MultiProcess version that removes keys all the way back to an original empty btree, placing removed nodes on a free list.  Operates under either memory mapping or file I/O.  Recommended btrees hosted on network file systems.
 
-btree2t.c       Single Threaded/MultiProcess version that removes keys all the way back to an original empty btree.
+btree2t.c       Single Threaded/MultiProcess version similar to btree2s except that fcntl locking has been replaced by test & set latches in the first few btree pages.  Uses either memory mapping or file I/O.
 
-threads2h.c     Multi-Threaded/Multi-Process with latching implemented by a latch manager with pthreads/SRW latches in the first few btree pages.
+btree2u.c              Single Threaded/MultiProcess version that implements a traditional buffer pool manager in the first n pages of the btree file.  The buffer pool accesses its pages with mmap.  Evicted pages are written back to the btree file from the buffer pool pages with pwrite. Recommended for linux.
 
-threads2i.c     Multi-Threaded/Multi-Process with latching implemented by a latch manager with test & set latches  in the first few btree pages with thread yield system calls during contention.
+btree2v.c              Single Threaded/MultiProcess version based on btree2u that utilizes linux only futex calls for latch contention.
 
-threads2j.c     Multi-Threaded/Multi-Process with latching implemented by a latch manager with test & set locks in the first few btree pages with Linux futex system calls during contention.
+threads2h.c     Multi-Threaded/Multi-Process with latching implemented by a latch manager with pthreads/SRW latches in the first few btree pages. Recommended for Windows.
+
+threads2i.c     Multi-Threaded/Multi-Process with latching implemented by a latch manager with test & set latches in the first few btree pages with thread yield system calls during contention.
 
-The Foster code set includes the same three types of latching:
+threads2j.c     Multi-Threaded/Multi-Process with latching implemented by a latch manager with test & set locks in the first few btree pages with Linux futex system calls during contention.
 
-Fosterbtreee.c  Multi-Threaded/Single Process with latching implemented by a latch manager with pthreads/SRW latches in the first few btree pages.
+threadskv1.c   Multi-Threaded/Multi-Process based on threads2i.c that generalizes key/value storage in the btree pages. The page slots are reduced to 16 or 32 bits, and the value byte storage occurs along with the key storage.
 
-Fosterbtreef.c  Multi-Threaded/Multi-Process with latching implemented by a latch manager with test & set latches  in the first few btree pages with thread yield  system calls during contention.
+threadskv2.c   Multi-Threaded/Multi-Process based on threadskv1 that replaces the linear sorted key array with a red/black tree.
 
-Fosterbtreeg.c  Multi-Threaded/Multi-Process with latching implemented by a latch manager with test & set locks in the first few btree pages with Linux futex system calls during contention.
+threadskv3.c   Multi-Threaded/Multi-Process based on threadskv1 that introduces librarian filler slots in the linear key array to minimize data movement when a new key is inserted into the middle of the array.
 
 Compilation is achieved on linux or Windows by:
 
@@ -31,4 +33,4 @@ or
 
 cl /Ox /D STANDALONE threads2h.c
 
-Please see the project wiki page for documentation
+Please see the project wiki page for additional documentation