llext.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Intel Corporation
 * Copyright (c) 2024 Schneider Electric
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_LLEXT_H
#define ZEPHYR_LLEXT_H
 
#include <zephyr/sys/slist.h>
#include <zephyr/llext/elf.h>
#include <zephyr/llext/symbol.h>
#include <zephyr/kernel.h>
#include <sys/types.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum llext_mem {
        LLEXT_MEM_TEXT,
        LLEXT_MEM_DATA,
        LLEXT_MEM_RODATA,
        LLEXT_MEM_BSS,
        LLEXT_MEM_EXPORT,
        LLEXT_MEM_SYMTAB,
        LLEXT_MEM_STRTAB,
        LLEXT_MEM_SHSTRTAB,
 
        LLEXT_MEM_COUNT,
};
 
#define LLEXT_MEM_PARTITIONS (LLEXT_MEM_BSS+1)
 
struct llext_loader;
 
struct llext {
        sys_snode_t _llext_list;
 
#ifdef CONFIG_USERSPACE
        struct k_mem_partition mem_parts[LLEXT_MEM_PARTITIONS];
        struct k_mem_domain mem_domain;
#endif
 
        char name[16];
 
        void *mem[LLEXT_MEM_COUNT];
 
        bool mem_on_heap[LLEXT_MEM_COUNT];
 
        size_t mem_size[LLEXT_MEM_COUNT];
 
        size_t alloc_size;
 
        /*
         * These are all global symbols in the extension, all of them don't
         * have to be exported to other extensions, but this table is needed for
         * faster internal linking, e.g. if the extension is built out of
         * several files, if any symbols are referenced between files, this
         * table will be used to link them.
         */
        struct llext_symtable sym_tab;
 
        struct llext_symtable exp_tab;
 
        unsigned int use_count;
};
 
struct llext *llext_by_name(const char *name);
 
int llext_iterate(int (*fn)(struct llext *ext, void *arg), void *arg);
 
struct llext_load_param {
        bool relocate_local;
};
 
#define LLEXT_LOAD_PARAM_DEFAULT {.relocate_local = true,}
 
int llext_load(struct llext_loader *loader, const char *name, struct llext **ext,
               struct llext_load_param *ldr_parm);
 
int llext_unload(struct llext **ext);
 
const void *llext_find_sym(const struct llext_symtable *sym_table, const char *sym_name);
 
int llext_call_fn(struct llext *ext, const char *sym_name);
 
int llext_add_domain(struct llext *ext, struct k_mem_domain *domain);
 
int arch_elf_relocate(elf_rela_t *rel, uintptr_t loc,
                             uintptr_t sym_base_addr, const char *sym_name, uintptr_t load_bias);
ssize_t llext_find_section(struct llext_loader *loader, const char *search_name);
 
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);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_LLEXT_H */