update Changelog

Changelog.asciidoc

@@ -1,6 +1,17 @@
 = Changelog
 
 
+v1.0::
+
+This is the WinFsp 2017 release! :tada:
+
+- The API is now *FROZEN*. Breaking API changes will receive a major version update (`2.0`). Incremental API changes will receive a minor version update (`1.x`).
+- Adds chocolatey package. Try `choco install winfsp` (note: pending approval from chocolatey.org).
+- FUSE `-d` output now always goes to stderr. There is also a new `-oDebugLog=FILE` switch to specify a debug output file.
+- FUSE now provides a default `statfs` implementation if a file system does not provide one.
+- The WinFsp DLL now exports `fuse_*` symbols in addition to the `fsp_fuse_*` symbols. These symbols are for use with programs that use FFI technology such as jnr-fuse and fusepy *ONLY*. They are not supposed to be used by native C/C++ programs. Such programs are supposed to include the `<fuse.h>` headers.
+
+
 v1.0RC3::
 
 This is the WinFsp 2017 Release Candidate 3, which should be the last Release Candidate according to the current plan. This release fixes a major issue with some file systems and includes a few smaller changes:

appveyor.yml

@@ -23,7 +23,7 @@ build_script:
 - tools\build.bat %CONFIGURATION%
 
 test_script:
-- for %%f in ("build\VStudio\build\%CONFIGURATION%\winfsp-*.msi") do start /wait msiexec /i %%f /qn INSTALLLEVEL=1000
+- choco install winfsp -s build\VStudio\build\%CONFIGURATION% -y
 - if %TESTING%==Func appveyor DownloadFile http://www.secfs.net/winfsp/resources/Test.Filter.Driver.zip && 7z x Test.Filter.Driver.zip
 - if %TESTING%==Func start /wait msiexec /i "Test.Filter.Driver\HCK Filter.Driver Content-x86_en-us.msi" /qn
 - if %TESTING%==Func tools\nmake-ext-test.bat %CONFIGURATION%
@@ -31,6 +31,7 @@ test_script:
 - if %TESTING%==Func tools\run-tests.bat %CONFIGURATION% ifstest
 - if %TESTING%==Func tools\run-tests.bat %CONFIGURATION% sample
 - if %TESTING%==Perf tools\run-perf-tests.bat %CONFIGURATION% baseline > perf-tests.csv && type perf-tests.csv & appveyor PushArtifact perf-tests.csv
+- choco uninstall winfsp -y
 - if exist %SystemRoot%\memory.dmp exit 1
 
 on_finish:

build/VStudio/version.properties

@@ -17,8 +17,8 @@
 
         <MyCanonicalVersion>1.0</MyCanonicalVersion>
 
-        <MyProductVersion>2017 RC3</MyProductVersion>
-        <MyProductStage>RC</MyProductStage>
+        <MyProductVersion>2017</MyProductVersion>
+        <MyProductStage>Gold</MyProductStage>
 
         <MyVersion>$(MyCanonicalVersion).$(MyBuildNumber)</MyVersion>
         <MyVersionWithCommas>$(MyVersion.Replace('.',',')),0</MyVersionWithCommas>

build/VStudio/winfsp_dll.vcxproj

@@ -34,6 +34,7 @@
     <ClCompile Include="..\..\src\dll\dirbuf.c" />
     <ClCompile Include="..\..\src\dll\eventlog.c" />
     <ClCompile Include="..\..\src\dll\fuse\fuse.c" />
+    <ClCompile Include="..\..\src\dll\fuse\fuse_compat.c" />
     <ClCompile Include="..\..\src\dll\fuse\fuse_intf.c" />
     <ClCompile Include="..\..\src\dll\fuse\fuse_main.c" />
     <ClCompile Include="..\..\src\dll\fuse\fuse_opt.c" />

build/VStudio/winfsp_dll.vcxproj.filters

@@ -106,6 +106,9 @@
     <ClCompile Include="..\..\src\dll\dirbuf.c">
       <Filter>Source</Filter>
     </ClCompile>
+    <ClCompile Include="..\..\src\dll\fuse\fuse_compat.c">
+      <Filter>Source\fuse</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <None Include="..\..\src\dll\library.def">

build/choco/chocolateyBeforeModify.ps1

