test: Update 32/64 tests to check the log

Use the DebugUtilsLogger to verify that the loader is downgrading the error
level of dll/so's from ERROR to INFO

test: Add DebugUtilsWrapper

This wrapper allows easy reading of the log output through the debug utils
messenger infrastructure. Since getting the stdout/stderr is not well
supported by googletest, this allows tests to be written which check for
specific log messages to be emitted, allowing another way to verify the
loader is behaving as expected.

loader: Downgrade wrong arch errors on windows

On linux, when the loader fails to load a .so if it was due to being on the
wrong architecture, the loader downgraded the error to INFO level. This
commit does the same thing for windows. Error code 193 is winapi's way to
signify that the dll failed to load cause of the architecture.

build: Update to header 1.2.189

- Update known-good
- Generate source

test: Set VK_LAYER_PATH properly

test: Update Device Layers Match test

Move the old EnumerateDeviceLayers.LayersMatch to the new framework,
implementing the necessary components in the TestLayer code path.

test: Use proper allocation count in tests

The test used to only keep track of the maximum number of allocations and fail
if it was exceeded, as calling free would decrease this number. Now tests use
the total number of times allocate was called, and realloc was added to this
metric. This should offer better OOM coverage due to failing at each and
every possible OOM place. The code does make sure not to increase the count
if realloc was called to 'downsize' the allocation, which shouldn't cause
OOM to occur ever.

test: Add test for PR #639

This test tries to recreate an out of memory condition which causes
a binary of the wrong type to be confused with a valid binary, which
causes VK_ERROR_INCOMPATIBLE_DRIVER to be returned instead of VK_SUCCESS
(Or OOM if the case may be)

loader: Fix accidental error propagation

When a dll/so of the wrong architecture is found, the loader would
return ERROR_INCOMPATIBLE_DRIVER from `loader_scanned_icd_add`.
Previously it would return VK_SUCCESS, but that caused the logic to
not skip over the ICD. This commit fixes the issue where the error
code would be propagated out of the function, which shouldn't happen
since there may be other drivers which do successfully load.

Fix Vulkan CTS testcase bug: "create_instance_device_intentional_alloc_fail"

In function loader_scanned_icd_add, if open_library fails, VK_SUCCESS
is still returned, which would cause the bad number of good ICDs.

test: Simplify wrong arch tests by adding a macro

Added the `CURRENT_PLATFORM_DUMMY_BINARY` macro which thanks to platform
defines contains the path of the binary which is 'wrong' for the current
architecture. EX: compiling with Win64, it points to the Win32 binary, and vice
versa when compiling for Win32. Same logic applies for linux 64/32 bit.

test: Add windows 32/64 bit binary tests

Added both layer and ICD tests. Included lengthy description of why the test
successfully creates an instance even though it really shouldn't.

test: Add linux x64 and x86 for wrong binaries

Test only looks for ICD binaries.

test: Add ELF test binaries for 32 and 64 bit

These binaries are necessary for testing whether the loader correctly
ignores binaries of the wrong architecture. Since they are data files
more than executables, they are being checked in.

Currently only Unix binaries are added but in the future windows along
with any other platform binaries will be added.

loader: Make use of a generated header version

This changes the loader to always set the version to the one which was used when
generating the source files that are checked into the repo, instead of using the
version gotten from the Vulkan-Headers find cmake file.

Change-Id: Id0955ddfd10e35e0f358f5a77799d8baa4992b04

loader: Reformated loader source code

Previously, clang-format was required for all new commits but the codebase
itself wasn't conformant. This commit formats the source files in the loader
folder.

test: Revamp which linux paths are redirected

Adds FALLBACK_DATA_DIRS, FALLBACK_CONFIG_DIRS, SYSCONFDIR, and EXTRASYSCONFDIR
to the list of redirected paths. They were previously 'covered' by manual entries.
This commit makes them responsive to changes in the build system.

This commit also makes sure that the path used for redirection is one searched by
the loader by using the SYSCONFIG variable. Previously it would use /usr/local/etc/
which was only correct on systems where CMAKE_INSTALL_PREFIX was set to /usr/local.

Fix environment test failure.

