69e476dcd5 2019-05-02 1: #include <xvfs-core.h>
d121970301 2019-05-02 2: #include <string.h>
69e476dcd5 2019-05-02 3: #include <tcl.h>
e5b6962adf 2019-05-02 4:
d92ba3d36d 2019-05-08 5: #if defined(XVFS_MODE_FLEXIBLE) || defined(XVFS_MODE_SERVER)
d92ba3d36d 2019-05-08 6: #define XVFS_INTERNAL_SERVER_MAGIC "\xD4\xF3\x05\x96\x25\xCF\xAF\xFE"
d92ba3d36d 2019-05-08 7: #define XVFS_INTERNAL_SERVER_MAGIC_LEN 8
d92ba3d36d 2019-05-08 8:
d92ba3d36d 2019-05-08 9: struct xvfs_tclfs_server_info {
b586d5b0a1 2019-05-08 10: char magic[XVFS_INTERNAL_SERVER_MAGIC_LEN];
d92ba3d36d 2019-05-08 11: int (*registerProc)(Tcl_Interp *interp, struct Xvfs_FSInfo *fsInfo);
d92ba3d36d 2019-05-08 12: };
d92ba3d36d 2019-05-08 13: #endif /* XVFS_MODE_FLEXIBLE || XVFS_MODE_SERVER */
d92ba3d36d 2019-05-08 14:
3e44e1def1 2019-05-02 15: #if defined(XVFS_MODE_SERVER) || defined(XVFS_MODE_STANDALONE) || defined(XVFS_MODE_FLEXIBLE)
d121970301 2019-05-02 16: #define XVFS_ROOT_MOUNTPOINT "//xvfs:/"
d121970301 2019-05-02 17:
d121970301 2019-05-02 18: struct xvfs_tclfs_instance_info {
d121970301 2019-05-02 19: struct Xvfs_FSInfo *fsInfo;
d121970301 2019-05-02 20: Tcl_Obj *mountpoint;
d121970301 2019-05-02 21: };
d121970301 2019-05-02 22:
d121970301 2019-05-02 23: /*
d121970301 2019-05-02 24: * Internal Core Utilities
d121970301 2019-05-02 25: */
d121970301 2019-05-02 26: static const char *xvfs_relativePath(Tcl_Obj *path, struct xvfs_tclfs_instance_info *info) {
d121970301 2019-05-02 27: const char *pathStr, *rootStr;
d121970301 2019-05-02 28: int pathLen, rootLen;
d121970301 2019-05-02 29:
d121970301 2019-05-02 30: pathStr = Tcl_GetStringFromObj(path, &pathLen);
d121970301 2019-05-02 31: rootStr = Tcl_GetStringFromObj(info->mountpoint, &rootLen);
d121970301 2019-05-02 32:
d121970301 2019-05-02 33: if (pathLen < rootLen) {
d121970301 2019-05-02 34: return(NULL);
d121970301 2019-05-02 35: }
d121970301 2019-05-02 36:
d121970301 2019-05-02 37: if (memcmp(pathStr, rootStr, rootLen) != 0) {
d121970301 2019-05-02 38: return(NULL);
d121970301 2019-05-02 39: }
d121970301 2019-05-02 40:
d121970301 2019-05-02 41: if (pathLen == rootLen) {
d121970301 2019-05-02 42: return("");
d121970301 2019-05-02 43: }
d121970301 2019-05-02 44:
d121970301 2019-05-02 45: /* XXX:TODO: Should this use the native OS path separator ? */
d121970301 2019-05-02 46: if (pathStr[rootLen] != '/') {
d121970301 2019-05-02 47: return(NULL);
d121970301 2019-05-02 48: }
d121970301 2019-05-02 49:
d121970301 2019-05-02 50: return(pathStr + rootLen + 1);
d121970301 2019-05-02 51: }
d121970301 2019-05-02 52:
d121970301 2019-05-02 53: /*
d121970301 2019-05-02 54: * Internal Tcl_Filesystem functions, with the appropriate instance info
d121970301 2019-05-02 55: */
d121970301 2019-05-02 56: static int xvfs_tclfs_pathInFilesystem(Tcl_Obj *path, ClientData *dataPtr, struct xvfs_tclfs_instance_info *instanceInfo) {
d121970301 2019-05-02 57: const char *relativePath;
d121970301 2019-05-02 58:
d121970301 2019-05-02 59: relativePath = xvfs_relativePath(path, instanceInfo);
d121970301 2019-05-02 60: if (!relativePath) {
d121970301 2019-05-02 61: return(-1);
d121970301 2019-05-02 62: }
d121970301 2019-05-02 63:
d121970301 2019-05-02 64: return(TCL_OK);
d121970301 2019-05-02 65: }
d121970301 2019-05-02 66:
d121970301 2019-05-02 67: static int xvfs_tclfs_stat(Tcl_Obj *path, Tcl_StatBuf *statBuf, struct xvfs_tclfs_instance_info *instanceInfo) {
d121970301 2019-05-02 68: const char *pathStr;
d121970301 2019-05-02 69: int retval;
d121970301 2019-05-02 70:
d121970301 2019-05-02 71: pathStr = xvfs_relativePath(path, instanceInfo);
d121970301 2019-05-02 72:
daf25f5222 2019-05-03 73: retval = instanceInfo->fsInfo->getStatProc(pathStr, statBuf);
d121970301 2019-05-02 74:
d121970301 2019-05-02 75: return(retval);
d121970301 2019-05-02 76: }
d121970301 2019-05-02 77:
d121970301 2019-05-02 78: static Tcl_Obj *xvfs_tclfs_listVolumes(struct xvfs_tclfs_instance_info *instanceInfo) {
d121970301 2019-05-02 79: return(NULL);
d121970301 2019-05-02 80: }
d121970301 2019-05-02 81:
d121970301 2019-05-02 82: static Tcl_Channel xvfs_tclfs_openFileChannel(Tcl_Interp *interp, Tcl_Obj *path, int mode, int permissions, struct xvfs_tclfs_instance_info *instanceInfo) {
d121970301 2019-05-02 83: const char *pathStr;
d121970301 2019-05-02 84:
d121970301 2019-05-02 85: pathStr = xvfs_relativePath(path, instanceInfo);
d121970301 2019-05-02 86: fprintf(stderr, "Called open(%s)!\n", pathStr);
d121970301 2019-05-02 87:
d121970301 2019-05-02 88: return(NULL);
d121970301 2019-05-02 89: }
3e44e1def1 2019-05-02 90: #endif /* XVFS_MODE_SERVER || XVFS_MODE_STANDALONE || XVFS_MODE_FLEIXBLE */
d121970301 2019-05-02 91:
88f96696b7 2019-05-03 92: #if defined(XVFS_MODE_STANDALONE) || defined(XVFS_MODE_FLEXIBLE)
d121970301 2019-05-02 93: /*
d121970301 2019-05-02 94: * Tcl_Filesystem handlers for the standalone implementation
d121970301 2019-05-02 95: */
acfc5037c6 2019-05-02 96: static struct xvfs_tclfs_instance_info xvfs_tclfs_standalone_info;
d121970301 2019-05-02 97: static int xvfs_tclfs_standalone_pathInFilesystem(Tcl_Obj *path, ClientData *dataPtr) {
d121970301 2019-05-02 98: return(xvfs_tclfs_pathInFilesystem(path, dataPtr, &xvfs_tclfs_standalone_info));
d121970301 2019-05-02 99: }
d121970301 2019-05-02 100:
d121970301 2019-05-02 101: static int xvfs_tclfs_standalone_stat(Tcl_Obj *path, Tcl_StatBuf *statBuf) {
d121970301 2019-05-02 102: return(xvfs_tclfs_stat(path, statBuf, &xvfs_tclfs_standalone_info));
e5b6962adf 2019-05-02 103: }
e5b6962adf 2019-05-02 104:
d121970301 2019-05-02 105: static Tcl_Obj *xvfs_tclfs_standalone_listVolumes(void) {
d121970301 2019-05-02 106: return(xvfs_tclfs_listVolumes(&xvfs_tclfs_standalone_info));
e5b6962adf 2019-05-02 107: }
e5b6962adf 2019-05-02 108:
d121970301 2019-05-02 109: static Tcl_Channel xvfs_tclfs_standalone_openFileChannel(Tcl_Interp *interp, Tcl_Obj *path, int mode, int permissions) {
d121970301 2019-05-02 110: return(xvfs_tclfs_openFileChannel(interp, path, mode, permissions, &xvfs_tclfs_standalone_info));
e5b6962adf 2019-05-02 111: }
32b55a907b 2019-05-02 112:
32b55a907b 2019-05-02 113: /*
32b55a907b 2019-05-02 114: * There are three (3) modes of operation for Xvfs_Register:
32b55a907b 2019-05-02 115: * 1. standalone -- We register our own Tcl_Filesystem
32b55a907b 2019-05-02 116: * and handle requests under `//xvfs:/<fsName>`
32b55a907b 2019-05-02 117: * 2. client -- A single Tcl_Filesystem is registered for the
32b55a907b 2019-05-02 118: * interp to handle requests under `//xvfs:/` which
32b55a907b 2019-05-02 119: * then dispatches to the appropriate registered
32b55a907b 2019-05-02 120: * handler
32b55a907b 2019-05-02 121: * 3. flexible -- Attempts to find a core Xvfs instance for the
32b55a907b 2019-05-02 122: * process at runtime, if found do #2, otherwise
32b55a907b 2019-05-02 123: * fallback to #1
32b55a907b 2019-05-02 124: *
32b55a907b 2019-05-02 125: */
cb77ecfb24 2019-05-06 126: static Tcl_Filesystem xvfs_tclfs_standalone_fs;
acfc5037c6 2019-05-02 127: int xvfs_standalone_register(Tcl_Interp *interp, struct Xvfs_FSInfo *fsInfo) {
e5b6962adf 2019-05-02 128: int tcl_ret;
d121970301 2019-05-02 129: static int registered = 0;
e5b6962adf 2019-05-02 130:
d121970301 2019-05-02 131: /*
d121970301 2019-05-02 132: * Ensure this instance is not already registered
d121970301 2019-05-02 133: */
d121970301 2019-05-02 134: if (registered) {
d121970301 2019-05-02 135: return(TCL_OK);
d121970301 2019-05-02 136: }
d121970301 2019-05-02 137: registered = 1;
d121970301 2019-05-02 138:
e5b6962adf 2019-05-02 139: /*
e5b6962adf 2019-05-02 140: * In standalone mode, we only support the same protocol we are
e5b6962adf 2019-05-02 141: * compiling for.
e5b6962adf 2019-05-02 142: */
e5b6962adf 2019-05-02 143: if (fsInfo->protocolVersion != XVFS_PROTOCOL_VERSION) {
e5b6962adf 2019-05-02 144: if (interp) {
e5b6962adf 2019-05-02 145: Tcl_SetResult(interp, "Protocol mismatch", NULL);
e5b6962adf 2019-05-02 146: }
e5b6962adf 2019-05-02 147: return(TCL_ERROR);
e5b6962adf 2019-05-02 148: }
e5b6962adf 2019-05-02 149:
cb77ecfb24 2019-05-06 150: xvfs_tclfs_standalone_fs.typeName = "xvfs";
cb77ecfb24 2019-05-06 151: xvfs_tclfs_standalone_fs.structureLength = sizeof(xvfs_tclfs_standalone_fs);
cb77ecfb24 2019-05-06 152: xvfs_tclfs_standalone_fs.version = TCL_FILESYSTEM_VERSION_1;
cb77ecfb24 2019-05-06 153: xvfs_tclfs_standalone_fs.pathInFilesystemProc = xvfs_tclfs_standalone_pathInFilesystem;
cb77ecfb24 2019-05-06 154: xvfs_tclfs_standalone_fs.dupInternalRepProc = NULL;
cb77ecfb24 2019-05-06 155: xvfs_tclfs_standalone_fs.freeInternalRepProc = NULL;
cb77ecfb24 2019-05-06 156: xvfs_tclfs_standalone_fs.internalToNormalizedProc = NULL;
cb77ecfb24 2019-05-06 157: xvfs_tclfs_standalone_fs.createInternalRepProc = NULL;
cb77ecfb24 2019-05-06 158: xvfs_tclfs_standalone_fs.normalizePathProc = NULL;
cb77ecfb24 2019-05-06 159: xvfs_tclfs_standalone_fs.filesystemPathTypeProc = NULL;
cb77ecfb24 2019-05-06 160: xvfs_tclfs_standalone_fs.filesystemSeparatorProc = NULL;
cb77ecfb24 2019-05-06 161: xvfs_tclfs_standalone_fs.statProc = xvfs_tclfs_standalone_stat;
cb77ecfb24 2019-05-06 162: xvfs_tclfs_standalone_fs.accessProc = NULL;
cb77ecfb24 2019-05-06 163: xvfs_tclfs_standalone_fs.openFileChannelProc = xvfs_tclfs_standalone_openFileChannel;
cb77ecfb24 2019-05-06 164: xvfs_tclfs_standalone_fs.matchInDirectoryProc = NULL;
cb77ecfb24 2019-05-06 165: xvfs_tclfs_standalone_fs.utimeProc = NULL;
cb77ecfb24 2019-05-06 166: xvfs_tclfs_standalone_fs.linkProc = NULL;
cb77ecfb24 2019-05-06 167: xvfs_tclfs_standalone_fs.listVolumesProc = xvfs_tclfs_standalone_listVolumes;
cb77ecfb24 2019-05-06 168: xvfs_tclfs_standalone_fs.fileAttrStringsProc = NULL;
cb77ecfb24 2019-05-06 169: xvfs_tclfs_standalone_fs.fileAttrsGetProc = NULL;
cb77ecfb24 2019-05-06 170: xvfs_tclfs_standalone_fs.fileAttrsSetProc = NULL;
cb77ecfb24 2019-05-06 171: xvfs_tclfs_standalone_fs.createDirectoryProc = NULL;
cb77ecfb24 2019-05-06 172: xvfs_tclfs_standalone_fs.removeDirectoryProc = NULL;
cb77ecfb24 2019-05-06 173: xvfs_tclfs_standalone_fs.deleteFileProc = NULL;
cb77ecfb24 2019-05-06 174: xvfs_tclfs_standalone_fs.copyFileProc = NULL;
cb77ecfb24 2019-05-06 175: xvfs_tclfs_standalone_fs.renameFileProc = NULL;
cb77ecfb24 2019-05-06 176: xvfs_tclfs_standalone_fs.copyDirectoryProc = NULL;
cb77ecfb24 2019-05-06 177: xvfs_tclfs_standalone_fs.lstatProc = NULL;
cb77ecfb24 2019-05-06 178: xvfs_tclfs_standalone_fs.loadFileProc = NULL;
cb77ecfb24 2019-05-06 179: xvfs_tclfs_standalone_fs.getCwdProc = NULL;
cb77ecfb24 2019-05-06 180: xvfs_tclfs_standalone_fs.chdirProc = NULL;
d121970301 2019-05-02 181:
d121970301 2019-05-02 182: xvfs_tclfs_standalone_info.fsInfo = fsInfo;
d121970301 2019-05-02 183: xvfs_tclfs_standalone_info.mountpoint = Tcl_NewObj();
d121970301 2019-05-02 184: Tcl_AppendStringsToObj(xvfs_tclfs_standalone_info.mountpoint, XVFS_ROOT_MOUNTPOINT, fsInfo->name, NULL);
d121970301 2019-05-02 185:
cb77ecfb24 2019-05-06 186: tcl_ret = Tcl_FSRegister(NULL, &xvfs_tclfs_standalone_fs);
e5b6962adf 2019-05-02 187: if (tcl_ret != TCL_OK) {
e5b6962adf 2019-05-02 188: if (interp) {
e5b6962adf 2019-05-02 189: Tcl_SetResult(interp, "Tcl_FSRegister() failed", NULL);
e5b6962adf 2019-05-02 190: }
e5b6962adf 2019-05-02 191:
e5b6962adf 2019-05-02 192: return(tcl_ret);
e5b6962adf 2019-05-02 193: }
e5b6962adf 2019-05-02 194:
e5b6962adf 2019-05-02 195: return(TCL_OK);
e5b6962adf 2019-05-02 196: }
d92ba3d36d 2019-05-08 197: #endif /* XVFS_MODE_STANDALONE || XVFS_MODE_FLEXIBLE */
88f96696b7 2019-05-03 198:
88f96696b7 2019-05-03 199: #if defined(XVFS_MODE_FLEXIBLE)
88f96696b7 2019-05-03 200: int xvfs_flexible_register(Tcl_Interp *interp, struct Xvfs_FSInfo *fsInfo) {
9bcf758fef 2019-05-08 201: ClientData fsHandlerDataRaw;
9bcf758fef 2019-05-08 202: struct xvfs_tclfs_server_info *fsHandlerData;
9bcf758fef 2019-05-08 203: const Tcl_Filesystem *fsHandler;
9bcf758fef 2019-05-08 204: int (*xvfs_register)(Tcl_Interp *interp, struct Xvfs_FSInfo *fsInfo);
9bcf758fef 2019-05-08 205: Tcl_Obj *rootPathObj;
9bcf758fef 2019-05-08 206:
9bcf758fef 2019-05-08 207: xvfs_register = &xvfs_standalone_register;
9bcf758fef 2019-05-08 208:
9bcf758fef 2019-05-08 209: rootPathObj = Tcl_NewStringObj(XVFS_ROOT_MOUNTPOINT, -1);
9bcf758fef 2019-05-08 210: if (!rootPathObj) {
9bcf758fef 2019-05-08 211: return(xvfs_register(interp, fsInfo));
9bcf758fef 2019-05-08 212: }
9bcf758fef 2019-05-08 213:
9bcf758fef 2019-05-08 214: Tcl_IncrRefCount(rootPathObj);
9bcf758fef 2019-05-08 215: fsHandler = Tcl_FSGetFileSystemForPath(rootPathObj);
9bcf758fef 2019-05-08 216: Tcl_DecrRefCount(rootPathObj);
9bcf758fef 2019-05-08 217:
9bcf758fef 2019-05-08 218: if (!fsHandler) {
9bcf758fef 2019-05-08 219: return(xvfs_register(interp, fsInfo));
9bcf758fef 2019-05-08 220: }
9bcf758fef 2019-05-08 221:
9bcf758fef 2019-05-08 222: fsHandlerDataRaw = Tcl_FSData(fsHandler);
9bcf758fef 2019-05-08 223: if (!fsHandlerDataRaw) {
9bcf758fef 2019-05-08 224: return(xvfs_register(interp, fsInfo));
9bcf758fef 2019-05-08 225: }
9bcf758fef 2019-05-08 226:
9bcf758fef 2019-05-08 227: fsHandlerData = (struct xvfs_tclfs_server_info *) fsHandlerDataRaw;
88f96696b7 2019-05-03 228:
88f96696b7 2019-05-03 229: /*
9bcf758fef 2019-05-08 230: * XXX:TODO: What is the chance that the handler for //xvfs:/ hold
b586d5b0a1 2019-05-08 231: * client data smaller than XVFS_INTERNAL_SERVER_MAGIC_LEN ?
88f96696b7 2019-05-03 232: */
b586d5b0a1 2019-05-08 233: if (memcmp(fsHandlerData->magic, XVFS_INTERNAL_SERVER_MAGIC, sizeof(fsHandlerData->magic)) == 0) {
9bcf758fef 2019-05-08 234: xvfs_register = fsHandlerData->registerProc;
88f96696b7 2019-05-03 235: }
9bcf758fef 2019-05-08 236:
88f96696b7 2019-05-03 237: return(xvfs_register(interp, fsInfo));
88f96696b7 2019-05-03 238: }
d92ba3d36d 2019-05-08 239: #endif /* XVFS_MODE_FLEXIBLE */
3e44e1def1 2019-05-02 240:
3e44e1def1 2019-05-02 241: #if defined(XVFS_MODE_SERVER)
e5b6962adf 2019-05-02 242: int Xvfs_Register(Tcl_Interp *interp, struct Xvfs_FSInfo *fsInfo) {
acfc5037c6 2019-05-02 243: return(TCL_ERROR);
69e476dcd5 2019-05-02 244: }
d92ba3d36d 2019-05-08 245: #endif /* XVFS_MODE_SERVER */