VSF Documented
vsf_fs.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
18#ifndef __VSF_FS_H__
19#define __VSF_FS_H__
20
21/*============================ INCLUDES ======================================*/
22
23#include "./vsf_fs_cfg.h"
24
25#if VSF_USE_FS == ENABLED
26
27#include "kernel/vsf_kernel.h"
28
29#if defined(__VSF_FS_CLASS_IMPLEMENT)
30# define __VSF_CLASS_IMPLEMENT__
31#elif defined(__VSF_FS_CLASS_INHERIT__)
32# define __VSF_CLASS_INHERIT__
33#endif
34
35#include "utilities/ooc_class.h"
36
37#ifdef __cplusplus
38extern "C" {
39#endif
40
41/*============================ MACROS ========================================*/
42
43#if VSF_KERNEL_CFG_EDA_SUPPORT_SUB_CALL != ENABLED
44# error VSF_KERNEL_CFG_EDA_SUPPORT_SUB_CALL is needed to use fs
45#endif
46
47/*============================ MACROFIED FUNCTIONS ===========================*/
48/*============================ TYPES =========================================*/
49
50vsf_dcl_class(vk_fs_t)
52vsf_dcl_class(vk_vfs_file_t)
53#if VSF_USE_SIMPLE_STREAM == ENABLED
55#endif
56
60
62 protected_member(
63 uint8_t close_local_size;
64 uint8_t read_local_size;
65 uint8_t write_local_size;
66 uint8_t setsize_local_size;
67 uint8_t setpos_local_size;
68 vsf_peda_evthandler_t fn_close;
70 vsf_peda_evthandler_t fn_write;
71 vsf_peda_evthandler_t fn_setsize;
72 vsf_peda_evthandler_t fn_setpos;
73
74 void * (*fn_direct_access)(vk_file_t *file);
75 )
76};
77
79 protected_member(
80 uint8_t lookup_local_size;
81 uint8_t create_local_size;
82 uint8_t unlink_local_size;
83 uint8_t chmod_local_size;
84 vsf_peda_evthandler_t fn_lookup;
85 vsf_peda_evthandler_t fn_create;
86 vsf_peda_evthandler_t fn_unlink;
87 vsf_peda_evthandler_t fn_chmod;
88 )
89};
90
91// TODO: remove fop and dop, put everything here for optimization
93 protected_member(
94 // if succeed, VSF_VFS_FILE_ATTR_MOUNTED should be set in file->attr
95 uint8_t mount_local_size;
96 uint8_t unmount_local_size;
97#if VSF_FS_CFG_USE_CACHE == ENABLED
98 uint8_t sync_local_size;
99#endif
100 uint8_t rename_local_size;
101 vsf_err_t (*fn_probe)(uint8_t *sector0_buf, uint_fast32_t sector_size);
102 vsf_peda_evthandler_t fn_mount;
103 vsf_peda_evthandler_t fn_unmount;
104 vsf_peda_evthandler_t fn_rename;
105#if VSF_FS_CFG_USE_CACHE == ENABLED
107#endif
108 vk_fs_fop_t fop;
109 vk_fs_dop_t dop;
111};
112
115 public_member(
116 vk_file_attr_t attr;
117 char *name;
119
120#if VSF_FS_CFG_TIME == ENABLED
121 struct {
122 uint64_t create;
124 uint64_t modify;
125 } time;
126#endif
128
129 protected_member(
130 const vk_fs_op_t *fsop;
131 vk_fs_info_t *fsinfo;
132
133 vk_file_t *parent;
134 uint64_t pos;
136
137 private_member(
138 uint32_t ref;
139 )
140};
141
145
146#if defined(__VSF_FS_CLASS_INHERIT__) || defined(__VSF_FS_CLASS_IMPLEMENT)
147typedef enum vk_vfs_file_attr_t {
148 VSF_VFS_FILE_ATTR_MOUNTED = VSF_FILE_ATTR_EXT,
149 VSF_VFS_FILE_ATTR_BOUND_TARGET = VSF_FILE_ATTR_MAX,
150} vk_vfs_file_attr_t;
151
152vsf_class(vk_vfs_file_t) {
153 implement(vk_file_t)
154 implement(vsf_dlist_node_t)
155
156 protected_member(
157 bool is_to_unlink;
158 union {
159 struct {
160 void *param;
161 struct {
162 void (*fn_read)(uintptr_t target, vsf_evt_t evt);
163 void (*fn_write)(uintptr_t target, vsf_evt_t evt);
164 } callback;
165# if VSF_FS_CFG_VFS_FILE_HAS_OP == ENABLED
166 void *op;
167# endif
168 } f;
169 struct {
170 void *param;
171 vsf_dlist_t child_list;
172 } d;
173 struct {
174 const vk_fs_op_t *op;
175 void *data;
176 vk_file_t *root;
177 } subfs;
178 };
179 )
180};
181#endif
182
183#if VSF_USE_SIMPLE_STREAM == ENABLED
185 public_member(
186 vk_file_t *file;
188 private_member(
190 uint32_t rw_size;
191 vsf_stream_t *stream;
192 uint32_t cur_size;
193 uint8_t *cur_buff;
194 vsf_eda_t *cur_eda;
195 )
196};
197#endif
198
199#if defined(__VSF_FS_CLASS_INHERIT__) || defined(__VSF_FS_CLASS_IMPLEMENT)
203
205 const char *name;
206 vk_file_attr_t attr;
207)
209 const char *name;
210)
211__vsf_component_peda_ifs(vk_file_lookup,
212 const char *name;
213 vk_file_t **result;
214)
217)
219 vk_file_t *olddir;
220 const char *oldname;
221 vk_file_t *newdir;
222 const char *newname;
223)
225 uint8_t *buff;
227)
229 uint8_t *buff;
231)
232__vsf_component_peda_ifs(vk_file_setpos,
234 uint64_t *result;
235)
238#endif
239
240/*============================ GLOBAL VARIABLES ==============================*/
241
242extern vk_fs_op_t vk_vfs_op;
243
244/*============================ PROTOTYPES ====================================*/
245
246extern void vk_fs_init(void);
247
248extern vsf_err_t vk_fs_mount(vk_file_t *dir, const vk_fs_op_t *fsop, void *fsdata);
250#if VSF_FS_CFG_USE_CACHE == ENABLED
251extern vsf_err_t vk_fs_sync(vk_file_t *dir);
252#endif
253
254extern vsf_err_t vk_file_open(vk_file_t *dir, const char *name, vk_file_t **file);
255extern vsf_err_t vk_file_create(vk_file_t *dir, const char *name, vk_file_attr_t attr);
256extern vsf_err_t vk_file_unlink(vk_file_t *dir, const char *name);
257extern vsf_err_t vk_file_rename(vk_file_t *olddir, const char *oldname, vk_file_t *newdir, const char *newname);
258
260extern vsf_err_t vk_file_close(vk_file_t *file);
261extern uint64_t vk_file_tell(vk_file_t *file);
266#if VSF_FS_CFG_USE_CACHE == ENABLED
267extern vsf_err_t vk_file_sync(vk_file_t *file);
268#endif
269
270extern char * vk_file_getfileext(char *fname);
271extern char * vk_file_getfilename(char *path);
273
274#if defined(__VSF_FS_CLASS_INHERIT__) || defined(__VSF_FS_CLASS_IMPLEMENT)
275extern bool vk_file_is_match(char *path, char *name);
276extern bool vk_file_is_div(char ch);
277
279extern void vk_file_free(vk_file_t *file);
280extern void * vk_file_direct_access(vk_file_t *file);
281
282extern void vk_fs_return(vk_file_t *file, vsf_err_t err);
283
284dcl_vsf_peda_methods(extern, vk_fsop_succeed)
285dcl_vsf_peda_methods(extern, vk_fsop_not_support)
286#endif
287
288#if VSF_USE_SIMPLE_STREAM == ENABLED
291#endif
292
293#ifdef __cplusplus
294}
295#endif
296
297/*============================ INCLUDES ======================================*/
298
299#ifndef __VSF_HEADER_ONLY_SHOW_FS_INFO__
300# if VSF_FS_USE_FATFS == ENABLED
302# endif
303# if VSF_FS_USE_MEMFS == ENABLED
305# endif
306# if VSF_FS_USE_WINFS == ENABLED
308# endif
309# if VSF_FS_USE_LITTLEFS == ENABLED
311# endif
312# if VSF_FS_USE_LINFS == ENABLED
314# endif
315# if VSF_FS_USE_ROMFS == ENABLED
317# endif
318#endif
319
320#undef __VSF_FS_CLASS_IMPLEMENT
321#undef __VSF_FS_CLASS_INHERIT__
322
323#endif // VSF_USE_FS
324#endif // __VSF_FS_H__
vsf_err_t
Definition __type.h:42
Definition vsf_fs.h:184
Definition vsf_fs.h:114
Definition vsf_fs.h:78
Definition vsf_fs.h:61
Definition vsf_fs.h:92
The event-driven task (TCB); every VSF task is an eda at the bottom. Tasks share stacks and only occu...
Definition vsf_eda.h:1838
Definition vsf_simple_stream.h:254
struct ieee80211_ext_chansw_ie data
Definition ieee80211.h:80
#define vsf_dcl_class
Definition ooc_class.h:50
#define vsf_class(__name)
Definition ooc_class.h:52
time_t time(time_t *t)
Definition vsf_linux_glibc_time.c:112
uint32_t uintptr_t
Definition stdint.h:38
unsigned uint32_t
Definition stdint.h:9
unsigned int uint_fast32_t
Definition stdint.h:27
unsigned long long uint64_t
Definition stdint.h:11
unsigned short uint_fast16_t
Definition stdint.h:25
unsigned char uint8_t
Definition stdint.h:5
long long int64_t
Definition stdint.h:10
Definition vsf_fs.h:142
vk_file_t root
Definition vsf_fs.h:143
Definition vsf_list.h:888
Definition vsf_list.h:883
#define access
Definition unistd.h:117
void sync(void)
Definition vsf_linux_fs.c:2291
#define __vsf_component_peda_ifs(__peda_name,...)
Definition vsf_component_cfg.h:62
#define vsf_peda_evthandler_t
Definition vsf_component_cfg.h:37
int16_t vsf_evt_t
Kernel event type.
Definition vsf_eda.h:1658
#define dcl_vsf_peda_methods(__decoration,...)
Alias of declare_vsf_peda_methods()
Definition vsf_eda.h:1000
bool vk_file_is_match(char *path, char *name)
Definition vsf_fs.c:268
void vk_file_free(vk_file_t *file)
Definition vsf_fs.c:222
void * vk_file_direct_access(vk_file_t *file)
Definition vsf_fs.c:233
vk_file_t * vk_file_alloc(uint_fast16_t size)
Definition vsf_fs.c:203
bool vk_file_is_div(char ch)
Definition vsf_fs.c:263
vsf_err_t vk_file_rename(vk_file_t *olddir, const char *oldname, vk_file_t *newdir, const char *newname)
Definition vsf_fs.c:860
vsf_err_t vk_file_sync(vk_file_t *file)
Definition vsf_fs.c:893
vk_file_t * vk_file_get_parent(vk_file_t *file)
Definition vsf_fs.c:279
vsf_err_t vk_file_write(vk_file_t *file, uint8_t *buff, uint_fast32_t size)
Definition vsf_fs.c:750
void vk_fs_init(void)
Definition vsf_fs.c:292
char * vk_file_getfilename(char *path)
Definition vsf_fs.c:250
vsf_err_t vk_file_unlink(vk_file_t *dir, const char *name)
Definition vsf_fs.c:842
vsf_err_t vk_file_close(vk_file_t *file)
Definition vsf_fs.c:723
vsf_err_t vk_fs_sync(vk_file_t *dir)
Definition vsf_fs.c:681
vsf_err_t vk_file_open(vk_file_t *dir, const char *name, vk_file_t **file)
Definition vsf_fs.c:693
char * vk_file_getfileext(char *fname)
Definition vsf_fs.c:241
vsf_err_t vk_file_create(vk_file_t *dir, const char *name, vk_file_attr_t attr)
Definition vsf_fs.c:823
uint64_t vk_file_tell(vk_file_t *file)
Definition vsf_fs.c:781
uint32_t vk_file_get_ref(vk_file_t *file)
Definition vsf_fs.c:198
vsf_err_t vk_file_read(vk_file_t *file, uint8_t *buff, uint_fast32_t size)
Definition vsf_fs.c:734
vk_fs_op_t vk_vfs_op
vsf_err_t vk_file_seek(vk_file_t *file, int64_t offset, vk_file_whence_t whence)
Definition vsf_fs.c:787
vsf_err_t vk_fs_mount(vk_file_t *dir, const vk_fs_op_t *fsop, void *fsdata)
Definition vsf_fs.c:652
vsf_err_t vk_file_setsize(vk_file_t *file, uint64_t size)
Definition vsf_fs.c:766
vsf_err_t vk_file_write_stream(vk_file_stream_t *pthis, vsf_stream_t *stream, uint_fast32_t size)
Definition vsf_fs.c:1590
vsf_err_t vk_fs_unmount(vk_file_t *dir)
Definition vsf_fs.c:668
vsf_err_t vk_file_read_stream(vk_file_stream_t *pthis, vsf_stream_t *stream, uint_fast32_t size)
Definition vsf_fs.c:1579
vk_file_attr_t
Definition vsf_fs_cfg.h:99
@ VSF_FILE_ATTR_EXT
Definition vsf_fs_cfg.h:108
@ VSF_FILE_ATTR_MAX
Definition vsf_fs_cfg.h:111
vk_file_whence_t
Definition vsf_fs_cfg.h:114
const vk_fs_op_t * fsop
Definition vsf_malfs.c:136
uint64_t offset
Definition vsf_memfs.h:49
uint8_t * buff
Definition vsf_memfs.h:51
uint32_t size
Definition vsf_memfs.h:50
Generated from commit: vsfteam/vsf@2a137b0