<!-- description --> @brief The same as bsl::ut_check, but checks for LOADER_SUCCESS <!-- inputs/outputs --> @param test if LOADER_SUCCESS, the test

<!-- description --> @brief Initializes this vm_t <!-- inputs/outputs --> @param i the ID for this vm_t

<!-- description --> @brief Allocates this vm_t <!-- inputs/outputs --> @param mut_tls the current TLS block @param mut_page_pool the page_pool_t to

<!-- description --> @brief Returns a pointer to the read-only mapped file. <!-- inputs/outputs --> @return Returns a pointer to the read-only mapped

@copyright Copyright (C) 2020 Assured Information Security, Inc. @copyright Permission is hereby granted, free of charge, to any person obtaining a c

<!-- description --> @brief Reports passed/failed so that a script can detect if the failed text shows up in the log. If the test fails, this function

<!-- description --> @brief Clears the vs_t's internal cache. Note that this is a hardware specific function and doesn't change the actual values stor

* <!-- description --> * @brief Writes a string to the serial. Note that you must initialize * the serial before you can use it. * * <!-- in

<!-- description --> @brief Returns the value of requested 64 bit VMCS field <!-- inputs/outputs --> @param field the 64 bit VMCS field to read @para

<!-- description --> @brief Opens a handle and returns the resulting handle <!-- inputs/outputs --> @return Opens a handle and returns the resulting

* <!-- description --> * @brief Outputs a string and an 64bit hex to the console * * <!-- inputs/outputs --> * @param str the string to output

* <!-- description --> * @brief Outputs a string to the console * * <!-- inputs/outputs --> * @param str the string to output */

<!-- description --> @brief Release the vm_t. <!-- inputs/outputs --> @param mut_tls the current TLS block @param mut_page_pool the page_pool_t to us

<!-- description --> @brief Creates the basic_page_pool_t given a mutable_buffer_t to the basic_page_pool_t as well as the virtual address base of the

<!-- description --> @brief Closes the file, releasing all of the resource back to the OS kernel.

<!-- description --> @brief Initializes this vp_t <!-- inputs/outputs --> @param gs the gs_t to use @param tls the tls_t to use @param sys the bf_sys

<!-- description --> @brief Resets common tests

<!-- description --> @brief Writes a field to the vs_t given a bf_reg_t defining the field and a value to write. <!-- inputs/outputs --> @param tls t

<!-- description --> @brief The same as bsl::ut_check, but checks for LOADER_FAILURE <!-- inputs/outputs --> @param test if LOADER_FAILURE, the test

<!-- description --> @brief Used to execute the actual checks. We put the checks in this function so that we can validate the tests both at compile-ti

<!-- description --> @brief Returns the number of bytes in the pool. <!-- inputs/outputs --> @return Returns the number of bytes in the pool.

<!-- description --> @brief Resets tests for x64

<!-- description --> @brief Sets the value of requested 64 bit VMCS field <!-- inputs/outputs --> @param field the 64 bit VMCS field to write to @par

<!-- description --> @brief Returns the ID of the first identified PP this vm_t is active on. If the vm_t is not active, bsl::safe_u16::failure() is r

<!-- description --> @brief Returns true if this vm_t is deallocated, false otherwise <!-- inputs/outputs --> @return Returns true if this vm_t is de

<!-- description --> @brief Returns true if this vm_t is allocated, false otherwise <!-- inputs/outputs --> @return Returns true if this vm_t is allo

<!-- description --> @brief Returns true if this vm_t is active on the current PP, false otherwise <!-- inputs/outputs --> @param tls the current TLS

* <!-- description --> * @brief Writes a string to the console. * * <!-- inputs/outputs --> * @param str the string to write to the console.

<!-- description --> @brief Dispatches the bf_vs_op syscalls <!-- inputs/outputs --> @param mut_tls the current TLS block @param mut_page_pool the pa

<!-- description --> @brief Returns true if this vp_t is deallocated, false otherwise <!-- inputs/outputs --> @return Returns true if this vp_t is de

<!-- description --> @brief Initializes a file_t <!-- inputs/outputs --> @param mut_file the file to initialize

<!-- description --> @brief Dumps the vm_t <!-- inputs/outputs --> @param tls the current TLS block

<!-- description --> @brief Reads a CPU register from the VS given a bf_reg_t. Note that the bf_reg_t is architecture specific. <!-- inputs/outputs -

