libwebsockets
Lightweight C library for HTML5 websockets
Loading...
Searching...
No Matches
lws-vfs.h
Go to the documentation of this file.
1/*
2 * libwebsockets - small server side websockets and web server implementation
3 *
4 * Copyright (C) 2010 - 2019 Andy Green <andy@warmcat.com>
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to
8 * deal in the Software without restriction, including without limitation the
9 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10 * sell copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
22 * IN THE SOFTWARE.
23 */
24
41
47
48#if defined(LWS_PLAT_FREERTOS)
49/* sdk preprocessor defs? compiler issue? gets confused with member names */
50#define LWS_FOP_OPEN _open
51#define LWS_FOP_CLOSE _close
52#define LWS_FOP_SEEK_CUR _seek_cur
53#define LWS_FOP_READ _read
54#define LWS_FOP_WRITE _write
55#else
56#define LWS_FOP_OPEN open
57#define LWS_FOP_CLOSE close
58#define LWS_FOP_SEEK_CUR seek_cur
59#define LWS_FOP_READ read
60#define LWS_FOP_WRITE write
61#endif
62
63#define LWS_FOP_FLAGS_MASK ((1 << 23) - 1)
64#define LWS_FOP_FLAG_COMPR_ACCEPTABLE_GZIP (1 << 24)
65#define LWS_FOP_FLAG_COMPR_IS_GZIP (1 << 25)
66#define LWS_FOP_FLAG_MOD_TIME_VALID (1 << 26)
67#define LWS_FOP_FLAG_VIRTUAL (1 << 27)
68
70
88typedef struct lws_fop_fd *lws_fop_fd_t;
89
91 const char *sig; /* NULL or vfs signature, eg, ".zip/" */
92 uint8_t len; /* length of above string */
93};
94
96 lws_fop_fd_t (*LWS_FOP_OPEN)(const struct lws_plat_file_ops *fops_own,
97 const struct lws_plat_file_ops *fops,
98 const char *filename, const char *vpath,
99 lws_fop_flags_t *flags);
116 lws_fileofs_t offset_from_cur_pos);
119 uint8_t *buf, lws_filepos_t len);
122 uint8_t *buf, lws_filepos_t len);
124
127
128 const struct lws_plat_file_ops *next;
131
132 struct lws_context *cx;
135
136 /* Add new things just above here ---^
137 * This is part of the ABI, don't needlessly break compatibility */
138};
139
146lws_get_fops(struct lws_context *context);
148lws_set_fops(struct lws_context *context, const struct lws_plat_file_ops *fops);
186
187extern struct lws_plat_file_ops fops_zip;
188
204lws_vfs_file_open(const struct lws_plat_file_ops *fops, const char *vfs_path,
205 lws_fop_flags_t *flags);
206
212static LWS_INLINE int
213lws_vfs_file_close(lws_fop_fd_t *fop_fd)
214{
215 if (*fop_fd && (*fop_fd)->fops)
216 return (*fop_fd)->fops->LWS_FOP_CLOSE(fop_fd);
217
218 return 0;
219}
220
229lws_vfs_file_seek_cur(lws_fop_fd_t fop_fd, lws_fileofs_t offset)
230{
231 return fop_fd->fops->LWS_FOP_SEEK_CUR(fop_fd, offset);
232}
242lws_vfs_file_read(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
243 uint8_t *buf, lws_filepos_t len)
244{
245 return fop_fd->fops->LWS_FOP_READ(fop_fd, amount, buf, len);
246}
256lws_vfs_file_write(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
257 uint8_t *buf, lws_filepos_t len)
258{
259 return fop_fd->fops->LWS_FOP_WRITE(fop_fd, amount, buf, len);
260}
261
262/* these are the platform file operations implementations... they can
263 * be called directly and used in fops arrays
264 */
265
268 const struct lws_plat_file_ops *fops, const char *filename,
269 const char *vpath, lws_fop_flags_t *flags);
276 uint8_t *buf, lws_filepos_t len);
279 uint8_t *buf, lws_filepos_t len);
280
282lws_alloc_vfs_file(struct lws_context *context, const char *filename,
283 uint8_t **buf, lws_filepos_t *amount);
uint32_t lws_fop_flags_t
unsigned int uint32_t
long long lws_fileofs_t
#define LWS_INLINE
#define LWS_EXTERN
unsigned char uint8_t
#define LWS_WARN_UNUSED_RESULT
#define LWS_VISIBLE
unsigned long long lws_filepos_t
int lws_filefd_type
lws_filepos_t pos
Definition lws-vfs.h:78
LWS_VISIBLE LWS_EXTERN uint32_t LWS_WARN_UNUSED_RESULT lws_vfs_get_mod_time(lws_fop_fd_t fop_fd)
LWS_VISIBLE LWS_EXTERN lws_fileofs_t lws_vfs_file_seek_set(lws_fop_fd_t fop_fd, lws_fileofs_t offset)
LWS_VISIBLE LWS_EXTERN lws_filepos_t LWS_WARN_UNUSED_RESULT lws_vfs_tell(lws_fop_fd_t fop_fd)
const char * sig
Definition lws-vfs.h:91
lws_fop_fd_t(* LWS_FOP_OPEN)(const struct lws_plat_file_ops *fops_own, const struct lws_plat_file_ops *fops, const char *filename, const char *vpath, lws_fop_flags_t *flags)
Definition lws-vfs.h:96
LWS_VISIBLE LWS_EXTERN lws_fop_fd_t _lws_plat_file_open(const struct lws_plat_file_ops *fops_own, const struct lws_plat_file_ops *fops, const char *filename, const char *vpath, lws_fop_flags_t *flags)
lws_fop_flags_t flags
Definition lws-vfs.h:82
const struct lws_plat_file_ops * next
Definition lws-vfs.h:128
LWS_VISIBLE LWS_EXTERN int _lws_plat_file_read(lws_fop_fd_t fop_fd, lws_filepos_t *amount, uint8_t *buf, lws_filepos_t len)
struct lws_fops_index fi[3]
Definition lws-vfs.h:125
LWS_VISIBLE LWS_EXTERN lws_fileofs_t _lws_plat_file_seek_cur(lws_fop_fd_t fop_fd, lws_fileofs_t offset)
int(* LWS_FOP_WRITE)(lws_fop_fd_t fop_fd, lws_filepos_t *amount, uint8_t *buf, lws_filepos_t len)
Definition lws-vfs.h:121
struct lws_context * cx
Definition lws-vfs.h:132
uint32_t mod_time
Definition lws-vfs.h:84
const struct lws_plat_file_ops * fops
Definition lws-vfs.h:74
LWS_VISIBLE LWS_EXTERN void lws_set_fops(struct lws_context *context, const struct lws_plat_file_ops *fops)
LWS_VISIBLE LWS_EXTERN int _lws_plat_file_write(lws_fop_fd_t fop_fd, lws_filepos_t *amount, uint8_t *buf, lws_filepos_t len)
struct lws_plat_file_ops fops_zip
lws_fileofs_t(* LWS_FOP_SEEK_CUR)(lws_fop_fd_t fop_fd, lws_fileofs_t offset_from_cur_pos)
Definition lws-vfs.h:115
lws_filefd_type fd
Definition lws-vfs.h:72
lws_filepos_t len
Definition lws-vfs.h:80
LWS_VISIBLE LWS_EXTERN int lws_alloc_vfs_file(struct lws_context *context, const char *filename, uint8_t **buf, lws_filepos_t *amount)
LWS_VISIBLE LWS_EXTERN struct lws_plat_file_ops *LWS_WARN_UNUSED_RESULT lws_get_fops(struct lws_context *context)
LWS_VISIBLE LWS_EXTERN lws_filepos_t LWS_WARN_UNUSED_RESULT lws_vfs_get_length(lws_fop_fd_t fop_fd)
LWS_VISIBLE LWS_EXTERN lws_fileofs_t lws_vfs_file_seek_end(lws_fop_fd_t fop_fd, lws_fileofs_t offset)
uint8_t len
Definition lws-vfs.h:92
int(* LWS_FOP_CLOSE)(lws_fop_fd_t *fop_fd)
Definition lws-vfs.h:113
LWS_VISIBLE LWS_EXTERN int _lws_plat_file_close(lws_fop_fd_t *fop_fd)
int(* LWS_FOP_READ)(lws_fop_fd_t fop_fd, lws_filepos_t *amount, uint8_t *buf, lws_filepos_t len)
Definition lws-vfs.h:118
void * filesystem_priv
Definition lws-vfs.h:76
LWS_VISIBLE LWS_EXTERN lws_fop_fd_t LWS_WARN_UNUSED_RESULT lws_vfs_file_open(const struct lws_plat_file_ops *fops, const char *vfs_path, lws_fop_flags_t *flags)
struct lws_fop_fd * lws_fop_fd_t
Definition lws-vfs.h:88