| // Copyright 2020 The IREE Authors |
| // |
| // Licensed under the Apache License v2.0 with LLVM Exceptions. |
| // See https://llvm.org/LICENSE.txt for license information. |
| // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
| |
| #include <assert.h> |
| #include <stddef.h> |
| #include <stdint.h> |
| #include <string.h> |
| |
| #include "iree/base/api.h" |
| #include "iree/vm/context.h" |
| #include "iree/vm/instance.h" |
| #include "iree/vm/module.h" |
| #include "iree/vm/native_module.h" |
| #include "iree/vm/ref.h" |
| #include "iree/vm/stack.h" |
| |
| // Wrapper for calling the import functions with type (i32)->i32. |
| // NOTE: we should have some common ones prebuilt or can generate and rely on |
| // LTO to strip duplicates across the entire executable. |
| // TODO(benvanik): generate/export these shims/call functions in stack.h. |
| static iree_status_t call_import_i32_i32(iree_vm_stack_t* stack, |
| const iree_vm_function_t* import, |
| int32_t arg0, int32_t* out_ret0) { |
| iree_vm_function_call_t call; |
| call.function = *import; |
| call.arguments = iree_make_byte_span(&arg0, sizeof(arg0)); |
| call.results = iree_make_byte_span(out_ret0, sizeof(*out_ret0)); |
| return import->module->begin_call(import->module, stack, call); |
| } |
| |
| typedef iree_status_t (*call_i32_i32_t)(iree_vm_stack_t* stack, |
| void* module_ptr, void* module_state, |
| int32_t arg0, int32_t* out_ret0); |
| |
| // Wrapper for calling a |target_fn| C function from the VM ABI. |
| // It's optional to bounce through like this; if the function can more |
| // efficiently directly access the arguments from the |call| then it can do so. |
| // This approach is most useful when the function may also be exported/used by |
| // non-VM code or may be internally referenced using a target-specific ABI. |
| // TODO(benvanik): generate/export these shims/call functions in stack.h. |
| static iree_status_t call_shim_i32_i32(iree_vm_stack_t* stack, |
| iree_vm_native_function_flags_t flags, |
| iree_byte_span_t args_storage, |
| iree_byte_span_t rets_storage, |
| call_i32_i32_t target_fn, void* module, |
| void* module_state) { |
| // We can use structs to allow compiler-controlled indexing optimizations, |
| // though this won't work for variadic cases. |
| // TODO(benvanik): packed attributes. |
| typedef struct { |
| int32_t arg0; |
| } args_t; |
| typedef struct { |
| int32_t ret0; |
| } results_t; |
| |
| const args_t* args = (const args_t*)args_storage.data; |
| results_t* results = (results_t*)rets_storage.data; |
| |
| // For simple cases like this (zero or 1 result) we can tail-call. |
| return target_fn(stack, module, module_state, args->arg0, &results->ret0); |
| } |
| |
| //===----------------------------------------------------------------------===// |
| // module_a |
| //===----------------------------------------------------------------------===// |
| // This simple stateless module exports two functions that can be imported by |
| // other modules or called directly by the user. When no imports, custom types, |
| // or per-context state is required this simplifies module definitions. |
| // |
| // module_b below imports these functions and demonstrates a more complex module |
| // with state. |
| |
| typedef struct module_a_t module_a_t; |
| typedef struct module_a_state_t module_a_state_t; |
| |
| // vm.import private @module_a.add_1(%arg0 : i32) -> i32 |
| static iree_status_t module_a_add_1(iree_vm_stack_t* stack, module_a_t* module, |
| module_a_state_t* module_state, |
| int32_t arg0, int32_t* out_ret0) { |
| // Add 1 to arg0 and return. |
| *out_ret0 = arg0 + 1; |
| return iree_ok_status(); |
| } |
| |
| // vm.import private @module_a.sub_1(%arg0 : i32) -> i32 |
| static iree_status_t module_a_sub_1(iree_vm_stack_t* stack, module_a_t* module, |
| module_a_state_t* module_state, |
| int32_t arg0, int32_t* out_ret0) { |
| // Sub 1 to arg0 and return. Fail if < 0. |
| *out_ret0 = arg0 - 1; |
| return iree_ok_status(); |
| } |
| |
| static const iree_vm_native_export_descriptor_t module_a_exports_[] = { |
| {iree_make_cstring_view("add_1"), iree_make_cstring_view("0i_i"), 0, NULL}, |
| {iree_make_cstring_view("sub_1"), iree_make_cstring_view("0i_i"), 0, NULL}, |
| }; |
| static const iree_vm_native_function_ptr_t module_a_funcs_[] = { |
| {(iree_vm_native_function_shim_t)call_shim_i32_i32, |
| (iree_vm_native_function_target_t)module_a_add_1}, |
| {(iree_vm_native_function_shim_t)call_shim_i32_i32, |
| (iree_vm_native_function_target_t)module_a_sub_1}, |
| }; |
| static_assert(IREE_ARRAYSIZE(module_a_funcs_) == |
| IREE_ARRAYSIZE(module_a_exports_), |
| "function pointer table must be 1:1 with exports"); |
| static const iree_vm_native_module_descriptor_t module_a_descriptor_ = { |
| /*name=*/iree_make_cstring_view("module_a"), |
| /*version=*/0, |
| /*attr_count=*/0, |
| /*attrs=*/NULL, |
| /*dependency_count=*/0, |
| /*dependencies=*/NULL, |
| /*import_count=*/0, |
| /*imports=*/NULL, |
| /*export_count=*/IREE_ARRAYSIZE(module_a_exports_), |
| /*exports=*/module_a_exports_, |
| /*function_count=*/IREE_ARRAYSIZE(module_a_funcs_), |
| /*functions=*/module_a_funcs_, |
| }; |
| |
| static iree_status_t module_a_create(iree_vm_instance_t* instance, |
| iree_allocator_t allocator, |
| iree_vm_module_t** out_module) { |
| // NOTE: this module has neither shared or per-context module state. |
| iree_vm_module_t interface; |
| IREE_RETURN_IF_ERROR(iree_vm_module_initialize(&interface, NULL)); |
| return iree_vm_native_module_create(&interface, &module_a_descriptor_, |
| instance, allocator, out_module); |
| } |
| |
| //===----------------------------------------------------------------------===// |
| // module_b |
| //===----------------------------------------------------------------------===// |
| // A more complex module that holds state for resolved types (shared across |
| // all instances), imported functions (stored per-context), per-context user |
| // data, and reflection metadata. |
| |
| typedef struct module_b_t module_b_t; |
| typedef struct module_b_state_t module_b_state_t; |
| |
| // Stores shared state across all instances of the module. |
| // This should generally be treated as read-only and if mutation is possible |
| // then users must synchronize themselves. |
| typedef struct module_b_t { |
| // Allocator the module must be freed with and that can be used for any other |
| // shared dynamic allocations. |
| iree_allocator_t allocator; |
| // Resolved types; these never change once queried and are safe to store on |
| // the shared structure to avoid needing to look them up again. |
| const iree_vm_ref_type_descriptor_t* types[1]; |
| } module_b_t; |
| |
| // Stores per-context state; at the minimum imports, but possibly other user |
| // state data. No synchronization is required as the VM will not call functions |
| // with the same state from multiple threads concurrently. |
| typedef struct module_b_state_t { |
| // Allocator the state must be freed with and that can be used for any other |
| // per-context dynamic allocations. |
| iree_allocator_t allocator; |
| // Resolved import functions matching 1:1 with the module import descriptors. |
| iree_vm_function_t imports[2]; |
| // Example user data stored per-state. |
| int counter; |
| } module_b_state_t; |
| |
| // Frees the shared module; by this point all per-context states have been |
| // freed and no more shared data is required. |
| static void IREE_API_PTR module_b_destroy(void* self) { |
| module_b_t* module = (module_b_t*)self; |
| iree_allocator_free(module->allocator, module); |
| } |
| |
| // Allocates per-context state, which stores resolved import functions and any |
| // other non-shared user state. |
| static iree_status_t IREE_API_PTR |
| module_b_alloc_state(void* self, iree_allocator_t allocator, |
| iree_vm_module_state_t** out_module_state) { |
| module_b_state_t* state = NULL; |
| IREE_RETURN_IF_ERROR( |
| iree_allocator_malloc(allocator, sizeof(*state), (void**)&state)); |
| memset(state, 0, sizeof(*state)); |
| state->allocator = allocator; |
| *out_module_state = (iree_vm_module_state_t*)state; |
| return iree_ok_status(); |
| } |
| |
| // Frees the per-context state. |
| static void IREE_API_PTR |
| module_b_free_state(void* self, iree_vm_module_state_t* module_state) { |
| module_b_state_t* state = (module_b_state_t*)module_state; |
| iree_allocator_free(state->allocator, state); |
| } |
| |
| // Called once per import function so the module can store the function ref. |
| static iree_status_t IREE_API_PTR module_b_resolve_import( |
| void* self, iree_vm_module_state_t* module_state, iree_host_size_t ordinal, |
| const iree_vm_function_t* function, |
| const iree_vm_function_signature_t* signature) { |
| module_b_state_t* state = (module_b_state_t*)module_state; |
| state->imports[ordinal] = *function; |
| return iree_ok_status(); |
| } |
| |
| // Our actual function. Here we directly access the registers but one could also |
| // use this as a trampoline into user code with a native signature (such as |
| // fetching the args, calling the function as a normal C function, and stashing |
| // back the results). |
| // |
| // vm.import private @module_b.entry(%arg0 : i32) -> i32 |
| static iree_status_t module_b_entry(iree_vm_stack_t* stack, module_b_t* module, |
| module_b_state_t* module_state, |
| int32_t arg0, int32_t* out_ret0) { |
| // NOTE: if we needed to use ref types here we have them under module->types. |
| assert(module->types[0]); |
| |
| // Call module_a.add_1. |
| IREE_RETURN_IF_ERROR( |
| call_import_i32_i32(stack, &module_state->imports[0], arg0, &arg0)); |
| |
| // Increment per-context state (persists across calls). No need for a mutex as |
| // only one thread can be using the per-context state at a time. |
| module_state->counter += arg0; |
| int32_t ret0 = module_state->counter; |
| |
| // Call module_a.sub_1. |
| IREE_RETURN_IF_ERROR( |
| call_import_i32_i32(stack, &module_state->imports[1], ret0, &ret0)); |
| |
| *out_ret0 = ret0; |
| return iree_ok_status(); |
| } |
| |
| // Table of exported function pointers. Note that this table could be read-only |
| // (like here) or shared/per-context to allow exposing different functions based |
| // on versions, access rights, etc. |
| static const iree_vm_native_function_ptr_t module_b_funcs_[] = { |
| {(iree_vm_native_function_shim_t)call_shim_i32_i32, |
| (iree_vm_native_function_target_t)module_b_entry}, |
| }; |
| |
| static const iree_vm_native_import_descriptor_t module_b_imports_[] = { |
| {IREE_VM_NATIVE_IMPORT_REQUIRED, iree_make_cstring_view("module_a.add_1")}, |
| {IREE_VM_NATIVE_IMPORT_REQUIRED, iree_make_cstring_view("module_a.sub_1")}, |
| }; |
| static_assert(IREE_ARRAYSIZE(module_b_state_t::imports) == |
| IREE_ARRAYSIZE(module_b_imports_), |
| "import storage must be able to hold all imports"); |
| static const iree_string_pair_t module_b_entry_attrs_[] = { |
| {iree_make_cstring_view("key1"), iree_make_cstring_view("value1")}, |
| }; |
| static const iree_vm_native_export_descriptor_t module_b_exports_[] = { |
| {iree_make_cstring_view("entry"), iree_make_cstring_view("0i_i"), |
| IREE_ARRAYSIZE(module_b_entry_attrs_), module_b_entry_attrs_}, |
| }; |
| static_assert(IREE_ARRAYSIZE(module_b_funcs_) == |
| IREE_ARRAYSIZE(module_b_exports_), |
| "function pointer table must be 1:1 with exports"); |
| static const iree_vm_native_module_descriptor_t module_b_descriptor_ = { |
| /*name=*/iree_make_cstring_view("module_b"), |
| /*version=*/0, |
| /*attr_count=*/0, |
| /*attrs=*/NULL, |
| /*dependency_count=*/0, |
| /*dependencies=*/NULL, |
| /*import_count=*/IREE_ARRAYSIZE(module_b_imports_), |
| /*imports=*/module_b_imports_, |
| /*export_count=*/IREE_ARRAYSIZE(module_b_exports_), |
| /*exports=*/module_b_exports_, |
| /*function_count=*/IREE_ARRAYSIZE(module_b_funcs_), |
| /*functions=*/module_b_funcs_, |
| }; |
| |
| static iree_status_t module_b_create(iree_vm_instance_t* instance, |
| iree_allocator_t allocator, |
| iree_vm_module_t** out_module) { |
| // Allocate shared module state. |
| module_b_t* module = NULL; |
| IREE_RETURN_IF_ERROR( |
| iree_allocator_malloc(allocator, sizeof(*module), (void**)&module)); |
| memset(module, 0, sizeof(*module)); |
| module->allocator = allocator; |
| |
| // Resolve types used by the module once so that we can share it across all |
| // instances of the module. |
| module->types[0] = |
| iree_vm_ref_lookup_registered_type(iree_make_cstring_view("vm.buffer")); |
| if (!module->types[0]) { |
| iree_allocator_free(allocator, module); |
| return iree_make_status( |
| IREE_STATUS_NOT_FOUND, |
| "required type vm.buffer not registered with the type system"); |
| } |
| |
| // Setup the interface with the functions we implement ourselves. Any function |
| // we omit will be handled by the base native module. |
| iree_vm_module_t interface; |
| iree_status_t status = iree_vm_module_initialize(&interface, module); |
| if (!iree_status_is_ok(status)) { |
| iree_allocator_free(allocator, module); |
| return status; |
| } |
| interface.destroy = module_b_destroy; |
| interface.alloc_state = module_b_alloc_state; |
| interface.free_state = module_b_free_state; |
| interface.resolve_import = module_b_resolve_import; |
| return iree_vm_native_module_create(&interface, &module_b_descriptor_, |
| instance, allocator, out_module); |
| } |