Annotation For xvfs.c.rvt

Origin for each line in xvfs.c.rvt from check-in 3c48891a32:

1ecab39ce5 2019-05-02        rkeene: #include <xvfs-core.h>
9d3052c6f1 2019-05-08        rkeene: #include <sys/stat.h>
303b2de493 2019-05-02        rkeene: #include <unistd.h>
32b55a907b 2019-05-02        rkeene: #include <string.h>
303b2de493 2019-05-02        rkeene: #include <tcl.h>
32b55a907b 2019-05-02        rkeene: 
32b55a907b 2019-05-02        rkeene: #define XVFS_NAME_LOOKUP_ERROR (-1)
fb9dd5d783 2019-05-03        rkeene: #define XVFS_FILE_BLOCKSIZE 1024
9d3052c6f1 2019-05-08        rkeene: 
3a68a54e44 2019-09-17        rkeene: /*
3a68a54e44 2019-09-17        rkeene:  * XXX:TODO: Determine this automatically rather than
3a68a54e44 2019-09-17        rkeene:  *           by heuristics
3a68a54e44 2019-09-17        rkeene:  */
3a68a54e44 2019-09-17        rkeene: #define HAVE_STRUCT_STAT_ST_BLKSIZE 1
3a68a54e44 2019-09-17        rkeene: #define HAVE_STRUCT_STAT_ST_BLOCKS  1
3a68a54e44 2019-09-17        rkeene: #ifdef WIN32
3a68a54e44 2019-09-17        rkeene: #  undef HAVE_STRUCT_STAT_ST_BLKSIZE
3a68a54e44 2019-09-17        rkeene: #  undef HAVE_STRUCT_STAT_ST_BLOCKS
3a68a54e44 2019-09-17        rkeene: #endif
3a68a54e44 2019-09-17        rkeene: 
32b55a907b 2019-05-02        rkeene: #define MIN(a, b) (((a) < (b)) ? (a) : (b))
303b2de493 2019-05-02        rkeene: 
303b2de493 2019-05-02        rkeene: typedef enum {
303b2de493 2019-05-02        rkeene: 	XVFS_FILE_TYPE_REG,
303b2de493 2019-05-02        rkeene: 	XVFS_FILE_TYPE_DIR
303b2de493 2019-05-02        rkeene: } xvfs_file_type_t;
303b2de493 2019-05-02        rkeene: 
303b2de493 2019-05-02        rkeene: typedef Tcl_WideInt xvfs_size_t;
303b2de493 2019-05-02        rkeene: 
303b2de493 2019-05-02        rkeene: struct xvfs_file_data {
303b2de493 2019-05-02        rkeene: 	const char          *name;
303b2de493 2019-05-02        rkeene: 	xvfs_file_type_t    type;
303b2de493 2019-05-02        rkeene: 	xvfs_size_t         size;
32b55a907b 2019-05-02        rkeene: 	union {
32b55a907b 2019-05-02        rkeene: 		const unsigned char *fileContents;
32b55a907b 2019-05-02        rkeene: 		const char          **dirChildren;
32b55a907b 2019-05-02        rkeene: 	} data;
303b2de493 2019-05-02        rkeene: };
47dcf5fc27 2019-05-01        rkeene: 
47dcf5fc27 2019-05-01        rkeene: <?
47dcf5fc27 2019-05-01        rkeene: 	package require xvfs
c1c3fa70b5 2019-09-17        rkeene: 
c1c3fa70b5 2019-09-17        rkeene: 	set ::xvfs::hashNameThreshold 3
c1c3fa70b5 2019-09-17        rkeene: 	if {[info exists ::env(XVFS_CREATE_HASH_NAME_THRESHOLD)]} {
c1c3fa70b5 2019-09-17        rkeene: 		set ::xvfs::hashNameThreshold $::env(XVFS_CREATE_HASH_NAME_THRESHOLD)
3c48891a32 2019-09-17        rkeene: 	}
3c48891a32 2019-09-17        rkeene: 	if {$::xvfs::hashNameThreshold < 0} {
3c48891a32 2019-09-17        rkeene: 		set ::xvfs::hashNameThreshold [expr {2**31}]
c1c3fa70b5 2019-09-17        rkeene: 	}
69e476dcd5 2019-05-02        rkeene: 	xvfs::main $argv
c1c3fa70b5 2019-09-17        rkeene: 
c1c3fa70b5 2019-09-17        rkeene: 	proc emitFilenameVerification {indentLevel outputFileNameLen outputFileIndexes} {
c1c3fa70b5 2019-09-17        rkeene: 		set indent [string repeat "\t" $indentLevel]
c1c3fa70b5 2019-09-17        rkeene: 		foreach outputFileIndex $outputFileIndexes {
c1c3fa70b5 2019-09-17        rkeene: ?><?= $indent ?>if (memcmp(path, xvfs_<?= $::xvfs::fsName ?>_data[<?= $outputFileIndex ?>].name, <?= $outputFileNameLen ?>) == 0) {
c1c3fa70b5 2019-09-17        rkeene: <?= $indent ?>	return(<?= $outputFileIndex ?>);
c1c3fa70b5 2019-09-17        rkeene: <?= $indent ?>}
c1c3fa70b5 2019-09-17        rkeene: <?
c1c3fa70b5 2019-09-17        rkeene: 		}
c1c3fa70b5 2019-09-17        rkeene: 	}
69e476dcd5 2019-05-02        rkeene: ?>
32b55a907b 2019-05-02        rkeene: static long xvfs_<?= $::xvfs::fsName ?>_nameToIndex(const char *path) {
c1c3fa70b5 2019-09-17        rkeene: <?
c1c3fa70b5 2019-09-17        rkeene: 	for {set index 0} {$index < [llength $::xvfs::outputFiles]} {incr index} {
c1c3fa70b5 2019-09-17        rkeene: 		set outputFileName [lindex $::xvfs::outputFiles $index]
c1c3fa70b5 2019-09-17        rkeene: 		set outputFileNameLen [string length $outputFileName]
c1c3fa70b5 2019-09-17        rkeene: 		set outputFileNameHash [zlib adler32 $outputFileName 0]
c1c3fa70b5 2019-09-17        rkeene: 		lappend outputFileNameHashToIndex([list $outputFileNameLen $outputFileNameHash]) $index
c1c3fa70b5 2019-09-17        rkeene: 		lappend outputFileNameLenToIndex($outputFileNameLen) $index
c1c3fa70b5 2019-09-17        rkeene: 	}
c1c3fa70b5 2019-09-17        rkeene: 
c1c3fa70b5 2019-09-17        rkeene: 	set needZlib false
c1c3fa70b5 2019-09-17        rkeene: 	foreach {outputFileNameLen outputFileIndexes} [lsort -stride 2 -dictionary [array get outputFileNameLenToIndex]] {
c1c3fa70b5 2019-09-17        rkeene: 		if {[llength $outputFileIndexes] > $::xvfs::hashNameThreshold} {
c1c3fa70b5 2019-09-17        rkeene: 			set needZlib true
c1c3fa70b5 2019-09-17        rkeene: 			break;
c1c3fa70b5 2019-09-17        rkeene: 		}
c1c3fa70b5 2019-09-17        rkeene: 	}
c1c3fa70b5 2019-09-17        rkeene: ?><?
c1c3fa70b5 2019-09-17        rkeene: 	if {$needZlib} {
c1c3fa70b5 2019-09-17        rkeene: ?>	unsigned int pathHash;
c1c3fa70b5 2019-09-17        rkeene: <?	} ?>	size_t pathLen;
fb9dd5d783 2019-05-03        rkeene: 	
32b55a907b 2019-05-02        rkeene: 	if (path == NULL) {
32b55a907b 2019-05-02        rkeene: 		return(XVFS_NAME_LOOKUP_ERROR);
32b55a907b 2019-05-02        rkeene: 	}
73cbe7370b 2019-05-03        rkeene: 
38bed7cee0 2019-09-13        rkeene: 	pathLen = strlen(path);
c1c3fa70b5 2019-09-17        rkeene: 	switch (pathLen) {
c1c3fa70b5 2019-09-17        rkeene: <?
c1c3fa70b5 2019-09-17        rkeene: 
c1c3fa70b5 2019-09-17        rkeene: 	foreach {outputFileNameLen outputFileIndexes} [lsort -stride 2 -dictionary [array get outputFileNameLenToIndex]] {
c1c3fa70b5 2019-09-17        rkeene: ?>		case <?= $outputFileNameLen ?>:
c1c3fa70b5 2019-09-17        rkeene: <?
c1c3fa70b5 2019-09-17        rkeene: 			if {[llength $outputFileIndexes] > $::xvfs::hashNameThreshold} {
c1c3fa70b5 2019-09-17        rkeene: ?>			pathHash = Tcl_ZlibAdler32(0, (const unsigned char *) path, <?= $outputFileNameLen ?>);
c1c3fa70b5 2019-09-17        rkeene: 			switch (pathHash) {
c1c3fa70b5 2019-09-17        rkeene: <?
c1c3fa70b5 2019-09-17        rkeene: 				foreach {key outputFileIndexes} [lsort -stride 2 -dictionary [array get outputFileNameHashToIndex [list $outputFileNameLen *]]] {
c1c3fa70b5 2019-09-17        rkeene: 					set outputFileNameHash [lindex $key 1]
c1c3fa70b5 2019-09-17        rkeene: ?>				case <?= $outputFileNameHash ?>:
c1c3fa70b5 2019-09-17        rkeene: <?
c1c3fa70b5 2019-09-17        rkeene: 					emitFilenameVerification 5 $outputFileNameLen $outputFileIndexes
c1c3fa70b5 2019-09-17        rkeene: ?>					break;	
c1c3fa70b5 2019-09-17        rkeene: <?
c1c3fa70b5 2019-09-17        rkeene: 				}
c1c3fa70b5 2019-09-17        rkeene: ?>			}
c1c3fa70b5 2019-09-17        rkeene: <?
c1c3fa70b5 2019-09-17        rkeene: 			} else {
c1c3fa70b5 2019-09-17        rkeene: 				emitFilenameVerification 3 $outputFileNameLen $outputFileIndexes
fb9dd5d783 2019-05-03        rkeene: 			}
fb9dd5d783 2019-05-03        rkeene: ?>			break;
c1c3fa70b5 2019-09-17        rkeene: <?	} ?>	}
fb9dd5d783 2019-05-03        rkeene: 	
32b55a907b 2019-05-02        rkeene: 	return(XVFS_NAME_LOOKUP_ERROR);
32b55a907b 2019-05-02        rkeene: }
32b55a907b 2019-05-02        rkeene: 
32b55a907b 2019-05-02        rkeene: static const char **xvfs_<?= $::xvfs::fsName ?>_getChildren(const char *path, Tcl_WideInt *count) {
32b55a907b 2019-05-02        rkeene: 	struct xvfs_file_data *fileInfo;
32b55a907b 2019-05-02        rkeene: 	long inode;
32b55a907b 2019-05-02        rkeene: 
32b55a907b 2019-05-02        rkeene: 	/*
32b55a907b 2019-05-02        rkeene: 	 * Validate input parameters
32b55a907b 2019-05-02        rkeene: 	 */
32b55a907b 2019-05-02        rkeene: 	if (count == NULL) {
32b55a907b 2019-05-02        rkeene: 		return(NULL);
32b55a907b 2019-05-02        rkeene: 	}
32b55a907b 2019-05-02        rkeene: 	
32b55a907b 2019-05-02        rkeene: 	/*
32b55a907b 2019-05-02        rkeene: 	 * Get the inode from the lookup function
32b55a907b 2019-05-02        rkeene: 	 */
32b55a907b 2019-05-02        rkeene: 	inode = xvfs_<?= $::xvfs::fsName ?>_nameToIndex(path);
32b55a907b 2019-05-02        rkeene: 	if (inode == XVFS_NAME_LOOKUP_ERROR) {
149aa89b7d 2019-09-13        rkeene: 		*count = XVFS_RV_ERR_ENOENT;
32b55a907b 2019-05-02        rkeene: 		return(NULL);
32b55a907b 2019-05-02        rkeene: 	}
32b55a907b 2019-05-02        rkeene: 	
32b55a907b 2019-05-02        rkeene: 	fileInfo = &xvfs_<?= $::xvfs::fsName ?>_data[inode];
32b55a907b 2019-05-02        rkeene: 
32b55a907b 2019-05-02        rkeene: 	/*
32b55a907b 2019-05-02        rkeene: 	 * Ensure this is a directory
32b55a907b 2019-05-02        rkeene: 	 */
32b55a907b 2019-05-02        rkeene: 	if (fileInfo->type != XVFS_FILE_TYPE_DIR) {
149aa89b7d 2019-09-13        rkeene: 		*count = XVFS_RV_ERR_ENOTDIR;
32b55a907b 2019-05-02        rkeene: 		return(NULL);
32b55a907b 2019-05-02        rkeene: 	}
32b55a907b 2019-05-02        rkeene: 	
32b55a907b 2019-05-02        rkeene: 	*count = fileInfo->size;
32b55a907b 2019-05-02        rkeene: 	return(fileInfo->data.dirChildren);
32b55a907b 2019-05-02        rkeene: }
32b55a907b 2019-05-02        rkeene: 
32b55a907b 2019-05-02        rkeene: static const unsigned char *xvfs_<?= $::xvfs::fsName ?>_getData(const char *path, Tcl_WideInt start, Tcl_WideInt *length) {
32b55a907b 2019-05-02        rkeene: 	struct xvfs_file_data *fileInfo;
32b55a907b 2019-05-02        rkeene: 	Tcl_WideInt resultLength;
32b55a907b 2019-05-02        rkeene: 	long inode;
32b55a907b 2019-05-02        rkeene: 
32b55a907b 2019-05-02        rkeene: 	/*
32b55a907b 2019-05-02        rkeene: 	 * Validate input parameters
32b55a907b 2019-05-02        rkeene: 	 */
149aa89b7d 2019-09-13        rkeene: 	if (length == NULL) {
32b55a907b 2019-05-02        rkeene: 		return(NULL);
32b55a907b 2019-05-02        rkeene: 	}
32b55a907b 2019-05-02        rkeene: 	
149aa89b7d 2019-09-13        rkeene: 	if (start < 0) {
149aa89b7d 2019-09-13        rkeene: 		*length = XVFS_RV_ERR_EINVAL;
32b55a907b 2019-05-02        rkeene: 		return(NULL);
32b55a907b 2019-05-02        rkeene: 	}
32b55a907b 2019-05-02        rkeene: 	
32b55a907b 2019-05-02        rkeene: 	if (*length < 0) {
149aa89b7d 2019-09-13        rkeene: 		*length = XVFS_RV_ERR_EINVAL;
32b55a907b 2019-05-02        rkeene: 		return(NULL);
32b55a907b 2019-05-02        rkeene: 	}
32b55a907b 2019-05-02        rkeene: 	
32b55a907b 2019-05-02        rkeene: 	/*
32b55a907b 2019-05-02        rkeene: 	 * Get the inode from the lookup function
32b55a907b 2019-05-02        rkeene: 	 */
32b55a907b 2019-05-02        rkeene: 	inode = xvfs_<?= $::xvfs::fsName ?>_nameToIndex(path);
32b55a907b 2019-05-02        rkeene: 	if (inode == XVFS_NAME_LOOKUP_ERROR) {
149aa89b7d 2019-09-13        rkeene: 		*length = XVFS_RV_ERR_ENOENT;
32b55a907b 2019-05-02        rkeene: 		return(NULL);
32b55a907b 2019-05-02        rkeene: 	}
32b55a907b 2019-05-02        rkeene: 	
32b55a907b 2019-05-02        rkeene: 	fileInfo = &xvfs_<?= $::xvfs::fsName ?>_data[inode];
32b55a907b 2019-05-02        rkeene: 
32b55a907b 2019-05-02        rkeene: 	/*
32b55a907b 2019-05-02        rkeene: 	 * Ensure this is a file that can be read
32b55a907b 2019-05-02        rkeene: 	 */
32b55a907b 2019-05-02        rkeene: 	if (fileInfo->type != XVFS_FILE_TYPE_REG) {
149aa89b7d 2019-09-13        rkeene: 		*length = XVFS_RV_ERR_EISDIR;
32b55a907b 2019-05-02        rkeene: 		return(NULL);
32b55a907b 2019-05-02        rkeene: 	}
32b55a907b 2019-05-02        rkeene: 
32b55a907b 2019-05-02        rkeene: 	/*
32b55a907b 2019-05-02        rkeene: 	 * Validate the length
32b55a907b 2019-05-02        rkeene: 	 */
32b55a907b 2019-05-02        rkeene: 	if (start > fileInfo->size) {
149aa89b7d 2019-09-13        rkeene: 		*length = XVFS_RV_ERR_EFAULT;
32b55a907b 2019-05-02        rkeene: 		return(NULL);
32b55a907b 2019-05-02        rkeene: 	}
32b55a907b 2019-05-02        rkeene: 
32b55a907b 2019-05-02        rkeene: 	if (*length == 0) {
32b55a907b 2019-05-02        rkeene: 		resultLength = fileInfo->size - start;
32b55a907b 2019-05-02        rkeene: 	} else {
32b55a907b 2019-05-02        rkeene: 		resultLength = MIN(fileInfo->size - start, *length);
32b55a907b 2019-05-02        rkeene: 	}
32b55a907b 2019-05-02        rkeene: 	*length = resultLength;
48adf54b98 2019-09-13        rkeene: 
32b55a907b 2019-05-02        rkeene: 	/*
32b55a907b 2019-05-02        rkeene: 	 * Return the data
32b55a907b 2019-05-02        rkeene: 	 */
32b55a907b 2019-05-02        rkeene: 	return(fileInfo->data.fileContents + start);
32b55a907b 2019-05-02        rkeene: }
32b55a907b 2019-05-02        rkeene: 
daf25f5222 2019-05-03        rkeene: static int xvfs_<?= $::xvfs::fsName ?>_getStat(const char *path, Tcl_StatBuf *statBuf) {
d121970301 2019-05-02        rkeene: 	struct xvfs_file_data *fileInfo;
d121970301 2019-05-02        rkeene: 	long inode;
d121970301 2019-05-02        rkeene: 
d121970301 2019-05-02        rkeene: 	/*
d121970301 2019-05-02        rkeene: 	 * Validate input parameters
d121970301 2019-05-02        rkeene: 	 */
d121970301 2019-05-02        rkeene: 	if (!statBuf) {
149aa89b7d 2019-09-13        rkeene: 		return(XVFS_RV_ERR_EINVAL);
d121970301 2019-05-02        rkeene: 	}
d121970301 2019-05-02        rkeene: 	
d121970301 2019-05-02        rkeene: 	/*
d121970301 2019-05-02        rkeene: 	 * Get the inode from the lookup function
d121970301 2019-05-02        rkeene: 	 */
d121970301 2019-05-02        rkeene: 	inode = xvfs_<?= $::xvfs::fsName ?>_nameToIndex(path);
d121970301 2019-05-02        rkeene: 	if (inode == XVFS_NAME_LOOKUP_ERROR) {
149aa89b7d 2019-09-13        rkeene: 		return(XVFS_RV_ERR_ENOENT);
d121970301 2019-05-02        rkeene: 	}
d121970301 2019-05-02        rkeene: 	
d121970301 2019-05-02        rkeene: 	fileInfo = &xvfs_<?= $::xvfs::fsName ?>_data[inode];
d121970301 2019-05-02        rkeene: 	
f7a81bb10b 2019-09-17        rkeene: 	statBuf->st_dev   = <?= [zlib adler32 $::xvfs::fsName] ?>;
f7a81bb10b 2019-09-17        rkeene: 	statBuf->st_rdev  = <?= [zlib adler32 $::xvfs::fsName] ?>;
d121970301 2019-05-02        rkeene: 	statBuf->st_ino   = inode;
f7a81bb10b 2019-09-17        rkeene: 	statBuf->st_uid   = 0;
f7a81bb10b 2019-09-17        rkeene: 	statBuf->st_gid   = 0;
d121970301 2019-05-02        rkeene: 	statBuf->st_atime = 0;
d121970301 2019-05-02        rkeene: 	statBuf->st_ctime = 0;
d121970301 2019-05-02        rkeene: 	statBuf->st_mtime = 0;
3a68a54e44 2019-09-17        rkeene: #ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
fb9dd5d783 2019-05-03        rkeene: 	statBuf->st_blksize = XVFS_FILE_BLOCKSIZE;
3a68a54e44 2019-09-17        rkeene: #endif
d121970301 2019-05-02        rkeene: 	
d121970301 2019-05-02        rkeene: 	if (fileInfo->type == XVFS_FILE_TYPE_REG) {
6b8ea28911 2019-09-16        rkeene: 		statBuf->st_mode   = 0100444;
d121970301 2019-05-02        rkeene: 		statBuf->st_nlink  = 1;
d121970301 2019-05-02        rkeene: 		statBuf->st_size   = fileInfo->size;
3a68a54e44 2019-09-17        rkeene: #ifdef HAVE_STRUCT_STAT_ST_BLOCKS
d121970301 2019-05-02        rkeene: 		statBuf->st_blocks = (fileInfo->size + statBuf->st_blksize - 1) / statBuf->st_blksize;
3a68a54e44 2019-09-17        rkeene: #endif
d121970301 2019-05-02        rkeene: 	} else if (fileInfo->type == XVFS_FILE_TYPE_DIR) {
6b8ea28911 2019-09-16        rkeene: 		statBuf->st_mode   = 040555;
d121970301 2019-05-02        rkeene: 		statBuf->st_nlink  = fileInfo->size;
d121970301 2019-05-02        rkeene: 		statBuf->st_size   = fileInfo->size;
3a68a54e44 2019-09-17        rkeene: #ifdef HAVE_STRUCT_STAT_ST_BLOCKS
d121970301 2019-05-02        rkeene: 		statBuf->st_blocks = 1;
3a68a54e44 2019-09-17        rkeene: #endif
d121970301 2019-05-02        rkeene: 	}
d121970301 2019-05-02        rkeene: 	
d121970301 2019-05-02        rkeene: 	return(0);
d121970301 2019-05-02        rkeene: }
d121970301 2019-05-02        rkeene: 
d121970301 2019-05-02        rkeene: static struct Xvfs_FSInfo xvfs_<?= $::xvfs::fsName ?>_fsInfo = {
d121970301 2019-05-02        rkeene: 	.protocolVersion = XVFS_PROTOCOL_VERSION,
d121970301 2019-05-02        rkeene: 	.name            = "<?= $::xvfs::fsName ?>",
d121970301 2019-05-02        rkeene: 	.getChildrenProc = xvfs_<?= $::xvfs::fsName ?>_getChildren,
d121970301 2019-05-02        rkeene: 	.getDataProc     = xvfs_<?= $::xvfs::fsName ?>_getData,
daf25f5222 2019-05-03        rkeene: 	.getStatProc     = xvfs_<?= $::xvfs::fsName ?>_getStat
d121970301 2019-05-02        rkeene: };
d121970301 2019-05-02        rkeene: 
69e476dcd5 2019-05-02        rkeene: int Xvfs_<?= $::xvfs::fsName ?>_Init(Tcl_Interp *interp) {
69e476dcd5 2019-05-02        rkeene: 	int register_ret;
e5b6962adf 2019-05-02        rkeene: 
e5b6962adf 2019-05-02        rkeene: #ifdef USE_TCL_STUBS
e5b6962adf 2019-05-02        rkeene: 	const char *tclInitStubs_ret;
e5b6962adf 2019-05-02        rkeene: 	/* Initialize Stubs */
e5b6962adf 2019-05-02        rkeene: 	tclInitStubs_ret = Tcl_InitStubs(interp, TCL_PATCH_LEVEL, 0);
e5b6962adf 2019-05-02        rkeene: 	if (!tclInitStubs_ret) {
e5b6962adf 2019-05-02        rkeene: 		return(TCL_ERROR);
e5b6962adf 2019-05-02        rkeene: 	}
e5b6962adf 2019-05-02        rkeene: #endif
69e476dcd5 2019-05-02        rkeene: 	
d121970301 2019-05-02        rkeene: 	register_ret = Xvfs_Register(interp, &xvfs_<?= $::xvfs::fsName ?>_fsInfo);
f74a2e47ab 2019-05-02        rkeene: 	if (register_ret != TCL_OK) {
f74a2e47ab 2019-05-02        rkeene: 		return(register_ret);
f74a2e47ab 2019-05-02        rkeene: 	}
f74a2e47ab 2019-05-02        rkeene: 	
f74a2e47ab 2019-05-02        rkeene: 	return(TCL_OK);
f74a2e47ab 2019-05-02        rkeene: }
5f2895faba 2019-09-17        rkeene: #undef XVFS_NAME_LOOKUP_ERROR
5f2895faba 2019-09-17        rkeene: #undef XVFS_FILE_BLOCKSIZE