source: mainline/uspace/srv/vfs/vfs.h@ 55a7fee

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 55a7fee was 55a7fee, checked in by Jakub Jermar <jakub@…>, 8 years ago

Streamline vfs_op_fstat()
  • Property mode set to 100644
File size: 7.3 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 <sys/types.h>
41#include <loc.h>
42#include <stdbool.h>
43#include <ipc/vfs.h>
44#include <task.h>
45
46#ifndef dprintf
47 #define dprintf(...)
48#endif
49
50/**
51 * A structure like this will be allocated for each registered file system.
52 */
53typedef struct {
54 link_t fs_link;
55 vfs_info_t vfs_info;
56 fs_handle_t fs_handle;
57 async_sess_t *sess;
58} fs_info_t;
59
60/**
61 * VFS_PAIR uniquely represents a file system instance.
62 */
63#define VFS_PAIR \
64 fs_handle_t fs_handle; \
65 service_id_t service_id;
66
67/**
68 * VFS_TRIPLET uniquely identifies a file system node (e.g. directory, file) but
69 * doesn't contain any state. For a stateful structure, see vfs_node_t.
70 *
71 * @note fs_handle, service_id and index are meant to be returned in one
72 * IPC reply.
73 */
74#define VFS_TRIPLET \
75 VFS_PAIR; \
76 fs_index_t index;
77
78typedef struct {
79 VFS_PAIR;
80} vfs_pair_t;
81
82typedef struct {
83 VFS_TRIPLET;
84} vfs_triplet_t;
85
86typedef enum vfs_node_type {
87 VFS_NODE_UNKNOWN,
88 VFS_NODE_FILE,
89 VFS_NODE_DIRECTORY,
90} vfs_node_type_t;
91
92typedef struct {
93 vfs_triplet_t triplet;
94 vfs_node_type_t type;
95 aoff64_t size;
96} vfs_lookup_res_t;
97
98/**
99 * Instances of this type represent an active, in-memory VFS node and any state
100 * which may be associated with it.
101 */
102typedef struct _vfs_node {
103 VFS_TRIPLET; /**< Identity of the node. */
104
105 /**
106 * Usage counter. This includes, but is not limited to, all vfs_file_t
107 * structures that reference this node.
108 */
109 unsigned refcnt;
110
111 ht_link_t nh_link; /**< Node hash-table link. */
112
113 vfs_node_type_t type; /**< Partial info about the node type. */
114
115 int64_t size; /**< Cached size if the node is a file. */
116
117 /**
118 * Holding this rwlock prevents modifications of the node's contents.
119 */
120 fibril_rwlock_t contents_rwlock;
121
122 struct _vfs_node *mount;
123} vfs_node_t;
124
125/**
126 * Instances of this type represent an open file. If the file is opened by more
127 * than one task, there will be a separate structure allocated for each task.
128 */
129typedef struct {
130 /** Serializes access to this open file. */
131 fibril_mutex_t _lock;
132
133 vfs_node_t *node;
134
135 /** Number of file handles referencing this file. */
136 unsigned refcnt;
137
138 int permissions;
139 bool open_read;
140 bool open_write;
141
142 /** Append on write. */
143 bool append;
144
145 /** Current absolute position in the file. */
146 int64_t pos;
147} vfs_file_t;
148
149extern fibril_mutex_t nodes_mutex;
150
151extern fibril_condvar_t fs_list_cv;
152extern fibril_mutex_t fs_list_lock;
153extern list_t fs_list; /**< List of registered file systems. */
154
155extern fibril_mutex_t fs_mntlist_lock;
156extern list_t fs_mntlist; /**< List of mounted file systems. */
157
158extern vfs_pair_t rootfs; /**< Root file system. */
159
160/** Each instance of this type describes one path lookup in progress. */
161typedef struct {
162 link_t plb_link; /**< Active PLB entries list link. */
163 unsigned index; /**< Index of the first character in PLB. */
164 size_t len; /**< Number of characters in this PLB entry. */
165} plb_entry_t;
166
167extern fibril_mutex_t plb_mutex;/**< Mutex protecting plb and plb_entries. */
168extern uint8_t *plb; /**< Path Lookup Buffer */
169extern list_t plb_entries; /**< List of active PLB entries. */
170
171/** Holding this rwlock prevents changes in file system namespace. */
172extern fibril_rwlock_t namespace_rwlock;
173
174extern async_exch_t *vfs_exchange_grab(fs_handle_t);
175extern void vfs_exchange_release(async_exch_t *);
176
177extern fs_handle_t fs_name_to_handle(unsigned int instance, const char *, bool);
178extern vfs_info_t *fs_handle_to_info(fs_handle_t);
179
180extern int vfs_lookup_internal(vfs_node_t *, char *, int, vfs_lookup_res_t *);
181extern int 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 int64_t vfs_node_get_size(vfs_node_t *node);
191extern bool vfs_node_has_children(vfs_node_t *node);
192
193#define MAX_OPEN_FILES 128
194
195extern void *vfs_client_data_create(void);
196extern void vfs_client_data_destroy(void *);
197
198extern void vfs_op_pass_handle(task_id_t, task_id_t, int);
199extern int vfs_wait_handle_internal(bool);
200
201extern vfs_file_t *vfs_file_get(int);
202extern void vfs_file_put(vfs_file_t *);
203extern int vfs_fd_assign(vfs_file_t *, int);
204extern int vfs_fd_alloc(vfs_file_t **file, bool desc);
205extern int vfs_fd_free(int);
206
207extern void vfs_node_addref(vfs_node_t *);
208extern void vfs_node_delref(vfs_node_t *);
209extern int vfs_open_node_remote(vfs_node_t *);
210
211extern int vfs_op_clone(int oldfd, bool desc);
212extern int vfs_op_close(int fd);
213extern int vfs_op_dup(int oldfd, int newfd);
214extern int vfs_op_fstat(int fd);
215extern int vfs_op_mount(int mpfd, unsigned servid, unsigned flags, unsigned instance, const char *opts, const char *fsname, int *outfd);
216extern int vfs_op_mtab_get(void);
217extern int vfs_op_open2(int fd, int flags);
218extern int vfs_op_read(int fd, size_t *out_bytes);
219extern int vfs_op_rename(int basefd, char *old, char *new);
220extern int vfs_op_seek(int fd, int64_t offset, int whence, int64_t *out_offset);
221extern int vfs_op_statfs(int fd);
222extern int vfs_op_sync(int fd);
223extern int vfs_op_truncate(int fd, int64_t size);
224extern int vfs_op_unlink2(int parentfd, int expectfd, int wflag, char *path);
225extern int vfs_op_unmount(int mpfd);
226extern int vfs_op_wait_handle(bool high_fd);
227extern int vfs_op_walk(int parentfd, int flags, char *path, int *out_fd);
228extern int vfs_op_write(int fd, size_t *out_bytes);
229
230extern void vfs_register(ipc_callid_t, ipc_call_t *);
231
232extern void vfs_page_in(ipc_callid_t, ipc_call_t *);
233
234typedef struct {
235 void *buffer;
236 size_t size;
237} rdwr_io_chunk_t;
238
239extern int vfs_rdwr_internal(int, bool, rdwr_io_chunk_t *);
240
241extern void vfs_connection(ipc_callid_t iid, ipc_call_t *icall, void *arg);
242
243#endif
244
245/**
246 * @}
247 */
Note: See TracBrowser for help on using the repository browser.