Annotation For lib/xvfs/xvfs.c.rvt

Origin for each line in lib/xvfs/xvfs.c.rvt from check-in 717062426a:

09e53d3c38 2019-09-20    1: <?
eebfe1f40f 2020-03-25    2: 	# Care must be taken when editing this file as
eebfe1f40f 2020-03-25    3: 	# it may be processed by either "xvfs-create"
eebfe1f40f 2020-03-25    4: 	# which uses a full Tcl and Rivet parser
eebfe1f40f 2020-03-25    5: 	# or by "xvfs-create-c" which uses a much
eebfe1f40f 2020-03-25    6: 	# simpler one that only knows about printable
eebfe1f40f 2020-03-25    7: 	# sections and ignores all Tcl sections
eebfe1f40f 2020-03-25    8: 
09e53d3c38 2019-09-20    9: 	if {[info exists ::xvfs::xvfsCoreH]} {
eebfe1f40f 2020-03-25   10: 		::minirivet::_emitOutput $::xvfs::xvfsCoreH
09e53d3c38 2019-09-20   11: 	} else {
09e53d3c38 2019-09-20   12: ?>#include <xvfs-core.h><? } ?>
2b7fa3a8fa 2019-09-20   13: #include <sys/stat.h>
2b7fa3a8fa 2019-09-20   14: #include <string.h>
2b7fa3a8fa 2019-09-20   15: #include <tcl.h>
2b7fa3a8fa 2019-09-20   16: 
2b7fa3a8fa 2019-09-20   17: #define XVFS_NAME_LOOKUP_ERROR (-1)
2b7fa3a8fa 2019-09-20   18: #define XVFS_FILE_BLOCKSIZE 1024
2b7fa3a8fa 2019-09-20   19: 
2b7fa3a8fa 2019-09-20   20: /*
2b7fa3a8fa 2019-09-20   21:  * XXX:TODO: Determine this automatically rather than
2b7fa3a8fa 2019-09-20   22:  *           by heuristics
2b7fa3a8fa 2019-09-20   23:  */
2b7fa3a8fa 2019-09-20   24: #define HAVE_STRUCT_STAT_ST_BLKSIZE 1
2b7fa3a8fa 2019-09-20   25: #define HAVE_STRUCT_STAT_ST_BLOCKS  1
2b7fa3a8fa 2019-09-20   26: #ifdef WIN32
2b7fa3a8fa 2019-09-20   27: #  undef HAVE_STRUCT_STAT_ST_BLKSIZE
2b7fa3a8fa 2019-09-20   28: #  undef HAVE_STRUCT_STAT_ST_BLOCKS
2b7fa3a8fa 2019-09-20   29: #endif
2b7fa3a8fa 2019-09-20   30: 
c57d8bead8 2019-09-20   31: #ifndef MIN
2b7fa3a8fa 2019-09-20   32: #define MIN(a, b) (((a) < (b)) ? (a) : (b))
c57d8bead8 2019-09-20   33: #endif
2b7fa3a8fa 2019-09-20   34: 
c57d8bead8 2019-09-20   35: #ifndef HAVE_DEFINED_XVFS_FILE_TYPE_T
c57d8bead8 2019-09-20   36: #define HAVE_DEFINED_XVFS_FILE_TYPE_T 1
2b7fa3a8fa 2019-09-20   37: typedef enum {
2b7fa3a8fa 2019-09-20   38: 	XVFS_FILE_TYPE_REG,
2b7fa3a8fa 2019-09-20   39: 	XVFS_FILE_TYPE_DIR
2b7fa3a8fa 2019-09-20   40: } xvfs_file_type_t;
c57d8bead8 2019-09-20   41: #endif
2b7fa3a8fa 2019-09-20   42: 
c57d8bead8 2019-09-20   43: #ifndef HAVE_DEFINED_XVFS_SIZE_T
c57d8bead8 2019-09-20   44: #define HAVE_DEFINED_XVFS_SIZE_T 1
2b7fa3a8fa 2019-09-20   45: typedef Tcl_WideInt xvfs_size_t;
c57d8bead8 2019-09-20   46: #endif
2b7fa3a8fa 2019-09-20   47: 
c57d8bead8 2019-09-20   48: #ifndef HAVE_DEFINED_XVFS_FILE_DATA
c57d8bead8 2019-09-20   49: #define HAVE_DEFINED_XVFS_FILE_DATA 1
2b7fa3a8fa 2019-09-20   50: struct xvfs_file_data {
a719156faf 2019-10-09   51: 	const char * const        name;
a719156faf 2019-10-09   52: 	const xvfs_file_type_t    type;
a719156faf 2019-10-09   53: 	const xvfs_size_t         size;
2b7fa3a8fa 2019-09-20   54: 	union {
a719156faf 2019-10-09   55: 		const unsigned char * const fileContents;
2b7fa3a8fa 2019-09-20   56: 		const char          **dirChildren;
2b7fa3a8fa 2019-09-20   57: 	} data;
2b7fa3a8fa 2019-09-20   58: };
c57d8bead8 2019-09-20   59: #endif
2b7fa3a8fa 2019-09-20   60: 
2b7fa3a8fa 2019-09-20   61: <?
2b7fa3a8fa 2019-09-20   62: 	package require xvfs
2b7fa3a8fa 2019-09-20   63: 
eebfe1f40f 2020-03-25   64: 	set ::xvfs::fileInfoStruct [xvfs::main $::xvfs::argv]
eebfe1f40f 2020-03-25   65: ?><?= $::xvfs::fileInfoStruct ?>
2b7fa3a8fa 2019-09-20   66: static long xvfs_<?= $::xvfs::fsName ?>_nameToIndex(const char *path) {
37d00c3cfb 2019-11-04   67: <?
eebfe1f40f 2020-03-25   68: 	set hashTable [::xvfs::generateHashTable pathIndex path pathLen XVFS_NAME_LOOKUP_ERROR $::xvfs::outputFiles prefix "\t" hashTableSize 30 validate "strcmp(path, xvfs_${::xvfs::fsName}_data\[pathIndex\].name) == 0" onValidated "return(pathIndex);"]
eebfe1f40f 2020-03-25   69: 	set hashTableHeader [dict get $hashTable header]
eebfe1f40f 2020-03-25   70: ?><?= $hashTableHeader ?>
eebfe1f40f 2020-03-25   71: 	long pathIndex;
f01f82c2d8 2020-04-01   72: 	size_t pathLen;
a719156faf 2019-10-09   73: 
2b7fa3a8fa 2019-09-20   74: 	if (path == NULL) {
2b7fa3a8fa 2019-09-20   75: 		return(XVFS_NAME_LOOKUP_ERROR);
2b7fa3a8fa 2019-09-20   76: 	}
2b7fa3a8fa 2019-09-20   77: 
2b7fa3a8fa 2019-09-20   78: 	pathLen = strlen(path);
a719156faf 2019-10-09   79: 
eebfe1f40f 2020-03-25   80: <?= [dict get $hashTable body] ?>
eebfe1f40f 2020-03-25   81: 
2b7fa3a8fa 2019-09-20   82: 	return(XVFS_NAME_LOOKUP_ERROR);
2b7fa3a8fa 2019-09-20   83: }
2b7fa3a8fa 2019-09-20   84: 
2b7fa3a8fa 2019-09-20   85: static const char **xvfs_<?= $::xvfs::fsName ?>_getChildren(const char *path, Tcl_WideInt *count) {
2b7fa3a8fa 2019-09-20   86: 	const struct xvfs_file_data *fileInfo;
2b7fa3a8fa 2019-09-20   87: 	long inode;
2b7fa3a8fa 2019-09-20   88: 
2b7fa3a8fa 2019-09-20   89: 	/*
2b7fa3a8fa 2019-09-20   90: 	 * Validate input parameters
2b7fa3a8fa 2019-09-20   91: 	 */
2b7fa3a8fa 2019-09-20   92: 	if (count == NULL) {
2b7fa3a8fa 2019-09-20   93: 		return(NULL);
2b7fa3a8fa 2019-09-20   94: 	}
2b7fa3a8fa 2019-09-20   95: 	
2b7fa3a8fa 2019-09-20   96: 	/*
2b7fa3a8fa 2019-09-20   97: 	 * Get the inode from the lookup function
2b7fa3a8fa 2019-09-20   98: 	 */
2b7fa3a8fa 2019-09-20   99: 	inode = xvfs_<?= $::xvfs::fsName ?>_nameToIndex(path);
2b7fa3a8fa 2019-09-20  100: 	if (inode == XVFS_NAME_LOOKUP_ERROR) {
2b7fa3a8fa 2019-09-20  101: 		*count = XVFS_RV_ERR_ENOENT;
2b7fa3a8fa 2019-09-20  102: 		return(NULL);
2b7fa3a8fa 2019-09-20  103: 	}
2b7fa3a8fa 2019-09-20  104: 	
2b7fa3a8fa 2019-09-20  105: 	fileInfo = &xvfs_<?= $::xvfs::fsName ?>_data[inode];
2b7fa3a8fa 2019-09-20  106: 
2b7fa3a8fa 2019-09-20  107: 	/*
2b7fa3a8fa 2019-09-20  108: 	 * Ensure this is a directory
2b7fa3a8fa 2019-09-20  109: 	 */
2b7fa3a8fa 2019-09-20  110: 	if (fileInfo->type != XVFS_FILE_TYPE_DIR) {
2b7fa3a8fa 2019-09-20  111: 		*count = XVFS_RV_ERR_ENOTDIR;
2b7fa3a8fa 2019-09-20  112: 		return(NULL);
2b7fa3a8fa 2019-09-20  113: 	}
2b7fa3a8fa 2019-09-20  114: 	
2b7fa3a8fa 2019-09-20  115: 	*count = fileInfo->size;
2b7fa3a8fa 2019-09-20  116: 	return(fileInfo->data.dirChildren);
2b7fa3a8fa 2019-09-20  117: }
2b7fa3a8fa 2019-09-20  118: 
2b7fa3a8fa 2019-09-20  119: static const unsigned char *xvfs_<?= $::xvfs::fsName ?>_getData(const char *path, Tcl_WideInt start, Tcl_WideInt *length) {
2b7fa3a8fa 2019-09-20  120: 	const struct xvfs_file_data *fileInfo;
2b7fa3a8fa 2019-09-20  121: 	Tcl_WideInt resultLength;
2b7fa3a8fa 2019-09-20  122: 	long inode;
2b7fa3a8fa 2019-09-20  123: 
2b7fa3a8fa 2019-09-20  124: 	/*
2b7fa3a8fa 2019-09-20  125: 	 * Validate input parameters
2b7fa3a8fa 2019-09-20  126: 	 */
2b7fa3a8fa 2019-09-20  127: 	if (length == NULL) {
2b7fa3a8fa 2019-09-20  128: 		return(NULL);
2b7fa3a8fa 2019-09-20  129: 	}
2b7fa3a8fa 2019-09-20  130: 	
2b7fa3a8fa 2019-09-20  131: 	if (start < 0) {
2b7fa3a8fa 2019-09-20  132: 		*length = XVFS_RV_ERR_EINVAL;
2b7fa3a8fa 2019-09-20  133: 		return(NULL);
2b7fa3a8fa 2019-09-20  134: 	}
2b7fa3a8fa 2019-09-20  135: 	
2b7fa3a8fa 2019-09-20  136: 	if (*length < 0) {
2b7fa3a8fa 2019-09-20  137: 		*length = XVFS_RV_ERR_EINVAL;
2b7fa3a8fa 2019-09-20  138: 		return(NULL);
2b7fa3a8fa 2019-09-20  139: 	}
2b7fa3a8fa 2019-09-20  140: 	
2b7fa3a8fa 2019-09-20  141: 	/*
2b7fa3a8fa 2019-09-20  142: 	 * Get the inode from the lookup function
2b7fa3a8fa 2019-09-20  143: 	 */
2b7fa3a8fa 2019-09-20  144: 	inode = xvfs_<?= $::xvfs::fsName ?>_nameToIndex(path);
2b7fa3a8fa 2019-09-20  145: 	if (inode == XVFS_NAME_LOOKUP_ERROR) {
2b7fa3a8fa 2019-09-20  146: 		*length = XVFS_RV_ERR_ENOENT;
2b7fa3a8fa 2019-09-20  147: 		return(NULL);
2b7fa3a8fa 2019-09-20  148: 	}
2b7fa3a8fa 2019-09-20  149: 	
2b7fa3a8fa 2019-09-20  150: 	fileInfo = &xvfs_<?= $::xvfs::fsName ?>_data[inode];
2b7fa3a8fa 2019-09-20  151: 
2b7fa3a8fa 2019-09-20  152: 	/*
2b7fa3a8fa 2019-09-20  153: 	 * Ensure this is a file that can be read
2b7fa3a8fa 2019-09-20  154: 	 */
2b7fa3a8fa 2019-09-20  155: 	if (fileInfo->type != XVFS_FILE_TYPE_REG) {
2b7fa3a8fa 2019-09-20  156: 		*length = XVFS_RV_ERR_EISDIR;
2b7fa3a8fa 2019-09-20  157: 		return(NULL);
2b7fa3a8fa 2019-09-20  158: 	}
2b7fa3a8fa 2019-09-20  159: 
2b7fa3a8fa 2019-09-20  160: 	/*
2b7fa3a8fa 2019-09-20  161: 	 * Validate the length
2b7fa3a8fa 2019-09-20  162: 	 */
2b7fa3a8fa 2019-09-20  163: 	if (start > fileInfo->size) {
2b7fa3a8fa 2019-09-20  164: 		*length = XVFS_RV_ERR_EFAULT;
2b7fa3a8fa 2019-09-20  165: 		return(NULL);
2b7fa3a8fa 2019-09-20  166: 	}
2b7fa3a8fa 2019-09-20  167: 
2b7fa3a8fa 2019-09-20  168: 	if (*length == 0) {
2b7fa3a8fa 2019-09-20  169: 		resultLength = fileInfo->size - start;
2b7fa3a8fa 2019-09-20  170: 	} else {
2b7fa3a8fa 2019-09-20  171: 		resultLength = MIN(fileInfo->size - start, *length);
2b7fa3a8fa 2019-09-20  172: 	}
2b7fa3a8fa 2019-09-20  173: 	*length = resultLength;
2b7fa3a8fa 2019-09-20  174: 
2b7fa3a8fa 2019-09-20  175: 	/*
2b7fa3a8fa 2019-09-20  176: 	 * Return the data
2b7fa3a8fa 2019-09-20  177: 	 */
2b7fa3a8fa 2019-09-20  178: 	return(fileInfo->data.fileContents + start);
2b7fa3a8fa 2019-09-20  179: }
2b7fa3a8fa 2019-09-20  180: 
2b7fa3a8fa 2019-09-20  181: static int xvfs_<?= $::xvfs::fsName ?>_getStat(const char *path, Tcl_StatBuf *statBuf) {
2b7fa3a8fa 2019-09-20  182: 	const struct xvfs_file_data *fileInfo;
2b7fa3a8fa 2019-09-20  183: 	long inode;
2b7fa3a8fa 2019-09-20  184: 
2b7fa3a8fa 2019-09-20  185: 	/*
2b7fa3a8fa 2019-09-20  186: 	 * Validate input parameters
2b7fa3a8fa 2019-09-20  187: 	 */
2b7fa3a8fa 2019-09-20  188: 	if (!statBuf) {
2b7fa3a8fa 2019-09-20  189: 		return(XVFS_RV_ERR_EINVAL);
2b7fa3a8fa 2019-09-20  190: 	}
2b7fa3a8fa 2019-09-20  191: 	
2b7fa3a8fa 2019-09-20  192: 	/*
2b7fa3a8fa 2019-09-20  193: 	 * Get the inode from the lookup function
2b7fa3a8fa 2019-09-20  194: 	 */
2b7fa3a8fa 2019-09-20  195: 	inode = xvfs_<?= $::xvfs::fsName ?>_nameToIndex(path);
2b7fa3a8fa 2019-09-20  196: 	if (inode == XVFS_NAME_LOOKUP_ERROR) {
2b7fa3a8fa 2019-09-20  197: 		return(XVFS_RV_ERR_ENOENT);
2b7fa3a8fa 2019-09-20  198: 	}
2b7fa3a8fa 2019-09-20  199: 	
2b7fa3a8fa 2019-09-20  200: 	fileInfo = &xvfs_<?= $::xvfs::fsName ?>_data[inode];
2b7fa3a8fa 2019-09-20  201: 	
eebfe1f40f 2020-03-25  202: 	statBuf->st_dev   = <?= [zlib adler32 $::xvfs::fsName 0] ?>;
eebfe1f40f 2020-03-25  203: 	statBuf->st_rdev  = <?= [zlib adler32 $::xvfs::fsName 0] ?>;
2b7fa3a8fa 2019-09-20  204: 	statBuf->st_ino   = inode;
2b7fa3a8fa 2019-09-20  205: 	statBuf->st_uid   = 0;
2b7fa3a8fa 2019-09-20  206: 	statBuf->st_gid   = 0;
2b7fa3a8fa 2019-09-20  207: 	statBuf->st_atime = 0;
2b7fa3a8fa 2019-09-20  208: 	statBuf->st_ctime = 0;
2b7fa3a8fa 2019-09-20  209: 	statBuf->st_mtime = 0;
2b7fa3a8fa 2019-09-20  210: #ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
2b7fa3a8fa 2019-09-20  211: 	statBuf->st_blksize = XVFS_FILE_BLOCKSIZE;
2b7fa3a8fa 2019-09-20  212: #endif
2b7fa3a8fa 2019-09-20  213: 	
2b7fa3a8fa 2019-09-20  214: 	if (fileInfo->type == XVFS_FILE_TYPE_REG) {
2b7fa3a8fa 2019-09-20  215: 		statBuf->st_mode   = 0100444;
2b7fa3a8fa 2019-09-20  216: 		statBuf->st_nlink  = 1;
2b7fa3a8fa 2019-09-20  217: 		statBuf->st_size   = fileInfo->size;
2b7fa3a8fa 2019-09-20  218: #ifdef HAVE_STRUCT_STAT_ST_BLOCKS
2b7fa3a8fa 2019-09-20  219: 		statBuf->st_blocks = (fileInfo->size + statBuf->st_blksize - 1) / statBuf->st_blksize;
2b7fa3a8fa 2019-09-20  220: #endif
2b7fa3a8fa 2019-09-20  221: 	} else if (fileInfo->type == XVFS_FILE_TYPE_DIR) {
2b7fa3a8fa 2019-09-20  222: 		statBuf->st_mode   = 040555;
2b7fa3a8fa 2019-09-20  223: 		statBuf->st_nlink  = fileInfo->size;
2b7fa3a8fa 2019-09-20  224: 		statBuf->st_size   = fileInfo->size;
2b7fa3a8fa 2019-09-20  225: #ifdef HAVE_STRUCT_STAT_ST_BLOCKS
2b7fa3a8fa 2019-09-20  226: 		statBuf->st_blocks = 1;
2b7fa3a8fa 2019-09-20  227: #endif
2b7fa3a8fa 2019-09-20  228: 	}
2b7fa3a8fa 2019-09-20  229: 	
2b7fa3a8fa 2019-09-20  230: 	return(0);
2b7fa3a8fa 2019-09-20  231: }
2b7fa3a8fa 2019-09-20  232: 
2b7fa3a8fa 2019-09-20  233: static struct Xvfs_FSInfo xvfs_<?= $::xvfs::fsName ?>_fsInfo = {
2b7fa3a8fa 2019-09-20  234: 	.protocolVersion = XVFS_PROTOCOL_VERSION,
2b7fa3a8fa 2019-09-20  235: 	.name            = "<?= $::xvfs::fsName ?>",
2b7fa3a8fa 2019-09-20  236: 	.getChildrenProc = xvfs_<?= $::xvfs::fsName ?>_getChildren,
2b7fa3a8fa 2019-09-20  237: 	.getDataProc     = xvfs_<?= $::xvfs::fsName ?>_getData,
2b7fa3a8fa 2019-09-20  238: 	.getStatProc     = xvfs_<?= $::xvfs::fsName ?>_getStat
2b7fa3a8fa 2019-09-20  239: };
2b7fa3a8fa 2019-09-20  240: 
717062426a 2020-04-13  241: #ifdef XVFS_<?= $::xvfs::fsName ?>_INIT_STATIC
717062426a 2020-04-13  242: static
717062426a 2020-04-13  243: #endif
2b7fa3a8fa 2019-09-20  244: int Xvfs_<?= $::xvfs::fsName ?>_Init(Tcl_Interp *interp) {
2b7fa3a8fa 2019-09-20  245: 	int register_ret;
2b7fa3a8fa 2019-09-20  246: 
2b7fa3a8fa 2019-09-20  247: #ifdef USE_TCL_STUBS
2b7fa3a8fa 2019-09-20  248: 	const char *tclInitStubs_ret;
2b7fa3a8fa 2019-09-20  249: 	/* Initialize Stubs */
2b7fa3a8fa 2019-09-20  250: 	tclInitStubs_ret = Tcl_InitStubs(interp, TCL_PATCH_LEVEL, 0);
2b7fa3a8fa 2019-09-20  251: 	if (!tclInitStubs_ret) {
2b7fa3a8fa 2019-09-20  252: 		return(TCL_ERROR);
2b7fa3a8fa 2019-09-20  253: 	}
2b7fa3a8fa 2019-09-20  254: #endif
2b7fa3a8fa 2019-09-20  255: 	
2b7fa3a8fa 2019-09-20  256: 	register_ret = Xvfs_Register(interp, &xvfs_<?= $::xvfs::fsName ?>_fsInfo);
2b7fa3a8fa 2019-09-20  257: 	if (register_ret != TCL_OK) {
2b7fa3a8fa 2019-09-20  258: 		return(register_ret);
2b7fa3a8fa 2019-09-20  259: 	}
2b7fa3a8fa 2019-09-20  260: 	
2b7fa3a8fa 2019-09-20  261: 	return(TCL_OK);
2b7fa3a8fa 2019-09-20  262: }
2b7fa3a8fa 2019-09-20  263: #undef XVFS_NAME_LOOKUP_ERROR
2b7fa3a8fa 2019-09-20  264: #undef XVFS_FILE_BLOCKSIZE
717062426a 2020-04-13  265: #undef XVFS_<?= $::xvfs::fsName ?>_INIT_STATIC