Add Svr2019, Svr2022 and Win11 to Inf2Cat

Signed-off-by: Owen Smith <owen.smith@citrix.com>

Add /CETCOMPAT to linker options

Signed-off-by: Owen Smith <owen.smith@citrix.com>

Fix CodeQL warnings

- ExAllocatePoolWithTag is deprecated in Win10 2004, use
    ExAllocatePoolUninitialized instead

Signed-off-by: Owen Smith <owen.smith@citrix.com>

Fix SDV/CodeQL log generation

- sarif files need to be stored with SDV logs when generating the DVL file
- Disable PREFast and CodeAnalysis by default
- Run a seperate CodeAnalysis build after SDV, but before generating DVL file
    DVL file should contain multiple summary lines for SDV, at least 1 line
    for CodeAnalysis and at least 1 line for Semmle (CodeQL)

Signed-off-by: Owen Smith <owen.smith@citrix.com>

Document CodeQL build requirements

CodeQL requires an additional tool and rule set which are seperate from the
EWDK ISOs, and require manual installation and configuration

Signed-off-by: Owen Smith <owen.smith@citrix.com>

Fix build with later WDKs

- Adds alias for GetProjectInfoForReference target to version.vcxproj
    Later kits seemed to have renamed the build target, and will fail without
    this alias target.
- Adds "/fd sha256" to signtool command line
    WDK 20344 and later require binaries signed with a SHA256 file digest, or
    the build outputs are deleted

Signed-off-by: Owen Smith <owen.smith@citrix.com>
- Squash warnings 4061 (in xencons.vcxproj) and 26052 (in
  xencons_monitor.vcxproj) to avoid bogus noise.

Signed-off-by: Paul Durrant <paul@xen.org>

Add CodeQL build stage

CodeQL logs will be required for future WHQL submissions. Add a stage
that generates the required SARIF files. CodeQL is a semantic code
analysis engine, which will highlight vunerabilities that will need
fixing.

In order to use CodeQL, the CodeQL binaries must be on the path and the
Windows-Driver-Developer-Supplemental-Tools must be on the path defined
by the CODEQL_QUERY_SUITE environment variable (if defined), or under
the parent folder (if CODEQL_QUERY_SUITE variable is not defined)

Note: Due to the way the codeql command line is built, using quotes in a
MSBuild command line is not possible, so generate a batch file to wrap
the command line.

Signed-off-by: Owen Smith <owen.smith@citrix.com>

Bring XENBUS interface versions up to date...

... and update binding accordingly.

Signed-off-by: Paul Durrant <pdurrant@amazon.com>

Inherit versioning info from environment if present

As the drivers stabilize and mature, there is an ever-growing
chance that other opensource virtualization projects will adopt
them. Allow external projects to inject their own versioning
into the drivers instead of hardcoding the latest winpv version.

Signed-off-by: Nicholas Tsirakis <tsirakisn@ainfosec.com>
Acked-by: Owen Smith <owen.smith@citrix.com>

Allow user to specify desired build architecture

Often times we only need to build a driver for a single
targeted architecture. Continue to build both by default,
but allow the user to specify one if desired.

Signed-off-by: Nicholas Tsirakis <tsirakisn@ainfosec.com>
Use [string]::IsNullOrEmpty($Arch)

Signed-off-by: Paul Durrant <paul@xen.org>

Don't pass MM_DONT_ZERO_ALLOCATION to MmAllocatePagesForMdlEx()...

...in __AllocatePages()

See commit 4f85d004 "Replace uses of MmAllocatePagesForMdlEx in
__AllocatePage" in XENVIF for more background.

In summary, it is to avoid BSOD 139 1e with a stack similar to the following:

nt!KeBugCheckEx
nt!KiBugCheckDispatch+0x69
nt!KiFastFailDispatch+0xd0
nt!KiRaiseSecurityCheckFailure+0x30e
nt!KiAcquireThreadStateLock+0x11fa90
nt!KeSetIdealProcessorThreadEx+0xd0
nt!MiZeroInParallelWorker+0x115016
nt!MiZeroInParallel+0x11c
nt!MiInitializeMdlBatchPages+0x2ae
nt!MiAllocatePagesForMdl+0x192
nt!MmAllocatePartitionNodePagesForMdlEx+0xc9
nt!MmAllocatePagesForMdlEx+0x4d

