VSF Documented
vsf_loader.h
Go to the documentation of this file.
1/*****************************************************************************
2 * Copyright(C)2009-2022 by VSF Team *
3 * *
4 * Licensed under the Apache License, Version 2.0 (the "License"); *
5 * you may not use this file except in compliance with the License. *
6 * You may obtain a copy of the License at *
7 * *
8 * http://www.apache.org/licenses/LICENSE-2.0 *
9 * *
10 * Unless required by applicable law or agreed to in writing, software *
11 * distributed under the License is distributed on an "AS IS" BASIS, *
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
13 * See the License for the specific language governing permissions and *
14 * limitations under the License. *
15 * *
16 ****************************************************************************/
17
33#ifndef __VSF_LOADER_H__
34#define __VSF_LOADER_H__
35
36/*============================ INCLUDES ======================================*/
37
40
41#if VSF_USE_LOADER == ENABLED
42
43#undef __VSF_LOADER_PUBLIC_CONST__
44#if defined(__VSF_LOADER_CLASS_IMPLEMENT)
45# define __VSF_CLASS_IMPLEMENT__
46# define __VSF_LOADER_PUBLIC_CONST__
47#elif defined(__VSF_LOADER_CLASS_INHERIT__)
48# define __VSF_CLASS_INHERIT__
49# define __VSF_LOADER_PUBLIC_CONST__
50#else
51# define __VSF_LOADER_PUBLIC_CONST__ const
52#endif
53
54#include "utilities/ooc_class.h"
55
56#ifdef __cplusplus
57extern "C" {
58#endif
59
60/*============================ MACROS ========================================*/
61/*============================ MACROFIED FUNCTIONS ===========================*/
62
63#define vsf_loader_read(__target, __offset, __ptr, __size) \
64 (__target)->fn_read((__target), (__offset), (__ptr), (__size))
65
66#define vsf_loader_malloc(__loader, __attr, __size, __align) \
67 (__loader)->heap_op->fn_malloc((vsf_loader_t *)(__loader), (__attr), (__size), (__align))
68#define vsf_loader_free(__loader, __attr, __ptr) \
69 (__loader)->heap_op->fn_free((vsf_loader_t *)(__loader), (__attr), (__ptr))
70
71/*============================ TYPES =========================================*/
72
74
75
89
97typedef struct vsf_loader_heap_op_t {
113 void * (*fn_malloc)(vsf_loader_t *loader, vsf_loader_mem_attr_t attr, uint32_t size, uint32_t alignment);
114
128 void (*fn_free)(vsf_loader_t *loader, vsf_loader_mem_attr_t attr, void *buffer);
130
167
168typedef struct vsf_loader_op_t {
169 int (*fn_load)(vsf_loader_t *loader, vsf_loader_target_t *target);
170 void (*fn_cleanup)(vsf_loader_t *loader);
173 void * (*fn_remap)(vsf_loader_t *loader, void *vaddr);
175
176
178 public_member(
179 const vsf_loader_heap_op_t *heap_op;
180 const vsf_loader_op_t *op;
181
182 __VSF_LOADER_PUBLIC_CONST__ void *static_base;
183 __VSF_LOADER_PUBLIC_CONST__ void *entry;
184 __VSF_LOADER_PUBLIC_CONST__ void *vplt_out;
185
186 void *vplt;
187 void * (*alloc_vplt)(int num);
188 void (*free_vplt)(void *vplt);
190 protected_member(
191 vsf_loader_target_t *target;
193};
194
195/*============================ GLOBAL VARIABLES ==============================*/
196
197#if VSF_USE_HEAP == ENABLED
206#endif
207
208/*============================ PROTOTYPES ====================================*/
209
226
243
244#if defined(__VSF_LOADER_CLASS_IMPLEMENT) || defined(__VSF_LOADER_CLASS_INHERIT__)
245extern void * vsf_loader_link(vsf_loader_t *loader, const char *name);
246#endif
247
248extern int vsf_loader_load(vsf_loader_t *loader, vsf_loader_target_t *target);
249extern void vsf_loader_cleanup(vsf_loader_t *loader);
250extern int vsf_loader_call_init_array(vsf_loader_t *loader);
251extern void vsf_loader_call_fini_array(vsf_loader_t *loader);
252extern void * vsf_loader_remap(vsf_loader_t *loader, void *vaddr);
253
254#ifdef __cplusplus
255}
256#endif
257
258#undef __VSF_LOADER_CLASS_IMPLEMENT
259#undef __VSF_LOADER_CLASS_INHERIT__
260
261/*============================ INCLUDES ======================================*/
262
263#if VSF_LOADER_USE_ELF == ENABLED
264# include "./elf/vsf_elfloader.h"
265#endif
266#if VSF_LOADER_USE_PE == ENABLED
267# include "./pe/vsf_peloader.h"
268#endif
269
270 // vsf_loader
271 // vsf_service
272
273#endif // VSF_USE_LOADER
274#endif // __VSF_LOADER_H__
Definition vsf_loader.h:177
const vsf_loader_heap_op_t vsf_loader_default_heap_op
Definition vsf_loader.c:49
struct vsf_loader_heap_op_t vsf_loader_heap_op_t
void vsf_loader_cleanup(vsf_loader_t *loader)
Definition vsf_loader.c:114
vsf_loader_mem_attr_t
Definition vsf_loader.h:82
int vsf_loader_load(vsf_loader_t *loader, vsf_loader_target_t *target)
Definition vsf_loader.c:108
void vsf_loader_call_fini_array(vsf_loader_t *loader)
Definition vsf_loader.c:126
uint32_t vsf_loader_xip_read(vsf_loader_target_t *target, uint32_t offset, void *buffer, uint32_t size)
Definition vsf_loader.c:96
void * vsf_loader_remap(vsf_loader_t *loader, void *vaddr)
Definition vsf_loader.c:132
struct vsf_loader_op_t vsf_loader_op_t
#define __VSF_LOADER_PUBLIC_CONST__
Definition vsf_loader.h:51
int vsf_loader_call_init_array(vsf_loader_t *loader)
Definition vsf_loader.c:120
uint32_t vsf_loader_stdio_read(vsf_loader_target_t *target, uint32_t offset, void *buffer, uint32_t size)
Definition vsf_loader.c:87
@ VSF_LOADER_MEM_X
Definition vsf_loader.h:85
@ VSF_LOADER_MEM_W
Definition vsf_loader.h:84
@ VSF_LOADER_MEM_RWX
Definition vsf_loader.h:87
@ VSF_LOADER_MEM_RW
Definition vsf_loader.h:86
@ VSF_LOADER_MEM_R
Definition vsf_loader.h:83
#define vsf_dcl_class
Definition ooc_class.h:50
#define vsf_class(__name)
Definition ooc_class.h:52
uint32_t uintptr_t
Definition stdint.h:38
unsigned uint32_t
Definition stdint.h:9
Definition vsf_loader.h:97
void(* fn_free)(vsf_loader_t *loader, vsf_loader_mem_attr_t attr, void *buffer)
Definition vsf_loader.h:128
Definition vsf_loader.h:168
void(* fn_call_fini_array)(vsf_loader_t *loader)
Definition vsf_loader.h:172
void(* fn_cleanup)(vsf_loader_t *loader)
Definition vsf_loader.h:170
int(* fn_call_init_array)(vsf_loader_t *loader)
Definition vsf_loader.h:171
int(* fn_load)(vsf_loader_t *loader, vsf_loader_target_t *target)
Definition vsf_loader.h:169
Definition vsf_loader.h:132
bool support_xip
Definition vsf_loader.h:148
uintptr_t object
Definition vsf_loader.h:138
uint32_t(* fn_read)(vsf_loader_target_t *target, uint32_t offset, void *buffer, uint32_t size)
Definition vsf_loader.h:165
const char * name
Definition vsf_loader.h:139
vsf elf loader
uint_fast32_t alignment
Definition vsf_heap.h:172
void * vsf_loader_link(vsf_loader_t *loader, const char *name)
Definition vsf_loader.c:103
uint64_t offset
Definition vsf_memfs.h:49
uint32_t size
Definition vsf_memfs.h:50
vsf pe loader
Generated from commit: vsfteam/vsf@2a137b0