test: Isolate Env-Vars from test framework

Previously if any of the env-vars the loader looks for were set on the
system, the loader would find and use them, leading to highly confusing
logs. Removing them preemptively at tests start make this a non-issue.

build: Fix using wrong Windows SDK for VS 2015

CMake 3.19 disallowed VS 2015 builds from selecting an SDK higher than
10.0.14393. Unfortunately, the loader requires SDK version 10.0.17763 or
higher. This commit uses the 3.19 capability to disable that limit set in
place by CMake so that we can use an SDK that suits our needs.

build: Update to header 1.2.193

- Update known-good
- Generate source

loader: Add cJSON prefix to update function

build: Update to header 1.2.192

- Update known-good
- Generate source

loader: Add loader.rc to Windows GN build

This omission was causing the build dll to be missing version info.

test: Fix 32 bit test suite build error

loader: Move struct decls to loader_common.h

Not all structs declarations in loader.h were moved to loader_common.h. This
caused compilation errors due to not having the struct declaration available
in the headers it was needed.

test: Add test which calls GetPDProps inside CreateInstance

This test makes sure that any layer calling GetPDProps inside of CreateInstance
succeeds and doesn't crash.

test: Add ICD Interface V6 TestICD binary

test: Add callback to layers create instance and device

This allows some code to be written inside the test which then gets run
during the call to vkCreateInstance and vkCreateDevice.

Update more logging info for the Loader

Output more information to the "info" debug target when the loader loads
so we can determine more info about:
 - Where loader was loaded from (Windows)
 - What Git Branch was used to build it
 - What Git tags were most recent when it was built.
Also, add more detailed logging of implicit layers:
 - Log manifest file location
 - Layer library location
 - Type of layer (implicit/explicit)
 - Disable enum if layer is implicit

loader: Reverst asserting on size 0 in malloc

loader: Move disable_environment into function body

The function `loader_read_layer_json` does not modify the
disable_environment parameter that is passed in. It can safely be made
a variable local to the function.

Change-Id: I25ef3f3e5f008082dc9514be8f607d2acbf212a1

build: Use generated source everywhere

The previous commit that added a generated header version didn't apply
it to mac or linux specific versioning. This commit fixes that.

test: Add test for memory leak in setup_tramp_phys_devs

Tries to trick the loader by increasing the number of physical devices
after the call to vkEnumeratePhysicalDevices to get the count.

loader: Fix freeing of uninitialized list

The memset of icd_tramp_list in terminator_EnumerateInstanceExtensionPropeties
was inside an else-branch. If an error occured in the preceding if branch, this
would cause the cleanup code to run on a non-zerod out icd_tramp_list.

Change-Id: I7af1da31580f01c54c4ffababbb9c7ecfa8966d8

loader: Remove deadstore when breaking from a loop

Change-Id: Ic72cf396cad918ce255b331fa9a9c3a652b8764d

loader: Prevent use-after-free in error path.

When `setup_loader_term_phys_devs` and `setup_loader_term_phys_dev_groups` hit an
error, they attempt to delete all the alocated elements in `new_phys_devs`. However,
the code first may copy elements from another array into it first before hitting
the error. This causes the deletion code to free those 'good' elements which were
copied, leading to use-after-free's.

Additionally, an error message used total_gpu_count instead of total_icd_count, this
is fixed with this commit.

Change-Id: I8f714f699ff09cc99d094cf2ed8190cedcad684b

loader: Don't pass null pointer into strcmp

strcmp wasn't correctly guarded against a null first parameter when
doing the shallow search in loader_name_in_dev_ext_table and
loader_name_in_phys_dev_ext_table.

Change-Id: Ia751e9860334895930210defa2dcb2becbfd6daa

loader: Remove dead store of total_count

`loaderScanForLayers` total_count is not used after determining
if it is not zero.

Change-Id: I2ff3a1a5d7dde42ce5ad7d57aab63831ccf58156