It was looking for a specific output for the manifest file search string.
Re-add that string for now.

build: Update to header 1.2.188

- Update known-good
- Generate source (no change)

scripts: Use altlen instead of parsing latexmath

KhronosGroup/Vulkan-ValidationLayers switched to this method a while ago
and this syncs the KhronosGroup/Vulkan-Loader version of
helper_file_generator.py to match.

Allow "icd" as well as "implem" for VK_LOADER_DEBUG

Add layer and implementation-specific logging

Add logging that will allow end-users to specifically just look at
messages for layers and implementations/ICDs.
Setting VK_LOADER_DEBUG to include one of the following:
  - layer        : enables layer-specific logging
  - implem       : enables implementation/ICD-specific logging

Fix loader_log messages to use LOADER_ log levels

The loader_log messages were using the DEBUG_REPORT log levels
which just happened to coincide with the existing LOADER_ log levels.
Going forward, to add layer logging in its own level, this would not
have worked.

test: Prevent macro collision

test: Make MetaLayer test add extensions

Needed to fixup more of the manifest writer in the process

test: Make invalid meta layer test more comprehensive

This required fixing a few bugsin the Manifest file printing logic

test: Add simple invalid-meta layer test

Creates a meta layer whose component layers do not exist

Deallocate the extension lists when deleting an item from layer list

Vulkan Loader loads the meta layer list and filters the ones that are
not valid. During filter it deallocates the attributes of the loaded
meta layer but does not deallocate the associated extension list.

test: Clear TestICDs before each test

Calling `dlclose` doesn't necessarily mean that the static variables will
be reset nor the libraries destructor gets called. This caused cascading
errors in tests on linux with GCC. By always manually resetting the ICD
or Layer before each test, we prevent any funny business from occuring.

test: Update tests/README.md

Include note to always destroy the instance at the end of a test.

test: Make all tests call vkDestroyInstance

This caused spurious failures in other tests due to the dynamic library
not being closed.

test: Add CreateInstance.LayerPresent test

test: Update framework_config to include paths to layer binaries

test: Add noexcept in test_environment

test: add CreateInstance.LayerNotPresent test

Remove the corresponding test in loader_validation_tests.cpp

test: Implemente layer create instance/device

Added the necessary bits to make calling create instance and device function,
though it may not work in all circumstances

build: Update to header 1.2.187

- Update known-good
- Generate source (no change)

Fix loader debug documentation

The loader debug environment variable (VK_LOADER_DEBUG) is not inclusive
of higher importance messages, it is exclusive to the types specifically
enabled.

test: Add basic threading test

Requires adding ability for device to return functions with
vkGetDeviceProcAddr that aren't necessarily useable functions.

Also added checks to make sure that the handle passed in by the loader
to the TestICD is the 'right handle' where necessary, as some functions
do not need to know which device is being called on, just that it is correct.

build: Update to header 1.2.186

- Update known-good
- Generate source (no change)

Change-Id: I7c0699f8613ecbfefe79981f34faa5e276703324

build: Update to header 1.2.185

- Update known-good
- Re-enable code generation for VK_HUAWEI_subpass_shading
- Generate source

Change-Id: I6607e1de097d1b8a2f631cd1f11b088204b8bb3a

build: Disable -Wimplicit-fallthrough in GN.

This flag was recently enabled by default in Chrome and ANGLE
and other projects inherit these build settings. Explicitly
dsiable this warning until it is enabled in the non-GN build.

Change-Id: I8f353f8abc3f7857481ff9cc774aff3618eaf35a

loader: Dont return OOM on function load failure

Win7 does not support D3DKMTEnumAdapters2, as such when the loader goes to
query it, it gets NULL back. Except, instead of just erroring out, it would
return VK_ERROR_OUT_OF_HOST_MEMORY. Problem was that change
73296a04678a07fc4fb1eef50cf4fe2778f059f8
starts checking for OOM, and finding one when running in Win7. This change
alters that behavior so that it doesn't report an OOM when one hasn't occured.

windows: update the loader copyright date

The date, specified in loader/loader.rc, was incorrectly set to 2020.

ci: Re-add code and commit formatting verification

Change-Id: I240f912daa03d001f2dbd2527d8374bbf394ac4a

