tinycdbff - CDB for Chan FatFs

This code is based on TinyCDB by Michael Tokarev.

Requires FatFs - Generic FAT File System Module to be also included, so that it has access to ff.h.

Sample Makefile integration parts

TINYCDBFF_DIR       ?= ./tinycdbff
TINYCDBFF_INCLUDE    = $(TINYCDBFF_DIR)
TINYCDBFF_SOURCE_DIR = $(TINYCDBFF_DIR)/
TINYCDBFF_SOURCE     = \
  cdb_hash.c \
  cdb_make_add.c \
  cdb_make.c \
  cdb_make_put.c \
  cdb_seek.c \
  cdb_unpack.c

CFLAGS              += -I$(TINYCDBFF_INCLUDE)

EXTRA_SOURCE        += $(addprefix $(TINYCDBFF_SOURCE_DIR), $(TINYCDBFF_SOURCE))

Sample query usage:

#include "ff.h"
#include "cdb.h"

FIL file;
f_open(&file, filename, FA_READ);
if (cdb_seek(&file, key, keylen, &datalen) > 0) {
  data = malloc(datalen + 1);
  cdb_bread(&file, data, datalen);
  data[datalen] = '\0';
  printf("key=%s data=%s\n", key, data);
} else {
  printf("key=%s not found\n", key);
}
f_close(&file);

Sample create usage:

#include "ff.h"
#include "cdb.h"

FIL file;
FRESULT fr;
struct cdb_make cdbm;
char *key, *data;
unsigned keylen, datalen;

/* initialize the database */
fr = f_open(&file, "NEW.CDB", FA_READ|FA_WRITE|FA_CREATE_ALWAYS);
if (fr) return -1; // error on opening
cdb_make_start(&cdbm, &file);

while(have_more_data()) {
  /* initialize key and data */
  if (cdb_make_exists(&cdbm, key, keylen) == 0) {
    cdb_make_add(&cdbm, key, keylen, data, datalen);
    /* or use cdb_make_put() with appropriate flags */
  }
}

/* finalize and close the database */
cdb_make_finish(&cdbm);
f_close(&file);

Compile-checking

The sources are a drop-in module; a real build links them against Chan FatFs. To catch breakage without vendoring all of FatFs, t/compile-check.sh syntax-checks every source against a minimal FatFs stub (t/ff.h):

sh t/compile-check.sh

This also runs on every push and pull request via GitHub Actions. It proves the sources compile; it does not exercise cdb behaviour (that needs real FatFs and storage).

License

Public domain — see LICENSE (The Unlicense). Based on tinycdb by Michael Tokarev (public domain); Chan FatFs port by Torsten Raudssus. Each source file carries the same public-domain dedication in its header.

Support

Support at #hardware on irc.perl.org

Report issues here at GitHub