source: mainline/uspace/srv/vfs/vfs.h@ 72c8f77

Last change on this file since 72c8f77 was bc56f30, checked in by Jiří Zárevúcky <zarevucky.jiri@…>, 6 years ago

Make some libc and libposix headers usable in C++

These headers either get included from standard C++ headers,
or are standard themselves, which means any unnamespaced nonstandard
identifiers are a problem. This commit attempts to fix those
issues, and removes hacks previously used in libcpp to work around it.
  • 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 vfs
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// TODO: Remove this arbitrary limit.
53/** Maximum number of open files per client. */
54#define VFS_MAX_OPEN_FILES 128
55
56/**
57 * A structure like this will be allocated for each registered file system.
58 */
59typedef struct {
60 link_t fs_link;
61 vfs_info_t vfs_info;
62 fs_handle_t fs_handle;
63 async_sess_t *sess;
64} fs_info_t;
65
66/** Uniquely represents a file system instance. */
67typedef struct {
68 fs_handle_t fs_handle;
69 service_id_t service_id;
70} vfs_pair_t;
71
72/** Uniquely identifies a file system node (e.g. directory, file)
73 * but doesn't contain any state. For a stateful structure, see vfs_node_t.
74 *
75 * @note fs_handle, service_id and index are meant to be returned in one
76 * IPC reply.
77 */
78typedef struct {
79 fs_handle_t fs_handle;
80 service_id_t service_id;
81 fs_index_t index;
82} vfs_triplet_t;
83
84typedef enum vfs_node_type {
85 VFS_NODE_UNKNOWN,
86 VFS_NODE_FILE,
87 VFS_NODE_DIRECTORY,
88} vfs_node_type_t;
89
90typedef struct {
91 vfs_triplet_t triplet;
92 vfs_node_type_t type;
93 aoff64_t size;
94} vfs_lookup_res_t;
95
96/**
97 * Instances of this type represent an active, in-memory VFS node and any state
98 * which may be associated with it.
99 */
100typedef struct _vfs_node {
101 /*
102 * Identity of the node
103 */
104
105 fs_handle_t fs_handle;
106 service_id_t service_id;
107 fs_index_t index;
108
109 /**
110 * Usage counter. This includes, but is not limited to, all vfs_file_t
111 * structures that reference this node.
112 */
113 unsigned refcnt;
114
115 ht_link_t nh_link; /**< Node hash-table link. */
116
117 vfs_node_type_t type; /**< Partial info about the node type. */
118
119 aoff64_t size; /**< Cached size if the node is a file. */
120
121 /**
122 * Holding this rwlock prevents modifications of the node's contents.
123 */
124 fibril_rwlock_t contents_rwlock;
125
126 struct _vfs_node *mount;
127} vfs_node_t;
128
129/**
130 * Instances of this type represent an open file. If the file is opened by more
131 * than one task, there will be a separate structure allocated for each task.
132 */
133typedef struct {
134 /** Serializes access to this open file. */
135 fibril_mutex_t _lock;
136
137 vfs_node_t *node;
138
139 /** Number of file handles referencing this file. */
140 unsigned refcnt;
141
142 int permissions;
143 bool open_read;
144 bool open_write;
145
146 /** Append on write. */
147 bool append;
148} vfs_file_t;
149
150extern fibril_mutex_t nodes_mutex;
151
152extern fibril_condvar_t fs_list_cv;
153extern fibril_mutex_t fs_list_lock;
154extern list_t fs_list; /**< List of registered file systems. */
155
156extern fibril_mutex_t fs_mntlist_lock;
157extern list_t fs_mntlist; /**< List of mounted file systems. */
158
159extern vfs_pair_t rootfs; /**< Root file system. */
160
161/** Each instance of this type describes one path lookup in progress. */
162typedef struct {
163 link_t plb_link; /**< Active PLB entries list link. */
164 unsigned index; /**< Index of the first character in PLB. */
165 size_t len; /**< Number of characters in this PLB entry. */
166} plb_entry_t;
167
168extern fibril_mutex_t plb_mutex;/**< Mutex protecting plb and plb_entries. */
169extern uint8_t *plb; /**< Path Lookup Buffer */
170extern list_t plb_entries; /**< List of active PLB entries. */
171
172/** Holding this rwlock prevents changes in file system namespace. */
173extern fibril_rwlock_t namespace_rwlock;
174
175extern async_exch_t *vfs_exchange_grab(fs_handle_t);
176extern void vfs_exchange_release(async_exch_t *);
177
178extern fs_handle_t fs_name_to_handle(unsigned int instance, const char *, bool);
179extern vfs_info_t *fs_handle_to_info(fs_handle_t);
180extern errno_t vfs_get_fstypes(vfs_fstypes_t *);
181
182extern errno_t vfs_lookup_internal(vfs_node_t *, char *, int, vfs_lookup_res_t *);
183extern errno_t vfs_link_internal(vfs_node_t *, char *, vfs_triplet_t *);
184
185extern bool vfs_nodes_init(void);
186extern vfs_node_t *vfs_node_get(vfs_lookup_res_t *);
187extern vfs_node_t *vfs_node_peek(vfs_lookup_res_t *result);
188extern void vfs_node_put(vfs_node_t *);
189extern void vfs_node_forget(vfs_node_t *);
190extern unsigned vfs_nodes_refcount_sum_get(fs_handle_t, service_id_t);
191
192extern bool vfs_node_has_children(vfs_node_t *node);
193
194extern void *vfs_client_data_create(void);
195extern void vfs_client_data_destroy(void *);
196
197extern void vfs_op_pass_handle(task_id_t, task_id_t, int);
198extern errno_t vfs_wait_handle_internal(bool, int *);
199
200extern vfs_file_t *vfs_file_get(int);
201extern void vfs_file_put(vfs_file_t *);
202extern errno_t vfs_fd_assign(vfs_file_t *, int);
203extern errno_t vfs_fd_alloc(vfs_file_t **file, bool desc, int *);
204extern errno_t vfs_fd_free(int);
205
206extern void vfs_node_addref(vfs_node_t *);
207extern void vfs_node_delref(vfs_node_t *);
208extern errno_t vfs_open_node_remote(vfs_node_t *);
209
210extern errno_t vfs_op_clone(int oldfd, int newfd, bool desc, int *);
211extern errno_t vfs_op_fsprobe(const char *, service_id_t, vfs_fs_probe_info_t *);
212extern errno_t vfs_op_mount(int mpfd, unsigned servid, unsigned flags, unsigned instance, const char *opts, const char *fsname, int *outfd);
213extern errno_t vfs_op_mtab_get(void);
214extern errno_t vfs_op_open(int fd, int flags);
215extern errno_t vfs_op_put(int fd);
216extern errno_t vfs_op_read(int fd, aoff64_t, size_t *out_bytes);
217extern errno_t vfs_op_rename(int basefd, char *old, char *new);
218extern errno_t vfs_op_resize(int fd, int64_t size);
219extern errno_t vfs_op_stat(int fd);
220extern errno_t vfs_op_statfs(int fd);
221extern errno_t vfs_op_sync(int fd);
222extern errno_t vfs_op_unlink(int parentfd, int expectfd, char *path);
223extern errno_t vfs_op_unmount(int mpfd);
224extern errno_t vfs_op_wait_handle(bool high_fd, int *out_fd);
225extern errno_t vfs_op_walk(int parentfd, int flags, char *path, int *out_fd);
226extern errno_t vfs_op_write(int fd, aoff64_t, size_t *out_bytes);
227
228extern void vfs_register(ipc_call_t *);
229
230extern void vfs_page_in(ipc_call_t *);
231
232typedef struct {
233 void *buffer;
234 size_t size;
235} rdwr_io_chunk_t;
236
237extern errno_t vfs_rdwr_internal(int, aoff64_t, bool, rdwr_io_chunk_t *);
238
239extern void vfs_connection(ipc_call_t *, void *);
240
241#endif
242
243/**
244 * @}
245 */
Note: See TracBrowser for help on using the repository browser.