<!-- description --> @brief Cleanup and returns success <!-- inputs/outputs --> @return Returns success

<!-- description --> @brief Sets this vm_t as active. <!-- inputs/outputs --> @param mut_tls the current TLS block

<!-- description --> @brief Returns the value of a requested TLS register <!-- inputs/outputs --> @param reg the TLS register to get @return Returns

<!-- description --> @brief Returns the value of a requested TLS register <!-- inputs/outputs --> @param reg the TLS register to get @return Returns

<!-- description --> @brief Deallocates this vm_t <!-- inputs/outputs --> @param mut_tls the current TLS block @param mut_page_pool the page_pool_t t

<!-- description --> @brief Returns true if this vp_t is allocated, false otherwise <!-- inputs/outputs --> @return Returns true if this vp_t is allo

<!-- description --> @brief Initializes this vp_t <!-- inputs/outputs --> @param gs the gs_t to use @param tls the tls_t to use @param sys the bf_sys

<!-- description --> @brief Allocates the vp_t and returns it's ID <!-- inputs/outputs --> @param gs the gs_t to use @param tls the tls_t to use @par

<!-- description --> @brief Returns the value of requested 32 bit VMCS field <!-- inputs/outputs --> @param field the 32 bit VMCS field to read @para

<!-- description --> @brief This syscall tells the microkernel that the extension would like to wait for a callback. This is a blocking syscall that n

<!-- description --> @brief Sets the value of requested 32 bit VMCS field <!-- inputs/outputs --> @param field the 32 bit VMCS field to write to @par

<!-- description --> @brief Dispatches the VMExit. <!-- inputs/outputs --> @param gs the gs_t to use @param tls the tls_t to use @param mut_sys the b

* <!-- description --> * @brief Implements itoa * * <!-- inputs/outputs --> * @param mut_value the value to convert to a strin

<!-- description --> @brief Dispatches the fail as needed, or returns an error so that the microkernel can halt the PP. <!-- inputs/outputs --> @para

* <!-- description --> * @brief This function contains all of the code that is common between * all archiectures and all platforms that is nee

<!-- description --> @brief Returns the ID of the VM this vp_t is assigned to. If vp_t is not assigned, syscall::BF_INVALID_ID is returned. <!-- inpu

* <!-- description --> * @brief This function contains all of the code that is common between * all archiectures and all platforms that is nee

<!-- description --> @brief Deallocates the vp_t <!-- inputs/outputs --> @param gs the gs_t to use @param tls the tls_t to use @param sys the bf_sysc

* <!-- description --> * @brief If test is false, a contract violation has occurred. This * should be used to assert preconditions that if not

<!-- description --> @brief Returns the number of bytes in the file being mapped. <!-- inputs/outputs --> @return Returns the number of bytes in the

* <!-- description --> * @brief A do nothing function designed to ensure line coverage * includes the line being touched. See bsl::tou

<!-- description --> @brief Sets this vm_t as inactive. <!-- inputs/outputs --> @param mut_tls the current TLS block

* <!-- description --> * @brief Outputs a string and an 64bit hex to the console * * <!-- inputs/outputs --> * @param str the string to output

<!-- description --> @brief Initializes the Global Storage (GS). <!-- inputs/outputs --> @param gs the gs_t to use @param sys the bf_syscall_t to use

<!-- description --> @brief Writes to a CPU register in the VS given a bf_reg_t and the value to write. Note that the bf_reg_t is architecture specifi

* <!-- description --> * @brief Outputs a string and an pointer to the console * * <!-- inputs/outputs --> * @param str the string to output

<!-- description --> @brief Flushes any TLB entries associated with this VS on the current PP. <!-- inputs/outputs --> @param tls the current TLS blo

<!-- description --> @brief Deletes the provided ELF file buffer. <!-- inputs/outputs --> @param elf_file_buf the ELF file buffer to delete

<!-- description --> @brief Returns an allocated and initialized ELF file buffer for use during testing. <!-- inputs/outputs --> @return Returns an a

<!-- description --> @brief Initializes common tests

<!-- description --> @brief Loads the initial state of an ELF file. <!-- inputs/outputs --> @param mut_file the ELF file to load @param phdr_table th

<!-- description --> @brief Provides the main entry point for NMI exceptions (which on AMD do not occur as NMIs are blocked). <!-- inputs/outputs -->

