Lib.rs

Write ahead logging for rust applications. Write ahead logging is a crucial component for applications requiring data durability. Many times it is inefficient to flush and sync new data (or modifications to existing data) to on-disk data-structures, like an index. Write-ahead-logging facilitates by ingesting write operations by appending and syncing it to disk and allows applications to pre-process a batch of write-operations and write them to on-disk structures in the most efficient manner.

Goals

• Serialize write operations to an append only journal file.
• Generate monotonically increasing sequence-number and return the same to the application.
• Configurable limit for journal file, beyond which log files are rotate.
• Configurable fsync, for persistence guarantee.
• Iterate over all entries persisted in the log file in monotonically increasing seqno order.
• Range over a subset of entries, specified with start-seqno and end-seqno.
• Wal type is parameterized over a state type S. This is helpful for using Wal type to be used with consensus protocol like Raft.
• Concurrent readers and writers into single log instance.

Concurrency

A single log-instance can be cloned and shared among multiple threads for concurrent writing and reading. All write operations are serialized. While read operations and write-operation are mutually exclusive, concurrent reads are allowed.

Performance

Single threaded write performance with different payload size and fsync enabled.

Multi-threaded write performance with constant payload size of 100-bytes per operation and fsync enabled.

Multi-threaded read performance with constant payload size of 100-bytes per operation and fsync enabled.

Contribution

• Simple workflow. Fork - Modify - Pull request.
• Before creating a PR,
  • Run make build to confirm all versions of build is passing with 0 warnings and 0 errors.
  • Run check.sh with 0 warnings, 0 errors and all testcases passing.
  • Run perf.sh with 0 warnings, 0 errors and all testcases passing.
  • Install and run cargo spellcheck to remove common spelling mistakes.
• Developer certificate of origin is preferred.