loader: Prevent stack_alloc of 0

`loader_create_device_chain` would previously attempt to use stack allocations
when `expanded_activated_layer_list.count` was zero, which is undefined behavior

Change-Id: I56fab835a1728914191f1a7adc210dae58afa155

loader: Get DeviceGroups early exits if 0 are found

This commit prevents undefined behavior by exiting
`setupLoaderTermPhysDevGroups` if total_count is 0.

Change-Id: Ieef2747724f79ec26a08a74884904bc0e0485c17

loader: Remove redundant stores

`layer_node = layer_node->next;` is redundant in error paths that goto out.

Change-Id: I889b03c825f896f458a1ed3171b951d64d8827d7

loader: assert if trying to malloc 0 bytes

The behavior of malloc is undefined if size is 0. This commit checks for that
and prevents a possible malloc of zero in device extension property enumeration
by only malloc'ing if size is greater than 0.

Change-Id: Id506ab93d404bd4895503c660ef74bcb9c4550a3

loader: Format WSI error messages

Change-Id: I3040be426a8e70ca41e7beede1fae6b52e1381af

loader: Use abort to force a crash where needed

Many places in the loader need to intentionally crash. This commit makes the
loader use `abort();` in those places, including replacing numerous
`assert(false)` statements. Using abort clearly signals intent instead of
having it do a null pointer dereference to cause the crash.

Change-Id: I6874eab5702c94af59b7984fab00f6eaf03f2f45

loader: Fix potential memory leak

Also remove a redundant setting of an int to 0

Change-Id: Ia099ad75e9da14aacf9874d75267716c12794305

loader: Handle OOM in loader_phys_dev_ext_gpa

Removing some dead code revealed a case where a potencial OOM situation
was not being handled.

Change-Id: Ibc5ad607f6adc0f590f663ab928c1abca6732d96

loader: Make trampolineGetProcAddr snake_case

loader: Move simple terminators to terminator.c

Keeps the complex terminators in loader.c for the time being.

loader: Rename SetupLoaderTermPhysDevGroups

Forgot this name when renaming all the functions.

gn: Fix gn build for refactor changes

loader: Move Windows logic to dedicated file

Relocated most windows specific functionality into loader_windows.h/.c
This removes the need for loader.c to include windows specific header files.

loader: Move struct declarations into header

loader: Move init functions closer together

loader: Header include cleanup

Separated headers into common groups, with system headers being first, then
Vulkan API headers, followed by loader headers.

Then alphabetized headers in each group. Due to moving _GNU_SOURCE to being set
by cmake, there isn't any implicit dependency between the include order used.

Made sure headers should be able to be included independently, such as
including the vulkan headers where appropriate.

loader: Remove headers from cmake source list

Headers do not do any functional thing here. Better to remove them so they dont
clutter up or make people thing they need to be there.

loader: Make logging and getenv their own headers

This commit pulls the logging capabilities into a single log.h/.c file and does
the same for the getenv functionality.

loader: Make _GNU_SOURCE a cmake definition

Moves the many instances of #define _GNU_SOURCE into a single cmake call which
sets the macro in all translation units for the vulkan library. This way it
cannot be forgotten and makes behavior across the library consistent.

loader: Move alloca into allocation.h

loader: Remove duplicate macro defines

loader: Make vk_loader_layer.h a proper header

Makes it possible to include this file without worry of not having the required
headers already included.

loader: Remove unneeded parts of loader_common.h

loader: Shift around vk_loader_platform headers

Moved the includes into their own block, instead of living in the block for
each operating system. This way is easier to see what includes are in the file
in its entirety.

Also, _GNU_SOURCE was uncommented since it appears in each source file
individually and is needed for alloca and secure_getenv

loader: Dont include C++ libraries in C++ mode

loader: Move allocation functions to a header

Functions pertainting to allocation (malloc, realloc, free) have been moved to
their own translation unit for better organizational purposes.

