Minor improvements to testing framework

- Moved scripts into scripts folder
- Removed what have been relatively unhelpful assert printing

scripts/corrupt.py

@@ -0,0 +1,44 @@
+#!/usr/bin/env python2
+
+import struct
+import sys
+import os
+import argparse
+
+def corrupt(block):
+    with open(block, 'r+b') as file:
+        # skip rev
+        file.read(4)
+
+        # go to last commit
+        tag = 0xffffffff
+        while True:
+            try:
+                ntag, = struct.unpack('>I', file.read(4))
+            except struct.error:
+                break
+
+            tag ^= ntag
+            size = (tag & 0x3ff) if (tag & 0x3ff) != 0x3ff else 0
+            file.seek(size, os.SEEK_CUR)
+
+        # lob off last 3 bytes
+        file.seek(-(size + 3), os.SEEK_CUR)
+        file.truncate()
+
+def main(args):
+    if args.n or not args.blocks:
+        with open('blocks/.history', 'rb') as file:
+            for i in range(int(args.n or 1)):
+                last, = struct.unpack('<I', file.read(4))
+                args.blocks.append('blocks/%x' % last)
+
+    for block in args.blocks:
+        print 'corrupting %s' % block
+        corrupt(block)
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-n')
+    parser.add_argument('blocks', nargs='*')
+    main(parser.parse_args())

scripts/debug.py

@@ -0,0 +1,112 @@
+#!/usr/bin/env python2
+
+import struct
+import binascii
+
+TYPES = {
+    (0x700, 0x400): 'splice',
+    (0x7ff, 0x401): 'create',
+    (0x7ff, 0x4ff): 'delete',
+    (0x700, 0x000): 'name',
+    (0x7ff, 0x001): 'name reg',
+    (0x7ff, 0x002): 'name dir',
+    (0x7ff, 0x0ff): 'name superblock',
+    (0x700, 0x200): 'struct',
+    (0x7ff, 0x200): 'struct dir',
+    (0x7ff, 0x202): 'struct ctz',
+    (0x7ff, 0x201): 'struct inline',
+    (0x700, 0x300): 'userattr',
+    (0x700, 0x600): 'tail',
+    (0x7ff, 0x600): 'tail soft',
+    (0x7ff, 0x601): 'tail hard',
+    (0x700, 0x700): 'gstate',
+    (0x7ff, 0x7ff): 'gstate move',
+    (0x700, 0x500): 'crc',
+}
+
+def typeof(type):
+    for prefix in range(12):
+        mask = 0x7ff & ~((1 << prefix)-1)
+        if (mask, type & mask) in TYPES:
+            return TYPES[mask, type & mask] + (
+                ' %0*x' % (prefix/4, type & ((1 << prefix)-1))
+                if prefix else '')
+    else:
+        return '%02x' % type
+
+def main(*blocks):
+    # find most recent block
+    file = None
+    rev = None
+    crc = None
+    versions = []
+
+    for block in blocks:
+        try:
+            nfile = open(block, 'rb')
+            ndata = nfile.read(4)
+            ncrc = binascii.crc32(ndata)
+            nrev, = struct.unpack('<I', ndata)
+
+            assert rev != nrev
+            if not file or ((rev - nrev) & 0x80000000):
+                file = nfile
+                rev = nrev
+                crc = ncrc
+
+            versions.append((nrev, '%s (rev %d)' % (block, nrev)))
+        except (IOError, struct.error):
+            pass
+
+    if not file:
+        print 'Bad metadata pair {%s}' % ', '.join(blocks)
+        return 1
+
+    print "--- %s ---" % ', '.join(v for _,v in sorted(versions, reverse=True))
+
+    # go through each tag, print useful information
+    print "%-4s  %-8s  %-14s  %3s %4s  %s" % (
+        'off', 'tag', 'type', 'id', 'len', 'dump')
+
+    tag = 0xffffffff
+    off = 4
+    while True:
+        try:
+            data = file.read(4)
+            crc = binascii.crc32(data, crc)
+            ntag, = struct.unpack('>I', data)
+        except struct.error:
+            break
+
+        tag ^= ntag
+        off += 4
+
+        type = (tag & 0x7ff00000) >> 20
+        id   = (tag & 0x000ffc00) >> 10
+        size = (tag & 0x000003ff) >> 0
+        iscrc = (type & 0x700) == 0x500
+
+        data = file.read(size if size != 0x3ff else 0)
+        if iscrc:
+            crc = binascii.crc32(data[:4], crc)
+        else:
+            crc = binascii.crc32(data, crc)
+
+        print '%04x: %08x  %-15s %3s %4s  %-23s  %-8s' % (
+            off, tag,
+            typeof(type) + (' bad!' if iscrc and ~crc else ''),
+            id if id != 0x3ff else '.',
+            size if size != 0x3ff else 'x',
+            ' '.join('%02x' % ord(c) for c in data[:8]),
+            ''.join(c if c >= ' ' and c <= '~' else '.' for c in data[:8]))
+
+        off += size if size != 0x3ff else 0
+        if iscrc:
+            crc = 0
+            tag ^= (type & 1) << 31
+
+    return 0
+
+if __name__ == "__main__":
+    import sys
+    sys.exit(main(*sys.argv[1:]))

scripts/stats.py

