Clean up layer test

My previous commit to enable physical device modifications in a layer
required new compiled layers to do the work.  Since this can more
cleanly be done by setting layer flags (as suggested by @charles-lunarg)
I have gone back and done that.

Fix Windows build and add proper phys dev group sorting

Code review comment fixes.

Also, cleaned up Linux vs Windows code so that there was less duplication and
complexity.

Loader single EnumPhysDev call through layers

The loader trampoline previously would query all devices every time
vkEnumeratePhysicalDevices was called.
To do this, it would make two calls every time:
  - First, it would ignore the passed in user values
  - Second, it would query the total number of available devices.
  - Third, it would query the values for every available device

This resulted in layers reporting 2 vkEnumeratePhysicalDevices call for
every 1 the application made which could get very polluted in output.
It didn't break any functionality, just made things messy.

This change removes that behavior and adds a bunch of test cases to verify
nothing broke in the move.

Add debug messages for unknown physical device extensions

Add debug messages to the loader so we can identify when an unknown
physical device extension's entrypoints are queried.

Update build.md and README.md for the tests

Guard building of live_verification tests

Don't build live verification tests by default. These are meant as manual tests for
developers to run to diagnose issues or verify correctness on a real system.

Switch ASSERT_EQ(false,true) for FAIL() in tests

Add explicit layer invalid variant number test

Add a few device layer tests

Since device layers are pretty much ignored, make sure that they don't
change any behavior.
Also add a few "load" entrypoint helper routines based on what was already
done elsewhere in the test system.

Add live_verification tests for runnign with real drivers

Some things need to be verified against real drivers. The supporting code in test_util and
test_environment make it easy to write application code which works against real drivers and
layers. This allows quickly verifying loader behavior out in the wild.

Add a test to verify that VK_INSTANCE_LAYERS behaves properly

Expand unknown function handling tests

Add tests for unknown device functions queried with both vkGetDeviceProcAddr
and vkGetInstanceProcAddr. Also loops enough times to exhaust the available
unknown function supply.

Had to fix the vk_layerGetPhysicalDeviceProcAddr in TestLayer to make the tests
pass.

MacOS currently skips tests which use vkGetInstanceProcAddr. This is due to the
need for unknown functions being lower priority and so do not warrent the time
needed to write the assembly necessary to resolve the issue fully.

Update tests function loading implementation

Remove the need for macros and use well crafted helper loading functions which
can figure out the type to convert to based on the type being assigned.

Fix Win32 Unknown Device function handling

The handling of unknown device functions queried with vkGetInstanceProcAddr
required an additional pointer dereference to get the dispatch table.

