1 files changed, 140 insertions, 69 deletions

diff --git a/firmware/include/dircache.h b/firmware/include/dircache.h
index 019ccf49b7..7e8c764e7f 100644
--- a/firmware/include/dircache.h
+++ b/firmware/include/dircache.h
@@ -8,6 +8,7 @@
  * $Id$
  *
  * Copyright (C) 2005 by Miika Pekkarinen
+ * Copyright (C) 2014 by Michael Sevakis
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -21,84 +22,154 @@
 #ifndef _DIRCACHE_H
 #define _DIRCACHE_H
 
-#include "config.h"
-#include "dir_uncached.h"
-#include <string.h> /* size_t */
+#include "mv.h"
+#include <string.h>    /* size_t */
+#include <sys/types.h> /* ssize_t */
 
 #ifdef HAVE_DIRCACHE
 
-#define DIRCACHE_RESERVE  (1024*64)
-#define DIRCACHE_LIMIT    (1024*1024*6)
-
-#define DIRCACHE_APPFLAG_TAGCACHE  0x0001
-#define DIRCACHE_APPFLAG_PLAYLIST  0x0002
-
-/* Internal structures. */
-struct travel_data {
-    struct dircache_entry *first;
-    struct dircache_entry *ce;
-    struct dircache_entry *down_entry;
-#if (CONFIG_PLATFORM & PLATFORM_HOSTED)
-    DIR_UNCACHED *dir, *newdir;
-    struct dirent_uncached *entry;
-#else
-    struct fat_dir *dir;
-    struct fat_dir newdir;
-    struct fat_direntry entry;
+/****************************************************************************
+ ** Configurable values
+ **/
+
+#if 0
+/* enable dumping code */
+#define DIRCACHE_DUMPSTER
+#define DIRCACHE_DUMPSTER_BIN   "/dircache_dump.bin"
+#define DIRCACHE_DUMPSTER_CSV   "/dircache_dump.csv"
 #endif
-    int pathpos;
+
+/* dircache builds won't search below this but will work down to this point
+   while below it the cache will just pass requests through to the storage;
+   the limiting factor is the scanning thread stack size, not the
+   implementation -- tune the two together */
+#define DIRCACHE_MAX_DEPTH  15
+#define DIRCACHE_STACK_SIZE (DEFAULT_STACK_SIZE + 0x100)
+
+/* memory buffer constants that control allocation */
+#define DIRCACHE_RESERVE (1024*64)     /* 64 KB - new entry slack */
+#define DIRCACHE_MIN     (1024*1024*1) /* 1 MB - provision min size */
+#define DIRCACHE_LIMIT   (1024*1024*6) /* 6 MB - provision max size */
+
+/* make it easy to change serialnumber size without modifying anything else;
+   32 bits allows 21845 builds before wrapping in a 6MB cache that is filled
+   exclusively with entries and nothing else (32 byte entries), making that
+   figure pessimistic */
+typedef uint32_t dc_serial_t;
+
+/**
+ ****************************************************************************/
+
+#if CONFIG_PLATFORM & PLATFORM_NATIVE
+/* native dircache is lower-level than on a hosted target */
+#define DIRCACHE_NATIVE
+#endif
+
+struct dircache_file
+{
+    int         idx;        /* this file's cache index */
+    dc_serial_t serialnum;  /* this file's serial number */
 };
 
-struct dirent_cached {
-    struct dirinfo info;
-    char *d_name;
-    long startcluster;
+enum dircache_status
+{
+    DIRCACHE_IDLE     = 0,  /* no volume is initialized */
+    DIRCACHE_SCANNING = 1,  /* dircache is scanning a volume */
+    DIRCACHE_READY    = 2,  /* dircache is ready to be used */
+};
+
+/** Dircache control **/
+void dircache_wait(void);
+void dircache_suspend(void);
+int dircache_resume(void);
+int dircache_enable(void);
+void dircache_disable(void);
+void dircache_free_buffer(void);
+
+/** Volume mounting **/
+void dircache_mount(void); /* always tries building everything it can */
+void dircache_unmount(IF_MV_NONVOID(int volume));
+
+
+/** File API service functions **/
+
+/* avoid forcing #include of file_internal.h, fat.h and dir.h */
+struct filestr_base;
+struct file_base_info;
+struct file_base_binding;
+struct dirent;
+struct dirscan_info;
+struct dirinfo_native;
+
+int dircache_readdir_dirent(struct filestr_base *stream,
+                            struct dirscan_info *scanp,
+                            struct dirent *entry);
+void dircache_rewinddir_dirent(struct dirscan_info *scanp);
+
+#ifdef DIRCACHE_NATIVE
+struct fat_direntry;
+int dircache_readdir_internal(struct filestr_base *stream,
+                              struct file_base_info *infop,
+                              struct fat_direntry *fatent);
+void dircache_rewinddir_internal(struct file_base_info *info);
+#endif /* DIRCACHE_NATIVE */
+
+
+/** Dircache live updating **/
+
+void dircache_get_rootinfo(struct file_base_info *infop);
+void dircache_bind_file(struct file_base_binding *bindp);
+void dircache_unbind_file(struct file_base_binding *bindp);
+void dircache_fileop_create(struct file_base_info *dirinfop,
+                            struct file_base_binding *bindp,
+                            const char *basename,
+                            const struct dirinfo_native *dinp);
+void dircache_fileop_rename(struct file_base_info *dirinfop,
+                            struct file_base_binding *bindp,
+                            const char *basename);
+void dircache_fileop_remove(struct file_base_binding *bindp);
+void dircache_fileop_sync(struct file_base_binding *infop,
+                          const struct dirinfo_native *dinp);
+
+
+/** Dircache paths and files **/
+ssize_t dircache_get_path(const struct dircache_file *dcfilep, char *buf,
+                          size_t size);
+int dircache_get_file(const char *path, struct dircache_file *dcfilep);
+
+
+/** Debug screen/info stuff **/
+
+struct dircache_info
+{
+    enum dircache_status status; /* current composite status value */
+    const char   *statusdesc;    /* pointer to string describing 'status' */
+    size_t       last_size;      /* cache size after last build */
+    size_t       size;           /* total size of entries (with holes) */
+    size_t       sizeused;       /* bytes of 'size' actually utilized */
+    size_t       size_limit;     /* maximum possible size */
+    size_t       reserve;        /* size of reserve area */
+    size_t       reserve_used;   /* amount of reserve used */
+    unsigned int entry_count;    /* number of cache entries */
+    long         build_ticks;    /* total time used to build cache */
 };
 
-typedef struct {
-    bool busy;
-    struct dirent_cached theent; /* .attribute is set to -1 on init(opendir) */
-    int internal_entry;          /* the current entry in the directory */
-    DIR_UNCACHED *regulardir;
-} DIR_CACHED;
+void dircache_get_info(struct dircache_info *info);
+#ifdef DIRCACHE_DUMPSTER
+void dircache_dump(void);
+#endif /* DIRCACHE_DUMPSTER */
+
 
-void dircache_init(void) INIT_ATTR;
+/** Misc. stuff **/
+void dircache_dcfile_init(struct dircache_file *dcfilep);
+
+#ifdef HAVE_EEPROM_SETTINGS
 int dircache_load(void);
 int dircache_save(void);
-int dircache_build(int last_size);
-void* dircache_steal_buffer(size_t *size);
-bool dircache_is_enabled(void);
-bool dircache_is_initializing(void);
-void dircache_set_appflag(long mask);
-bool dircache_get_appflag(long mask);
-int dircache_get_entry_count(void);
-int dircache_get_cache_size(void);
-int dircache_get_reserve_used(void);
-int dircache_get_build_ticks(void);
-void dircache_disable(void);
-void dircache_suspend(void);
-bool dircache_resume(void);
-int dircache_get_entry_id(const char *filename);
-size_t dircache_copy_path(int index, char *buf, size_t size);
-
-/* the next two are internal for file.c */
-long _dircache_get_entry_startcluster(int id);
-struct dirinfo* _dircache_get_entry_dirinfo(int id);
-
-void dircache_bind(int fd, const char *path);
-void dircache_update_filesize(int fd, long newsize, long startcluster);
-void dircache_update_filetime(int fd);
-void dircache_mkdir(const char *path);
-void dircache_rmdir(const char *path);
-void dircache_remove(const char *name);
-void dircache_rename(const char *oldpath, const char *newpath);
-void dircache_add_file(const char *path, long startcluster);
-
-DIR_CACHED* opendir_cached(const char* name);
-struct dirent_cached* readdir_cached(DIR_CACHED* dir);
-int closedir_cached(DIR_CACHED *dir);
-int mkdir_cached(const char *name);
-int rmdir_cached(const char* name);
-#endif /* !HAVE_DIRCACHE */
+#endif /* HAVE_EEPROM_SETTINGS */
 
-#endif
+void dircache_init(size_t last_size) INIT_ATTR;
+
+#endif /* HAVE_DIRCACHE */
+
+#endif /* _DIRCACHE_H */