Update docs and set version to 8.1.0

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

Don't trust the integrity of the shared rings after migration

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

Don't mess with DbgPrint filters

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

Move friendly name setting into driver

XENVIF can set the friendly name of each PDO during start device processing
which removes the need for the XENNET co-installer to handle this.

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

Fix co-installer compatibility check

It was using the wrong enumerator name.

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

Use new unplug mechanism

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

Remove interface subscriber checks from the co-installer...

...and replace with a scan of child driver software keys to check that
the revision number in the MatchingDeviceId value is supported.

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

Apply new PDO revision numbering policy

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

Remove PDO Luid field

It's not used any more.

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

Fix potential buffer overflow

The buffer allocation in FdoQueryDeviceRelations() is completely bogus. Fix
it.

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

Note lack of IPv6 addresses in the log

When we are copying settings, say whether we found any IPv6 address.

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

Remove test for HardwareInterface in FrontendGetInterfaceIndex()

Apparently no interface in the mib table on Windows Server 2008 SP2 is
a hardware interface, even if it has (virtual) hardware.

Also add a missing \n to a trace statement.

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

Modify Trace() macro to keep SDV happy

SDV's free build of the driver was getting upset when arguments to
trace were evaluated but not used.

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

Lookup active network interfaces by index rather than LUID

The frontend address lookup code was failing to check whether the interface
it was querying was actually active, and also using LUID is kind of overkill
when we could just use index.

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

Fix memory leak

...detected by SDV.

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

Avoid PDO namespace conflicts...

...by encoding the driver major version in the upper byte of the
revision.

This clearly implies that any future change in the driver major version
will start a new PDO namespace, but that it almost certainly the correct
thing to do in that case.

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

Update bindings

Refresh the interface headers (just suspend_interface.h in this case) 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>

Add functions to backup and restore network settings

In PdoStartDevice(), if an aliasing emulated device is found in the MIB
interface table, back up its network settings to a private area under the
the PDO software key before requesting reboot.

In a later boot, if the emulated device has been unplugged, restore the
network settings from the private area to the PDO such that it will start
with the same configuration as the emulated device it has replaced.

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

Stop synthesizing the NET_LUID

From Windows 10 the lifetime of the registry keys used to synthesize the
PDO's NET_LUID has changed. Instead of using a synthesized NET_LUID, look it
up in the MIB interface table (keyed by the permanent physical address)

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

Move reboot request code into driver.c

It doesn't really belong in pdo.c

Also this patch adds a check in PdoStartDevice() to fail if a reboot has
already been requested. This is because Windows 10 apparently has a couple
of goes at starting the PDO even after it failed to start the first time
(because we requested a reboot).

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

Only open the PDO software key once

There are currently two functions where the PDO software key is opened and
closed: __PdoSetCurrentAddress() and __PdoSetLuid(). Both of these
functions are called from PdoStartDevice() so it's more efficient to open
the software key there and pass it as an argument to the aforementioned
functions.

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

Infer REG_SZ or REG_MULTI_SZ type in RegistryUpdateSzValue()

The argument is a pointer to an array of ANSI_STRINGs in both cases so the
type can easily be inferred from the length of the array.

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

Add a type argument to the RegistryEnumerateValues() callback...

...and pass ANSI_STRINGs rather than PCHARs.

Also fix both RegistryEnumerateSubKeys() and RegistryEnumerateValues() to
not clobber their own buffer sizes when calling ZwEnumerateKey() or
ZwEnumerateValueKey() respectively.

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

Add functions to query and update binary values in the registry

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

Remove use of 'Addresses' subkey

XENVIF writes the permanent address of each vif into a subkey under its
service key. This is done to allow XENNET's co-installer to copy network
settings from any emulated device that currently has that address.

As of Windows 10, this functionality cannot be provided by a co-installer
and so this subkey has become useless. Hence this patch removes its use.

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

Remove erroneous use of transmitter DPC

If the backend does not support split event channels then the transmitter
DPC should not be used, and it contains an assertion to that effect.
The ring enable function, however, unconditionally queues the DPC leading
to an assertion failure. This patch makes sure the DPC is only queued if
the backend does indeed support split event channels.

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

Dispense with long PDO descriptions

Windows does not present them well and they are somewhat ugly. The relation-
ship between interface versions and PDO revision is now simply logged.

Also this patch applies appropriate limits to the HardwareIDs and
CompatibleIDs.

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

Release and re-acquire backend on resume

When resuming from suspend, any previously cached backend domid and path are
invalid. The frontend code should therefore release and re-acquire those
values before attempting to manipulate vif state.

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

Fix Trace statement

This can cause a crash in checked builds

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

Re-work frontend xenbus state handling code

Any time the xenbus state transitions through XenbusStateClosed (6) then
it's possible for the toolstack to tear down the vif, regardless of whether
the state transition was initialiated by the backend going offline or the
frontend being disabled at the same time the backend happens to go offline.
It's important, therefore, that the frontend code allows for this and
always requests PDO ejection if the backend does go away (even if a new
immediately appears).

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