These bugchecks have been observed in recent updates of Server 2019.

This patch, rather than replacing calls to MmAllocatePagesForMdlEx() with
calls to MmMapLockedPagesSpecifyCache(), just avoids passing
MM_DONT_ZERO_ALLOCATION to work round the bug.

The patch instead passes MM_ALLOCATE_FULLY_REQUIRED, which arguably should
have always been passed for allocations larger than a single page. It also
fixes a formatting issue.

Reported-by: Jan Bakuwel <jan.bakuwel@gmail.com>
Signed-off-by: Paul Durrant <pdurrant@amazon.com>

Handle return codes from MSBuild

If MSBuild fails, it returns a non-zero return value. Forward this
failure to the calling scripts to fail earlier.

Signed-off-by: Owen Smith <owen.smith@citrix.com>

MAINTAINERS: Update my email address

My @amazon.com address is no longer convenient to use.

Signed-off-by: Paul Durrant <paul@xen.org>

bump version to 9.1.0

Now that 9.0 is branched (in staging-9.0) the master version needs to be
advanced.

Signed-off-by: Paul Durrant <pdurrant@amazon.com>

MAINTAINERS: Update my email address

Signed-off-by: Paul Durrant <pdurrant@amazon.com>

Add option to elevate administrator users

If the user has Administrator access, add a prompt and ability to
elevate the access to the Administrator privilege level instead of
retaining the user privilege level.

Signed-off-by: Owen Smith <owen.smith@citrix.com>
[squashed 'Improve elevation prompts']
Signed-off-by: Paul Durrant <paul@xen.org>

Don't store password longer than required

Signed-off-by: Owen Smith <owen.smith@citrix.com>

Add support for EWDK_19h1_release_svc_prod3_18362_190416-1111

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

MAINTAINERS: Update my email address

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Remove the old python build scripts and document use of the EWDK

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Use genfiles to set DriverVer

Signed-off-by: Owen Smith <owen.smith@citrix.com>

Add PowerShell build scripts, version.vcxproj

Based on the sequence of commits to xenbus, add powershell scripts to
build the solution using the EWDK
version.vcxproj generates versioned files (version.h and xencons.inf) using
 scripts/genfiles.ps1
Strips duplicated functionality from build.py toproduce consistant
builds between python and powershell.

Signed-off-by: Owen Smith <owen.smith@citrix.com>

Add BUILD_NUMBER to reported version string

Signed-off-by: Owen Smith <owen.smith@citrix.com>

Avoid assertion failure on PdoDestroy

