bareflank-hypervisor/loader/include/alloc_mk_stack.h
Rian Quinn dcbe19368c Adds missing unit tests for the loader
This patch:
- Completes the unit tests for the loader
- Fixes issues with Clang Tidy
2021-10-15 08:07:34 -06:00

54 lines
1.9 KiB
C

/**
* @copyright
* Copyright (C) 2020 Assured Information Security, Inc.
*
* @copyright
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* @copyright
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* @copyright
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#ifndef ALLOC_MK_STACK_H
#define ALLOC_MK_STACK_H
#include <span_t.h>
#include <types.h>
#ifdef __cplusplus
extern "C"
{
#endif
/**
* <!-- description -->
* @brief Allocates a chunk of memory for the stack used by the
* microkernel. Note that the "size" parameter is in total pages and
* not in bytes. If the provided size is 0, this function will allocate
* a default number of pages.
*
* <!-- inputs/outputs -->
* @param pmut_stack the span_t to store the stack addr/size.
* @return LOADER_SUCCESS on success, LOADER_FAILURE on failure.
*/
NODISCARD int64_t alloc_mk_stack(struct span_t *const pmut_stack) NOEXCEPT;
#ifdef __cplusplus
}
#endif
#endif