Demote the link Info message to a Trace

It doesn't really need to go into the log

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

Remove excessive force-inlining from the frontend module

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

Allow PdoResume() to fail

At the moment FrontendResume() can fail, but PdoResume() cannot and hence
the error status is ignored. This is problematic because it is not safe to
call FrontendSuspend() if FrontendResume() did not complete successfully.
This patch, therefore, wires through the failure of FrontendResume() into
PdoResume() and on into FdoAddPhysicalDeviceObject().

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

Remove excessive force-inlining from co-installer

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

Log a message to note that when a receiver is waiting for packets

Before the receiver object in the frontend can be shut down, the Windows
network stack must return all buffers passed up. The code therefore
waits for this to happen during the VIF Disable method. Add logging to
note that the wait is occuring as it can take a significant amount of time.

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

Ping the transmitter backend when trying to disable

Any transmit requests which have been pushed to the backend must be
responded to before the frontend shuts down, otherwise the frontend
cannot safely tear down the shared ring structures. Whilst waiting
for the backend to respond, send events to make sure it is awake.

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

Fix a couple of ASSERT failures

The multi-processor-group patch introduced a new statistics array in
the Frontend object. Unfortunately, whilst the array is correctly freed
on object destruction, the pointer is not NULL-ed out so the IsZeroMemory
check fails. This patch adss the ncessary lines to NULL the array pointer.

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

Add the 'NeedReboot' flag back in

Older versions of the code used to set a 'NeedReboot' registry value if
the PDO failed to start because the corresponding emulated device was
found to be still present. The value was set directly in the service key
which is non-volatile and thus the value would persist after reboot.

This patch adds code to again set a 'NeedReboot' value, but this time it
is in a volatile 'Status' key under the service key so that it does not
persist. This value can then be used by the XENNET co-installer to
determine whether it should request a reboot during postinstall
processing.

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

Fix typos and type problems in previous patch

Also add some extra trace statements that proved useful in debugging

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

Make XENVIF processor group aware

Processor groups have been around for a long time in Windows and
contnuing to ignore them becomes ever more painful when trying to
pass the HCK multiple processor group device test. This patch, therefore,
modifies all the code that uses the non-group-aware kernel calls to use
the newer group aware calls.

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

Fix various bits of (largely autogen) stupidity in vcxproj files

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

Update headers to xen.git:f919dbc0583797d1c5c09da815518084ce77eb81

This brings the headers into line with XENBUS. There's no reliance on a
post-4.5.0 change in XENVIF but the re-structuring in the headers done
after 4.5.0 does mean change is necessary and we may as well take the pain
sooner rather than later.

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

Fix line endings

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

Move util.h from include to src/xenvif

It should be co-located with headers such as assert.h and names.h

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

Disambiguate transmitter packet caches

When a VM has multiple VIFs then it is not currently possible to tell
which transmitter packet cache applies to which VIF. This patch adds
the VIF path into the cache name to disambiguate.

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>

Get rid of Granter abstraction

Since the addition of GNTTAB Caches in XENBUS, the Granter abstraction in
XENVIF has been fairly pointless. This patch finally gets rid of it.

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

Fix memory leak

Verifier discovered a memory leak on shutdown of XENVIF. This is because
the per-ring path used for talking to multi-queue aware backends is not
freed in the case where there is only one queue. This patch simply removes
that check as it is incorrect.

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

Fix WHQL induced BSODs

The PNP Rebalance Fail Restart Device test causes BSODs due to incorrect
PnP state assumptions about the FDO. This patch fixes these problems
allowing the test to pass.

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

Fix VS2013 SDV failures

The code in registry.c needs the same prefast suppression as it does in
XENBUS.

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

Release lower bus interface before passing removal IRP to PDO

If the PDO is surprised removed then the FDO tries to retain its
reference to the PDO's bus interface byond its destruction. This will
cause an assertion failure in checked builds of XENBUS and may cause
memory corruption.

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

Update to EVTCHN version 3

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

A single queue to the backend should imply and index of 0

There is no need to test for both so change the extra test into an
assertion.

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

Fix type mismatch

The size of PWCHAR and the size of ULONG are the same for 32-bit
installations so this bug only affects 64-bit installations, but the
symptom is a crash on PDO destruction due to a corrupted heap.

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

Fix memory leak in __LinkGetImageBase()

The in-function allocated QueryInfo object was correctly freed for all error
cases, but not the successful one.

Signed-off-by: Kostas Ladopoulos <konstantinos.ladopoulos@citrix.com>

Use correct location when multi-queues are not used.

When the backend does not support multi-queues, or the frontend has
explicitly disallowed multi-queues, the frontend needs to write
event-channel and ring-references to the non-queued (old) locations,
not under device/vif/<id>/queue-<index>

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

Reflect interface versions in PDO description

For convenience add a string containing the latest versions of all the
interfaces exported by the driver into the PDO description. This can be
seen in Device Manager as the 'Bus reported device description' detail.

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>

Implement multiple queues

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

Implement VIF Interface v2