* <!-- description --> * @brief Releases a previously allocated root_page_table_t that was allocated * using the alloc_mk_root_page_table func

<!-- description --> @brief Loads the initial state of the program header table. <!-- inputs/outputs --> @param mut_phdr_table the program header tab

* <!-- description --> * @brief This function allocates the root page table * * <!-- inputs/outputs --> * @param pmut_rpt where to return the

<!-- description --> @brief Returns the ID of this vs_t <!-- inputs/outputs --> @return Returns the ID of this vs_t

* <!-- description --> * @brief This function frees memory previously allocated using the * platform_alloc() function. * * <!-- inputs/outpu

<!-- description --> @brief Sets the value of a requested TLS register <!-- inputs/outputs --> @param reg the TLS register to set @param val the valu

<!-- description --> @brief Sets the value of a requested TLS register <!-- inputs/outputs --> @param reg the TLS register to set @param val the valu

<!-- description --> @brief Returns the ID of this vs_t <!-- inputs/outputs --> @return Returns the ID of this vs_t

<!-- description --> @brief Release the vp_t. <!-- inputs/outputs --> @param gs the gs_t to use @param tls the tls_t to use @param sys the bf_syscall

<!-- description --> @brief Dispatches the bf_vm_op syscalls <!-- inputs/outputs --> @param mut_tls the current TLS block @param mut_page_pool the pa

<!-- description --> @brief Returns the ID of this vm_t <!-- inputs/outputs --> @return Returns the ID of this vm_t

* <!-- description --> * @brief Outputs a string and an 16bit hex to the console * * <!-- inputs/outputs --> * @param str the string to output

<!-- description --> @brief Returns the ID of the PP this vs_t is assigned to. If this vs_t is not assigned, syscall::BF_INVALID_ID is returned. <!--

<!-- description --> @brief Returns the ID of the VM this vs_t is assigned to. If this vs_t is not assigned, syscall::BF_INVALID_ID is returned. <!--

* <!-- description --> * @brief This function frees memory previously allocated using the * platform_alloc() function. * * <!-- inputs/outpu

* <!-- description --> * @brief This function allocates read/write virtual memory from the * kernel. This memory is not physically contiguous.

<!-- description --> @brief Used to execute the actual checks. We put the checks in this function so that we can validate the tests both at compile-ti

<!-- description --> @brief Tells the extension that a VM was created so that it can initialize it's VM specific resources. <!-- inputs/outputs --> @

<!-- description --> @brief Used to execute the actual checks. We put the checks in this function so that we can validate the tests both at compile-ti

<!-- description --> @brief Outputs a character to the serial port. <!-- inputs/outputs --> @param mut_ring the debug ring to output to @param c the

<!-- description --> @brief Returns the ID of the PP this vs_t is assigned to If vs_t is not assigned, syscall::BF_INVALID_ID is returned. <!-- input

<!-- description --> @brief Returns the ID of this vp_t <!-- inputs/outputs --> @return Returns the ID of this vp_t

<!-- description --> @brief Returns the value of requested 16 bit VMCS field <!-- inputs/outputs --> @param field the 16 bit VMCS field to read @para

<!-- description --> @brief This syscall tells the microkernel to create a VP given the IDs of the VM and PP the VP will be assigned to. Upon success,

<!-- description --> @brief Outputs a string to the serial port. <!-- inputs/outputs --> @param str the string to output @param len the total number

<!-- description --> @brief Dispatches the bf_debug_op syscalls <!-- inputs/outputs --> @param mut_tls the current TLS block @param page_pool the pag

<!-- description --> @brief Used to execute the actual checks. We put the checks in this function so that we can validate the tests both at compile-ti

<!-- description --> @brief Returns the ID of the VM this vp_t is assigned to. If this vp_t is not assigned, syscall::BF_INVALID_ID is returned. <!--

<!-- description --> @brief This syscall tells the microkernel to create a VS and return it's ID. <!-- inputs/outputs --> @param vpid The ID of the V

* <!-- description --> * @brief Releases a previously allocated code_aliases_t that was allocated * using the alloc_and_copy_mk_code_aliases f

* <!-- description --> * @brief Given a virtual address, this function returns the virtual * address's physical address. Returns NULL if the c

<!-- description --> @brief Print the contents of a register <!-- inputs/outputs --> @param name the name of the register @param val the value of the