Prevent events getting lost, and remove xenstore polling

Auto-resetting events, on occasion, are getting lost.  This
can be avoided by ensuring events are manually reset.

As events are no longer lost, there is no longer a need to
poll shudown or suspend every minute

Also fix invocation of CreateEvent methods.

Signed-Off-By: Ben.Chalmers@citrix.com

Remove VS2012 and VS2013 build scripts

This patch removes the scripts for building under VS2013 and VS2013 and
also fixes the package destination when building using VS2015.

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

Add a new CConvCreator object to handle laptop/slate mode switch

This patch adds a new object derived from IDeviceCreator to interact
with the laptop/slate mode switch interface provided by a Windows
driver that binds to the ACPI CONV device.

It also adds code to support the documented PV interface for triggering
laptop/slate mode switch [1].

http://xenbits.xen.org/gitweb/?p=xen.git;a=commit;h=3bdb1400

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

Only add device if the guid matches

The IDeviceCreator::OnDeviceAdded() method should only be called for
devices matching the GUID specified to the CDeviceList object creator.

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

Split xeniface specific parts out of CXenAgent into CXenIfaceCreator

In preparation for supporting more than one device interface, the
one-to-one correspondence between the IDeviceCreator interface and the
CXenAgent object needs to be broken.

This patch separates all code that interacts with the CXenIfaceDevice
object (as well as the CDevice and CDeviceList instances for the xeniface
interface) into a new CXenIfaceCreator object.

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

Avoid repeatedly acting as if returning from suspend

Setting m_count to equal count means we will fall out of CheckSuspend
early, if initiated by a timeout when a new suspend has not occurred.

Signed-off-by : <Ben Chalmers> ben.chalmers@citrix.com

Fix SDV build

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

Fix memory leak in __FreePage()

The pool memory for the MDL also needs to be freed.

Also, generalise __AllocatePage() and __FreePage() to __AllocatePages()
and __FreePages() to allow for multi-page allocations in future.

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

Update BUILD.md with VS2015/WDK10 information

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

Fixes for VS2015/WDK10 build

The package build was not working correctly and caused the overall build
to fail.
At least part of the reason for this is that Microsoft, in their infinite
wisdom, have removed the DIFx redist from WDK10. This patch makes use of
a new environment variable 'DPINST_REDIST' to find the copy of dpinst.exe
to package such that this can be pointed at an older WDK or alternative
location where dpinst.exe can be found.

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

Add support for building under VS2015/WDK10

Moving to the new toolchain also threw up a few new warnings, which this
patch either fixes or squashes. Also, SDV appears to be fragile in new
ways (and whinge about some new things) so there are fixes for that too.

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

Update driver version from 8.2.0 to 9.0.0

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

Log some more information at build time

The OBJECT_PREFIX and REG_KEY_NAME were not being logged by build.py.

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

Reduce severity of some debug messages

Error and Warning were used for Info level messages

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

Remove XenIfaceDebugPrint

Replace "XenIfaceDebugPrint(TRACE," with "Trace("
Replace "XenIfaceDebugPrint(INFO," with "Info("
Replace "XenIfaceDebugPrint(WARNING," with "Warning("
Replace "XenIfaceDebugPrint(ERROR," with "Error("

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

Don't call DbgPrint (or variants) from an event channel callback

Windows debug primitives will IPI so it's not a good idea to use them
from within an interrupt handler which may get called at HIGH_LEVEL.

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

Stop using FAST_MUTEX

There are several build warnings because of functions that must be called
at PASSIVE_LEVEL being called at APC_LEVEL. This is because acquiring a
FAST_MUTEX raises IRQL to APC_LEVEL which is an annoying semantic that
basically renders them useless.

This patch replaces occurences of FAST_MUTEX with XENIFACE_MUTEX acquisition
of which does not modify IRQL.

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

Ensure session stays locked...

...until the reference to WatchThread is stored in it.

This prevents us trying to dispose of an uniintialised WatchThread
if a session is removed (by the driver being removed) while the
session is still being created

Signed-off-by: Ben Chalmers <ben.chalmers@citrix.com>

Try to make sure the agent always always handles shutdown events

It seems that on Server 2008 the agent does not reliably wake up on
shutdown watch events. This does not seem to occur on any other OS so
it is likely that this is a bug in Server 2008.

To work around the problem this patch nodifies the agent wake up once a
minute and check for a shutdown event (or a suspend event, for
completeness) and act accordingly.