@@ -0,0 +1,36 @@
+$ErrorActionPreference = 'Stop';
+
+$packageName = 'winfsp'
+$softwareName = 'WinFsp*'
+$installerType = 'msi'
+$silentArgs = '/qn /norestart'
+$validExitCodes = @(0, 3010, 1605, 1614, 1641)
+
+[array]$key = Get-UninstallRegistryKey -SoftwareName $softwareName
+
+if ($key.Count -eq 1) {
+    $key | % {
+        # The Product Code GUID is all that should be passed for MSI, and very
+        # FIRST, because it comes directly after /x, which is already set in the
+        # Uninstall-ChocolateyPackage msiargs (facepalm).
+        $silentArgs = "$($_.PSChildName) $silentArgs"
+
+        # Don't pass anything for file, it is ignored for msi (facepalm number 2)
+        # Alternatively if you need to pass a path to an msi, determine that and
+        # use it instead of the above in silentArgs, still very first
+        $file = ''
+
+        Uninstall-ChocolateyPackage `
+            -PackageName $packageName `
+            -FileType $installerType `
+            -SilentArgs "$silentArgs" `
+            -ValidExitCodes $validExitCodes `
+            -File "$file"
+    }
+} elseif ($key.Count -eq 0) {
+    Write-Warning "$packageName has already been uninstalled by other means."
+} elseif ($key.Count -gt 1) {
+    Write-Warning "Too many matching packages found! Package may not be uninstalled."
+    Write-Warning "Please alert package maintainer the following packages were matched:"
+    $key | % {Write-Warning "- $_"}
+}

build/choco/chocolateyInstall.ps1

@@ -0,0 +1,16 @@
+$ErrorActionPreference = 'Stop';
+
+$toolsDir           = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
+$fileLocation       = @(Get-ChildItem $toolsDir -filter winfsp-*.msi)[0].FullName
+
+$packageArgs = @{
+    packageName     = 'winfsp'
+    fileType        = 'msi'
+    file            = $fileLocation
+    silentArgs      = "/qn /norestart INSTALLLEVEL=1000"
+    validExitCodes  = @(0, 3010, 1641)
+}
+
+Install-ChocolateyInstallPackage @packageArgs
+
+Remove-Item -Force $packageArgs.file

build/choco/winfsp.nuspec

@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="utf-8"?>
+<package xmlns="http://schemas.microsoft.com/packaging/2015/06/nuspec.xsd">
+    <metadata>
+        <id>winfsp</id>
+        <version>$version$</version>
+        <packageSourceUrl>https://github.com/billziss-gh/winfsp/tree/master/build/choco</packageSourceUrl>
+        <owners>Bill Zissimopoulos &lt;billziss at navimatics.com&gt;</owners>
+
+        <title>WinFsp</title>
+        <authors>Bill Zissimopoulos &lt;billziss at navimatics.com&gt;</authors>
+        <projectUrl>https://github.com/billziss-gh/winfsp</projectUrl>
+        <iconUrl>https://github.com/billziss-gh/winfsp/raw/master/art/winfsp-solid.png</iconUrl>
+        <copyright>Bill Zissimopoulos</copyright>
+        <licenseUrl>https://github.com/billziss-gh/winfsp/blob/master/License.txt</licenseUrl>
+        <requireLicenseAcceptance>false</requireLicenseAcceptance>
+        <projectSourceUrl>https://github.com/billziss-gh/winfsp</projectSourceUrl>
+        <docsUrl>https://github.com/billziss-gh/winfsp/tree/master/doc</docsUrl>
+        <mailingListUrl>https://groups.google.com/forum/#!forum/winfsp</mailingListUrl>
+        <bugTrackerUrl>https://github.com/billziss-gh/winfsp/issues</bugTrackerUrl>
+        <tags>driver filesystem fuse gplv3 windows-kernel admin</tags>
+        <summary>Windows File System Proxy - FUSE for Windows</summary>
+        <description>
+WinFsp is a set of software components for Windows computers that allows the creation of user mode file systems. In this sense it is similar to FUSE (Filesystem in Userspace), which provides the same functionality on UNIX-like computers.
+
+Some of the benefits of using WinFsp are listed below:
+
+* Very well-tested and stable.
+* Very fast.
+* Strives for compatibility with NTFS.
+* Easy to understand but comprehensive API.
+* FUSE compatibility layer for native Windows and Cygwin.
+* Signed drivers provided on every release.
+* Available under the GPLv3 license with a special exception for Free/Libre and Open Source Software.
+        </description>
+        <releaseNotes>https://github.com/billziss-gh/winfsp/blob/master/Changelog.asciidoc</releaseNotes>
+
+        <!--<dependencies>
+            <dependency id="chocolatey-uninstall.extension" />
+        </dependencies>-->
+    </metadata>
+
+    <files>
+        <file src="chocolateyInstall.ps1" target="tools" />
+        <file src="chocolateyBeforeModify.ps1" target="tools" />
+        <file src="winfsp-$version$.msi" target="tools" />
+    </files>
+</package>

doc/WinFsp-Tutorial.asciidoc

@@ -112,7 +112,7 @@ usage: passthrough OPTIONS
 
 options:
     -d DebugFlags       [-1: enable all debug logs]
-    -D DebugLogFile     [file path; use - for stdout]
+    -D DebugLogFile     [file path; use - for stderr]
     -u \Server\Share    [UNC prefix (single backslash)]
     -p Directory        [directory to expose as pass through file system]
     -m MountPoint       [X:|*|directory]
@@ -138,7 +138,7 @@ The variable `DebugLogFile` is used to control the WinFsp debug logging mechanis
     if (0 != DebugLogFile)
     {
         if (0 == wcscmp(L"-", DebugLogFile))
-            DebugLogHandle = GetStdHandle(STD_OUTPUT_HANDLE);
+            DebugLogHandle = GetStdHandle(STD_ERROR_HANDLE);
         else
             DebugLogHandle = CreateFileW(
                 DebugLogFile,

inc/winfsp/winfsp.h

@@ -26,7 +26,10 @@
 #include <windows.h>
 #undef WIN32_NO_STATUS
 #include <winternl.h>
+#pragma warning(push)
+#pragma warning(disable:4005)           /* macro redefinition */
 #include <ntstatus.h>
+#pragma warning(pop)
 
 #if defined(WINFSP_DLL_INTERNAL)
 #define FSP_API                         __declspec(dllexport)
@@ -1642,6 +1645,18 @@ NTSTATUS FspLoad(PVOID *PModule)
 #endif
 #define FSP_DLLPATH                     "bin\\" FSP_DLLNAME
 
+    WINADVAPI
+    LSTATUS
+    APIENTRY
+    RegGetValueW(
+        HKEY hkey,
+        LPCWSTR lpSubKey,
+        LPCWSTR lpValue,
+        DWORD dwFlags,
+        LPDWORD pdwType,
+        PVOID pvData,
+        LPDWORD pcbData);
+
     WCHAR PathBuf[MAX_PATH];
     DWORD Size;
     HKEY RegKey;

src/dll/fsop.c

@@ -1354,7 +1354,7 @@ FSP_API BOOLEAN FspFileSystemFindReparsePoint(FSP_FILE_SYSTEM *FileSystem,
     return FALSE;
 }
 
-FSP_API NTSTATUS FspFileSystemResolveReparsePointsInternal(FSP_FILE_SYSTEM *FileSystem,
+static NTSTATUS FspFileSystemResolveReparsePointsInternal(FSP_FILE_SYSTEM *FileSystem,
     NTSTATUS (*GetReparsePointByName)(
         FSP_FILE_SYSTEM *FileSystem, PVOID Context,
         PWSTR FileName, BOOLEAN IsDirectory, PVOID Buffer, PSIZE_T PSize),

src/dll/fuse/fuse.c

@@ -32,6 +32,7 @@ struct fsp_fuse_core_opt_data
 {
     struct fsp_fuse_env *env;
     int help, debug;
+    HANDLE DebugLogHandle;
     int set_umask, umask,
         set_uid, uid,
         set_gid, gid,
@@ -52,6 +53,8 @@ static struct fuse_opt fsp_fuse_core_opts[] =
     FSP_FUSE_CORE_OPT("-d", debug, 1),
     FSP_FUSE_CORE_OPT("debug", debug, 1),
 
+    FUSE_OPT_KEY("DebugLog=", 'D'),
+
     FUSE_OPT_KEY("hard_remove", FUSE_OPT_KEY_DISCARD),
     FUSE_OPT_KEY("use_ino", FUSE_OPT_KEY_DISCARD),
     FUSE_OPT_KEY("readdir_ino", FUSE_OPT_KEY_DISCARD),
@@ -450,6 +453,7 @@ static int fsp_fuse_core_opt_proc(void *opt_data0, const char *arg, int key,
     case 'h':
         FspServiceLog(EVENTLOG_ERROR_TYPE, L""
             FSP_FUSE_LIBRARY_NAME " options:\n"
+            "    -o DebugLog=FILE           debug log file (deflt: stderr)\n"
             "    -o SectorSize=N            sector size for Windows (512-4096, deflt: 4096)\n"
             "    -o SectorsPerAllocationUnit=N  sectors per allocation unit (deflt: 1)\n"
             "    -o MaxComponentLength=N    max file name component length (deflt: 255)\n"
@@ -466,6 +470,17 @@ static int fsp_fuse_core_opt_proc(void *opt_data0, const char *arg, int key,
             FUSE_MAJOR_VERSION, FUSE_MINOR_VERSION);
         opt_data->help = 1;
         return 1;
+    case 'D':
+        arg += sizeof "DebugLog=" - 1;
+        opt_data->DebugLogHandle = CreateFileA(
+            arg,
+            FILE_APPEND_DATA,
+            FILE_SHARE_READ | FILE_SHARE_WRITE,
+            0,
+            OPEN_ALWAYS,
+            FILE_ATTRIBUTE_NORMAL,
+            0);
+        return 0;
     case 'U':
         if ('U' == arg[2])
             arg += sizeof "--UNC=" - 1;
@@ -508,6 +523,7 @@ FSP_FUSE_API struct fuse *fsp_fuse_new(struct fsp_fuse_env *env,
 
     memset(&opt_data, 0, sizeof opt_data);
     opt_data.env = env;
+    opt_data.DebugLogHandle = GetStdHandle(STD_ERROR_HANDLE);
     opt_data.VolumeParams.FileInfoTimeout = 1000;   /* default FileInfoTimeout for FUSE file systems */
 
     if (-1 == fsp_fuse_opt_parse(env, args, &opt_data, fsp_fuse_core_opts, fsp_fuse_core_opt_proc))
@@ -515,6 +531,16 @@ FSP_FUSE_API struct fuse *fsp_fuse_new(struct fsp_fuse_env *env,
     if (opt_data.help)
         return 0;
 
+    if (opt_data.debug)
+    {
+        if (INVALID_HANDLE_VALUE == opt_data.DebugLogHandle)
+        {
+            ErrorMessage = L": cannot open debug log file.";
+            goto fail;
+        }
+        FspDebugLogSetHandle(opt_data.DebugLogHandle);
+    }
+
     if ((opt_data.set_uid && -1 == opt_data.uid) ||
         (opt_data.set_gid && -1 == opt_data.gid))
     {

src/dll/fuse/fuse_compat.c

@@ -0,0 +1,35 @@
+/**
+ * @file dll/fuse/fuse_compat.c
+ *
+ * @copyright 2015-2017 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 file in
+ * accordance with the commercial license agreement provided with the
+ * software.
+ */
+
+#include <dll/library.h>
+
+/*
+ * This file provides an implementation of the `fuse_*` symbols. This
+ * implementation is a simple shim that forwards `fuse_*` calls to the
+ * equivalent `fsp_fuse_*` ones using a default `fsp_fuse_env`.
+ *
+ * These symbols should *not* be used by C/C++ programs. For this reason
+ * the `fuse.h` headers only expose the `fsp_fuse_*` symbols, wrapped
+ * with macros. These symbols are for use only from programs using FFI
+ * technology to access FUSE symbols (e.g. fusepy, jnr-fuse).
+ */
+
+#define FSP_FUSE_API
+#define FSP_FUSE_SYM(proto, ...)        __declspec(dllexport) proto { __VA_ARGS__ }
+#include <fuse/fuse_common.h>
+#include <fuse/fuse.h>
+#include <fuse/fuse_opt.h>

src/dll/fuse/fuse_intf.c

@@ -636,13 +636,13 @@ static NTSTATUS fsp_fuse_intf_GetVolumeInfo(FSP_FILE_SYSTEM *FileSystem,
     struct fuse_statvfs stbuf;
     int err;
 
-    if (0 == f->ops.statfs)
-        return STATUS_INVALID_DEVICE_REQUEST;
-
     memset(&stbuf, 0, sizeof stbuf);
-    err = f->ops.statfs("/", &stbuf);
-    if (0 != err)
-        return fsp_fuse_ntstatus_from_errno(f->env, err);
+    if (0 != f->ops.statfs)
+    {
+        err = f->ops.statfs("/", &stbuf);
+        if (0 != err)
+            return fsp_fuse_ntstatus_from_errno(f->env, err);
+    }
 
     VolumeInfo->TotalSize = (UINT64)stbuf.f_blocks * (UINT64)stbuf.f_frsize;
     VolumeInfo->FreeSize = (UINT64)stbuf.f_bfree * (UINT64)stbuf.f_frsize;

tools/build.bat

@@ -1,6 +1,7 @@
 @echo off
 
 setlocal
+setlocal EnableDelayedExpansion
 
 set MsiName="WinFsp - Windows File System Proxy"
 set CrossCert="%~dp0DigiCert High Assurance EV Root CA.crt"
@@ -19,6 +20,7 @@ if not X%SignedPackage%==X (
     if not exist "%~dp0..\build\VStudio\build\%Configuration%\winfsp-*.msi" (echo previous build not found >&2 & exit /b 1)
     if not exist "%SignedPackage%" (echo signed package not found >&2 & exit /b 1)
     del "%~dp0..\build\VStudio\build\%Configuration%\winfsp-*.msi"
+    if exist "%~dp0..\build\VStudio\build\%Configuration%\winfsp.*.nupkg" del "%~dp0..\build\VStudio\build\%Configuration%\winfsp.*.nupkg"
     for /R "%SignedPackage%" %%f in (*.sys) do (
         copy "%%f" "%~dp0..\build\VStudio\build\%Configuration%" >nul
     )
@@ -81,6 +83,16 @@ for %%f in (build\%Configuration%\winfsp-*.msi) do (
 
 if not %signfail%==0 echo SIGNING FAILED! The product has been successfully built, but not signed.
 
+where /q choco.exe
+if %ERRORLEVEL% equ 0 (
+    for %%f in (build\%Configuration%\winfsp-*.msi) do set Version=%%~nf
+    set Version=!Version:winfsp-=!
+
+    copy ..\choco\* build\%Configuration%
+    choco pack build\%Configuration%\winfsp.nuspec --version=!Version! --outputdirectory=build\%Configuration%
+    if errorlevel 1 goto fail
+)
+
 exit /b 0
 
 :fail

tst/memfs/memfs-main.c

@@ -106,7 +106,7 @@ NTSTATUS SvcStart(FSP_SERVICE *Service, ULONG argc, PWSTR *argv)
     if (0 != DebugLogFile)
     {
         if (0 == wcscmp(L"-", DebugLogFile))
-            DebugLogHandle = GetStdHandle(STD_OUTPUT_HANDLE);
+            DebugLogHandle = GetStdHandle(STD_ERROR_HANDLE);
         else
             DebugLogHandle = CreateFileW(
                 DebugLogFile,
@@ -184,7 +184,7 @@ usage:
         "\n"
         "options:\n"
         "    -d DebugFlags       [-1: enable all debug logs]\n"
-        "    -D DebugLogFile     [file path; use - for stdout]\n"
+        "    -D DebugLogFile     [file path; use - for stderr]\n"
         "    -i                  [case insensitive file system]\n"
         "    -t FileInfoTimeout  [millis]\n"
         "    -n MaxFileNodes\n"

tst/passthrough/passthrough.c

@@ -846,7 +846,7 @@ static NTSTATUS SvcStart(FSP_SERVICE *Service, ULONG argc, PWSTR *argv)
     if (0 != DebugLogFile)
     {
         if (0 == wcscmp(L"-", DebugLogFile))
-            DebugLogHandle = GetStdHandle(STD_OUTPUT_HANDLE);
+            DebugLogHandle = GetStdHandle(STD_ERROR_HANDLE);
         else
             DebugLogHandle = CreateFileW(
                 DebugLogFile,
@@ -903,7 +903,7 @@ usage:
         "\n"
         "options:\n"
         "    -d DebugFlags       [-1: enable all debug logs]\n"
-        "    -D DebugLogFile     [file path; use - for stdout]\n"
+        "    -D DebugLogFile     [file path; use - for stderr]\n"
         "    -u \\Server\\Share    [UNC prefix (single backslash)]\n"
         "    -p Directory        [directory to expose as pass through file system]\n"
         "    -m MountPoint       [X:|*|directory]\n";