Avoid triggering ASSERT(IsZeroMemory(Pdo, sizeof(XENCONS_PDO))
by NULL-ing Pdo->Context.

Signed-off-by: Owen Smith <owen.smith@citrix.com>

Add more logging to xencons_tty

Signed-off-by: Owen Smith <owen.smith@citrix.com>
Don't restrict logging to debug builds and use 4 '=' characters in arrows,
to be consistent with other code.

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Disable warning 5032

WDK17763 triggers a warning (mismatched #pragma warning(push)) in
include/um/winioctl.h
Disable this warning until the WDK header has resolved this issue.

Signed-off-by: Owen Smith <owen.smith@citrix.com>

Conditionally package DPInst

Since DPInst.exe is not shipped with the Windows Driver Kit 10, an
environment variable must point to local copies. Make the inclusion of
DPInst conditional on DPINST_REDIST being defined and that path
existing. This simplifies building packages which do not require DPInst
for installation, and removes a required step to create a working build.

Signed-off-by: Owen Smith <owen.smith@citrix.com>

Work around bug in VS2017 SDV

XENBUS commit 868cd40f (of the same name) introduced a workaround for a
quoting bug in SDV. This commit applies a similar workaround for XENCONS.

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Fix SDV release parameter

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Disable spectre mitigation warnings

These are not terribly useful and cause the build to fail.

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Fail FrontendPrepare if backend doesn't re-initialize

Current backend will crash (taking out the VM) if any attempt is
made to reconnect to a backend that has transitioned to the
Closed state. Forces the frontend offline, which will fail the
frontend state transitions, and its initiating IRP.

Signed-off-by: Owen Smith <owen.smith@citrix.com>

Ensure D0 <-> D3 transitions occur only from the correct state

Attempting to set D0 when already at D0 will trigger an ASSERT
and overwrite several variables.

Signed-off-by: Owen Smith <owen.smith@citrix.com>

Implement ring protocol

Adds ring.h/.c which implements the console ring protocol and
handles the cancel safe queues for the outstanding read/write IRPs.
Connect the ring with the state protocol in the frontend.
Also fixes frontend state transitions to get allow the ring to
connect and operate correctly.

Signed-off-by: Owen Smith <owen.smith@citrix.com>

Add EVTCHN and GNTTAB interfaces

Adds query for EVTCHN and GNTTAB interfaces, and adds
FdoGet[Evtchn|Gnttab]Interface functions

Signed-off-by: Owen Smith <owen.smith@citrix.com>

Respond to non-default console IOCTLs

Signed-off-by: Owen Smith <owen.smith@citrix.com>

Add boilerplate frontend

* Frontend is used for non-default consoles
* State changes are disabled for now, as there is insufficient
  implementation to handle the state model (no evtchn/gnttab changes)
* Reads "protocol" and "name" xenstore fields

Signed-off-by: Owen Smith <owen.smith@citrix.com>
Re-worked create/destroy code and renamed some items

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Hide console access behind an interface

* Allows a different implementation of the console protocol for
  non-default consoles.

Signed-off-by: Owen Smith <owen.smith@citrix.com>
* Re-worked create/destroy and renamed some items.
* Left IsDefault as a flag on the Pdo.
* Fail to create the PDO in the non-default case.
* ASSERT the Pdo is default before attempting to use the ABI, since it
  is only valid in this case.

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Enumerate non-default consoles

* Add enumeration thread and watch
* Non-default consoles will fail any read/write/iocontrol IRPs

Signed-off-by: Owen Smith <owen.smith@citrix.com>
Whitespace fix, and introduce __PdoSetDefault() rather than setting
flag directly in PdoCreate()

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Make monitor service multi-console aware

* Move console specific data to a seperate structure
* Make all threads' use the console data
* Removes the Add and Remove event in favor of inline add/remove
* Convert Win32 calls to explicit narrow/wide character set as appropriate
* Removes tchar.h include to force narrow/wide character usage
* Renames structures and thread functions
* Pipe names are based on console name
* INF file stores "Executable" under console's name subkey
* Change pipe name tty.exe uses
* Add WaitNamedPipe() before connecting to pipes in tty.exe

Signed-off-by: Owen Smith <owen.smith@citrix.com>

Add IOCTLs to query instance, name and protocol

Signed-off-by: Owen Smith <owen.smith@citrix.com>
Renamed __ConsolePutQueue() to __ConsoleReadWrite().
PdoDispatchReadWriteClose() should mark pending IRPs.

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Move console handler to static Pdo

Moves the interface and all console operations to the static Pdo.

Signed-off-by: Owen Smith <owen.smith@citrix.com>
Modified commit comment slightly since the static Pdo was introduced by a
previous patch.

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Add boilerplate Pdo

Enumerates a single static RawPdo.

Signed-off-by: Owen Smith <owen.smith@citrix.com>

Move console handlers to console.c

Isolate console handler code from fdo code.
This will make the console code easier to maintain.

Signed-off-by: Owen Smith <owen.smith@citrix.com>
Rename __ConsoleDestroy() to __ConsoleDestroyHandle() and introduce
__ConsoleCreateHandle() which is called by ConsoleOpen() to allocate and
initialize a handle.

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

chmod ug+x msbuild.bat

cygwin does not like non-executable scripts

Signed-off-by: Owen Smith <owen.smith@citrix.com>
Reduced permissions from the overly-liberal 777

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Do more optimization in release builds and add /Qspectre flag

Spectre mitigations apparently only work on optimized code.

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Add support for building with Visual Studio 2017

Also remove mappings for obsolete versions of VS in build.py.

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Update util.h

XENCONS does not use much of the functionality in util.h, including the
__AllocatePages() function modified by this change, however
it is good to keep the header in-sync with the other drivers.

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Handle DBT_DEVICEREMOVEPENDING and DBT_DEVICEREMOVECOMPLETE

When surprise removed, DBT_DEVICEQUERYREMOVE is not called, and
the handles opened by the service need closing before the driver
gets the IRP_MN_REMOVE_DEVICE Irp.

Signed-off-by: Owen Smith <owen.smith@citrix.com>

Destroy all handles on FdoD0ToD3

Since the StreamWorker holds a reference to the XENBUS_CONS interface,
xenbus will BUG_ON if the handles are not cleaned up before power down.
The service should close all handles in response to a
DBT_DEVICEQUERYREMOVE notification, but this may not be issued on
system power down.

Signed-off-by: Owen Smith <owen.smith@citrix.com>
Added missing UNREFERENCED_PARAMETER() to fix build failure.

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Cancel all outstanding IRPs in StreamDestroy

After IRP_MJ_CLEANUP completes, all outstanding IRPs (for that FileObject)
are cancelled. This would attempt to use the cancel safe queue and list
which are now zeroed, and lead to a 0xCC Bugcheck.

Signed-off-by: Owen Smith <owen.smith@citrix.com>

Flush and Disconnect pipe clients

Named pipes should be flushed and disconnected before closed.

Signed-off-by: Owen Smith <owen.smith@citrix.com>

Use PutString to manage short WriteFile

PutString will now deal in UCHARs, so the calculated lengths need to be
translated into byte counts.

Signed-off-by: Owen Smith <owen.smith@citrix.com>

Ensure handles are closed when pipe disconnects

Fixes leaks where the pipe handles were not closed, preventing new
connections. Fixes the MONITOR_PIPE context leaking when its thread
is stopped.

Signed-off-by: Owen Smith <owen.smith@citrix.com>
Since error gotos are introduced, have them do the cleanup. The scope of
Pipe and Instance needs to be widened but it keeps the code neater overall.
Also removed the unnecessary newlines in the log messages.

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Remove ZwFlushKey() from registry code

Attempting to flush registry keys early in boot causes an error to be
logged.

This patch therefore removes the explicit flushes from the registry code.
There is no option but to trust Windows lazy flush.

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Add option to not spawn child process.

If the "Executable" registry parameter is not found, do not spawn
a child process instead of failing.

Signed-off-by: Owen Smith <owen.smith@citrix.com>
Removed unnecessary hunk checking value for NULL before passing to
free().

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Launch monitored process without command line

Changed tty to open named pipe by name, not command line argument

Signed-off-by: Owen Smith <owen.smith@citrix.com>

Pass data through pipe

All data read during the DeviceThread will be passes to all named pipes.
All data read from any named pipe will be passed to the device.

Signed-off-by: Owen Smith <owen.smith@citrix.com>

Add named pipe server

Create a threaded NamedPipe server for the device.
This will be used to pass data from the console to child processes, and
read data from the child processes to pass to the console device.

Signed-off-by: Owen Smith <owen.smith@citrix.com>
s/memset/ZeroMemory
Add a '__' prefix to forceinlined list manipulation primitives

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Add asynchronous device polling thread

Adds a thread that will asynchrously read the device handle.
This will be used to read console data from the device, for passing
to the named pipe.

Signed-off-by: Owen Smith <owen.smith@citrix.com>
s/memset/ZeroMemory

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Rename ThreadEvent and Thread to Monitor[Event|Thread]

Add clarity to the variables used with the MonitorThread

Signed-off-by: Owen Smith <owen.smith@citrix.com>

Add BUILD.md and fix final package location

Microsoft helpfully removed the PackageDir property from package projects
in VS2015 so, as an interim fix, OutDir was used. This unfortunately means
that package output ends up in xencons/<arch>/package rather than just
xencons/<arch>.

This patch fixes the final package location by using python to do the
final copy (replacing what older VS used to do) and also adds a BUILD.md,
which was missing.

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Squash a spurious warning that is breaking SDV

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Add a TTY utility

This patch adds a new TTY utility which will open the console device and
pipe it to a command shell (cmd.exe) process. It also provides login
functionality for a local user such that the command shell is invoked as
that user.

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Add a monitor service

This patch adds a basic service to monitor the xencons interface.

All it does is open the interface when it becomes available and close it
down when either the device is going away, or the service is being
stopped.

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Add console functionality

This patch adds a new interface so that user-space code can open a
character device to the PV console along with all the necessary dispatch
handling for basic functionality.

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Add basic driver and associated build scripts

This driver is just the necessary boilerplate for PnP, Power and basic
interaction with XENBUS.

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Initial commit

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>