Simple Virtual Machine
A simple but flexible virtual machine
|
This module contains API functions to handle SVM memory aliases. More...
Functions | |
SVM_FUNCTION void | svm_memory_add_alias (const void *svm, const SVM_Kernel kernel, const SVM_Value_String alias, const SVM_Value_Pointer pointer) |
This function creates a new alias in a memory from a string value. More... | |
SVM_FUNCTION void | svm_memory_add_alias__string (const void *svm, const SVM_Kernel kernel, const SVM_String alias, const SVM_Value_Pointer pointer) |
This function creates a new alias in a memory from a SVM_String. More... | |
SVM_FUNCTION void | svm_memory_add_alias__raw (const void *svm, const SVM_Kernel kernel, const char *alias, const SVM_Value_Pointer pointer) |
This function creates a new alias in a memory from a C nul-terminated value. More... | |
SVM_FUNCTION SVM_Boolean | svm_memory_has_alias (const void *svm, const SVM_Kernel kernel, const SVM_Value_String alias) |
This function checks whether an alias is defined in a memory from a string value. More... | |
SVM_FUNCTION SVM_Boolean | svm_memory_has_alias__string (const void *svm, const SVM_Kernel kernel, const SVM_String alias) |
This function checks whether an alias is defined in a memory from a SVM_String. More... | |
SVM_FUNCTION SVM_Boolean | svm_memory_has_alias__raw (const void *svm, const SVM_Kernel kernel, const char *alias) |
This function checks whether an alias is defined in a memory from a C nul-terminated string. More... | |
SVM_FUNCTION SVM_Value_Pointer | svm_memory_alias_get_pointer (const void *svm, const SVM_Kernel kernel, const SVM_Value_String alias) |
This function extracts the pointer associated to an alias in a memory from a string value. More... | |
SVM_FUNCTION SVM_Value_Pointer | svm_memory_alias_get_pointer__string (const void *svm, const SVM_Kernel kernel, const SVM_String alias) |
This function extracts the pointer associated to an alias in a memory from a SVM_String. More... | |
SVM_FUNCTION SVM_Value_Pointer | svm_memory_alias_get_pointer__raw (const void *svm, const SVM_Kernel kernel, const char *alias) |
This function extracts the pointer associated to an alias in a memory from a C nul-terminated string. More... | |
SVM_FUNCTION void | svm_memory_remove_alias (const void *svm, const SVM_Kernel kernel, const SVM_Value_String alias) |
This function removes an alias from a memory from a string value. More... | |
SVM_FUNCTION void | svm_memory_remove_alias__string (const void *svm, const SVM_Kernel kernel, const SVM_String alias) |
This function removes an alias from a memory from a SVM_String. More... | |
SVM_FUNCTION void | svm_memory_remove_alias__raw (const void *svm, const SVM_Kernel kernel, const char *alias) |
This function removes an alias from a memory from a C nul-terminated string. More... | |
This module contains API functions to handle SVM memory aliases.
SVM_FUNCTION void svm_memory_add_alias | ( | const void * | svm, |
const SVM_Kernel | kernel, | ||
const SVM_Value_String | alias, | ||
const SVM_Value_Pointer | pointer | ||
) |
This function creates a new alias in a memory from a string value.
[in] | svm | The SVM pointer passed as first argument of the callback function. |
[in] | kernel | The kernel in which the targeted memory is. |
[in] | alias | The alias to create. |
[in] | pointer | The memory zone to be identified by the alias. |
FAILURE | interruption when a parameter is incorrect. (Please refer to the main description page of this API.) |
FAILURE | interruption when the kernel is not owned by our process or is not in a process locked by ours. |
MEMORY | interruption when the alias already exists. |
SVM_FUNCTION void svm_memory_add_alias__raw | ( | const void * | svm, |
const SVM_Kernel | kernel, | ||
const char * | alias, | ||
const SVM_Value_Pointer | pointer | ||
) |
This function creates a new alias in a memory from a C nul-terminated value.
[in] | svm | The SVM pointer passed as first argument of the callback function. |
[in] | kernel | The kernel in which the targeted memory is. |
[in] | alias | The alias to create. |
[in] | pointer | The memory zone to be identified by the alias. |
FAILURE | interruption when a parameter is incorrect. (Please refer to the main description page of this API.) |
FAILURE | interruption when the kernel is not owned by our process or is not in a process locked by ours. |
MEMORY | interruption when the alias already exists. |
SVM_FUNCTION void svm_memory_add_alias__string | ( | const void * | svm, |
const SVM_Kernel | kernel, | ||
const SVM_String | alias, | ||
const SVM_Value_Pointer | pointer | ||
) |
This function creates a new alias in a memory from a SVM_String.
[in] | svm | The SVM pointer passed as first argument of the callback function. |
[in] | kernel | The kernel in which the targeted memory is. |
[in] | alias | The alias to create. |
[in] | pointer | The memory zone to be identified by the alias. |
FAILURE | interruption when a parameter is incorrect. (Please refer to the main description page of this API.) |
FAILURE | interruption when the kernel is not owned by our process or is not in a process locked by ours. |
MEMORY | interruption when the alias already exists. |
SVM_FUNCTION SVM_Value_Pointer svm_memory_alias_get_pointer | ( | const void * | svm, |
const SVM_Kernel | kernel, | ||
const SVM_Value_String | alias | ||
) |
This function extracts the pointer associated to an alias in a memory from a string value.
[in] | svm | The SVM pointer passed as first argument of the callback function. |
[in] | kernel | The kernel in which the targeted memory is. |
[in] | alias | The alias from which the pointer is extracted . |
FAILURE | interruption when a parameter is incorrect. (Please refer to the main description page of this API.) |
FAILURE | interruption when the kernel is not owned by our process or is not in a process locked by ours. |
FAILURE | interruption when the alias is not defined. |
SVM_FUNCTION SVM_Value_Pointer svm_memory_alias_get_pointer__raw | ( | const void * | svm, |
const SVM_Kernel | kernel, | ||
const char * | alias | ||
) |
This function extracts the pointer associated to an alias in a memory from a C nul-terminated string.
[in] | svm | The SVM pointer passed as first argument of the callback function. |
[in] | kernel | The kernel in which the targeted memory is. |
[in] | alias | The alias from which the pointer is extracted . |
FAILURE | interruption when a parameter is incorrect. (Please refer to the main description page of this API.) |
FAILURE | interruption when the kernel is not owned by our process or is not in a process locked by ours. |
FAILURE | interruption when the alias is not defined. |
SVM_FUNCTION SVM_Value_Pointer svm_memory_alias_get_pointer__string | ( | const void * | svm, |
const SVM_Kernel | kernel, | ||
const SVM_String | alias | ||
) |
This function extracts the pointer associated to an alias in a memory from a SVM_String.
[in] | svm | The SVM pointer passed as first argument of the callback function. |
[in] | kernel | The kernel in which the targeted memory is. |
[in] | alias | The alias from which the pointer is extracted . |
FAILURE | interruption when a parameter is incorrect. (Please refer to the main description page of this API.) |
FAILURE | interruption when the kernel is not owned by our process or is not in a process locked by ours. |
FAILURE | interruption when the alias is not defined. |
SVM_FUNCTION SVM_Boolean svm_memory_has_alias | ( | const void * | svm, |
const SVM_Kernel | kernel, | ||
const SVM_Value_String | alias | ||
) |
This function checks whether an alias is defined in a memory from a string value.
[in] | svm | The SVM pointer passed as first argument of the callback function. |
[in] | kernel | The kernel in which the targeted memory is. |
[in] | alias | The alias to check. |
FAILURE | interruption when a parameter is incorrect. (Please refer to the main description page of this API.) |
FAILURE | interruption when the kernel is not owned by our process or is not in a process locked by ours. |
SVM_FUNCTION SVM_Boolean svm_memory_has_alias__raw | ( | const void * | svm, |
const SVM_Kernel | kernel, | ||
const char * | alias | ||
) |
This function checks whether an alias is defined in a memory from a C nul-terminated string.
[in] | svm | The SVM pointer passed as first argument of the callback function. |
[in] | kernel | The kernel in which the targeted memory is. |
[in] | alias | The alias to check. |
FAILURE | interruption when a parameter is incorrect. (Please refer to the main description page of this API.) |
FAILURE | interruption when the kernel is not owned by our process or is not in a process locked by ours. |
SVM_FUNCTION SVM_Boolean svm_memory_has_alias__string | ( | const void * | svm, |
const SVM_Kernel | kernel, | ||
const SVM_String | alias | ||
) |
This function checks whether an alias is defined in a memory from a SVM_String.
[in] | svm | The SVM pointer passed as first argument of the callback function. |
[in] | kernel | The kernel in which the targeted memory is. |
[in] | alias | The alias to check. |
FAILURE | interruption when a parameter is incorrect. (Please refer to the main description page of this API.) |
FAILURE | interruption when the kernel is not owned by our process or is not in a process locked by ours. |
SVM_FUNCTION void svm_memory_remove_alias | ( | const void * | svm, |
const SVM_Kernel | kernel, | ||
const SVM_Value_String | alias | ||
) |
This function removes an alias from a memory from a string value.
[in] | svm | The SVM pointer passed as first argument of the callback function. |
[in] | kernel | The kernel in which the targeted memory is. |
[in] | alias | The alias to delete. |
This API function does nothing if the alias did not exist.
FAILURE | interruption when a parameter is incorrect. (Please refer to the main description page of this API.) |
FAILURE | interruption when the kernel is not owned by our process or is not in a process locked by ours. |
SVM_FUNCTION void svm_memory_remove_alias__raw | ( | const void * | svm, |
const SVM_Kernel | kernel, | ||
const char * | alias | ||
) |
This function removes an alias from a memory from a C nul-terminated string.
[in] | svm | The SVM pointer passed as first argument of the callback function. |
[in] | kernel | The kernel in which the targeted memory is. |
[in] | alias | The alias to delete. |
This API function does nothing if the alias did not exist.
FAILURE | interruption when a parameter is incorrect. (Please refer to the main description page of this API.) |
FAILURE | interruption when the kernel is not owned by our process or is not in a process locked by ours. |
SVM_FUNCTION void svm_memory_remove_alias__string | ( | const void * | svm, |
const SVM_Kernel | kernel, | ||
const SVM_String | alias | ||
) |
This function removes an alias from a memory from a SVM_String.
[in] | svm | The SVM pointer passed as first argument of the callback function. |
[in] | kernel | The kernel in which the targeted memory is. |
[in] | alias | The alias to delete. |
This API function does nothing if the alias did not exist.
FAILURE | interruption when a parameter is incorrect. (Please refer to the main description page of this API.) |
FAILURE | interruption when the kernel is not owned by our process or is not in a process locked by ours. |