initial commit

3rd_party/winfsp-1.10/samples/memfs/memfs-main.c

@@ -0,0 +1,241 @@
+/**
+ * @file memfs-main.c
+ *
+ * @copyright 2015-2021 Bill Zissimopoulos
+ */
+/*
+ * This file is part of WinFsp.
+ *
+ * You can redistribute it and/or modify it under the terms of the GNU
+ * General Public License version 3 as published by the Free Software
+ * Foundation.
+ *
+ * Licensees holding a valid commercial license may use this software
+ * in accordance with the commercial license agreement provided in
+ * conjunction with the software.  The terms and conditions of any such
+ * commercial license agreement shall govern, supersede, and render
+ * ineffective any application of the GPLv3 license to this software,
+ * notwithstanding of any reference thereto in the software or
+ * associated repository.
+ */
+
+#include <winfsp/winfsp.h>
+#include "memfs.h"
+
+#define PROGNAME                        "memfs"
+
+#define info(format, ...)               FspServiceLog(EVENTLOG_INFORMATION_TYPE, format, __VA_ARGS__)
+#define warn(format, ...)               FspServiceLog(EVENTLOG_WARNING_TYPE, format, __VA_ARGS__)
+#define fail(format, ...)               FspServiceLog(EVENTLOG_ERROR_TYPE, format, __VA_ARGS__)
+
+#define argtos(v)                       if (arge > ++argp) v = *argp; else goto usage
+#define argtol(v)                       if (arge > ++argp) v = wcstol_deflt(*argp, v); else goto usage
+
+static ULONG wcstol_deflt(wchar_t *w, ULONG deflt)
+{
+    wchar_t *endp;
+    ULONG ul = wcstol(w, &endp, 0);
+    return L'\0' != w[0] && L'\0' == *endp ? ul : deflt;
+}
+
+NTSTATUS SvcStart(FSP_SERVICE *Service, ULONG argc, PWSTR *argv)
+{
+    wchar_t **argp, **arge;
+    ULONG DebugFlags = 0;
+    PWSTR DebugLogFile = 0;
+    ULONG Flags = MemfsDisk;
+    ULONG OtherFlags = 0;
+    ULONG FileInfoTimeout = INFINITE;
+    ULONG MaxFileNodes = 1024;
+    ULONG MaxFileSize = 16 * 1024 * 1024;
+    ULONG SlowioMaxDelay = 0;       /* -M: maximum slow IO delay in millis */
+    ULONG SlowioPercentDelay = 0;   /* -P: percent of slow IO to make pending */
+    ULONG SlowioRarefyDelay = 0;    /* -R: adjust the rarity of pending slow IO */
+    PWSTR FileSystemName = 0;
+    PWSTR MountPoint = 0;
+    PWSTR VolumePrefix = 0;
+    PWSTR RootSddl = 0;
+    HANDLE DebugLogHandle = INVALID_HANDLE_VALUE;
+    MEMFS *Memfs = 0;
+    NTSTATUS Result;
+
+    for (argp = argv + 1, arge = argv + argc; arge > argp; argp++)
+    {
+        if (L'-' != argp[0][0])
+            break;
+        switch (argp[0][1])
+        {
+        case L'?':
+            goto usage;
+        case L'd':
+            argtol(DebugFlags);
+            break;
+        case L'D':
+            argtos(DebugLogFile);
+            break;
+        case L'f':
+            OtherFlags = MemfsFlushAndPurgeOnCleanup;
+            break;
+        case L'F':
+            argtos(FileSystemName);
+            break;
+        case L'i':
+            OtherFlags = MemfsCaseInsensitive;
+            break;
+        case L'm':
+            argtos(MountPoint);
+            break;
+        case L'M':
+            argtol(SlowioMaxDelay);
+            break;
+        case L'n':
+            argtol(MaxFileNodes);
+            break;
+        case L'P':
+            argtol(SlowioPercentDelay);
+            break;
+        case L'R':
+            argtol(SlowioRarefyDelay);
+            break;
+        case L'S':
+            argtos(RootSddl);
+            break;
+        case L's':
+            argtol(MaxFileSize);
+            break;
+        case L't':
+            argtol(FileInfoTimeout);
+            break;
+        case L'u':
+            argtos(VolumePrefix);
+            if (0 != VolumePrefix && L'\0' != VolumePrefix[0])
+                Flags = MemfsNet;
+            break;
+        default:
+            goto usage;
+        }
+    }
+
+    if (arge > argp)
+        goto usage;
+
+    if (MemfsDisk == Flags && 0 == MountPoint)
+        goto usage;
+
+    if (0 != DebugLogFile)
+    {
+        if (0 == wcscmp(L"-", DebugLogFile))
+            DebugLogHandle = GetStdHandle(STD_ERROR_HANDLE);
+        else
+            DebugLogHandle = CreateFileW(
+                DebugLogFile,
+                FILE_APPEND_DATA,
+                FILE_SHARE_READ | FILE_SHARE_WRITE,
+                0,
+                OPEN_ALWAYS,
+                FILE_ATTRIBUTE_NORMAL,
+                0);
+        if (INVALID_HANDLE_VALUE == DebugLogHandle)
+        {
+            fail(L"cannot open debug log file");
+            goto usage;
+        }
+
+        FspDebugLogSetHandle(DebugLogHandle);
+    }
+
+    Result = MemfsCreateFunnel(
+        Flags | OtherFlags,
+        FileInfoTimeout,
+        MaxFileNodes,
+        MaxFileSize,
+        SlowioMaxDelay,
+        SlowioPercentDelay,
+        SlowioRarefyDelay,
+        FileSystemName,
+        VolumePrefix,
+        RootSddl,
+        &Memfs);
+    if (!NT_SUCCESS(Result))
+    {
+        fail(L"cannot create MEMFS");
+        goto exit;
+    }
+
+    FspFileSystemSetDebugLog(MemfsFileSystem(Memfs), DebugFlags);
+
+    if (0 != MountPoint && L'\0' != MountPoint[0])
+    {
+        Result = FspFileSystemSetMountPoint(MemfsFileSystem(Memfs),
+            L'*' == MountPoint[0] && L'\0' == MountPoint[1] ? 0 : MountPoint);
+        if (!NT_SUCCESS(Result))
+        {
+            fail(L"cannot mount MEMFS");
+            goto exit;
+        }
+    }
+
+    Result = MemfsStart(Memfs);
+    if (!NT_SUCCESS(Result))
+    {
+        fail(L"cannot start MEMFS");
+        goto exit;
+    }
+
+    MountPoint = FspFileSystemMountPoint(MemfsFileSystem(Memfs));
+
+    info(L"%s -t %ld -n %ld -s %ld%s%s%s%s%s%s",
+        L"" PROGNAME, FileInfoTimeout, MaxFileNodes, MaxFileSize,
+        RootSddl ? L" -S " : L"", RootSddl ? RootSddl : L"",
+        0 != VolumePrefix && L'\0' != VolumePrefix[0] ? L" -u " : L"",
+            0 != VolumePrefix && L'\0' != VolumePrefix[0] ? VolumePrefix : L"",
+        MountPoint ? L" -m " : L"", MountPoint ? MountPoint : L"");
+
+    Service->UserContext = Memfs;
+    Result = STATUS_SUCCESS;
+
+exit:
+    if (!NT_SUCCESS(Result) && 0 != Memfs)
+        MemfsDelete(Memfs);
+
+    return Result;
+
+usage:
+    static wchar_t usage[] = L""
+        "usage: %s OPTIONS\n"
+        "\n"
+        "options:\n"
+        "    -d DebugFlags       [-1: enable all debug logs]\n"
+        "    -D DebugLogFile     [file path; use - for stderr]\n"
+        "    -i                  [case insensitive file system]\n"
+        "    -f                  [flush and purge cache on cleanup]\n"
+        "    -t FileInfoTimeout  [millis]\n"
+        "    -n MaxFileNodes\n"
+        "    -s MaxFileSize      [bytes]\n"
+        "    -M MaxDelay         [maximum slow IO delay in millis]\n"
+        "    -P PercentDelay     [percent of slow IO to make pending]\n"
+        "    -R RarefyDelay      [adjust the rarity of pending slow IO]\n"
+        "    -F FileSystemName\n"
+        "    -S RootSddl         [file rights: FA, etc; NO generic rights: GA, etc.]\n"
+        "    -u \\Server\\Share    [UNC prefix (single backslash)]\n"
+        "    -m MountPoint       [X:|* (required if no UNC prefix)]\n";
+
+    fail(usage, L"" PROGNAME);
+
+    return STATUS_UNSUCCESSFUL;
+}
+
+NTSTATUS SvcStop(FSP_SERVICE *Service)
+{
+    MEMFS *Memfs = Service->UserContext;
+
+    MemfsStop(Memfs);
+    MemfsDelete(Memfs);
+
+    return STATUS_SUCCESS;
+}
+
+int wmain(int argc, wchar_t **argv)
+{
+    return FspServiceRun(L"" PROGNAME, SvcStart, SvcStop, 0);
+}