Also this patch squashes the uninteresting error messages that occur
when an attempt is made to read a non-existent xenstore key.

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

Indirect user space watch events through a thread

It is useful, for diagnostic purposes, to log the path of a user-space
registered watch when we are about to signal it. To do this create a
thread to handle each user-space watch.

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

Fix build warnings

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

xenagent: use new Start/StopShutdownWatch() functions in resume from suspend

The patch removes some code duplication by using the StopShutdownwatch()
and StartShutdownWatch() functions on resume from suspend rather than
duplicating their content.

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

xenagent: remove icon

This icon is used by Citrix XenServer. The Xen Project agent should not
be using it.

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

xenagent: enable all warnings

Instead of using warning level 3 (which misses quite a lot), enable all
build warnings and disable only selected warnings that we don't want.

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

xenagent: re-register shutdown watch after resume from S4

When xenagent resumes in a VM that was put into S4 it needs to re-
register the watch on control/shutdown and re-advertise all
control/feature-XXX flags.

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

xenagent: remove the service when the package is removed

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>
Cc: Owen Smith <owen.smith@citrix.com>

xenagent: get event logging working properly

The xenagent build does not create the necessary DLL for event logging. This
patch re-works the build vcxproj files to create the DLL and adds the
necessary code in package INF file to install it and configure it.

As part of the work the service display name has been changed to match the
module name.

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>
Cc: Owen Smith <owen.smith@citrix.com>

xenagent: use spec. compliant control/feature-XXX keys

control/feature-shutdown is not documented in Xen's xenstore-paths
documentation. The correct keys are feature-poweroff, feature-reboot,
feature-s3 and feature-s4. Also the values that the toolstack should
write control/shutdown are poweroff, reboot, s3 and s4 so the xenagent
should only respond to these values.

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>
Cc: Owen Smith <owen.smith@citrix.com>

Make sure trailing whitespace is trimmed from log messages

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

Log messages to dom0 log (if possible)

IoctlLog will strip any trailing newline and insert a single
newline to enforce log file consistancy

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

Clean up watches, suspend handlers and events on D0->D3

* Call XenIfaceCleanup on D0->D3 transition
* Change XenIfaceCleanup to accept a NULL file object, which will
  clean up everything, regardless of file object

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

Add the missing package name to the INF file

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

Recreate watch on resume from suspend

Watches are flagged as inactive on the resume from suspend,
and will only recieve the initial watch fire after a suspend.

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

An ioctl should fail on any invalid argument

Previously failures happened only if all arguments
were invalid, leading to bugchecks if both InLen
and OutLen were 0

Signed-off-by: Ben.Chalmers@citrix.com

Set VM's time based on host's time exposed by Xen

Sets the VM's time when XenIface starts and on resume from suspend.
Uses the underlying host's time, accessed via Xen. Provide an option
for the guest to treat Xen's time as UTC or the current timezone.
This option adds 2 new brandable variables that specify a partial
registry path and value in the VM that determines how the time offset
is modified. These values are REG_TOOLS_PATH and REG_UTC_NAME which
should be specified in the build environment if the values need to
be different.

Signed-off-by: Owen Smith <owen.smith@citrix.com>
Changed REG_TOOLS_PATH to REG_KEY_NAME, which now defaults to 'Windows
PV Drivers' (that being the official XenProject sub-project name), and
use hard coded 'HostTime' key name instead of brandable REG_UTC_NAME.
If we have a brandable parent registry key, then we don't really need
to brand the value names under it.

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

Add Suspend and Shutdown handlers

Suspend needs to re-advertise the shutdown feature
Shutdown responds to control\shutdown to issue a shutdown, reboot,
hibernate or S3 transition.
Suitable event log entries are added when these events are triggered.

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

Track active device in service class

Hold a CriticalSection protected local pointer to the XenIfaceDevice
that is currently available. This will be used for all accesses to
the interfaces provided.

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

Add XenIfaceDevice

XenIfaceDevice is a CDevice subclass that abstracts the IOCTL
interface by managing the conversion to/from IOCTL inputs/outputs.

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

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

Add device list to track XenIface device(s)

Uses RegisterDeviceNotificationA and SetupApi to track
GUID_INTERFACE_XENIFACE device(s). Calls service base class
after insertion and before remove complete.

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

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

Remove LiteAgent, replace with boilerplate xenagent service

Remove the LiteAgent project and replace it with the xenagent
project. Xenagent is a boilerplate service that has no
functionality in this patch. Subsiquent patches will add
the required functionality.

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

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

