Add Virtual SMB shares configuration support. (#50) (Contributed by Vigilans.)

Co-authored-by: Vigilans <vigilans@foxmail.com>

Author: MouriNaruto

Documents/ConfigurationReference.md

@@ -132,6 +132,10 @@
     - Port (Number)
     - Path (String)
     - Name (String)
+  - VirtualSmbShares (Object Array)
+    - ReadOnly (Boolean)
+    - Path (String)
+    - Name (String)
 
 ### NanaBox
 
@@ -228,36 +232,39 @@ Available values: "Disabled", "Default", "List" and "Mirror"
 
 #### EnableHostDriverStore
 
-(Optional) Set it true if you want to enable readonly Plan 9 shares for several
-GPU-PV (paravirtualization) related folders from the Host OS.
+(Optional) Set it true if you want to enable readonly Plan 9 and Virtual SMB
+shares for several GPU-PV (paravirtualization) related folders from the Host OS.
 
 Note: You cannot suspend the virtual machine properly if this option is enabled.
 
 Note: All these shares are transported with Hyper-V Socket.
 
 Note: Available starting with NanaBox 1.2.
 
-Here are the exposed readonly Plan 9 shares:
+Here are the exposed readonly Plan 9 and Virtual SMB shares:
 
 - Access Name: HostDriverStore
   - Available starting with NanaBox 1.2.
   - Deprecated, reserved for compatibility with virtual machines hosted with
     previous NanaBox versions.
   - Host Path: %SystemRoot%\System32\DriverStore
-  - Hyper-V Socket Port: 50001
+  - Hyper-V Socket Port for Plan 9 share: 50001
+  - Virtual SMB share support: N/A
   - Suggested Guest Paths:
     - Windows: %SystemRoot%\System32\HostDriverStore
 - Access Name: NanaBox.HostDrivers
   - Available starting with NanaBox 1.5 Update 3.
   - Host Path: %SystemRoot%\System32\DriverStore\FileRepository
-  - Hyper-V Socket Port: 50001
+  - Hyper-V Socket Port for Plan 9 share: 50001
+  - Virtual SMB share support: Available starting with NanaBox 1.6 Update 1.
   - Suggested Guest Paths:
     - Windows: %SystemRoot%\System32\HostDriverStore\FileRepository
     - Linux: /usr/lib/wsl/drivers
 - Access Name: NanaBox.HostLxssLib
   - Available starting with NanaBox 1.5 Update 3.
   - Host Path: %SystemRoot%\System32\lxss\lib
-  - Hyper-V Socket Port: 50001
+  - Hyper-V Socket Port for Plan 9 share: 50001
+  - Virtual SMB share support: Available starting with NanaBox 1.6 Update 1.
   - Suggested Guest Paths:
     - Linux: /usr/lib/wsl/lib
 
@@ -877,6 +884,42 @@ names mentioned in "EnableHostDriverStore" related document for the current Plan
 
 Note: Available starting with NanaBox 1.5 Update 2.
 
+### VirtualSmbShares
+
+The Virtual SMB shares setting object array of virtual machine.
+
+Note: You cannot suspend the virtual machine properly if this option is enabled.
+
+Note: Available starting with NanaBox 1.6 Update 1.
+
+#### ReadOnly
+
+(Optional) Set it true if you want to make the current Virtual SMB share read-only.
+
+Note: Available starting with NanaBox 1.6 Update 1.
+
+#### Path
+
+The host path of the current Virtual SMB share.
+
+Note: The relative path is supported.
+
+Example value: "D:\\Projects"
+
+Note: Available starting with NanaBox 1.6 Update 1.
+
+#### Name
+
+The guest access name of the current Virtual SMB share.
+
+Example value: "HostProjects"
+
+Note: If you have set the "EnableHostDriverStore" true, you should not use the
+names mentioned in "EnableHostDriverStore" related document for the current
+Virtual SMB share.
+
+Note: Available starting with NanaBox 1.6 Update 1.
+
 ## Samples
 
 ### Typical Windows Virtual Machine

Documents/ConfigurationSchema.json

@@ -136,7 +136,7 @@
             },
             "EnableHostDriverStore": {
               "type": "boolean",
-              "description": "Set it true if you want to enable readonly Plan 9 shares for several GPU-PV (paravirtualization) related folders from the Host OS. You cannot suspend the virtual machine properly if this option is enabled. All these shares are transported with Hyper-V Socket. Available starting with NanaBox 1.2. Read NanaBox Configuration File Reference for more information."
+              "description": "Set it true if you want to enable readonly Plan 9 and Virtual SMB shares for several GPU-PV (paravirtualization) related folders from the Host OS. You cannot suspend the virtual machine properly if this option is enabled. All these shares are transported with Hyper-V Socket. Available starting with NanaBox 1.2. Read NanaBox Configuration File Reference for more information."
             },
             "SelectedDevices": {
               "type": "array",
@@ -401,6 +401,30 @@
                 }
               }
             }
