Zephyr API Documentation 3.7.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
llext.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2023 Intel Corporation
3 * Copyright (c) 2024 Schneider Electric
4 *
5 * SPDX-License-Identifier: Apache-2.0
6 */
7
8#ifndef ZEPHYR_LLEXT_H
9#define ZEPHYR_LLEXT_H
10
11#include <zephyr/sys/slist.h>
12#include <zephyr/llext/elf.h>
13#include <zephyr/llext/symbol.h>
14#include <zephyr/kernel.h>
15#include <sys/types.h>
16#include <stdbool.h>
17
18#ifdef __cplusplus
19extern "C" {
20#endif
21
59
62/* Number of memory partitions used by LLEXT */
63#define LLEXT_MEM_PARTITIONS (LLEXT_MEM_BSS+1)
64
65struct llext_loader;
68/* Maximim number of dependency LLEXTs */
69#define LLEXT_MAX_DEPENDENCIES 8
70
77struct llext {
79 sys_snode_t _llext_list;
80
81#ifdef CONFIG_USERSPACE
82 struct k_mem_partition mem_parts[LLEXT_MEM_PARTITIONS];
83 struct k_mem_domain mem_domain;
84#endif
85
89 char name[16];
90
93
96
99
102
110
117
119 unsigned int use_count;
120
123};
124
145
147#define LLEXT_LOAD_PARAM_DEFAULT { .relocate_local = true, }
148
155struct llext *llext_by_name(const char *name);
156
168int llext_iterate(int (*fn)(struct llext *ext, void *arg), void *arg);
169
185int llext_load(struct llext_loader *loader, const char *name, struct llext **ext,
186 const struct llext_load_param *ldr_parm);
187
193int llext_unload(struct llext **ext);
194
196typedef void (*llext_entry_fn_t)(void *user_data);
197
209int llext_bringup(struct llext *ext);
210
223int llext_teardown(struct llext *ext);
224
241void llext_bootstrap(struct llext *ext, llext_entry_fn_t entry_fn, void *user_data);
242
261__syscall ssize_t llext_get_fn_table(struct llext *ext, bool is_init, void *buf, size_t size);
262
275const void *llext_find_sym(const struct llext_symtable *sym_table, const char *sym_name);
276
289int llext_call_fn(struct llext *ext, const char *sym_name);
290
304int llext_add_domain(struct llext *ext, struct k_mem_domain *domain);
305
325 uintptr_t sym_base_addr, const char *sym_name, uintptr_t load_bias);
326
336ssize_t llext_find_section(struct llext_loader *loader, const char *search_name);
337
347void arch_elf_relocate_local(struct llext_loader *loader, struct llext *ext,
348 const elf_rela_t *rel, const elf_sym_t *sym, size_t got_offset);
349
354#ifdef __cplusplus
355}
356#endif
357
358#include <zephyr/syscalls/llext.h>
359
360#endif /* ZEPHYR_LLEXT_H */
int llext_bringup(struct llext *ext)
Calls bringup functions for an extension.
#define LLEXT_MAX_DEPENDENCIES
Definition llext.h:69
int llext_load(struct llext_loader *loader, const char *name, struct llext **ext, const struct llext_load_param *ldr_parm)
Load and link an extension.
void(* llext_entry_fn_t)(void *user_data)
Entry point function signature for an extension.
Definition llext.h:196
int llext_iterate(int(*fn)(struct llext *ext, void *arg), void *arg)
Iterate over all loaded extensions.
int arch_elf_relocate(elf_rela_t *rel, uintptr_t loc, uintptr_t sym_base_addr, const char *sym_name, uintptr_t load_bias)
Architecture specific opcode update function.
ssize_t llext_get_fn_table(struct llext *ext, bool is_init, void *buf, size_t size)
Get pointers to setup or cleanup functions for an extension.
ssize_t llext_find_section(struct llext_loader *loader, const char *search_name)
Locates an ELF section in the file.
void arch_elf_relocate_local(struct llext_loader *loader, struct llext *ext, const elf_rela_t *rel, const elf_sym_t *sym, size_t got_offset)
Architecture specific function for updating addresses via relocation table.
int llext_add_domain(struct llext *ext, struct k_mem_domain *domain)
Add an extension to a memory domain.
void llext_bootstrap(struct llext *ext, llext_entry_fn_t entry_fn, void *user_data)
Bring up, execute, and teardown an extension.
llext_mem
List of memory regions stored or referenced in the LLEXT subsystem.
Definition llext.h:44
struct llext * llext_by_name(const char *name)
Find an llext by name.
const void * llext_find_sym(const struct llext_symtable *sym_table, const char *sym_name)
Find the address for an arbitrary symbol.
int llext_unload(struct llext **ext)
Unload an extension.
int llext_call_fn(struct llext *ext, const char *sym_name)
Call a function by name.
int llext_teardown(struct llext *ext)
Calls teardown functions for an extension.
@ LLEXT_MEM_SYMTAB
Symbol table.
Definition llext.h:50
@ LLEXT_MEM_SHSTRTAB
Section name strings.
Definition llext.h:52
@ LLEXT_MEM_TEXT
Executable code.
Definition llext.h:45
@ LLEXT_MEM_DATA
Initialized data.
Definition llext.h:46
@ LLEXT_MEM_PREINIT
Array of early setup functions.
Definition llext.h:53
@ LLEXT_MEM_BSS
Uninitialized data.
Definition llext.h:48
@ LLEXT_MEM_RODATA
Read-only data.
Definition llext.h:47
@ LLEXT_MEM_INIT
Array of setup functions.
Definition llext.h:54
@ LLEXT_MEM_FINI
Array of cleanup functions.
Definition llext.h:55
@ LLEXT_MEM_COUNT
Number of regions managed by LLEXT.
Definition llext.h:57
@ LLEXT_MEM_STRTAB
Symbol name strings.
Definition llext.h:51
@ LLEXT_MEM_EXPORT
Exported symbol table.
Definition llext.h:49
struct _snode sys_snode_t
Single-linked list node structure.
Definition slist.h:39
Public kernel APIs.
__SIZE_TYPE__ ssize_t
Definition types.h:28
Data structures and constants defined in the ELF specification.
#define bool
Definition stdbool.h:13
__UINTPTR_TYPE__ uintptr_t
Definition stdint.h:105
Relocation entry for 64-bit ELFs with addend.
Definition elf.h:374
Section Header(64-bit)
Definition elf.h:177
Symbol table entry(64-bit)
Definition elf.h:241
Memory Domain.
Definition mem_domain.h:80
Memory Partition.
Definition mem_domain.h:55
Advanced llext_load parameters.
Definition llext.h:130
bool relocate_local
Perform local relocation.
Definition llext.h:132
bool pre_located
Use the virtual symbol addresses from the ELF, not addresses within the memory buffer,...
Definition llext.h:137
bool(* section_detached)(const elf_shdr_t *shdr)
Extensions can implement custom ELF sections to be loaded in specific memory regions,...
Definition llext.h:143
Linkable loadable extension loader context.
Definition loader.h:42
A symbol table.
Definition symbol.h:81
Structure describing a linkable loadable extension.
Definition llext.h:77
size_t mem_size[LLEXT_MEM_COUNT]
Size of each stored region.
Definition llext.h:98
struct llext_symtable sym_tab
Table of all global symbols in the extension; used internally as part of the linking process.
Definition llext.h:109
char name[16]
Name of the llext.
Definition llext.h:89
size_t alloc_size
Total llext allocation size.
Definition llext.h:101
unsigned int use_count
Extension use counter, prevents unloading while in use.
Definition llext.h:119
struct llext * dependency[8]
Array of extensions, whose symbols this extension accesses.
Definition llext.h:122
bool mem_on_heap[LLEXT_MEM_COUNT]
Is the memory for this region allocated on heap?
Definition llext.h:95
struct llext_symtable exp_tab
Table of symbols exported by the llext via LL_EXTENSION_SYMBOL.
Definition llext.h:116
void * mem[LLEXT_MEM_COUNT]
Lookup table of memory regions.
Definition llext.h:92
Linkable loadable extension symbol definitions.