Update contact information

test: Move more old tests to new test framework

Remove them from the calling scripts where appropriate. Notably the 'get count
then run tests and pass in count' are now using the framework where that is
completely redundant.

Change-Id: I00d561a85047742a849df48818398b10c62d3b74

Report a warning if the number of GPUs doesn't match

We've encountered situations where a layer removes physical devices
from the list which can cause issues on some systems if it's done
incorrectly.  For now, simply throw a warning if the loader determines
that a layer has removed devices.

NOTE: In the long-run, I think we should define a policy which states
that layers can re-order devices, but not add or remove.  If a layer
wants to add, it should become an ICD.

build: Update to header 1.2.184

- Update known-good
- Generate source

Change-Id: Ib2cfed88095541a127c23cf7418e9a66d81bd35e

test: Fix TestLayer exports on windows

* `get_instance_func` needed to have __stdcall (VKAPI_ATTR) added
* Several .def files were incorrect
* vk_layer.h forward declares vkNegotiateLoaderLayerInterfaceVersion. This is
problomatic because it doesn't have __declspec(dllexport), a token added by
FRAMEWORK_EXPORT on windows. We have to special case the export macro here to
prevent that mismatched definition.

test: Add Enumeration Function stubs to TestLayer

Change-Id: I68b3597877fed803f4284e7e67f19ce4e3e2fe53

test: Flesh out TestLayer to include relevant exports

Functions needed in the various layer interface versions are now
exported as well as guarded behind macros configurable from CMake.
The export_definitions folder was populated as well.

Change-Id: Iebfdd8ae02062eb81b8aa9f705885c9384c95be9

test: Use MACRO=1 in TestICD for definition style

This replaces instances of `#ifdef MACRO_NAME` with `#if MACRO_NAME` as now
MACRO_NAME will have a value of 0 or 1, instead of it being defined or not
defined.

Change-Id: I27a4330511a0f0d779f41851fe816fc79e868de2

test: Update Framework Readme.md

Change-Id: Iaf3740b046b3f6457c337988c573a73f068ff1a3

test: Use a new `string_eq` function instead of raw strcmp

Change-Id: I703763133c42eb78ae3c6e194450411e3f784e35

test: Drop fp_ from function pointer names

Change-Id: Ibd047e99f442d4a9755ac186e16b3620d3544e37

test: Remove some redundant tests in old test suite

Change-Id: Icc84b25bb092e15e054433651112e86b30726e52

test: Rename regressions test cases

From RegressionTests.CreateInstanceExampleTestCase
To CreateInstance.ExampleTestCase

Change-Id: Ibd74541f93edbcaccb3daa9016dcacf8ecccfa78

test: Remove Allocation tests from old test suite

loader_alloc_callback_tests.cpp now contain all of the removed tests.

Change-Id: Ia99df3a8f86d40f0d5e89a62b7b0a5f9bebafb7c

build: Update to header 1.2.183

- Update known-good
- Generate source (no change)

Change-Id: I059e6c2d8430228b4f20cadb83929b220efa5d0d

docs: Add info on DXGI adapters in Windows ICD Discovery

copyrights: updated copyrights on MIT files

During SDK testing we identified that the runtime copyrights
were out-of-date.  The loader runtime includes two separate
MIT copyrights, each attributed to a pair of source files,
one initiated by Dave Gamble and one by joseph werle.

I examined these files to discover that the last LunarG change to
three out of the four was actually in 2017, not 2016.  This
date should be attributed to Khronos, Valve, and LunarG.

By updating the copyright notice in these files, we ensure that
the license registry remains up-to-date.

Note that no real content changed (which is why the copyrights are not
being updated to 2021).

Loader shared lib: back to default cmake prefix

but it changed the import lib name (libvulkan.dll.a instead of libvulkan-1.dll.a) which in turns breaks cmake detection in FindVulkan
now we go back to using the default cmake prefix which is equivalent to what #595 wants, (prior to #523), but without the broken behavior

cc @Biswa96

test: Delete old temp folders when starting tests/framework/test_util

Make sure the work space is clean before starting a test, this is mainly for developer builds, as CI
runs will generally wipe the entire build tree instead.

