path: root/firmware/target/hosted/filesystem-win32.h
diff options
authorMichael Sevakis <>2013-08-05 22:02:45 -0400
committerMichael Sevakis <>2014-08-30 03:48:23 +0200
commit7d1a47cf13726c95ac46027156cc12dd9da5b855 (patch)
treeeb20d07656806479a8e1fea25887a490ea30d1d8 /firmware/target/hosted/filesystem-win32.h
parent95a4c3afcd53a1f8b835dec33de51f9c304de4d9 (diff)
Rewrite filesystem code (WIP)
This patch redoes the filesystem code from the FAT driver up to the clipboard code in onplay.c. Not every aspect of this is finished therefore it is still "WIP". I don't wish to do too much at once (haha!). What is left to do is get dircache back in the sim and find an implementation for the dircache indicies in the tagcache and playlist code or do something else that has the same benefit. Leaving these out for now does not make anything unusable. All the basics are done. Phone app code should probably get vetted (and app path handling just plain rewritten as environment expansions); the SDL app and Android run well. Main things addressed: 1) Thread safety: There is none right now in the trunk code. Most of what currently works is luck when multiple threads are involved or multiple descriptors to the same file are open. 2) POSIX compliance: Many of the functions behave nothing like their counterparts on a host system. This leads to inconsistent code or very different behavior from native to hosted. One huge offender was rename(). Going point by point would fill a book. 3) Actual running RAM usage: Many targets will use less RAM and less stack space (some more RAM because I upped the number of cache buffers for large memory). There's very little memory lying fallow in rarely-used areas (see 'Key core changes' below). Also, all targets may open the same number of directory streams whereas before those with less than 8MB RAM were limited to 8, not 12 implying those targets will save slightly less. 4) Performance: The test_disk plugin shows markedly improved performance, particularly in the area of (uncached) directory scanning, due partly to more optimal directory reading and to a better sector cache algorithm. Uncached times tend to be better while there is a bit of a slowdown in dircache due to it being a bit heavier of an implementation. It's not noticeable by a human as far as I can say. Key core changes: 1) Files and directories share core code and data structures. 2) The filesystem code knows which descriptors refer to same file. This ensures that changes from one stream are appropriately reflected in every open descriptor for that file (fileobj_mgr.c). 3) File and directory cache buffers are borrowed from the main sector cache. This means that when they are not in use by a file, they are not wasted, but used for the cache. Most of the time, only a few of them are needed. It also means that adding more file and directory handles is less expensive. All one must do in ensure a large enough cache to borrow from. 4) Relative path components are supported and the namespace is unified. It does not support full relative paths to an implied current directory; what is does support is use of "." and "..". Adding the former would not be very difficult. The namespace is unified in the sense that volumes may be specified several times along with relative parts, e.g.: "/<0>/foo/../../<1>/bar" :<=> "/<1>/bar". 5) Stack usage is down due to sharing of data, static allocation and less duplication of strings on the stack. This requires more serialization than I would like but since the number of threads is limited to a low number, the tradoff in favor of the stack seems reasonable. 6) Separates and heirarchicalizes (sic) the SIM and APP filesystem code. SIM path and volume handling is just like the target. Some aspects of the APP file code get more straightforward (e.g. no path hashing is needed). Dircache: Deserves its own section. Dircache is new but pays homage to the old. The old one was not compatible and so it, since it got redone, does all the stuff it always should have done such as: 1) It may be update and used at any time during the build process. No longer has one to wait for it to finish building to do basic file management (create, remove, rename, etc.). 2) It does not need to be either fully scanned or completely disabled; it can be incomplete (i.e. overfilled, missing paths), still be of benefit and be correct. 3) Handles mounting and dismounting of individual volumes which means a full rebuild is not needed just because you pop a new SD card in the slot. Now, because it reuses its freed entry data, may rebuild only that volume. 4) Much more fundamental to the file code. When it is built, it is the keeper of the master file list whether enabled or not ("disabled" is just a state of the cache). Its must always to ready to be started and bind all streams opened prior to being enabled. 5) Maintains any short filenames in OEM format which means that it does not need to be rebuilt when changing the default codepage. Miscellaneous Compatibility: 1) Update any other code that would otherwise not work such as the hotswap mounting code in various card drivers. 2) File management: Clipboard needed updating because of the behavioral changes. Still needs a little more work on some finer points. 3) Remove now-obsolete functionality such as the mutex's "no preempt" flag (which was only for the prior FAT driver). 4) struct dirinfo uses time_t rather than raw FAT directory entry time fields. I plan to follow up on genericizing everything there (i.e. no FAT attributes). 5) unicode.c needed some redoing so that the file code does not try try to load codepages during a scan, which is actually a problem with the current code. The default codepage, if any is required, is now kept in RAM separarately (bufalloced) from codepages specified to iso_decode() (which must not be bufalloced because the conversion may be done by playback threads). Brings with it some additional reusable core code: 1) Revised file functions: Reusable code that does things such as safe path concatenation and parsing without buffer limitations or data duplication. Variants that copy or alter the input path may be based off these. To do: 1) Put dircache functionality back in the sim. Treating it internally as a different kind of file system seems the best approach at this time. 2) Restore use of dircache indexes in the playlist and database or something effectively the same. Since the cache doesn't have to be complete in order to be used, not getting a hit on the cache doesn't unambiguously say if the path exists or not. Change-Id: Ia30f3082a136253e3a0eae0784e3091d138915c8 Reviewed-on: Reviewed-by: Michael Sevakis <> Tested: Michael Sevakis <>
Diffstat (limited to 'firmware/target/hosted/filesystem-win32.h')
1 files changed, 111 insertions, 0 deletions
diff --git a/firmware/target/hosted/filesystem-win32.h b/firmware/target/hosted/filesystem-win32.h
new file mode 100644
index 0000000000..1d8f2749f9
--- /dev/null
+++ b/firmware/target/hosted/filesystem-win32.h
@@ -0,0 +1,111 @@
+ * __________ __ ___.
+ * Open \______ \ ____ ____ | | _\_ |__ _______ ___
+ * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
+ * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
+ * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
+ * \/ \/ \/ \/ \/
+ * $Id$
+ *
+ * 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
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
+ * KIND, either express or implied.
+ *
+ ****************************************************************************/
+#ifndef _FILESYSTEM_WIN32_H_
+#define _FILESYSTEM_WIN32_H_
+#ifdef __MINGW32__
+/* filesystem-win32.c contains some string functions that could be useful
+ * elsewhere; just move them away to unicode.c or something if they prove
+ * so. */
+size_t strlcpy_ucs2utf8(char *buffer, const unsigned short *ucs,
+ size_t bufsize);
+#define strlcpy_from_os strlcpy_ucs2utf8
+#endif /* __MINGW32__ */
+#endif /* _FILESYSTEM_WIN32_H_ */
+#ifdef __MINGW32__
+#ifdef _FILE_H_
+#include <unistd.h>
+#include <sys/stat.h>
+#define OS_STAT_T struct _stat
+/* Wrap for off_t <=> long conversions */
+static inline off_t os_filesize_(int osfd)
+ { return _filelength(osfd); }
+static inline int os_ftruncate_(int osfd, off_t length)
+ { return _chsize(osfd, length); }
+#define os_filesize os_filesize_
+#define os_ftruncate os_ftruncate_
+#define os_fsync _commit
+#define os_fstat _fstat
+#define os_close close
+#define os_lseek lseek
+#ifndef os_read
+#define os_read read
+#ifndef os_write
+#define os_write write
+/* These need string type conversion from utf8 to ucs2; that's done inside */
+int os_open(const char *ospath, int oflag, ...);
+int os_creat(const char *ospath, mode_t mode);
+int os_stat(const char *ospath, struct _stat *s);
+int os_remove(const char *ospath);
+int os_rename(const char *osold, const char *osnew);
+#endif /* _FILESYSTEM_WIN32__FILE_H_ */
+#endif /* _FILE_H_ */
+#ifdef _DIR_H_
+#ifndef _FILESYSTEM_WIN32__DIR_H_
+#define _FILESYSTEM_WIN32__DIR_H_
+#include <dirent.h>
+#define OS_DIRENT_CONVERT /* needs string conversion */
+#define OS_DIR_T _WDIR
+#define OS_DIRENT_T struct _wdirent
+_WDIR * os_opendir(const char *osdirname);
+int os_opendirfd(const char *osdirname);
+#define os_readdir _wreaddir
+#define os_closedir _wclosedir
+int os_mkdir(const char *ospath, mode_t mode);
+int os_rmdir(const char *ospath);
+#endif /* _FILESYSTEM_WIN32__DIR_H_ */
+#endif /* _DIR_H_ */
+#else /* !__MINGW32__ */
+#include "filesystem-unix.h"
+#endif /* __MINGW32__ */