Initial commit

Signed-off-by: Alin Gabriel Serdean <[email protected]>

Author: aserdean

.gitignore

@@ -0,0 +1,36 @@
+#*#
+*.a
+*.d
+*.gcno
+*.gcda
+*.ko
+*.la
+*.lo
+*.loT
+*.mod.c
+*.o
+*.obj
+*.exe
+*.exp
+*.ilk
+*.lib
+*.pdb
+*.pyc
+*.retry
+*.so
+*.suo
+**/*.sym
+*~
+*,cover
+.#*
+.*.cmd
+.*.swp
+Module.symvers
+TAGS
+cscope.*
+tags
+*/.vs
+/vstudio/x64/
+/lib/ksocket_wsk/x64/
+/userspace/userspace/x64/
+

Dockerfile/Dockerfile

@@ -0,0 +1,41 @@
+# escape=`
+
+ARG WIN_VER="ltsc2019"
+
+FROM mcr.microsoft.com/windows/servercore:$WIN_VER
+
+ADD https://aka.ms/vs/16/release/vs_buildtools.exe C:\TEMP\vs_buildtools.exe
+ADD https://chocolatey.org/install.ps1 C:\TEMP\choco-install.ps1
+ADD https://go.microsoft.com/fwlink/?linkid=2085767 C:\TEMP\wdksetup.exe
+
+# Let's be explicit about the shell that we're going to use.
+SHELL ["cmd", "/S", "/C"]
+
+# Install Build Tools. A 3010 error signals that requested operation is
+# successfull but changes will not be effective until the system is rebooted.
+RUN C:\TEMP\vs_buildtools.exe --quiet --wait --norestart --nocache `
+    --installPath C:\BuildTools `
+    --add Microsoft.VisualStudio.Workload.VCTools `
+    --add Microsoft.VisualStudio.Workload.MSBuildTools `
+    --add Microsoft.VisualStudio.Component.VC.Runtimes.x86.x64.Spectre `
+    --add Microsoft.VisualStudio.Component.VC.Tools.x86.x64 `
+    --add Microsoft.VisualStudio.Component.Windows10SDK.18362 `
+    --add Microsoft.VisualStudio.Component.VC.14.24.x86.x64 `
+    --add Microsoft.VisualStudio.Component.VC.14.24.x86.x64.Spectre `
+ || IF "%ERRORLEVEL%"=="3010" EXIT 0
+
+RUN powershell C:\TEMP\choco-install.ps1
+
+RUN choco install git -y
+
+# Install WDK excluding WDK.vsix.
+RUN C:\TEMP\wdksetup.exe /q
+
+# Install WDK.vsix in manual manner.
+RUN copy "C:\Program Files (x86)\Windows Kits\10\Vsix\VS2019\WDK.vsix" C:\TEMP\wdkvsix.zip
+RUN powershell Expand-Archive C:\TEMP\wdkvsix.zip -DestinationPath C:\TEMP\wdkvsix
+RUN robocopy.exe /e "C:\temp\wdkvsix\$MSBuild\Microsoft\VC\v160" "C:\BuildTools\MSBuild\Microsoft\VC\v160" || EXIT 0
+
+SHELL ["cmd"]
+
+CMD [ "cmd","/k","c:\\BuildTools\\VC\\Auxiliary\\Build\\vcvarsall.bat", "x86_x64", "10.0.18362.0" ]

Dockerfile/Readme.md

@@ -0,0 +1,168 @@
+Windows Network Block Device (WNBD)
+===================================
+
+Build Status:
+-------------
+[![Build status](https://ci.appveyor.com/api/projects/status/2m73dxm2t7s7jlit/branch/master?svg=true)](https://ci.appveyor.com/project/aserdean/wnbd/branch/master)
+
+
+What is WNBD?
+-------------
+
+WNBD is a client side implementation of [Network Block Device](https://nbd.sourceforge.io/)
+
+Prerequisites
+-------------
+
+Visual Studio 2019 build tools or GUI ([Community version](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=Community&rel=16)  or above)
+
+[Windows Driver Kit 1909](https://docs.microsoft.com/en-us/windows-hardware/drivers/download-the-wdk)
+
+Folders
+-------
+
+* <a href="Dockerfile/">Dockerfile</a> contains a Dockerfile to create a Docker image that contains needed prerequisites
+
+* <a href="driver/">driver</a> contains the driver sources
+
+* <a href="lib/ksocket_wsk/">ksocket_wsk</a> contains the WSK implementation needed to communicate with the Network Block Device server
+
+* <a href="userspace/userspace/">userspace</a> contains a simple console application `wnbd-client` useful for testing
+
+* <a href="vstudio/">vstudio</a> contains the Visual Studio solution file and its projects
+
+How to build
+------------
+
+```
+> git clone https://github.com/aserdean/wnbd
+> msbuild wnbd\vstudio\wnbd.sln
+> copy wnbd\vstudio\x64\Debug\driver\* .
+> copy wnbd\vstudio\x64\Debug\wnbd-client.exe .
+```
+
+* You can download the latest prebuilt packages from Appveyor via the links:
+  * [Debug](https://ci.appveyor.com/api/projects/aserdean/wnbd/artifacts/wnbd-Debug.zip?job=Configuration%3A+Debug)
+  * [Release](https://ci.appveyor.com/api/projects/aserdean/wnbd/artifacts/wnbd-Release.zip?job=Configuration%3A+Release)
+
+How to install
+--------------
+
+* **Prerequisites**.
+
+  After building, the driver is automatically test signed. To install the built driver you must make sure that your target machine is Test Signed enabled first.
+  To enable Test Signing on your target machine, please issue the following from an elevated command prompt:
+  ```
+  > bcdedit.exe /set testsigning yes
+  ```
+  Please note that you can enable driver signing only if Secure Boot is not enabled on the target machine.
+  To check if your target machine does not have Secure Boot enabled issue `Confirm-SecureBootUEFI` from an elevated powershell prompt
+  ```
+  PS C:\WINDOWS\system32> Confirm-SecureBootUEFI
+  False
+  ```
+
+* **Installation/removal**.
+
+  We require [devcon.exe](https://cloudbase.it/downloads/devcon.exe) utility to install and uninstall the driver.
+
+  * To **install** the driver issue the following from an elevated command prompt:
+    ```
+    > .\devcon.exe install .\wnbd.inf root\wnbd
+    ```
+  (The command above assumes that the utility `devcon.exe` and the driver files `wnbd.inf`, `wnbd.cat`, `wnbd.sys` are in the current directory)
+
+  * To **uninstall** the driver issue the following from an elevated command prompt:
+    ```
+    .\devcon.exe remove "root\wnbd"
+    ```
+  (The command above assumes that the utility `devcon.exe` is in the current directory)
+
+  For convenience, we included <a href="vstudio/reinstall.cmd">reinstall.cmd</a> which uninstalls (ignoring the error) and installs the driver again.
+
+[Ceph integration](https://docs.ceph.com/docs/master/man/8/rbd-nbd/) [`rbd-nbd`](https://github.com/cloudbase/ceph/tree/windows)
+--------------------------
+
+
+Testing with NBD (Network Block Device)
+---------------------------------------
+
+We assume you are familiar with <a href="https://github.com/NetworkBlockDevice/nbd#using-nbd">using NBD</a>.
+
+  * `wnbd-client` syntax
+  ```
+  PS C:\workspace> .\wnbd-client.exe
+  Syntax:
+  wnbd-client map  <InstanceName> <HostName> <PortName> <ExportName> <DoNotNegotiate>
+  wnbd-client unmap <InstanceName>
+  wnbd-client list
+  ```
+
+  * NBD server configuration:
+  ```
+  root@ubuntu-Virtual-Machine:/home/ubuntu# cat /etc/nbd-server/config
+  [generic]
+  # If you want to run everything as root rather than the nbd user, you
+  # may either say "root" in the two following lines, or remove them
+  # altogether. Do not remove the [generic] section, however.
+          port = 9000
+          user = nbd
+          group = nbd
+          includedir = /etc/nbd-server/conf.d
+
+  # What follows are export definitions. You may create as much of them as
+  # you want, but the section header has to be unique.
+
+  [foo]
+      exportname = /blaz/bla.img
+      port = 9000
+      copyonwrite = true
+  root@ubuntu-Virtual-Machine:/home/ubuntu# ifconfig eth0 | grep 172
+          inet 172.17.160.251  netmask 255.255.255.240  broadcast 172.17.160.255
+  ```
+
+  * Mapping an export:
+  ```
+  PS C:\workspace> .\wnbd-client.exe map test2 172.17.160.251 9000 foo
+  InstanceName=test2
+  HostName=172.17.160.251
+  PortName=9000
+  ExportName=foo
+  MustNegociate=1
+  PS C:\workspace> Get-Disk
+
+  Number Friendly Name            Serial Number   HealthStatus         OperationalStatus      Total Size Partition
+                                                                                                        Style
+  ------ -------------            -------------   ------------         -----------------      ---------- ----------
+  0      Msft Virtual Disk                        Healthy              Online                     127 GB GPT
+  1      WNBD Dis WNBD_DISK_ID    test2           Healthy              Online                     256 MB RAW
+  ```
+
+  * Listing the mapped device
+  ```
+  PS C:\workspace> .\wnbd-client.exe list
+  Status: 0
+  InstanceName    Pid     DiskNumber
+  test2           6712            1
+  ```
+
+  * Unmapping the device
+  ```
+  PS C:\workspace> .\wnbd-client.exe unmap test2
+  PS C:\workspace> Get-Disk
+
+  Number Friendly Name             Serial Number    HealthStatus         OperationalStatus      Total Size Partition
+                                                                                                          Style
+  ------ -------------             -------------    ------------         -----------------      ---------- ----------
+  0      Msft Virtual Disk                          Healthy              Online                     127 GB GPT
+
+```
+
+What other documentation is available?
+--------------------------------------
+
+Build via docker
+
+- [BUILD.Docker.md]
+
+[BUILD.Docker.md]:Dockerfile/Readme.md

LICENSE

@@ -0,0 +1,22 @@
+version: 1.0.{build}
+image: Visual Studio 2019
+branches:
+  only:
+  - master
+configuration:
+  - Debug
+  - Release
+clone_folder: C:\wnbd
+init:
+- ps: $env:PATH ="C:\Python37;"+$env:PATH
+- ps: New-Item -Type HardLink -Path "C:\Python37\python3.exe" -Value "C:\Python37\python.exe"
+
+build_script:
+- '"C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvarsx86_amd64.bat"'
+- msbuild C:\wnbd\vstudio\wnbd.sln /property:Configuration=%CONFIGURATION%
+- copy C:\wnbd\vstudio\x64\%CONFIGURATION%\driver\* .
+- 7z a wnbd-%CONFIGURATION%.zip C:\wnbd\vstudio\x64\%CONFIGURATION%\driver\wnbd.cat C:\wnbd\vstudio\x64\%CONFIGURATION%\driver\wnbd.inf C:\wnbd\vstudio\x64\%CONFIGURATION%\driver\wnbd.sys C:\wnbd\vstudio\x64\%CONFIGURATION%\wnbd-client.exe
+
+artifacts:
+  - path: wnbd-%CONFIGURATION%.zip
+    name: wnbd

README.md

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2019 SUSE LLC
+ *
+ * Licensed under LGPL-2.1 (see LICENSE)
+ */
+
+#ifndef COMMON_H
+#define COMMON_H 1
+
+#include <wdm.h>
+#include <storport.h>
+#include <devioctl.h>
+#include <ntstatus.h>
+#include <ntddscsi.h>
+#include <ntintsafe.h>
+#include <ntstrsafe.h>
+
+#endif

appveyor.yml

@@ -0,0 +1,39 @@
+/*
+ * Copyright (c) 2019 SUSE LLC
+ *
+ * Licensed under LGPL-2.1 (see LICENSE)
+ */
+
+#include <ntstatus.h>
+#include <ntstrsafe.h>
+#include <wdm.h>
+
+#include "debug.h"
+
+#define WNBD_LOG_BUFFER_SIZE 512
+#define WNBD_DBG_DEFAULT     WNBD_DBG_INFO
+
+UINT32  WnbdLogLevel = WNBD_DBG_DEFAULT;
+
+_Use_decl_annotations_
+VOID
+WnbdLog(UINT32 Level,
+        PCHAR FuncName,
+        UINT32 Line,
+        PCHAR Format,
+        ...)
+{
+    va_list Args;
+    CHAR Buf[WNBD_LOG_BUFFER_SIZE];
+
+    if (Level > WnbdLogLevel) {
+        return;
+    }
+
+    Buf[0] = 0;
+    va_start(Args, Format);
+    RtlStringCbVPrintfA(Buf, sizeof(Buf), Format, Args);
+    va_end(Args);
+
+    DbgPrintEx(DPFLTR_SCSIMINIPORT_ID, Level, "%s:%lu %s\n", FuncName, Line, Buf);
+}

driver/common.h

@@ -0,0 +1,55 @@
+/*
+ * Copyright (c) 2019 SUSE LLC
+ *
+ * Licensed under LGPL-2.1 (see LICENSE)
+ */
+
+#ifndef DEBUG_H
+#define DEBUG_H 1
+
+#include <ntdef.h>
+#include <wdm.h>
+
+ //TODO remove
+#if DBG
+#define OVERRIDE_LOUD
+#endif
+
+#ifndef OVERRIDE_LOUD
+#define WNBD_DBG_ERROR    DPFLTR_ERROR_LEVEL
+#define WNBD_DBG_WARN     DPFLTR_WARNING_LEVEL
+#define WNBD_DBG_TRACE    DPFLTR_TRACE_LEVEL
+#define WNBD_DBG_INFO     DPFLTR_INFO_LEVEL
+#define WNBD_DBG_LOUD     (DPFLTR_INFO_LEVEL + 1)
+#else
+#define WNBD_DBG_ERROR    DPFLTR_ERROR_LEVEL
+#define WNBD_DBG_WARN     DPFLTR_ERROR_LEVEL
+#define WNBD_DBG_TRACE    DPFLTR_ERROR_LEVEL
+#define WNBD_DBG_INFO     DPFLTR_ERROR_LEVEL
+#define WNBD_DBG_LOUD     DPFLTR_ERROR_LEVEL
+#endif
+
+
+
+VOID
+WnbdLog(_In_ UINT32 Level,
+        _In_ PCHAR FuncName,
+        _In_ UINT32 Line,
+        _In_ PCHAR Format, ...);
+
+#define WNBD_LOG_LOUD(_format, ...) \
+   WnbdLog(WNBD_DBG_LOUD, __FUNCTION__, __LINE__, _format,  __VA_ARGS__)
+
+#define WNBD_LOG_INFO(_format, ...) \
+   WnbdLog(WNBD_DBG_INFO, __FUNCTION__, __LINE__, _format, __VA_ARGS__)
+
+#define WNBD_LOG_TRACE(_format, ...) \
+   WnbdLog(WNBD_DBG_TRACE, __FUNCTION__, __LINE__, _format, __VA_ARGS__)
+
+#define WNBD_LOG_ERROR(_format, ...) \
+   WnbdLog(WNBD_DBG_ERROR, __FUNCTION__, __LINE__, _format, __VA_ARGS__)
+
+#define WNBD_LOG_WARN(_format, ...) \
+   WnbdLog(WNBD_DBG_WARN, __FUNCTION__, __LINE__, _format, __VA_ARGS__)
+
+#endif