+          },
+          "VirtualSmbShares": {
+            "type": "array",
+            "description": "The Virtual SMB shares setting object array of virtual machine. You cannot suspend the virtual machine properly if this option is enabled. Available starting with NanaBox 1.6 Update 1.",
+            "items": {
+              "type": "object",
+              "required": [ "Path", "Name" ],
+              "properties": {
+                "ReadOnly": {
+                  "type": "boolean",
+                  "description": "Set it true if you want to make the current Virtual SMB share read-only. Available starting with NanaBox 1.6 Update 1."
+                },
+                "Path": {
+                  "type": "string",
+                  "description": "The host path of the current Virtual SMB share. The relative path is supported. Available starting with NanaBox 1.6 Update 1.",
+                  "examples": [ "D:\\Projects" ]
+                },
+                "Name": {
+                  "type": "string",
+                  "description": "The guest access name of the current Virtual SMB share. If you have set the \"EnableHostDriverStore\" true, you should not use the names mentioned in \"EnableHostDriverStore\" related document for the current Virtual SMB share. Available starting with NanaBox 1.6 Update 1.",
+                  "examples": [ "HostProjects" ]
+                }
+              }
+            }
           }
         }
       }

NanaBox/ConfigurationManager.cpp

@@ -361,12 +361,20 @@ std::string NanaBox::MakeHcsConfiguration(
 
         {
             nlohmann::json Plan9Shares;
+            nlohmann::json VirtualSmbShares;
 
             if (Configuration.Gpu.EnableHostDriverStore)
             {
+                std::wstring SystemDirectoryPath(MAX_PATH, L'\0');
+                SystemDirectoryPath.resize(::GetSystemDirectoryW(
+                    SystemDirectoryPath.data(),
+                    static_cast<UINT>(SystemDirectoryPath.size())));
+
                 const std::uint32_t Plan9SharePort = 50001;
 
-                const struct { LPCSTR Name; LPCWSTR Path; } Plan9ShareItems[] =
+                typedef struct { LPCSTR Name; LPCWSTR Path; } ShareItem;
+
+                const ShareItem Plan9ShareItems[] =
                 {
                     { "HostDriverStore", L"\\DriverStore" },
                     { "NanaBox.HostDrivers", L"\\DriverStore\\FileRepository" },
@@ -375,10 +383,13 @@ std::string NanaBox::MakeHcsConfiguration(
                 const size_t Plan9ShareItemsCount =
                     sizeof(Plan9ShareItems) / sizeof(*Plan9ShareItems);
 
-                std::wstring SystemDirectoryPath(MAX_PATH, L'\0');
-                SystemDirectoryPath.resize(::GetSystemDirectoryW(
-                    SystemDirectoryPath.data(),
-                    static_cast<UINT>(SystemDirectoryPath.size())));
+                const ShareItem VirtualSmbShareItems[] =
+                {
+                    { "NanaBox.HostDrivers", L"\\DriverStore\\FileRepository" },
+                    { "NanaBox.HostLxssLib", L"\\lxss\\lib" }
+                };
+                const size_t VirtualSmbShareItemsCount =
+                    sizeof(VirtualSmbShareItems) / sizeof(*VirtualSmbShareItems);
 
                 for (size_t i = 0; i < Plan9ShareItemsCount; ++i)
                 {
@@ -398,6 +409,27 @@ std::string NanaBox::MakeHcsConfiguration(
                     Current["Flags"] = NanaBox::Plan9ShareFlags::ReadOnly;
                     Plan9Shares.push_back(Current);
                 }
+
+                for (size_t i = 0; i < VirtualSmbShareItemsCount; ++i)
+                {
+                    std::wstring SharePath(
+                        SystemDirectoryPath + VirtualSmbShareItems[i].Path);
+
+                    if (!::PathFileExistsW(SharePath.c_str()))
+                    {
+                        continue;
+                    }
+
+                    nlohmann::json Current;
+                    Current["Name"] = VirtualSmbShareItems[i].Name;
+                    Current["Path"] = Mile::ToString(CP_UTF8, SharePath);
+                    Current["Options"]["ReadOnly"] = true;
+                    Current["Options"]["ShareRead"] = true;
+                    Current["Options"]["CacheIo"] = true;
+                    Current["Options"]["PseudoOplocks"] = true;
+                    Current["Options"]["SupportCloudFiles"] = true;
+                    VirtualSmbShares.push_back(Current);
+                }
             }
 
             for (NanaBox::Plan9ShareConfiguration const& Plan9Share
@@ -413,11 +445,27 @@ std::string NanaBox::MakeHcsConfiguration(
                     : NanaBox::Plan9ShareFlags::None;
                 Plan9Shares.push_back(Current);
             }
-
             if (!Plan9Shares.empty())
             {
                 Devices["Plan9"]["Shares"] = Plan9Shares;
             }
+
+            for (NanaBox::VirtualSmbShareConfiguration const& VirtualSmbShare
+                : Configuration.VirtualSmbShares)
+            {
+                nlohmann::json Current;
+                Current["Name"] = VirtualSmbShare.Name;
+                Current["Path"] = ::GetAbsoluteUtf8Path(VirtualSmbShare.Path);
+                if (VirtualSmbShare.ReadOnly)
+                {
+                    Current["Options"]["ReadOnly"] = true;
+                    Current["Options"]["ShareRead"] = true;
+                    Current["Options"]["CacheIo"] = true;
+                    Current["Options"]["PseudoOplocks"] = true;
+                }
+                Current["Options"]["SupportCloudFiles"] = true;
+                VirtualSmbShares.push_back(Current);
+            }
         }
     }
     VirtualMachine["Devices"] = Devices;

NanaBox/NanaBox.Configuration.Parser.cpp

@@ -840,6 +840,49 @@ NanaBox::Plan9ShareConfiguration NanaBox::ToPlan9ShareConfiguration(
     return Result;
 }
 
+nlohmann::json NanaBox::FromVirtualSmbShareConfiguration(
+    VirtualSmbShareConfiguration const& Value)
+{
+    nlohmann::json Result;
+
+    if (Value.ReadOnly)
+    {
+        Result["ReadOnly"] = true;
+    }
+
+    if (!Value.Path.empty())
+    {
+        Result["Path"] = Value.Path;
+    }
+
+    if (!Value.Name.empty())
+    {
+        Result["Name"] = Value.Name;
+    }
+
+    return Result;
+}
+
+NanaBox::VirtualSmbShareConfiguration NanaBox::ToVirtualSmbShareConfiguration(
+    nlohmann::json const& Value)
+{
+    NanaBox::VirtualSmbShareConfiguration Result;
+
+    Result.ReadOnly = Mile::Json::ToBoolean(
+        Mile::Json::GetSubKey(Value, "ReadOnly"),
+        Result.ReadOnly);
+
+    Result.Path = Mile::Json::ToString(
+        Mile::Json::GetSubKey(Value, "Path"),
+        Result.Path);
+
+    Result.Name = Mile::Json::ToString(
+        Mile::Json::GetSubKey(Value, "Name"),
+        Result.Name);
+
+    return Result;
+}
+
 nlohmann::json NanaBox::FromVirtualMachineConfiguration(
     NanaBox::VirtualMachineConfiguration const& Value)
 {
@@ -983,6 +1026,23 @@ nlohmann::json NanaBox::FromVirtualMachineConfiguration(
         Result["Plan9Shares"] = Plan9Shares;
     }
 
+    if (!Value.VirtualSmbShares.empty())
+    {
+        nlohmann::json VirtualSmbShares;
+        for (NanaBox::VirtualSmbShareConfiguration const& VirtualSmbShare
+            : Value.VirtualSmbShares)
+        {
+            if (VirtualSmbShare.Path.empty() || VirtualSmbShare.Name.empty())
+            {
+                continue;
+            }
+
+            VirtualSmbShares.push_back(
+                NanaBox::FromVirtualSmbShareConfiguration(VirtualSmbShare));
+        }
+        Result["VirtualSmbShares"] = VirtualSmbShares;
+    }
+
     return Result;
 }
 
@@ -1100,5 +1160,19 @@ NanaBox::VirtualMachineConfiguration NanaBox::ToVirtualMachineConfiguration(
         Result.Plan9Shares.push_back(Current);
     }
 
+    for (nlohmann::json const& VirtualSmbShare : Mile::Json::ToArray(
+        Mile::Json::GetSubKey(Value, "VirtualSmbShares")))
+    {
+        NanaBox::VirtualSmbShareConfiguration Current =
+            NanaBox::ToVirtualSmbShareConfiguration(VirtualSmbShare);
+
+        if (Current.Path.empty() || Current.Name.empty())
+        {
+            continue;
+        }
+
+        Result.VirtualSmbShares.push_back(Current);
+    }
+
     return Result;
 }

NanaBox/NanaBox.Configuration.Parser.h

@@ -95,6 +95,12 @@ namespace NanaBox
     Plan9ShareConfiguration ToPlan9ShareConfiguration(
         nlohmann::json const& Value);
 
+    nlohmann::json FromVirtualSmbShareConfiguration(
+        VirtualSmbShareConfiguration const& Value);
+
+    VirtualSmbShareConfiguration ToVirtualSmbShareConfiguration(
+        nlohmann::json const& Value);
+
     nlohmann::json FromVirtualMachineConfiguration(
         VirtualMachineConfiguration const& Value);
 

NanaBox/NanaBox.Configuration.Specification.h

@@ -148,6 +148,13 @@ namespace NanaBox
         std::string Name;
     };
 
+    struct VirtualSmbShareConfiguration
+    {
+        bool ReadOnly = false;
+        std::string Path;
+        std::string Name;
+    };
+
     struct VirtualMachineConfiguration
     {
         std::uint32_t Version = 1;
@@ -171,6 +178,7 @@ namespace NanaBox
         VideoMonitorConfiguration VideoMonitor;
         std::vector<std::string> Policies;
         std::vector<Plan9ShareConfiguration> Plan9Shares;
+        std::vector<VirtualSmbShareConfiguration> VirtualSmbShares;
     };
 }