biswa96/hvtool

Experiments with Hyper-V VM and container managing APIs.

hvtool

Experiments with Hyper-V VM and container managing APIs.

How to build

Clone this repository. Open the solution (.sln) or project (.vcxproj) file in Visual Studio and build it. Alternatively, run Visual Studio developer command prompt, go to the cloned folder and run msbuild command. This project can also be built with mingw-w64 toolchain. Open terminal in the cloned folder and run make command. The binaries will be in /bin folder.

Build export libraries:

• Generate DEF file:

gendef /c/Windows/System32/computecore.dll

• For MSVC:

lib /DEF:computecore.def /MACHINE:X64

• For mingw-w64/GCC:

dlltool -D /c/Windows/System32/computecore.dll -d computecore.def -l libcomputecore.a

How to use

All the APIs require administrator privilege or user need to be member of Hyper-V Administrators group. Here are the valid options for hvtool:

Usage: %ls [options] [agruments]
Options:
  endp       Get list of network endpoints.
  help       Show this usage information.
  list       Get list of containers.
  net        Get list of networks.
  kill       Container ID
             Kill the specified container.
  pause      Container ID
             Pause the specified container.
  resume     Container ID
             Resume the specified container.
  shutdown   Container ID
             Shutdown the specified container (for VM only).
  wsl        Get Windows side IPv4 address connected with WSL2 VM.
The Container argument can be found in "list" option output.

Project layout

• hcn: Function declarations of Hyper-V Host Networking Service Client Library.
• hcs: Function declarations of Hyper-V Host Compute Service Core Client Library.
• helper: Helper functions for logging.
• hvtool: Wrapper functions which calls underlying APIs.
• jsmn: Small JSON parser/tokenizer.

License

hvtool is licensed under the GNU General Public License v3. A full copy of the license is provided in LICENSE.

hvtool -- Experiments with Hyper-V VM and container managing APIs.
Copyright (C) 2019 Biswapriyo Nath

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

hvtool's Issues

Is HcsCreateOperation needed?

hvtool uses HcsCreateOperation(NULL, NULL).

e.g. here:

    hcsOperation = HcsCreateOperation(NULL, NULL);
    hRes = HcsEnumerateComputeSystems(NULL, hcsOperation);
    hRes = HcsWaitForOperationResult(hcsOperation, INFINITE, &result);

Is it needed? Why?