Add Log IOCTL

Adds an IOCTL that sends a user defined message to Xen to log.

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

Add SharedInfo IOCTL interface

Adds
* GetTime - returns Xen wallclock time

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

Add Suspend IOCTL interface

Adds
* GetCount - returns a value which changes over suspend
* Register - registers an event that is set on resume from suspend
* Deregister - deregisters a resume from suspend event

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

Call XenIfaceCleanup from IRP_MJ_CLEANUP

XenIfaceCleanup was not called which meant that some watches, event
channels and grant entries were not cleaned up on closing the device
handle and required explicit cleanup. Add a IRP handler to call
XenIfaceCleanup from the IRP_MJ_CLEANUP for a specific FileObject.
This ensures all watches, event channels and grant entries are
destroyed in the event of the caller crashing or not gracefullly
cleaning up objects.

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

Get rid of InitSafeBootMode veto

This driver does nothing that clashes with any emulation so it's fine to
leave it emabled in safe mode.

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

Avoid evaluating assertion expressions in free builds

The evaluations are pointless and the warnings generated by not evaluating
can be squashed with a couple of #pragmas.

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

Use a DPC per XENIFACE_EVTCHN_CONTEXT for signalling to user space

The scheme of using a DPC per CPU will not work when multiple event channels
are in use since events may be lost when channels bound to the same CPU
are simultaneously pending. The problem is avoided by simply having
separate DPCs for each channel.

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>
Cc: Rafal Wojdyla <omeg@invisiblethingslab.com>

Re-synchronize registry.c with XENBUS

The registry code in XENBUS has some fixes that are not present in the
XENIFACE copy, so import the updated code from XENBUS.

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

Re-synchronize util.h with XENBUS and use __toupper()

A recent patch introduced __tolower() and __toupper() into util.h as
replacements for tolower() and toupper() respectively as the latter do
a hidden conversion to Unicode which make then unsafe at any IRQL other
than PASSIVE_LEVEL.
This patch imports util.h from XENBUS and fixes other code to be compatible.

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

Fix ASSERT failure

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

Publish distribution information to xenstore

My recent patch series to Xen added a documented path and format for
publishing information about PV driver distributions to xenstore.

This patch adds code to populate the documented path (should it exist)
with information about the XENIFACE driver package.

Suggested-by: Owen Smith <owen.smith@citrix.com>
Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Small whitespace fix

There was a residual hard tab in driver.c

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

Dont force a WMI event when reregistering a watch

When a watch is registered, the watch gets triggered. This will result
in a WMI event being fired. There is no need to manually fire a WMI
event in this case, as it can lead to the WMI event being discarded.

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

Ensure defunct watches have NULL handles

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

Fold __FdoD0ToD3/__FdoD3ToD0 into caller Remove redundant functions

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

Rework Wmi setup/cleanup to always Resume/Suspend sessions

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

Refactor Wmi header, split initialize/teardown and register/deregister

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

Refactor WmiFireSuspendEvent

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

Cleanup fdo dispatch entry points

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

Fix VS2013 build

Commit 9498b68 only dealt with VS2012 builds and broke VS2013 build. This patch
restores parity.

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

Remove calls to KeGetCurrentProcessorNumber()

This function is not valid for group aware drivers.

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

Define NT_PROCESSOR_GROUPS for VS2012 project

Previous patch missed the obvious compatability macros provided
and used by xenbus.
Also fixes a few badly formed ASSERTions

Signed-off-by: Owen Smith <owen.smith@citrix.com>
Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Bind to the latest XENBUS revision

Revision 0x0800000B or later is needed for STORE interface version 2 and
GNTTAB interface version 2.

Signed-off-by: Rafal Wojdyla <omeg@invisiblethingslab.com>

Implement new IOCTL handlers

This patch implements new store, evtchn and gnttab IOCTLs.
Handlers are split into separate files for readability.

Signed-off-by: Rafal Wojdyla <omeg@invisiblethingslab.com>

Define new IOCTLs for user-mode clients

IOCTL input is defined as XENIFACE_*_IN structs.
IOCTL output is defined as XENIFACE_*_OUT structs.

Signed-off-by: Rafal Wojdyla <omeg@invisiblethingslab.com>

Untabify the whole XENIFACE project

Signed-off-by: Rafal Wojdyla <omeg@invisiblethingslab.com>

Include ntifs.h instead of ntddk.h

Gnttab code uses KeStackAttachProcess which is only declared in ntifs.h
(conflicts with ntddk.h).

