Annotation For xvfs.c.rvt

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

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