Annotation For xvfs.c.rvt

Origin for each line in xvfs.c.rvt from check-in 5f2895faba:

1ecab39ce5 2019-05-02    1: #include <xvfs-core.h>
9d3052c6f1 2019-05-08    2: #include <sys/stat.h>
303b2de493 2019-05-02    3: #include <unistd.h>
32b55a907b 2019-05-02    4: #include <string.h>
303b2de493 2019-05-02    5: #include <tcl.h>
32b55a907b 2019-05-02    6: 
32b55a907b 2019-05-02    7: #define XVFS_NAME_LOOKUP_ERROR (-1)
fb9dd5d783 2019-05-03    8: #define XVFS_FILE_BLOCKSIZE 1024
fb9dd5d783 2019-05-03    9: 
32b55a907b 2019-05-02   10: #define MIN(a, b) (((a) < (b)) ? (a) : (b))
303b2de493 2019-05-02   11: 
303b2de493 2019-05-02   12: typedef enum {
303b2de493 2019-05-02   13: 	XVFS_FILE_TYPE_REG,
303b2de493 2019-05-02   14: 	XVFS_FILE_TYPE_DIR
303b2de493 2019-05-02   15: } xvfs_file_type_t;
303b2de493 2019-05-02   16: 
303b2de493 2019-05-02   17: typedef Tcl_WideInt xvfs_size_t;
303b2de493 2019-05-02   18: 
303b2de493 2019-05-02   19: struct xvfs_file_data {
303b2de493 2019-05-02   20: 	const char          *name;
303b2de493 2019-05-02   21: 	xvfs_file_type_t    type;
303b2de493 2019-05-02   22: 	xvfs_size_t         size;
32b55a907b 2019-05-02   23: 	union {
32b55a907b 2019-05-02   24: 		const unsigned char *fileContents;
32b55a907b 2019-05-02   25: 		const char          **dirChildren;
32b55a907b 2019-05-02   26: 	} data;
303b2de493 2019-05-02   27: };
47dcf5fc27 2019-05-01   28: 
47dcf5fc27 2019-05-01   29: <?
47dcf5fc27 2019-05-01   30: 	package require xvfs
47dcf5fc27 2019-05-01   31: 	xvfs::main $argv
47dcf5fc27 2019-05-01   32: ?>
32b55a907b 2019-05-02   33: static long xvfs_<?= $::xvfs::fsName ?>_nameToIndex(const char *path) {
fb9dd5d783 2019-05-03   34: 	unsigned int pathHash;
73cbe7370b 2019-05-03   35: 	size_t pathLen;
fb9dd5d783 2019-05-03   36: 	
32b55a907b 2019-05-02   37: 	if (path == NULL) {
32b55a907b 2019-05-02   38: 		return(XVFS_NAME_LOOKUP_ERROR);
32b55a907b 2019-05-02   39: 	}
73cbe7370b 2019-05-03   40: 
73cbe7370b 2019-05-03   41: 	pathLen = strlen(path);
73cbe7370b 2019-05-03   42: 	pathHash = Tcl_ZlibAdler32(0, (const unsigned char *) path, pathLen);
fb9dd5d783 2019-05-03   43: 	switch (pathHash) {
fb9dd5d783 2019-05-03   44: <?
fb9dd5d783 2019-05-03   45: 	for {set index 0} {$index < [llength $::xvfs::outputFiles]} {incr index} {
32b55a907b 2019-05-02   46: 		set outputFile [lindex $::xvfs::outputFiles $index]
fb9dd5d783 2019-05-03   47: 		set outputFileHash [zlib adler32 $outputFile 0]
fb9dd5d783 2019-05-03   48: 		lappend outputFileHashToIndex($outputFileHash) $index
32b55a907b 2019-05-02   49: 	}
fb9dd5d783 2019-05-03   50: 	
fb9dd5d783 2019-05-03   51: 	foreach {outputFileHash outputFileIndexes} [lsort -stride 2 -dictionary [array get outputFileHashToIndex]] {
fb9dd5d783 2019-05-03   52: ?>		case <?= $outputFileHash ?>:
fb9dd5d783 2019-05-03   53: <?
fb9dd5d783 2019-05-03   54: 			foreach outputFileIndex $outputFileIndexes {
73cbe7370b 2019-05-03   55: 				set outputFileName [lindex $::xvfs::outputFiles $outputFileIndex]
73cbe7370b 2019-05-03   56: 				set outputFileNameLen [string length $outputFileName]
73cbe7370b 2019-05-03   57: ?>			if (pathLen == <?= $outputFileNameLen ?> && memcmp(path, xvfs_<?= $::xvfs::fsName ?>_data[<?= $outputFileIndex ?>].name, pathLen) == 0) {
fb9dd5d783 2019-05-03   58: 				return(<?= $outputFileIndex ?>);
fb9dd5d783 2019-05-03   59: 			}
fb9dd5d783 2019-05-03   60: <?
fb9dd5d783 2019-05-03   61: 			}
fb9dd5d783 2019-05-03   62: ?>			break;
32b55a907b 2019-05-02   63: <?	} ?>
fb9dd5d783 2019-05-03   64: 	}
fb9dd5d783 2019-05-03   65: 	
32b55a907b 2019-05-02   66: 	return(XVFS_NAME_LOOKUP_ERROR);
32b55a907b 2019-05-02   67: }
32b55a907b 2019-05-02   68: 
32b55a907b 2019-05-02   69: static const char **xvfs_<?= $::xvfs::fsName ?>_getChildren(const char *path, Tcl_WideInt *count) {
32b55a907b 2019-05-02   70: 	struct xvfs_file_data *fileInfo;
32b55a907b 2019-05-02   71: 	long inode;
32b55a907b 2019-05-02   72: 
32b55a907b 2019-05-02   73: 	/*
32b55a907b 2019-05-02   74: 	 * Validate input parameters
32b55a907b 2019-05-02   75: 	 */
32b55a907b 2019-05-02   76: 	if (count == NULL) {
32b55a907b 2019-05-02   77: 		return(NULL);
32b55a907b 2019-05-02   78: 	}
32b55a907b 2019-05-02   79: 	
32b55a907b 2019-05-02   80: 	/*
32b55a907b 2019-05-02   81: 	 * Get the inode from the lookup function
32b55a907b 2019-05-02   82: 	 */
32b55a907b 2019-05-02   83: 	inode = xvfs_<?= $::xvfs::fsName ?>_nameToIndex(path);
32b55a907b 2019-05-02   84: 	if (inode == XVFS_NAME_LOOKUP_ERROR) {
149aa89b7d 2019-09-13   85: 		*count = XVFS_RV_ERR_ENOENT;
32b55a907b 2019-05-02   86: 		return(NULL);
32b55a907b 2019-05-02   87: 	}
32b55a907b 2019-05-02   88: 	
32b55a907b 2019-05-02   89: 	fileInfo = &xvfs_<?= $::xvfs::fsName ?>_data[inode];
32b55a907b 2019-05-02   90: 
32b55a907b 2019-05-02   91: 	/*
32b55a907b 2019-05-02   92: 	 * Ensure this is a directory
32b55a907b 2019-05-02   93: 	 */
32b55a907b 2019-05-02   94: 	if (fileInfo->type != XVFS_FILE_TYPE_DIR) {
149aa89b7d 2019-09-13   95: 		*count = XVFS_RV_ERR_ENOTDIR;
32b55a907b 2019-05-02   96: 		return(NULL);
32b55a907b 2019-05-02   97: 	}
32b55a907b 2019-05-02   98: 	
32b55a907b 2019-05-02   99: 	*count = fileInfo->size;
32b55a907b 2019-05-02  100: 	return(fileInfo->data.dirChildren);
32b55a907b 2019-05-02  101: }
32b55a907b 2019-05-02  102: 
32b55a907b 2019-05-02  103: static const unsigned char *xvfs_<?= $::xvfs::fsName ?>_getData(const char *path, Tcl_WideInt start, Tcl_WideInt *length) {
32b55a907b 2019-05-02  104: 	struct xvfs_file_data *fileInfo;
32b55a907b 2019-05-02  105: 	Tcl_WideInt resultLength;
32b55a907b 2019-05-02  106: 	long inode;
32b55a907b 2019-05-02  107: 
32b55a907b 2019-05-02  108: 	/*
32b55a907b 2019-05-02  109: 	 * Validate input parameters
32b55a907b 2019-05-02  110: 	 */
149aa89b7d 2019-09-13  111: 	if (length == NULL) {
149aa89b7d 2019-09-13  112: 		return(NULL);
149aa89b7d 2019-09-13  113: 	}
149aa89b7d 2019-09-13  114: 	
32b55a907b 2019-05-02  115: 	if (start < 0) {
149aa89b7d 2019-09-13  116: 		*length = XVFS_RV_ERR_EINVAL;
32b55a907b 2019-05-02  117: 		return(NULL);
32b55a907b 2019-05-02  118: 	}
32b55a907b 2019-05-02  119: 	
32b55a907b 2019-05-02  120: 	if (*length < 0) {
149aa89b7d 2019-09-13  121: 		*length = XVFS_RV_ERR_EINVAL;
32b55a907b 2019-05-02  122: 		return(NULL);
32b55a907b 2019-05-02  123: 	}
32b55a907b 2019-05-02  124: 	
32b55a907b 2019-05-02  125: 	/*
32b55a907b 2019-05-02  126: 	 * Get the inode from the lookup function
32b55a907b 2019-05-02  127: 	 */
32b55a907b 2019-05-02  128: 	inode = xvfs_<?= $::xvfs::fsName ?>_nameToIndex(path);
32b55a907b 2019-05-02  129: 	if (inode == XVFS_NAME_LOOKUP_ERROR) {
149aa89b7d 2019-09-13  130: 		*length = XVFS_RV_ERR_ENOENT;
32b55a907b 2019-05-02  131: 		return(NULL);
32b55a907b 2019-05-02  132: 	}
32b55a907b 2019-05-02  133: 	
32b55a907b 2019-05-02  134: 	fileInfo = &xvfs_<?= $::xvfs::fsName ?>_data[inode];
32b55a907b 2019-05-02  135: 
32b55a907b 2019-05-02  136: 	/*
32b55a907b 2019-05-02  137: 	 * Ensure this is a file that can be read
32b55a907b 2019-05-02  138: 	 */
32b55a907b 2019-05-02  139: 	if (fileInfo->type != XVFS_FILE_TYPE_REG) {
149aa89b7d 2019-09-13  140: 		*length = XVFS_RV_ERR_EISDIR;
32b55a907b 2019-05-02  141: 		return(NULL);
32b55a907b 2019-05-02  142: 	}
32b55a907b 2019-05-02  143: 
32b55a907b 2019-05-02  144: 	/*
32b55a907b 2019-05-02  145: 	 * Validate the length
32b55a907b 2019-05-02  146: 	 */
32b55a907b 2019-05-02  147: 	if (start > fileInfo->size) {
149aa89b7d 2019-09-13  148: 		*length = XVFS_RV_ERR_EFAULT;
32b55a907b 2019-05-02  149: 		return(NULL);
32b55a907b 2019-05-02  150: 	}
32b55a907b 2019-05-02  151: 
32b55a907b 2019-05-02  152: 	if (*length == 0) {
32b55a907b 2019-05-02  153: 		resultLength = fileInfo->size - start;
32b55a907b 2019-05-02  154: 	} else {
32b55a907b 2019-05-02  155: 		resultLength = MIN(fileInfo->size - start, *length);
32b55a907b 2019-05-02  156: 	}
32b55a907b 2019-05-02  157: 	*length = resultLength;
48adf54b98 2019-09-13  158: 
32b55a907b 2019-05-02  159: 	/*
32b55a907b 2019-05-02  160: 	 * Return the data
32b55a907b 2019-05-02  161: 	 */
32b55a907b 2019-05-02  162: 	return(fileInfo->data.fileContents + start);
32b55a907b 2019-05-02  163: }
32b55a907b 2019-05-02  164: 
daf25f5222 2019-05-03  165: static int xvfs_<?= $::xvfs::fsName ?>_getStat(const char *path, Tcl_StatBuf *statBuf) {
d121970301 2019-05-02  166: 	struct xvfs_file_data *fileInfo;
d121970301 2019-05-02  167: 	long inode;
d121970301 2019-05-02  168: 
d121970301 2019-05-02  169: 	/*
d121970301 2019-05-02  170: 	 * Validate input parameters
d121970301 2019-05-02  171: 	 */
d121970301 2019-05-02  172: 	if (!statBuf) {
149aa89b7d 2019-09-13  173: 		return(XVFS_RV_ERR_EINVAL);
d121970301 2019-05-02  174: 	}
d121970301 2019-05-02  175: 	
d121970301 2019-05-02  176: 	/*
d121970301 2019-05-02  177: 	 * Get the inode from the lookup function
d121970301 2019-05-02  178: 	 */
d121970301 2019-05-02  179: 	inode = xvfs_<?= $::xvfs::fsName ?>_nameToIndex(path);
d121970301 2019-05-02  180: 	if (inode == XVFS_NAME_LOOKUP_ERROR) {
149aa89b7d 2019-09-13  181: 		return(XVFS_RV_ERR_ENOENT);
d121970301 2019-05-02  182: 	}
d121970301 2019-05-02  183: 	
d121970301 2019-05-02  184: 	fileInfo = &xvfs_<?= $::xvfs::fsName ?>_data[inode];
d121970301 2019-05-02  185: 	
d121970301 2019-05-02  186: 	statBuf->st_dev   = 0;
d121970301 2019-05-02  187: 	statBuf->st_rdev  = 0;
d121970301 2019-05-02  188: 	statBuf->st_ino   = inode;
d121970301 2019-05-02  189: 	statBuf->st_uid   = -1;
d121970301 2019-05-02  190: 	statBuf->st_gid   = -1;
d121970301 2019-05-02  191: 	statBuf->st_atime = 0;
d121970301 2019-05-02  192: 	statBuf->st_ctime = 0;
d121970301 2019-05-02  193: 	statBuf->st_mtime = 0;
fb9dd5d783 2019-05-03  194: 	statBuf->st_blksize = XVFS_FILE_BLOCKSIZE;
d121970301 2019-05-02  195: 	
d121970301 2019-05-02  196: 	if (fileInfo->type == XVFS_FILE_TYPE_REG) {
6b8ea28911 2019-09-16  197: 		statBuf->st_mode   = 0100444;
d121970301 2019-05-02  198: 		statBuf->st_nlink  = 1;
d121970301 2019-05-02  199: 		statBuf->st_size   = fileInfo->size;
d121970301 2019-05-02  200: 		statBuf->st_blocks = (fileInfo->size + statBuf->st_blksize - 1) / statBuf->st_blksize;
d121970301 2019-05-02  201: 	} else if (fileInfo->type == XVFS_FILE_TYPE_DIR) {
6b8ea28911 2019-09-16  202: 		statBuf->st_mode   = 040555;
d121970301 2019-05-02  203: 		statBuf->st_nlink  = fileInfo->size;
d121970301 2019-05-02  204: 		statBuf->st_size   = fileInfo->size;
d121970301 2019-05-02  205: 		statBuf->st_blocks = 1;
d121970301 2019-05-02  206: 	}
d121970301 2019-05-02  207: 	
d121970301 2019-05-02  208: 	return(0);
d121970301 2019-05-02  209: }
d121970301 2019-05-02  210: 
d121970301 2019-05-02  211: static struct Xvfs_FSInfo xvfs_<?= $::xvfs::fsName ?>_fsInfo = {
d121970301 2019-05-02  212: 	.protocolVersion = XVFS_PROTOCOL_VERSION,
d121970301 2019-05-02  213: 	.name            = "<?= $::xvfs::fsName ?>",
d121970301 2019-05-02  214: 	.getChildrenProc = xvfs_<?= $::xvfs::fsName ?>_getChildren,
d121970301 2019-05-02  215: 	.getDataProc     = xvfs_<?= $::xvfs::fsName ?>_getData,
daf25f5222 2019-05-03  216: 	.getStatProc     = xvfs_<?= $::xvfs::fsName ?>_getStat
d121970301 2019-05-02  217: };
d121970301 2019-05-02  218: 
69e476dcd5 2019-05-02  219: int Xvfs_<?= $::xvfs::fsName ?>_Init(Tcl_Interp *interp) {
f74a2e47ab 2019-05-02  220: 	int register_ret;
e5b6962adf 2019-05-02  221: 
e5b6962adf 2019-05-02  222: #ifdef USE_TCL_STUBS
e5b6962adf 2019-05-02  223: 	const char *tclInitStubs_ret;
e5b6962adf 2019-05-02  224: 	/* Initialize Stubs */
e5b6962adf 2019-05-02  225: 	tclInitStubs_ret = Tcl_InitStubs(interp, TCL_PATCH_LEVEL, 0);
e5b6962adf 2019-05-02  226: 	if (!tclInitStubs_ret) {
e5b6962adf 2019-05-02  227: 		return(TCL_ERROR);
e5b6962adf 2019-05-02  228: 	}
e5b6962adf 2019-05-02  229: #endif
f74a2e47ab 2019-05-02  230: 	
d121970301 2019-05-02  231: 	register_ret = Xvfs_Register(interp, &xvfs_<?= $::xvfs::fsName ?>_fsInfo);
f74a2e47ab 2019-05-02  232: 	if (register_ret != TCL_OK) {
f74a2e47ab 2019-05-02  233: 		return(register_ret);
f74a2e47ab 2019-05-02  234: 	}
f74a2e47ab 2019-05-02  235: 	
f74a2e47ab 2019-05-02  236: 	return(TCL_OK);
f74a2e47ab 2019-05-02  237: }
5f2895faba 2019-09-17  238: #undef XVFS_NAME_LOOKUP_ERROR
5f2895faba 2019-09-17  239: #undef XVFS_FILE_BLOCKSIZE