3rd_party/winfsp-1.10/samples/memfs/memfs.h

@@ -0,0 +1,79 @@
+/**
+ * @file memfs.h
+ *
+ * @copyright 2015-2021 Bill Zissimopoulos
+ */
+/*
+ * This file is part of WinFsp.
+ *
+ * You can redistribute it and/or modify it under the terms of the GNU
+ * General Public License version 3 as published by the Free Software
+ * Foundation.
+ *
+ * Licensees holding a valid commercial license may use this software
+ * in accordance with the commercial license agreement provided in
+ * conjunction with the software.  The terms and conditions of any such
+ * commercial license agreement shall govern, supersede, and render
+ * ineffective any application of the GPLv3 license to this software,
+ * notwithstanding of any reference thereto in the software or
+ * associated repository.
+ */
+
+#ifndef MEMFS_H_INCLUDED
+#define MEMFS_H_INCLUDED
+
+#include <winfsp/winfsp.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+typedef struct _MEMFS MEMFS;
+
+enum
+{
+    MemfsDisk                           = 0x00000000,
+    MemfsNet                            = 0x00000001,
+    MemfsDeviceMask                     = 0x0000000f,
+    MemfsCaseInsensitive                = 0x80000000,
+    MemfsFlushAndPurgeOnCleanup         = 0x40000000,
+    MemfsLegacyUnlinkRename             = 0x20000000,
+};
+
+#define MemfsCreate(Flags, FileInfoTimeout, MaxFileNodes, MaxFileSize, VolumePrefix, RootSddl, PMemfs)\
+    MemfsCreateFunnel(\
+        Flags,\
+        FileInfoTimeout,\
+        MaxFileNodes,\
+        MaxFileSize,\
+        0/*SlowioMaxDelay*/,\
+        0/*SlowioPercentDelay*/,\
+        0/*SlowioRarefyDelay*/,\
+        0/*FileSystemName*/,\
+        VolumePrefix,\
+        RootSddl,\
+        PMemfs)
+NTSTATUS MemfsCreateFunnel(
+    ULONG Flags,
+    ULONG FileInfoTimeout,
+    ULONG MaxFileNodes,
+    ULONG MaxFileSize,
+    ULONG SlowioMaxDelay,
+    ULONG SlowioPercentDelay,
+    ULONG SlowioRarefyDelay,
+    PWSTR FileSystemName,
+    PWSTR VolumePrefix,
+    PWSTR RootSddl,
+    MEMFS **PMemfs);
+VOID MemfsDelete(MEMFS *Memfs);
+NTSTATUS MemfsStart(MEMFS *Memfs);
+VOID MemfsStop(MEMFS *Memfs);
+FSP_FILE_SYSTEM *MemfsFileSystem(MEMFS *Memfs);
+
+NTSTATUS MemfsHeapConfigure(SIZE_T InitialSize, SIZE_T MaximumSize, SIZE_T Alignment);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif