loader.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_LLEXT_LOADER_H
#define ZEPHYR_LLEXT_LOADER_H
 
#include <zephyr/llext/elf.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <zephyr/llext/llext.h>
 
struct llext_elf_sect_map; /* defined in llext_priv.h */
enum llext_storage_type {
        LLEXT_STORAGE_TEMPORARY,
        LLEXT_STORAGE_PERSISTENT,
        LLEXT_STORAGE_WRITABLE,
};
 
struct llext_loader {
        int (*prepare)(struct llext_loader *ldr);
 
        int (*read)(struct llext_loader *ldr, void *out, size_t len);
 
        int (*seek)(struct llext_loader *ldr, size_t pos);
 
        void *(*peek)(struct llext_loader *ldr, size_t pos);
 
        void (*finalize)(struct llext_loader *ldr);
 
        enum llext_storage_type storage;
 
        elf_ehdr_t hdr;
        elf_shdr_t sects[LLEXT_MEM_COUNT];
        struct llext_elf_sect_map *sect_map;
};
 
static inline int llext_prepare(struct llext_loader *l)
{
        if (l->prepare) {
                return l->prepare(l);
        }
 
        return 0;
}
 
static inline int llext_read(struct llext_loader *l, void *buf, size_t len)
{
        return l->read(l, buf, len);
}
 
static inline int llext_seek(struct llext_loader *l, size_t pos)
{
        return l->seek(l, pos);
}
 
static inline void *llext_peek(struct llext_loader *l, size_t pos)
{
        if (l->peek) {
                return l->peek(l, pos);
        }
 
        return NULL;
}
 
static inline void llext_finalize(struct llext_loader *l)
{
        if (l->finalize) {
                l->finalize(l);
        }
}
/* @endcond */
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_LLEXT_LOADER_H */