The VkDevice handle is a pointer to the `chain_device` member of
`loader_device`. This member is actually a pointer to `loader_dispatch`, or
put another way, the "start" of `loader_device`. Thus, to get access to the
dispatch table, we need to dereference the VkDevice passed into the function
then dereference the chain_device to get loader_dispatch`.

Fix NULL check and make a few more consistent

Test layer pre-instance functions

Add tests to verify that the 3 pre-instance functions are properly
intercepted by the layer when everything is well-defined.

Also include two fixes:
 1) Disable environment variable value of 0 should be treated the same as not present
 2) The vkEnumerateInstanceVersion override path was broken, missing a NULL check

Update Windows runtime installer copyright

Clarify behavior of override_paths + VK_LAYER_PATH

If a meta layer which contains `override_paths` is active, all of the paths in
VK_LAYER_PATH are ignored when searchign for explicit layers. This may be changed
changed in the future but for now is better tested and documented.

MetaLayer version checking had paren in wrong place

Produced spurious warnings for versions that are correct.

Test when there are no devices or device extensions

Adds 2 tests:
* ZeroPhysicalDevices - Return VK_ERROR_INITIALIZATION_FAILED if the driver has zero
physical devices.
* ZeroPhyiscalDeviceExtensions - Return VK_SUCCESS if no physical device extensions are
found.

Dont return an error for 0 physical device extensions

Previously the logic of loader_add_device_extensions could return an error from
enumerating device extensions. This was because the code would return immediately
if either an error was returned from the driver or the count was zero. Now the
logic will return an error only if the driver returned an error. Zero device
extensions won't be treated as an error and will simply return VK_SUCCESS.

Add debug utils loader testing

Fix loader logging of VUIDs

The loader was logging some VUID failures and it was sending them to the general
message output.  Send the information also to the validation stream to make sure
that if anyone enables validation filtering they will still see those errors

Update loader VUID messages

Update the loader VUID messages that were added in validating handles
so that thye include the validation flag when going through debug utils
messenger.

Add DebugReport

Fix Apple build

We don't want Apple builds using the Linux sorting algorithm.

Update Docs table of contents

Remove Instance and Device extension logging

While the DEBUG level of logging is meant for verbose output, the actual extensions
enumerated rarely are useful for the purposes of debugging the loaders behavior.
With this in mind, the loader will now no longer print all the extensions found.

build: Update to header 1.3.205

- Update known-good
- Generate source

Make vkGetInstanceProcAddr able to get itself

There was a regression with 1.3 that meant vkGetInstanceProcAddr wouldn't be
able to query itself if instance was set for 1.3. This commit makes it possible
to query for vkGetInstanceProcAddr with itself no matter the value of instance.

use the correct instance

Verify GIPA on device extensions

Verify that using vkGetInstanceProcAddr to get an entrypoint to a device
extension works when the extension is enabled, and crashes when the
extension isn't enabled.

Also, update a copyright notice date for my last commit.

Add tests to verify extension support in physical devices

Add 2 tests to verify that physical devices supporting instance
and device extensions (which are really physical device extensions)
are properly handled.

Add a few tests to verify the vkGet***ProcAddr commands

Verify that the loader exported version matches the ones you
receive from vkGet****ProcAddr.

Fix incorrect indexing of local_phys_dev_groups

Seems to have been a copy paste error that meant the group's icd_term was assigned
to the incorrect group.

loader: Try to handle ICD failure in vkEnumeratePhysicalDevices

If any ICD failed to enumerate device groups here, we would fail the call entirely, which means a broken driver for device A could prevent you from using device B. Just skip over the failing ICD instead.

Add tests to validate layer extensions

We had tests that verified that instance and device extensions defined
in a layer had the non-null pointers returned from the corresponding
vkGetXXXProcAddr functions, but we weren't verifying that the functions
actually got called.

loader log error if a requested layer not loaded

This should throw an error message if a requested layer didn't load.
This could happen if the JSON file is present, but only a library
exists on the system for the wrong target (like 32 vs 64-bit).

If it did fail because of being the wrong bit-type, we report an info
message only, unless it was directly requested by the application.

Modify the improper bit-depth layer loading test so that it is now 4
tests:
 - Verify bad explicit layer generates VK_ERROR_LAYER_NOT_PRESENT error
 - Verify bad implicit layer generates only an info in the loader output
 - Test case with both a bad implicit and explicit layer with INFO logging
   we should see both messages.
 - Test case with both a bad implicit and explicit layer with ERROR logging
   we should see only the explicit failure message.

Report info failure for ICD wrong bit-type as well.

Finally, fixed a small compilation warning for disabled code.

Fix warning for using wrong variant layers

Mistakenly used DRIVER instead of LAYER logging level.

Add wrong Variant tests

Ignore layers with non zero variant value

Layers which contain an API version where the variant value is non zero are not
designed for the Vulkan-Loader, so it should be ignored.

Refactor json and API version parsing code

Reuse the loader_api_struct struct and associated parsing functions where
appropriate to reduce code duplication.

Skip ICD's with non zero variant value

If the JSON ICD Manifest contains an api_version that has a non zero variant
value, then the ICD should be skipped since it corresponds to a Vulkan variant.

Detect Variant versions in given api versions

Since it is possible that API versions given to the loader have a variant
component, the loader should know how to handle them. It shouldn't use a
variant other than 0, but that is up to the caller to handle.

Update tests to use correct version macro

The VK_MAKE_API_VERSION macro and the VK_API_VERSION_1_X macros are better to
use. This commit switches the tests over to the non-deprecated versions of the
macros.

Warn when the apiVersion's variant isn't 0

The 1.2.175 header release saw the addition of API Variants. For the purposes
of the loader, this should always be set to 0. If this value isn't zero, the
loader should warn about it.

Use VK_API_VERSION_XXX macros everywhere

The older VK_VERSION_XXX macros are deprecated and cause confusion when they
report a MAJOR version that is above zero. All uses of the deprecated macro are
now replaced with the correct macro.

Add test for implicit layer with 0.1 API version

The loader disables implicit layers if their API version isn't the same or
greater than the application. Make sure this still works even with pre 1.0
versions.

Test EnumPhysDev to make sure handles don't change

Add a test to make sure that the physical device handles don't change
between calls to vkEnumeratePhysicalDevices

Fix Linux sort order crash

We were completely re-creating the physical device lists every time
EnumeratePhysicalDevices was triggered in the loader.  This could
cause applications to have out-dated physical device handles.
We need to copy existing handles that match devices whenever they're
found.

Add VK_NN_vi_surface to WSI extension names array

VK_NN_vi_surface WSI implementation

Use size_t instead of uint32_t in test_icd

Compiler complained about possible loss of data. This fixes it.

Update LoaderLayerInterface.md documentation

Expand override layer documentation to include override_paths

Add Versioning and Activation Interactions section which details some of the
more complex rules around when a layer is activated or not.

Add override_paths tests for OverrideLayer

Add 4 tests:
* Shows the override_paths object in the layer manifest is being used to find a
layer.
* Shows that regular explicit layers are not found
* Shows that the log properly identifies meta layers which have an
override_paths object but shouldn't according to their manifest.
* Shows that implicit layers not in the override paths are not found.

Fix loader manifest version checks

Several version checks were underspecified and either caused false positives
or didn't catch version violations.
For example, a manifest version 1.2.0 is valid but would emit warnings implying
the version is less than 1.1.

Add TestLayerDetails helper struct

Increasingly it is common to need more control over what the framework
environment does when adding layers. While only a refactor, this change
makes it easier to extend the functionality by adding data to the
TestLayerDetails struct.

The code to check whether the lib_path specified in add_layer_impl was
improved by using the `.stem()` functionality of the fs::path abstraction.

size_t was replaced with uint32_t where the compiler gave warnings.

Make layer tests specify number of extensions

It is good practice to make use of equality checks vs comparison checks where
possible. Here, the number of extensions is knowable, as its debug_report +
debug_utils + however many come from implicit layers, which some tests do.

Fixup tests/README to use newlines for sentences

Add meta layer blacklist test

Add meta layer fields to layer manifest in tests

Add check_permutation test helper

This allows easily checking that the returned list of extensions or layers
is a valid permutation. Since the order of layers and extensions isn't
deterministic, tests cannot rely on the returned order to verify the output.

Add many meta-layer tests

Add tests for:
ExplicitMetaLayer - meta layer found in explicit paths
MetaLayerNameInComponentLayers - meta layer contains itself
MetaLayerWhichAddsmetaLayer - when a meta layer enables another meta layer
InstanceExtensionInComponentLayer - instance extension propagation
DeviceExtensionInComponentLayer - device extension propagation
OverrideMetaLayer.OlderVersionThanInstance - Checks behavior of override layer
  if the applications version is greater.

Cleanup loader layer removal code

The loader_read_layer_json function wasn't decrementing the count of layers in the
list if it failed to load, leading to inconsistent results.

Several places were removing layers in a layer list manually when the functions
loader_remove_layer_in_list exists. They also weren't modifying their loop counters
when it was necessary.

Simplify test framework FolderManager write function

Condense the overloaded write function from taking either an icd manifest or a layer manifest
and only take a string. This reduces the amount of copy-paste code.

Remove redundant layer validity check

The Loader makes sure all component layers in a meta layer are found. It would then do this check
immediately afterwards. This is redundant and can be removed.

TestICD return features, props, & memprops

Make the TestICD return the features, properties, & memory properties of
a physical device.

Check for version 1.3 in GetP.D.ToolProperties

To ensure that no crashes occur due to calling into the driver's
vkGetPhysicalDeviceToolProperties. This prevents cases where the function is
exported but the physical device doesn't actually support the function (such
as mesa with its function dispatcher shared between drivers).

loader: Add basic 1.3 tests

Not complete and mainly just makes sure an app can load the function pointer and call it
without crashing.

loader: Add manual trampolines for 1.3

loader: Add core 1.3 function to gpa_helper

loader: Add 1.3 symbols defs to appropriate files

vulkan-1.def and vulkan.symbols.api for fuschia

loader: Add GetToolinInfo trampoline/terminator

build: Update to header 1.3.204

- Update known-good
- Generate source

Add support for building on ChromeOS

Fix writing to filtered extension list

VK_KHR_get_physical_device_properties2 is added to an extension list
on Linux targets, but the index used for setting the extension string
in that list is wrong, leaving a NULL pointer where the extension
name should be.

Fix issue #802

The loader assumed if Vulkan 1.1 is supported, then the PCI bus extension
must automatically be supported.  This was a mistake as that extension is
not part of core.

Downgrade all policy messages from ERROR to WARN

Enable Address Sanitizser in Github Actions

Add VK_LOADER_TEST_LOADER_PATH env-var for tests

The environment variable VK_LOADER_TEST_LOADER_PATH allows running of tests
using a different binary than the one built by the repo. This is extremely
useful for checking that a test exercises a bugfix, by quickly allowing the
running of the same test on the current 'fixed' loader and an older 'broken'
loader.

murmurhash: Fix an undefined behavior when hashing function names

In Vulkan loader GetProcAddr handlers, for functions that are
not specified in the Vulkan registry, the loader will try loading
the name from ICDs or layers, and store the function entry into
a hashtable. The hashtable uses |murmurhash()| function to hash
Vulkan function names.

murmurhash handles data as 4-byte chunks and read one chunk at a
time; and it simply converts uint8_t pointers to uint32_t pointers
while loading data. However, the address of function name might
not be 32-bit aligned and this will cause an undefined behavior in
C99 / C11.

This change fixes the murmurhash() behavior so that it handles
unaligned access correctly. For most common platforms that supports
unaligned memory access this could compile into a single mov/load
instruction even if compiling using -O0.

Change-Id: I16011720198a0ee96e556855858a9909f95ec376

Add test for older implicit layer version

Add NewerInstanceVersionThanImplicitLayer test which exercises the loader's
removal of layers whoses API version is less than the application specified
API version.

Add meta-layer versioning tests

Adds three tests:
* OlderMetaLayerWithNewerInstanceVersion - Checks for interaction between app's
instance version and the meta layer version
* NewerComponentLayerInMetaLayer - When a component layer has an API version
newer than the meta layer, the meta layer is disabled.
* OlderComponentLayerInMetaLayer - When a component layer has an API version
older than the meta layer, the meta layer is disabled.

Fix layers not being removed by meta-layer

The code was faulty and would remove the layers that were supposed to be kept,
such as the meta layer itself. Bugs include taking a copy instead of a pointer
which led to an assignment being forgotten and using the wrong list when
looking through the list of layers.

Check for duplicates before adding layer

If an application decided to enable an implicit layer, it would result in the
layer properties being stored twice in the activated layer list. Simply not
adding the layer if it already is in the list prevents the duplication.

Log meta-layer messages when inst is NULL

The code previously would only log meta-layer messages when the instance
isn't NULL (so never during pre-instance calls). This leads to critical
information being left out while debugging, making issues harder to
diagnose.

Fix layer manifest version check

The check assumed that 1.1.x was the highest Layer Manifest version in existance.
This causes 1.2 layer manifests to erroneously report a message. No functionality
is affected by the check, so this commit just silences a wrong warning.

Add test for manually enabled implicit layer

If an application manually enabled an implicit layer, the layer should
be enabled without issue.

Consistent loader device ordering

The loader ICD ordering could be random on Linux based on using readdir
to find ICD manifest files.  This can result in random behaviors as
applications that select only the first device can switch which device is
used.  To resolve this, we now sort based on device type and then
internally to the types based on PCI bus information.

This also introduces a VK_LOADER_DEFAULT_DEVICE environment variable
that can be used to force a specific PCI device.  This environment variable
is actually a duplicate of the MESA_VK_DEVICE_SELECT variable, which is
also looked for if the loader environment variable is not found.

Note, that at least one ICD must support it for the extension to be used at all.
So we only do the sorting if one ICD supports it.

Fixes part of #657

Move the LDP_DRIVER_6 message to a warning for now

Add 1.2.1 as valid Layer Manifest version

Fixup phys_dev_inst_ext_tests

Add tests which exercise the case of a ICD being 1.0 with support for
VK_KHR_get_physical_device_properties2 while the ICD enables 1.1 and the
extension but tries to use the extension.

Removed TEST_F in this file, wasn't needed and caused an extra ICD to be found.

Converted the CompareXXX functions from internally using ASSERT_EQ to returning
a bool. This made the tests more robust since ASSERT_EQ in a function will just
return the function early, not end the test.

Tests separate 1.1 and VK_KHR_get_phys_dev_props2

Previously the TestICD would conflate the 2 distinct situations by accident. This commit
moves the logic into their separate blocks to prevent mixups.

Fallback to 2KHR terminators if available

The functions added from VK_KHR_get_physical_device_properties2 were made core, but a
recent loader change meant that an application which was trying to use the extension may
use the fallback version (which ignores the pNext chain). This breaks existing
applications and thus needs to be rectified. This commit makes it so that if the core
GetPhysicalDeviceXXX functions aren't available and the extension is supported & enabled,
the extension version is used instead.

Remove unnecessary code in test

Fix a few code review snippets

Messages weren't clear on some errors, and rework the library ending
code based on @charles-lunarg suggestions

Add layer tests for instance extension support

Verify that the loader properly handles instance extensions defined
in a layer (both implicit and explicit).

Add device extension layer tests

Need to make sure the loader behaves appropriately for layers which report
one or more device extensions.

Fix debug utils wrapping in tests

Also fix another compiler warning.