source: mainline/uspace/srv/vfs/vfs.h@ 3061bc1

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 3061bc1 was 1b20da0, checked in by Jiří Zárevúcky <zarevucky.jiri@…>, 7 years ago

style: Remove trailing whitespace on non-empty lines, in certain file types.

Command used: tools/srepl '\([^[:space:]]\)\s\+$' '\1' -- *.c *.h *.py *.sh *.s *.S *.ag
  • Property mode set to 100644
File size: 7.4 KB
Line 
1/*
2 * Copyright (c) 2008 Jakub Jermar
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup fs
30 * @{
31 */
32
33#ifndef VFS_VFS_H_
34#define VFS_VFS_H_
35
36#include <async.h>
37#include <adt/list.h>
38#include <adt/hash_table.h>
39#include <fibril_synch.h>
40#include <stddef.h>
41#include <stdint.h>
42#include <loc.h>
43#include <stdbool.h>
44#include <ipc/vfs.h>
45#include <task.h>
46#include <vfs/vfs.h>
47
48#ifndef dprintf
49 #define dprintf(...)
50#endif
51
52/**
53 * A structure like this will be allocated for each registered file system.
54 */
55typedef struct {
56 link_t fs_link;
57 vfs_info_t vfs_info;
58 fs_handle_t fs_handle;
59 async_sess_t *sess;
60} fs_info_t;
61
62/**
63 * VFS_PAIR uniquely represents a file system instance.
64 */
65#define VFS_PAIR \
66 fs_handle_t fs_handle; \
67 service_id_t service_id;
68
69/**
70 * VFS_TRIPLET uniquely identifies a file system node (e.g. directory, file) but
71 * doesn't contain any state. For a stateful structure, see vfs_node_t.
72 *
73 * @note fs_handle, service_id and index are meant to be returned in one
74 * IPC reply.
75 */
76#define VFS_TRIPLET \
77 VFS_PAIR; \
78 fs_index_t index;
79
80typedef struct {
81 VFS_PAIR;
82} vfs_pair_t;
83
84typedef struct {
85 VFS_TRIPLET;
86} vfs_triplet_t;
87
88typedef enum vfs_node_type {
89 VFS_NODE_UNKNOWN,
90 VFS_NODE_FILE,
91 VFS_NODE_DIRECTORY,
92} vfs_node_type_t;
93
94typedef struct {
95 vfs_triplet_t triplet;
96 vfs_node_type_t type;
97 aoff64_t size;
98} vfs_lookup_res_t;
99
100/**
101 * Instances of this type represent an active, in-memory VFS node and any state
102 * which may be associated with it.
103 */
104typedef struct _vfs_node {
105 VFS_TRIPLET; /**< Identity of the node. */
106
107 /**
108 * Usage counter. This includes, but is not limited to, all vfs_file_t
109 * structures that reference this node.
110 */
111 unsigned refcnt;
112
113 ht_link_t nh_link; /**< Node hash-table link. */
114
115 vfs_node_type_t type; /**< Partial info about the node type. */
116
117 aoff64_t size; /**< Cached size if the node is a file. */
118
119 /**
120 * Holding this rwlock prevents modifications of the node's contents.
121 */
122 fibril_rwlock_t contents_rwlock;
123
124 struct _vfs_node *mount;
125} vfs_node_t;
126
127/**
128 * Instances of this type represent an open file. If the file is opened by more
129 * than one task, there will be a separate structure allocated for each task.
130 */
131typedef struct {
132 /** Serializes access to this open file. */
133 fibril_mutex_t _lock;
134
135 vfs_node_t *node;
136
137 /** Number of file handles referencing this file. */
138 unsigned refcnt;
139
140 int permissions;
141 bool open_read;
142 bool open_write;
143
144 /** Append on write. */
145 bool append;
146} vfs_file_t;
147
148extern fibril_mutex_t nodes_mutex;
149
150extern fibril_condvar_t fs_list_cv;
151extern fibril_mutex_t fs_list_lock;
152extern list_t fs_list; /**< List of registered file systems. */
153
154extern fibril_mutex_t fs_mntlist_lock;
155extern list_t fs_mntlist; /**< List of mounted file systems. */
156
157extern vfs_pair_t rootfs; /**< Root file system. */
158
159/** Each instance of this type describes one path lookup in progress. */
160typedef struct {
161 link_t plb_link; /**< Active PLB entries list link. */
162 unsigned index; /**< Index of the first character in PLB. */
163 size_t len; /**< Number of characters in this PLB entry. */
164} plb_entry_t;
165
166extern fibril_mutex_t plb_mutex;/**< Mutex protecting plb and plb_entries. */
167extern uint8_t *plb; /**< Path Lookup Buffer */
168extern list_t plb_entries; /**< List of active PLB entries. */
169
170/** Holding this rwlock prevents changes in file system namespace. */
171extern fibril_rwlock_t namespace_rwlock;
172
173extern async_exch_t *vfs_exchange_grab(fs_handle_t);
174extern void vfs_exchange_release(async_exch_t *);
175
176extern fs_handle_t fs_name_to_handle(unsigned int instance, const char *, bool);
177extern vfs_info_t *fs_handle_to_info(fs_handle_t);
178extern errno_t vfs_get_fstypes(vfs_fstypes_t *);
179
180extern errno_t vfs_lookup_internal(vfs_node_t *, char *, int, vfs_lookup_res_t *);
181extern errno_t vfs_link_internal(vfs_node_t *, char *, vfs_triplet_t *);
182
183extern bool vfs_nodes_init(void);
184extern vfs_node_t *vfs_node_get(vfs_lookup_res_t *);
185extern vfs_node_t *vfs_node_peek(vfs_lookup_res_t *result);
186extern void vfs_node_put(vfs_node_t *);
187extern void vfs_node_forget(vfs_node_t *);
188extern unsigned vfs_nodes_refcount_sum_get(fs_handle_t, service_id_t);
189
190extern bool vfs_node_has_children(vfs_node_t *node);
191
192extern void *vfs_client_data_create(void);
193extern void vfs_client_data_destroy(void *);
194
195extern void vfs_op_pass_handle(task_id_t, task_id_t, int);
196extern errno_t vfs_wait_handle_internal(bool, int *);
197
198extern vfs_file_t *vfs_file_get(int);
199extern void vfs_file_put(vfs_file_t *);
200extern errno_t vfs_fd_assign(vfs_file_t *, int);
201extern errno_t vfs_fd_alloc(vfs_file_t **file, bool desc, int *);
202extern errno_t vfs_fd_free(int);
203
204extern void vfs_node_addref(vfs_node_t *);
205extern void vfs_node_delref(vfs_node_t *);
206extern errno_t vfs_open_node_remote(vfs_node_t *);
207
208extern errno_t vfs_op_clone(int oldfd, int newfd, bool desc, int *);
209extern errno_t vfs_op_fsprobe(const char *, service_id_t, vfs_fs_probe_info_t *);
210extern errno_t vfs_op_mount(int mpfd, unsigned servid, unsigned flags, unsigned instance, const char *opts, const char *fsname, int *outfd);
211extern errno_t vfs_op_mtab_get(void);
212extern errno_t vfs_op_open(int fd, int flags);
213extern errno_t vfs_op_put(int fd);
214extern errno_t vfs_op_read(int fd, aoff64_t, size_t *out_bytes);
215extern errno_t vfs_op_rename(int basefd, char *old, char *new);
216extern errno_t vfs_op_resize(int fd, int64_t size);
217extern errno_t vfs_op_stat(int fd);
218extern errno_t vfs_op_statfs(int fd);
219extern errno_t vfs_op_sync(int fd);
220extern errno_t vfs_op_unlink(int parentfd, int expectfd, char *path);
221extern errno_t vfs_op_unmount(int mpfd);
222extern errno_t vfs_op_wait_handle(bool high_fd, int *out_fd);
223extern errno_t vfs_op_walk(int parentfd, int flags, char *path, int *out_fd);
224extern errno_t vfs_op_write(int fd, aoff64_t, size_t *out_bytes);
225
226extern void vfs_register(ipc_callid_t, ipc_call_t *);
227
228extern void vfs_page_in(ipc_callid_t, ipc_call_t *);
229
230typedef struct {
231 void *buffer;
232 size_t size;
233} rdwr_io_chunk_t;
234
235extern errno_t vfs_rdwr_internal(int, aoff64_t, bool, rdwr_io_chunk_t *);
236
237extern void vfs_connection(ipc_callid_t iid, ipc_call_t *icall, void *arg);
238
239#endif
240
241/**
242 * @}
243 */
Note: See TracBrowser for help on using the repository browser.