@@ -0,0 +1,30 @@
+#!/usr/bin/env python2
+
+import struct
+import sys
+import time
+import os
+import re
+
+def main():
+    with open('blocks/.config') as file:
+        s = struct.unpack('<LLLL', file.read())
+        print 'read_size: %d' % s[0]
+        print 'prog_size: %d' % s[1]
+        print 'block_size: %d' % s[2]
+        print 'block_size: %d' % s[3]
+
+    print 'real_size: %d' % sum(
+        os.path.getsize(os.path.join('blocks', f))
+        for f in os.listdir('blocks') if re.match('\d+', f))
+
+    with open('blocks/.stats') as file:
+        s = struct.unpack('<QQQ', file.read())
+        print 'read_count: %d' % s[0]
+        print 'prog_count: %d' % s[1]
+        print 'erase_count: %d' % s[2]
+
+    print 'runtime: %.3f' % (time.time() - os.stat('blocks').st_ctime)
+
+if __name__ == "__main__":
+    main(*sys.argv[1:])

scripts/template.fmt

@@ -0,0 +1,99 @@
+/// AUTOGENERATED TEST ///
+#include "lfs.h"
+#include "emubd/lfs_emubd.h"
+#include <stdio.h>
+#include <string.h>
+#include <stdlib.h>
+
+
+// test stuff
+static void test_assert(const char *file, unsigned line,
+        const char *s, uintmax_t v, uintmax_t e) {{
+    if (v != e) {{
+        fprintf(stderr, "\033[31m%s:%u: assert %s failed with %jd, "
+                "expected %jd\033[0m\n", file, line, s, v, e);
+        exit(-2);
+    }}
+}}
+
+#define test_assert(s, v, e) test_assert(__FILE__, __LINE__, s, v, e)
+
+
+// utility functions for traversals
+static int __attribute__((used)) test_count(void *p, lfs_block_t b) {{
+    (void)b;
+    unsigned *u = (unsigned*)p;
+    *u += 1;
+    return 0;
+}}
+
+
+// lfs declarations
+lfs_t lfs;
+lfs_emubd_t bd;
+lfs_file_t file[4];
+lfs_dir_t dir[4];
+struct lfs_info info;
+
+uint8_t buffer[1024];
+uint8_t wbuffer[1024];
+uint8_t rbuffer[1024];
+lfs_size_t size;
+lfs_size_t wsize;
+lfs_size_t rsize;
+
+uintmax_t test;
+
+#ifndef LFS_READ_SIZE
+#define LFS_READ_SIZE 16
+#endif
+
+#ifndef LFS_PROG_SIZE
+#define LFS_PROG_SIZE LFS_READ_SIZE
+#endif
+
+#ifndef LFS_BLOCK_SIZE
+#define LFS_BLOCK_SIZE 512
+#endif
+
+#ifndef LFS_BLOCK_COUNT
+#define LFS_BLOCK_COUNT 1024
+#endif
+
+#ifndef LFS_BLOCK_CYCLES
+#define LFS_BLOCK_CYCLES 1024
+#endif
+
+#ifndef LFS_CACHE_SIZE
+#define LFS_CACHE_SIZE 64
+#endif
+
+#ifndef LFS_LOOKAHEAD_SIZE
+#define LFS_LOOKAHEAD_SIZE 16
+#endif
+
+const struct lfs_config cfg = {{
+    .context = &bd,
+    .read  = &lfs_emubd_read,
+    .prog  = &lfs_emubd_prog,
+    .erase = &lfs_emubd_erase,
+    .sync  = &lfs_emubd_sync,
+
+    .read_size      = LFS_READ_SIZE,
+    .prog_size      = LFS_PROG_SIZE,
+    .block_size     = LFS_BLOCK_SIZE,
+    .block_count    = LFS_BLOCK_COUNT,
+    .block_cycles   = LFS_BLOCK_CYCLES,
+    .cache_size     = LFS_CACHE_SIZE,
+    .lookahead_size = LFS_LOOKAHEAD_SIZE,
+}};
+
+
+// Entry point
+int main(void) {{
+    lfs_emubd_create(&cfg, "blocks");
+
+{tests}
+
+    lfs_emubd_destroy(&cfg);
+}}

scripts/test.py

@@ -0,0 +1,61 @@
+#!/usr/bin/env python2
+
+import re
+import sys
+import subprocess
+import os
+
+def generate(test):
+    with open("scripts/template.fmt") as file:
+        template = file.read()
+
+    lines = []
+    for line in re.split('(?<=(?:.;| [{}]))\n', test.read()):
+        match = re.match('(?: *\n)*( *)(.*)=>(.*);', line, re.DOTALL | re.MULTILINE)
+        if match:
+            tab, test, expect = match.groups()
+            lines.append(tab+'test = {test};'.format(test=test.strip()))
+            lines.append(tab+'test_assert("{name}", test, {expect});'.format(
+                    name = re.match('\w*', test.strip()).group(),
+                    expect = expect.strip()))
+        else:
+            lines.append(line)
+
+    # Create test file
+    with open('test.c', 'w') as file:
+        file.write(template.format(tests='\n'.join(lines)))
+
+    # Remove build artifacts to force rebuild
+    try:
+        os.remove('test.o')
+        os.remove('lfs')
+    except OSError:
+        pass
+
+def compile():
+    subprocess.check_call([
+            os.environ.get('MAKE', 'make'),
+            '--no-print-directory', '-s'])
+
+def execute():
+    if 'EXEC' in os.environ:
+        subprocess.check_call([os.environ['EXEC'], "./lfs"])
+    else:
+        subprocess.check_call(["./lfs"])
+
+def main(test=None):
+    if test and not test.startswith('-'):
+        with open(test) as file:
+            generate(file)
+    else:
+        generate(sys.stdin)
+
+    compile()
+
+    if test == '-s':
+        sys.exit(1)
+
+    execute()
+
+if __name__ == "__main__":
+    main(*sys.argv[1:])