state.h

Go to the documentation of this file.

#pragma once
 
#include <modules/acpi/aml/encoding/arg.h>
#include <modules/acpi/aml/encoding/local.h>
#include <modules/acpi/aml/namespace.h>
#include <modules/acpi/aml/object.h>
 
/**
 * @brief State
 * @defgroup modules_acpi_aml_state State
 * @ingroup modules_acpi_aml
 *
 * @{
 */
 
/**
 * @brief AML State
 * @struct aml_state_t
 *
 * Used to keep track of the virtual machine's state and while invoking methods or parsing DSDT/SSDT tables.
 *
 * Note that when a Method is evaluated a new `aml_state_t` is created for the Method's AML bytecode stream.
 */
typedef struct aml_state
{
    aml_local_t* locals[AML_MAX_LOCALS]; ///< Local variables for the method, if any, initialized lazily.
    aml_arg_t* args[AML_MAX_ARGS];       ///< Argument variables for the method, if any.
    aml_object_t* result;                ///< The return value, see `aml_method_invoke()` for details.
    uint64_t errorDepth;                 ///< The length of the error traceback, if 0 then no error has occurred.
    aml_overlay_t overlay;               ///< Holds any named objects created during parsing.
} aml_state_t;
 
/**
 * @brief Initialize an AML state.
 *
 * @param state Pointer to the state to initialize.
 * @param args Array of pointers to the objects to pass as arguments, or `NULL`. Must be null-terminated.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_state_init(aml_state_t* state, aml_object_t** args);
 
/**
 * @brief Deinitialize an AML state.
 *
 * @param state Pointer to the state to deinitialize.
 */
void aml_state_deinit(aml_state_t* state);
 
/**
 * @brief Get the result object of the state.
 *
 * If no result is available, a Integer object with value 0 is returned.
 *
 * @see aml_method_invoke() for more details.
 *
 * @param state Pointer to the state.
 * @return On success, a copy of the result object. On failure, `NULL` and `errno` is set.
 */
aml_object_t* aml_state_result_get(aml_state_t* state);
 
/**
 * @brief Set the result object of the state.
 *
 * Note that methods are supposed to return copies of objects, not references to existing objects. However, due to the
 * behaviour of implicit returns, always returning the last evaluated object, means there is no way for the object to be
 * modified between this function being called and the method returning. So in this case it is acceptable to store a
 * reference to the object and only make a copy when the method actually returns.
 *
 * @see aml_method_invoke() for more details.
 *
 * @param state Pointer to the state.
 * @param result Pointer to the result object, or `NULL` to clear the result.
 */
void aml_state_result_set(aml_state_t* state, aml_object_t* result);
 
/** @} */