Use VIF v2 structures internally, and add translation layer
for VIF v1 calls.

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

Update to VIF Interface v2

Renames XENVIF_TRANSMITTER_PACKET to XENVIF_TRANSMITTER_PACKET_V1 and
adds XENVIF_TRANSMITTER_PACKET_V2 for future patches.
VIF v2 will be implemented in another patch.

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

Remove notifier object

Fold event channels into transmitter/receiver ring objects.
Receiver ring object takes over single event channel case and passes
notifications to transmitter object, tagged with ring index (so that
only the specified ring is executed).
Split notifications are handled independently by each ring object.

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

Move to receiver ring pointer array

Replace the list of rings with a maximally sized array of pointers.

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

Move to transmitter ring pointer array

Replace the list of rings with a maximally sized array of pointers.

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

Make interface exposure explicit

Add pass-through query for XenBus's Cache interface and
account for interface versions when determining the revision(s).
Do not pass through any other queries, as the revision is not
accounted for.

Signed-off-by: Owen Smith <owen.smith@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>

Squash buffer overlow error messages in transmit

Occasionally packets are too fragmented to fit into the maximum number of
requests allowed by the netif protocol. In this case the packet preparation
function will fail with STATUS_BUFFER_OVERFLOW and the alternative copy-
coalesce prepation function will be called. These error messages are
therefore un-interesting (since the number of packets directly granted vs.
those that were copied is available in the statistics dump initiated by the
debug VIRQ).
This patch squashes the error messages to avoid filling logs.

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

Update to latest XENBUS interfaces

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

Avoid incorrecly extending checksum accumulator

It was noticed that checksums were occasionally being incorrectly verified.
The reason for this turned out to be that the value passed to
ChecksumVerify as a USHORT was being extended to ULONG prior to being
inverted, thus leaving bits 16-31 set and thus an overflow from the lower
bits was not being correctly folded.

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

Set correct payload offset when processing checksums

The receiver code was not accounting for a non-zero packet offset when
processing checksums. This lead to inbound packets being corrupted.

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

Fix a stupid if-then-else

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>

Cope with unexpected initial backend states

If the OS is booted via iSCSI, then the backend will already be in the
Connected state when the xenvif driver loads.  The backend is stable
in this state, so __FrontendPrepare() eventually times out waiting for
the backend state to change.

Fix by leading the backend through the Closing and Closed states if we
find it initially in the Connected (or Closing) states.

Signed-off-by: Michael Brown <mbrown@fensystems.co.uk>
Forward ported.

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

Update documentation

Improve build documentation and add doxygen configuration and tags to build
documentation for the VIF interface.

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

Add support for Visual Studio 2013 & WDK 8.1

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

Change pointer assignment to intended structure assignment

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

Add missing API versioning text to README.md

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>

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 #35 from pauldu/xop-577

Treat a missing Aliases value as an empty one

Treat a missing Aliases value as an empty one

There are certain cases when xennet's co-installer may not have run so
we end up trying to (safely) start PDOs without even an empty alias.

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

Merge pull request #34 from pauldu/ca-140184

[CA-140184]

Revert previous commits that add use of XENBUS's CACHE interface to XENVIF (and then modify cache lifecycle to avoid a crash during hibernation).
The reversions undid a couple of other fixes which are re-applied by the third patch.

Approved-By: Ben.Chalmers@citrix.com

Re-fix issues uncovered by previous reversions.

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

Revert commit 80ace57b353764c9165673e021c2a6cf7616a3bb

>    Use new XENBUS CACHE interface rather than local pool code
>
>    Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

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

Revert commit 3714613096b1bb7b7a76e9d360106ea19208f243

>    Change Cache lifecycle to match ring lifecycle.
>    Ensure caches are destroyed when device transitions to D3 to prevent
>    assertion failure in xenbus.
>
>    Signed-off-by: Owen Smith <owen.smith@citrix.com>

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

Merge pull request #33 from OwenSmith/master

Change Cache lifecycle to match ring lifecycle.

Change Cache lifecycle to match ring lifecycle.
Ensure caches are destroyed when device transitions to D3 to prevent
assertion failure in xenbus.

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

Merge pull request #32 from pauldu/gnttab

Updated GNTTAB interface

Use new GNTTAB interface

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

Remove much code duplication

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

Use new XENBUS CACHE interface rather than local pool code

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

Merge pull request #30 from pauldu/master

Avoid duplicate entries in the IP address table

Avoid duplicate entries in the IP address table

Duplicates are useless and actually cause problems overflowing xenstore's
quota. Also, we should not bother looking at the MIB address table unless
the frontend is CONNECTED or ENABLED since our NetLuid is not necessarily
valid unless we are in one of those states.

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

Merge pull request #29 from OwenSmith/master

Protect Netio imports with a mutex.

Protect Netio imports with a mutex.

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

Merge pull request #27 from pauldu/master

Re-try AuxKlibQueryModuleInformation() if buffer was too small

Approved-By: Ben Chalmers <ben.chalmers@citrix.com>

Re-try AuxKlibQueryModuleInformation() if buffer was too small

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