test: Update googlestest to 1.10.0

test: Add revamped allocation tests

Creates a memory tracker class and rewrites the existing allocation tests.

Change-Id: I09ca2dc5b4d83f775ae0e3fd362a3fa4f7255d27

ci: Enable regression tests on MacOS

Change-Id: I85b08bfd2914e03840a027240470e2596415f4dc

test: Fix framework to work on MacOS

Main issue was getting function redireciton to work, dyld-interposer accomplishes that.
It required making the shim-library a dylib, but otherwise only required minor changes.

Change-Id: I7b7e2c86cc0c0b082f58241a7e146b74af72e792

build: Update to header 1.2.182

- Update known-good
- Disable codegen for VK_HUAWEI_subpass_shading
  https://github.com/KhronosGroup/Vulkan-Docs/issues/1564
- Generate source

Change-Id: If59954254bdf433bd5171f2a63cad88e34069c89

Add layer manifest version 1.2.0 to history

build: Update to header 1.2.181

- Update known-good
- Generate source (no change)

Change-Id: I7aed911c95d3faa89f7cd012ce56ccde00927943

loader: Change VkResult when no ICDs were found

ReadDataFilesInRegistry would return VK_ERROR_INITIALIZATION_FAILED in several cases
which could cause the loader to short cirtuit and return that value when no drivers were
found in the registry. This is inconsistent with the later check of the size of the list
of manifest, which if it is 0 returns VK_ERROR_INCOMPATABLE_DRIVER. This commit changes
the instances of INIT_FAILED into INCOMPATABLE_DRIVER where relevant.

loader: Create AddManifestFile function

loader: Replace consistency checks with asserts

test: Refactor tests that use VK_ICD_FILENAMES

Change-Id: I34117fd500f7110669ae19d32ff1e1be920238a9

test: Control process elevation on Windows

Since the loader only uses environment variables if the process is
not running with elevated priviledges, the test harness needs to be
able to control that aspect to ensure consistency as CI systems may
run the tests in an 'elevated' context.

Change-Id: I8b15a1ecd4ab4960049ba198af8199943e872bba

test: Delete files properly on windows

Move windows specific error reporting to test_util.h
This allows for its use anywhere its required.

Change-Id: I14a0da85dc0d3f4e651b99aa005469b47d98d940

ci: Enable building of tests

test: Fix Windows x86 icd shim exports

_stdcall in Windows x86 builds would mangle names even with `export "C"`
By adding .def files, the correct name is used in the .dll and the loader will
correctly load it.

Additionally, ShimEnumAdapters2 needs _stdcall for 32 bit mode

Change-Id: Ia60a5e2a9e4378dc3e09864648e04852b10fe524

ci: Enable regression tests in Windows CI

Change-Id: I5bb1d03f9c9a3be82f7ed0763a325996a5d8dae8

build: Update to header 1.2.180

- Update known-good
- Generate source (no change)

Change-Id: I56d4483f777754c9e368ac9b0025d550070fdd83

GN: Support custom library name.

This allows for projects like ANGLE that build the loader to prevent
conflicts with the system.

CMake: Fix linking option and libraries for MinGW.

Check MSVC for Visual Studio specific libraries.

loader: Silence erroneous implicit layer warning

When the override layer or an implicit meta layer is detected, the loader will
go and find all of the explicit layers because the override/meta layer might
require them. During that process `loaderAddLayerProperties` is called. It was
accidentally called with `is_implicit = true`, which causes the loader to interpret the manifest files as if they were implicit, generating
many erroneous warnings.

Change-Id: I8bc6bfa0d2a81159ebc33406e18ebf2099355768

tests: Include <memory> in test_util.h

Change-Id: If2b6766521dd6bea5478b6316eadef8ce3e048cf

ci: Make linux CI run regression tests

Change-Id: I212a714cc0ec41da11bc69e216b4bb54685415a7

cmake: Only enable testing with BUILD_TESTS

`enable_testing()` was previously always enabled when configuring
the loader repository. This commit only does that when `BUILD_TESTS`
is true.

Change-Id: I75666088b84efc4613f72e6938da9ed88b54fb1f

loader: Add pragma once to adapters.h