loader: Remove TLS

The only purpose TLS was serving was as a channel for allocation callbacks to
be useable inside cJSON and dirent_on_windows. TLS didn't solve any specific
threading problem. Instead it served as an information channel. On top of that,
the only time when the TLS was used was inside vkCreateInstance as the
pre-instance calls would have the TLS pointer to loader_instance be set to
NULL.

loader: cJSON to use regular heap instead of TLS

Refactored the cJSON library to take an loader_instance pointer everywhere it
allocates memory. This way a TLS loader_instance pointer doesn't need to be
set at initialization and then at vkCreateInstance.

loader: Dont use TLS in dirent_on_windows

Loader will now pass in the instance handle directly rather than rely on TLS to
pass it. This makes the loader code simpler to reason about and better since
if a second instance is created on the same thread the TLS wont be overwritten.

loader: Add gpa_helper.c

Make gpa_helper.h not contain function definitions, moving them into the
appropriate header file.

loader: Move loader struct defs into common file

This commit separates the structure definitions from the function declarations.
The reason to do this is to allow splitting of loader.h/.c functionality into
individual headers, which may require access to these structs but don't need to
know about the other functions.

loader: Update Copyright for 2021

loader: Use #pragma once everywhere

The #pragma once include guard is sufficiently widespread enough to allow
usage of it everywhere.

loader: Update Copyright

build: Alphabetize loader source file list

test: Add test for Override Meta Layer

test: Fix extra } in layer manifest printer

loader: Move layer cleanup to a single function

Previously the logic to free all the components of loader_layer_properties was spread
across a half dozen different places, resulting in leaks. This commit moves the logic
into a single location, centralizing the process and making it easier to add new
fields to the loader_layer_properties struct.

build: Update to header 1.2.191

- Update known-good
- Generate source

test: Improved Test Wrapper interface

Made InstanceWrapper and DeviceWrapper simpler to use by moving them to test_environment
then making the Create() member functions and doing the gtest assertions in the function
itself.

Additionally:
Removed the `detail` namespace in the test_environment.
Renamed get_new_test_icd/layer to just `reset_icd/layer`. This is clearer about what it
is doing and makes the interface more expressive with code such as
`env->reset_icd().SetMinInterfaceVersion(5);`

loader: Make all loader functions use snake_case

Before it was a mix of camelCase, PascalCase, and snake_case.

"Vulkan" functions, like terminator_GetPhysicalDeviceProperties, remain in camelCase.
This way it looks visually similar with the actual vulkan functions they correspond to.

Fix loader not knowing about extensions enabled in layers

This change allows the loader to know extensions enabled in the layers
as well as extensions enabled but handled by layers.
This should fix several issues where the enabled extensions is not
known soon enough for layers to use.

Update XDG paths

Issue #245 was created because we were not properly using the XDG
paths.
This change updates the path search order to be more correct.
While an argument could be made that the loader really should only
be looking in the DATA folders, we already are looking in the
CONFIG folders.  Therefore, just correct the order and also make
sure the proper _HOME variable for CONFIG and DATA is searched
first (but only in non-superuser mode).

test: Add handle_assert helper functions

Added functions which check handle values using GTEST. Includes:
checking for null, not null, equality of two handles, and variants that
operate on vectors and arrays.

test: Move DeviceGroup tests to regression suite

test: Add TestICD DeviceGroup support

Add support for tests which use device groups by adding a new structure that
holds pointes to PhysicalDevice structs and implementing the necessary vulkan
API calls.

This commit also:
 - Formats test_icd.cpp
 - Makes vk_icdGetPhysicalDeviceProcAddr return stuff by refactoring the
   instance procaddr functions

scripts: Remove loader_icd_init_entries duplicate

Seems to be a copy-paste error that makes the function declaration appear twice.

build: Update to header 1.2.190

- Update known-good
- Generate source

build: Silence MSVC warning of replacing /GR

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.