Create a helper script to turn on kernel dump gathering

Signed-off-by: Vitalii Chulak <[email protected]>

Tools/helpers/EnableKernelMemoryDump.ps1

@@ -0,0 +1,49 @@
+#  This script enables the "Always Keep Memory Dump" feature in Windows
+#  by setting the appropriate registry key.
+
+#  Copyright (c) 2024 Red Hat, Inc. and/or its affiliates. All rights reserved.
+
+#  Redistribution and use in source and binary forms, with or without
+#  modification, are permitted provided that the following conditions
+#  are met:
+#  1. Redistributions of source code must retain the above copyright
+#     notice, this list of conditions and the following disclaimer.
+#  2. Redistributions in binary form must reproduce the above copyright
+#     notice, this list of conditions and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+#  3. Neither the names of the copyright holders nor the names of their contributors
+#     may be used to endorse or promote products derived from this software
+#     without specific prior written permission.
+#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+#  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+#  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+#  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE
+#  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+#  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+#  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+#  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+#  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+#  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+#  SUCH DAMAGE.
+
+
+#  Ensure the script runs with an unrestricted execution policy (for Windows 10 and Windows Server 2016)
+#  Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope Process -Force
+
+$RegistryPath = "HKLM:\System\CurrentControlSet\Control\CrashControl"
+$ValueName = "AlwaysKeepMemoryDump"
+$ValueData = 1
+
+if (-Not (Test-Path $RegistryPath)) {
+    New-Item -Path $RegistryPath -Force | Out-Null
+}
+
+Set-ItemProperty -Path $RegistryPath -Name $ValueName -Value $ValueData -Type DWord
+
+$SetValue = Get-ItemProperty -Path $RegistryPath -Name $ValueName
+
+if ($SetValue.AlwaysKeepMemoryDump -eq $ValueData) {
+    Write-Output "Successfully set AlwaysKeepMemoryDump registry value  to $ValueData"
+} else {
+    Write-Output "Failed to set AlwaysKeepMemoryDump registry value."
+}

Tools/helpers/LICENSE

@@ -0,0 +1,28 @@
+Copyright 2024 Red Hat, Inc. and/or its affiliates.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+
+Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+Neither the name of the copyright holder nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Tools/helpers/README.md

@@ -0,0 +1,66 @@
+# Helper Scripts
+
+This directory contains various helper scripts for use with the KVM Guest Drivers for Windows.
+
+## Overview
+
+These PowerShell scripts are designed to assist with system configuration, diagnostics, and management tasks related to KVM guest drivers on Windows systems.
+
+## Current Scripts
+
+### EnableKernelMemoryDump.ps1
+
+This script enables the "Always Keep Memory Dump" feature in Windows by setting the appropriate registry key.
+
+#### What it does
+
+1. Sets the `AlwaysKeepMemoryDump` registry value to 1 under `HKLM:\System\CurrentControlSet\Control\CrashControl`.
+2. Verifies the change and outputs the result.
+
+## Planned Scripts
+
+Additional helper scripts are planned for this directory. They may include:
+
+- System information collection
+- Driver installation and management
+- Performance optimization for KVM guests
+- Troubleshooting tools
+
+## Usage Guidelines
+
+1. **Prerequisites:**
+   - PowerShell (Windows 10/Windows Server 2016 or later recommended)
+   - Administrative privileges (for scripts that modify system settings)
+   - Ensure scripts run with an appropriate execution policy:
+     ```powershell
+     Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process -Force
+     ```
+
+2. **Running Scripts:**
+   - Open PowerShell as an administrator.
+   - Navigate to the script's directory.
+   - Execute the desired script, e.g.:
+     ```powershell
+     .\ScriptName.ps1
+     ```
+
+3. **Output:**
+   - Each script will provide its own output, which may include:
+     - Console messages
+     - Log files
+     - Modified system settings
+
+## Contributing
+
+Contributions to this collection of helper scripts are welcome. If you have ideas for new scripts or improvements to existing ones, please consider the following:
+
+1. Ensure your script has a clear, descriptive name.
+2. Include detailed comments explaining the scripts purpose and usage.
+3. Follow existing style conventions and PowerShell best practices.
+4. Update this README with information about new scripts.
+5. If applicable, include error handling and logging.
+
+
+## Disclaimer
+
+These scripts may modify system settings. Use them at your own risk and always back up your system before making changes.