This allows the header to be included multiple times without error.

Change-Id: I4f4ca4ab57c0b7f8606f397d61dadfadc2597b0b

tests: Add CMake to handle Detours library

The Detours library uses a make file to build it. Thus it needed
to be translated into CMake equivalent code to make a useable target.

Change-Id: Ibed33c962e522f44297c7fa9cbe3f62964503ceb

tests: fix spelling in loader_validation_tests

Change-Id: I2e278b959cd1d47bdc0d7fc19965e4d57e71b481

test: Add regression tests code

These files are the current 4 source code files used to create the
regression test suite

loader_regression_tests.cpp and loader_version_tests.cpp contain a
majority of the tests.

loader_wsi_test.cpp is all the tests pertaining to the WSI functions
in the loader.

loader_testing_main.cpp contains the `main()` which has windows CRT
specific calls to disable popups and debug aserts.

There are two executables created, test_regression and test_wsi.
test_regression is both regression_tests and version_tests. test_wsi
is the WSI tests. These tests are separate as they rely on linking
with platform specific windowing libraries which may not be present
on a CI system.

Change-Id: I1c02b0f82826d337599f4a9a7c02dde40ea5afa3

test: Add framework test_environment

The test environment is the code which glues the platform shim,
TestICD, and TestLayers together so that test code can be easily
written. The main components tests use are the SingleICDShim and
MultipleICDShim classes. Both take care of copying the ICD binaries,
setting up the manifests, and redirecting the platform specific
systems to point at those manifests.

Change-Id: I7cbb76c9555fe13b323173c3838cbb3616b77a18

test: Add test framekwork layer utility

At the present moment, this change is to define simple layer
utilities that tests in the future may use.

Change-Id: I9ab5e1950da64061997891a0527d0f70a49e41e7

test: Add framework platform abstraction shim

The loader queries various platform systems for info such as the
location of ICDs and layers. To isolate the loader during testing
from the system it is running on, the platform shim intercepts the
necessary functions so that the contents of the systems queried by
the loader can be configured by tests.

On windows this involves 2 aspects:
Detouring Win32 API functions and redirecting the registry.
The `Detours` library is used to easily capture Win32 API calls.
And the registry uses `RegOverridePredefKey` to redirect the registry
entries the loader accesses.

On linux this only involves intercepting 3 functions; `opendir`,
`access`, and `fopen`. This allows the framework to tell the loader
what to actuall open/access/fopen. These interceptions call the
underlying function but with altered arguments, specifically to
paths the tests set up.

Change-Id: I3531a1cb190c489ffd9f1f0549d0ebcacb3818c5

tests: Add TestICD for mocking ICD's

The TestICD is a configurable ICD which can recreate much of the
behavior the loader expects of an ICD. Combined with a direct line
of communication between the tests and TestICD, tests can setup
specific conditions that have a known response from the loader,
thus allowing proper regression testing.

Change-Id: I84303f0ddb6011fc1b76dad25fd249abb2da29c9

test: Add framework cmake and utilities

Create the CMake infrastructure for a testing framework.
`test_util.h/.cpp` contains the core macros, wrappers, and utilities.
framework_config.h.in is the header that other components include
to get the full path to binaries on a system.

Change-Id: I3e24a3ee4ff24da499a3bca63059e3b872d3981c

cmake: Make loader use same CRT in debug mode

This solves the issue of debug asserts appearing in the output due to
mixed CRT's in the same build.

Change-Id: I06169c143614dd1102c901f57aa4bdf431df8846

build: Update to header 1.2.179

- Update known-good
- Generate source (no change)

Change-Id: Ib52dc0ff04f76fd1db2dea4a125a094d30abab62

build: Update to header 1.2.178

- Update known-good
- Generate source

Change-Id: I3e2756d9dc0452cc3743a05840d8e2a76961406a

loader: Emit DEBUG for unknown function names

Loader previously emitted WARN level log messages for unknown
function names. This isn't wrong behavior and is mainly useful to
loader developers. Many layers and applications try to load all
function pointers they know about, so this code path is well
travelled.

Change-Id: Ia3e4b47eddb36bd02bcbab8452e5a96d03f75bd3