package chamelon

  1. Overview
  2. Docs
Subset of littlefs filesystem fulfilling MirageOS KV

Install

dune-project
 Dependency

Authors

Maintainers

Sources

chamelon-0.2.1.tbz
sha256=782b84fc81d7bf34fe10442437c6c507ca7ada2c9c822970cc23261be6a5178c
sha512=82fd26fdecf760f77289a9d917c93e1996afca95783d73dfd2947a60dfa817e37e068e3131b418388405927344f0d7536dc43db43b2544ab7be0a0807187edb2

doc/CHANGES.html

v0.2.1 (2025-10-09)

  • bugfix: use dd instead of fallocate, since fallocate is not available on many platforms (@yomimono)
  • tests: don't run last_modified tests, which are are flaky on 32-bit platforms and in general Need Work (@yomimono)
  • maintenance: remove mirage-clock dependency (@hannesm)

v0.2.0 (2025-10-03)

  • improvement: use the new-to-chamelon Float.log2 for skip-list math (@yomimono)
  • improvement: actually implement Kv.allocate and Kv.rename (@yomimono)
  • improvement: chamelon.exe now provides chamelon parse, which outputs a block-by-block parse attempt to stderr. Many types now also have pps to support this. This tool does not distinguish between metadata and data blocks, which makes it primarily useful for debugging rather than recovery. (@yomimono)
  • bugfix: fix many places where tags weren't checked for the 'tag deleted' field (@yomimono)
  • bugfix: fix potential data loss bug when keys are overwritten and the new entry is the first in a newly-split block (reported by independently by @palainp and then by @armael and @gasche with tests and a great writeup, fix by @yomimono)
  • bugfix: fix incorrect No_space when re-mounting a filesystem where many blocks are already used, but nowhere near all of them (reported by @reynir with tests, fix by @yomimono)
  • bugfix: fix confusion about superblock entry bearing the name littlefs (@yomimono)
  • bugfix: check block revision counts with sequence math, as in the spec (@yomimono)
  • maintenance: break dependency cycle between Tag and Entry (@emillon)
  • maintenance: adapt to mirage-kv 6.0.1 type signatures (@hannesm, @palainp)
  • maintenance: various opam updates for the modern age (@hannesm)
  • tests: add a lot of tests (@reynir, @gasche, @armael, @yomimono)
  • miscellaneous: break some logic into fs_internal.ml, a precursor to a more general reorganization to get error-prone low-level operations out of kv and fs (@yomimono)

v0.1.1 (2022-07-28, all changes by @yomimono)

  • bugfix: remove dependency cycle between chamelon and chamelon-unix
  • bugfix: tag src/runtest with (package chamelon-unix)

v0.1.0 (prepared and superseded 2022-07-28, all changes by @yomimono)

  • new features: expose and implement Kv.size t key and Kv.get_partial t key ~offset ~length.
  • bugfix: large files could be misread under certain circumstances because the final block index wasn't correctly calculated. remove bitwise module and the Base popcount it referenced, and instead calculate the block index with a recursive function.
  • bugfix: detect unwriteable blocks instead of endlessly splitting to try to accommodate them.
  • bugfix: keep track of allocated but not-yet-written blocks, and don't hand them out twice.
  • bugfix: check the maximum name length against the block size when mounting a filesystem.

v0.0.10

  • detect simple cycles in the metadata tree at connect time (@yomimono)
  • check block size in the superblock at connect time, and fail if it doesn't match block device (@yomimono)

v0.0.9.1 (2022-06-23)

  • fix 32-bit compilation, for real this time (@yomimono)

v0.0.9 (unreleased)

  • be consistent in the use of Logs vs Log module (@palainp)
  • implement a lookahead block allocator more similar to the littlefs one (@yomimono)
  • bring back fuzz tests and improve them (@yomimono)
  • test for correct block index detection in CTZ files, and fix an edge case (@yomimono)

v0.0.8 (2022-04-29)

  • use the sector_size given by the block device via its info (@dinosaure)

v0.0.7 (2022-03-04)

  • initial opam release

v0.0.6 (2022-03-01)

  • unix binaries are now all subcommands of the chamelon command
  • refactor split and add many more tests
  • fix a bug where writing a block that is over half full and already has a hardtail would never cause compaction

v0.0.5 (2022-02-09)

  • fix several problems with remove
  • fix problem where making new directories could get exciting unexpected contents

v0.0.4 (2022-01-26)

  • always start processing a directory at its first blockpair, not its last
  • add timestamp output to lfs_ls

v0.0.3 (2022-01-22)

  • follow hardtails when making new directories

v0.0.2 (2022-01-18)

  • used block detection now correctly finds the last block in a CTZ list
  • entries in a directory are no longer sometimes lost after splitting when block size is small
  • the allocator now has a separate function for allocating metadata block pairs, so the user doesn't have to retrieve two blocks individually

v0.0.1 (2022-01-10)

Initial release.