Signed-off-by: Rafal Wojdyla <omeg@invisiblethingslab.com>

Update XENBUS interface headers

Also add headers needed for next patches in the series.

Signed-off-by: Rafal Wojdyla <omeg@invisiblethingslab.com>

Add a registry override to veto driver installations

There are certain cases where a local installer package may wish to
prevent Windows Update installations of drivers. This can be achieved by
having the co-installer check for a registry value and fail it's pre-install
phase if the value is present.

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

Change coinstaller log level to TXTLOG_WARNING

Windows 10 does not enable logging of TXTLOG_DETAILS in setupapi.dev.log by
default, so use TXTLOG_WARNING to make sure the messages appear.

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

Parameterize vendor prefix and PCI device id

The XenServer PV vendor prefix ('XS') and PCI device (C000) are still
hard-coded into the XENIFACE package. These need to be stripped out and
replaced by values that can be customized at build time. This patch does
that.

The patch also reverts to building version.h and customizing xeniface.inf
directly in build.py.

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

Update to 8.2.0

I also removed CHANGELOG as it's pretty useless and will likely become
misleading.

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

Update docs and set version to 8.1.0

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

Remove use of subscriber keys from co-installer

They are no longer necessary. The co-installer actually does nothing now
and can probably be removed.

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

Update bindings

A recent change to XENBUS to introduce a new unplug mechanism was
incompatible with older drivers so the PDO revisions were deliberately
changed. This patch brings XENIFACE up to date with the new revision
number.

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

Update bindings

Refresh the interface headers and add the XENBUS major version into
the top byte of the revision, since this is now used to avoid namespace
conflicts.

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

Set script file execute permissions

The lack of execute persmission causes clones done using cygwin git to
leave scripts in a non-executable state.

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

Fix VS2013 SDV failures

Also update the assert.h header.

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

Move interface subscription code into co-installer

Interface subscription is better handled at package installation time and
therefore the co-installer is the right place for it to live.

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

Add a co-installer

The co-installer does not do anything as yet. Functionality will be added in
a subsequent patch.

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

Fix line endings

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

Make sure INF gets re-built each time

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

Make sure version header gets re-built each time

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

Fix line endings

Files checked into the repository should use unix line endings

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

Fix OBJECT_PREFIX and PRODUCT_NAME substitution

There were missing trailing '@' characters causing substitution to fail.

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

Reduce spam from build.py

We don't the verbose prints when deciding whether we're using vs2012 or 2013.

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

Don't use universal_newlines=True in subprocess.Popen()

For some versions of python this appears to cause corruption of the
output byte string by forcibly decoding with the wrong encoding.

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

Support Visual Studio 2013 & WDK 8.1

Signed-off-by: Ben Chalmers <ben.chalmers@citrix.com>
Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

Update branding

Remove the use of the 'XenServer' product name except where it is
still appropriate.
Remove use of 'Citrix' from all places except source file
copyrights.
Allow company and product name to be set at build time.

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

Fix/suppress prefast warnings

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

Implement new API version scheme

This patch changes the way APIs work in an incompatible way. (See README.md
for details).
The patch also includes a *lot* of code tidying and movement and as such
is not really suitable for review as a patch; the resulting code should
itself be reviewed.
Given the scale of the change, the major version number has been revised to
8 and other version numbers reset to zero.

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

Merge pull request #12 from benchalmers/sdv

Add SDV to the standard build

Add SDV to the standard build

Merge pull request #11 from benchalmers/CP-7374

[CP-7374] Port UTC Hosttime / timezone support to lite agent

[CP-7374] Bugfixes to lite agent UTC hosttime code

Cope with WoW64
Cope with failing to read a DWORD from xenstore
Reorder some misleading logging

Signed-off-by: Ben Chalmers <Ben.Chalmers@citrix.com>

Merge

Merge pull request #10 from benchalmers/cp-7391-2

[CP-7391] Ensure new directories are created when copying release binari...

Approved-By Ben Chalmers <Ben.Chalmers@citrix.com>

[CP-7391] Ensure new directories are created when copying release binaries too

Signed-off-by: Ben Chalmers <Ben.Chalmers@citrix.com>

Merge pull request #9 from benchalmers/cp-7391-2

[CP-7391] Ensure new directories are created when copying binaries

[CP-7391] Ensure new directories are created when copying binaries

Signed-off-by: Ben Chalmers <Ben.Chalmers@citrix.com>