WebSVN – HelenOS – Diff – /trunk/uspace/srv/vfs/vfs.h


/*
 * Copyright (c) 2007 Jakub Jermar
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
/** @addtogroup fs
 * @{
 */
 
#ifndef VFS_VFS_H_
#define VFS_VFS_H_
 
#include <ipc/ipc.h>
#include <libadt/list.h>
#include <atomic.h>
#include <sys/types.h>
#include <bool.h>
 
#define dprintf(...)    printf(__VA_ARGS__)
 
#define VFS_FIRST   IPC_FIRST_USER_METHOD
 
#define IPC_METHOD_TO_VFS_OP(m) ((m) - VFS_FIRST)   
 
typedef enum {
    VFS_REGISTER = VFS_FIRST,
    VFS_MOUNT,
    VFS_UNMOUNT,
    VFS_LOOKUP,
    VFS_OPEN,
    VFS_CREATE,
    VFS_CLOSE,
    VFS_READ,
    VFS_WRITE,
    VFS_SEEK,
    VFS_RENAME,
    VFS_UNLINK,
    VFS_LAST,       /* keep this the last member of the enum */
} vfs_request_t;
 
 
/**
 * An instance of this structure is associated with a particular FS operation.
 * It tells VFS if the FS supports the operation or maybe if a default one
 * should be used.
 */
typedef enum {
    VFS_OP_NULL = 0,
    VFS_OP_DEFAULT,
    VFS_OP_DEFINED
} vfs_op_t;
 
#define FS_NAME_MAXLEN  20
 
/**
 * A structure like this is passed to VFS by each individual FS upon its
 * registration. It assosiates a human-readable identifier with each
 * registered FS. More importantly, through this structure, the FS announces
 * what operations it supports.
 */
typedef struct {
    /** Unique identifier of the fs. */
    char name[FS_NAME_MAXLEN];
   
    /** Operations. */
    vfs_op_t ops[VFS_LAST - VFS_FIRST];
} vfs_info_t;
 
/**
 * A structure like this will be allocated for each registered file system.
 */
typedef struct {
    link_t fs_link;
    vfs_info_t vfs_info;
    int fs_handle;
    atomic_t phone_futex;   /**< Phone serializing futex. */
    ipcarg_t phone;
} fs_info_t;
 
/**
 * VFS_PAIR uniquely represents a file system instance.
 */
#define VFS_PAIR    \
    int fs_handle;  \
    int dev_handle; 
 
/**
 * VFS_TRIPLET uniquely identifies a file system node (e.g. directory, file) but
 * doesn't contain any state. For a stateful structure, see vfs_node_t.
 *
 * @note    fs_handle, dev_handle and index are meant to be returned in one
 *      IPC reply.
 */
#define VFS_TRIPLET \
    VFS_PAIR;   \
    uint64_t index;
 
typedef struct {
    VFS_PAIR;
} vfs_pair_t;
 
typedef struct {
    VFS_TRIPLET;
} vfs_triplet_t;
 
/**
 * Instances of this type represent an active, in-memory VFS node and any state
 * which may be associated with it.
 */
typedef struct {
    VFS_TRIPLET;        /**< Identity of the node. */
    unsigned refcnt;    /**< Usage counter. */
    link_t nh_link;     /**< Node hash-table link. */
} vfs_node_t;
 
/**
 * Instances of this type represent an open file. If the file is opened by more
 * than one task, there will be a separate structure allocated for each task.
 */
typedef struct {
    vfs_node_t *node;
   
    /** Number of file handles referencing this file. */
    unsigned refcnt;
 
    /** Current position in the file. */
    off_t pos;
} vfs_file_t;
 
extern link_t fs_head;      /**< List of registered file systems. */
 
extern vfs_triplet_t rootfs;    /**< Root node of the root file system. */
 
#define MAX_PATH_LEN        (64 * 1024)
 
#define PLB_SIZE        (2 * MAX_PATH_LEN)
 
/** Each instance of this type describes one path lookup in progress. */
typedef struct {
    link_t  plb_link;   /**< Active PLB entries list link. */
    unsigned index;     /**< Index of the first character in PLB. */
    size_t len;     /**< Number of characters in this PLB entry. */
} plb_entry_t;
 
extern atomic_t plb_futex;  /**< Futex protecting plb and plb_head. */
extern uint8_t *plb;        /**< Path Lookup Buffer */
extern link_t plb_head;     /**< List of active PLB entries. */
 
extern atomic_t unlink_futex;   /**< VFS_{CREATE|OPEN|UNLINK} serialization. */
 
extern int vfs_grab_phone(int);
extern void vfs_release_phone(int);
 
extern int fs_name_to_handle(char *, bool);
 
extern int vfs_lookup_internal(char *, size_t, vfs_triplet_t *, vfs_pair_t *);
 
 
extern vfs_node_t *vfs_node_get(vfs_triplet_t *);
extern void vfs_node_put(vfs_node_t *);
 
extern bool vfs_files_init(void);
extern vfs_file_t *vfs_file_get(int);
extern int vfs_fd_alloc(void);
extern void vfs_fd_free(int);
 
extern void vfs_file_addref(vfs_file_t *);
extern void vfs_file_delref(vfs_file_t *);
 
extern void vfs_node_addref(vfs_node_t *);
extern void vfs_node_delref(vfs_node_t *);
 
#define MAX_OPEN_FILES  128 
 
extern void vfs_register(ipc_callid_t, ipc_call_t *);
extern void vfs_mount(ipc_callid_t, ipc_call_t *);
extern void vfs_open(ipc_callid_t, ipc_call_t *);
 
#endif
 
/**
 * @}
 */
 

Rev 2590	Rev 2593
1	/*	1	/*
2	* Copyright (c) 2007 Jakub Jermar	2	* Copyright (c) 2007 Jakub Jermar
3	* All rights reserved.	3	* All rights reserved.
4	*	4	*
5	* Redistribution and use in source and binary forms, with or without	5	* Redistribution and use in source and binary forms, with or without
6	* modification, are permitted provided that the following conditions	6	* modification, are permitted provided that the following conditions
7	* are met:	7	* are met:
8	*	8	*
9	* - Redistributions of source code must retain the above copyright	9	* - Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.	10	* notice, this list of conditions and the following disclaimer.
11	* - Redistributions in binary form must reproduce the above copyright	11	* - Redistributions in binary form must reproduce the above copyright
12	* notice, this list of conditions and the following disclaimer in the	12	* notice, this list of conditions and the following disclaimer in the
13	* documentation and/or other materials provided with the distribution.	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	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.	15	* derived from this software without specific prior written permission.
16	*	16	*
17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR	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	18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.	19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,	20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT	21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,	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	23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT	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	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.	26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27	*/	27	*/
28		28
29	/** @addtogroup fs	29	/** @addtogroup fs
30	* @{	30	* @{
31	*/	31	*/
32		32
33	#ifndef VFS_VFS_H_	33	#ifndef VFS_VFS_H_
34	#define VFS_VFS_H_	34	#define VFS_VFS_H_
35		35
36	#include <ipc/ipc.h>	36	#include <ipc/ipc.h>
37	#include <libadt/list.h>	37	#include <libadt/list.h>
38	#include <atomic.h>	38	#include <atomic.h>
39	#include <sys/types.h>	39	#include <sys/types.h>
40	#include <bool.h>	40	#include <bool.h>
41		41
42	#define dprintf(...) printf(__VA_ARGS__)	42	#define dprintf(...) printf(__VA_ARGS__)
43		43
44	#define VFS_FIRST IPC_FIRST_USER_METHOD	44	#define VFS_FIRST IPC_FIRST_USER_METHOD
45		45
46	#define IPC_METHOD_TO_VFS_OP(m) ((m) - VFS_FIRST)	46	#define IPC_METHOD_TO_VFS_OP(m) ((m) - VFS_FIRST)
47		47
48	typedef enum {	48	typedef enum {
49	VFS_REGISTER = VFS_FIRST,	49	VFS_REGISTER = VFS_FIRST,
50	VFS_MOUNT,	50	VFS_MOUNT,
51	VFS_UNMOUNT,	51	VFS_UNMOUNT,
52	VFS_LOOKUP,	52	VFS_LOOKUP,
53	VFS_OPEN,	53	VFS_OPEN,
54	VFS_CREATE,	54	VFS_CREATE,
55	VFS_CLOSE,	55	VFS_CLOSE,
56	VFS_READ,	56	VFS_READ,
57	VFS_WRITE,	57	VFS_WRITE,
58	VFS_SEEK,	58	VFS_SEEK,
-		59	VFS_RENAME,
-		60	VFS_UNLINK,
59	VFS_LAST, /* keep this the last member of the enum */	61	VFS_LAST, /* keep this the last member of the enum */
60	} vfs_request_t;	62	} vfs_request_t;
61		63
62		64
63	/**	65	/**
64	* An instance of this structure is associated with a particular FS operation.	66	* An instance of this structure is associated with a particular FS operation.
65	* It tells VFS if the FS supports the operation or maybe if a default one	67	* It tells VFS if the FS supports the operation or maybe if a default one
66	* should be used.	68	* should be used.
67	*/	69	*/
68	typedef enum {	70	typedef enum {
69	VFS_OP_NULL = 0,	71	VFS_OP_NULL = 0,
70	VFS_OP_DEFAULT,	72	VFS_OP_DEFAULT,
71	VFS_OP_DEFINED	73	VFS_OP_DEFINED
72	} vfs_op_t;	74	} vfs_op_t;
73		75
74	#define FS_NAME_MAXLEN 20	76	#define FS_NAME_MAXLEN 20
75		77
76	/**	78	/**
77	* A structure like this is passed to VFS by each individual FS upon its	79	* A structure like this is passed to VFS by each individual FS upon its
78	* registration. It assosiates a human-readable identifier with each	80	* registration. It assosiates a human-readable identifier with each
79	* registered FS. More importantly, through this structure, the FS announces	81	* registered FS. More importantly, through this structure, the FS announces
80	* what operations it supports.	82	* what operations it supports.
81	*/	83	*/
82	typedef struct {	84	typedef struct {
83	/** Unique identifier of the fs. */	85	/** Unique identifier of the fs. */
84	char name[FS_NAME_MAXLEN];	86	char name[FS_NAME_MAXLEN];
85		87
86	/** Operations. */	88	/** Operations. */
87	vfs_op_t ops[VFS_LAST - VFS_FIRST];	89	vfs_op_t ops[VFS_LAST - VFS_FIRST];
88	} vfs_info_t;	90	} vfs_info_t;
89		91
90	/**	92	/**
91	* A structure like this will be allocated for each registered file system.	93	* A structure like this will be allocated for each registered file system.
92	*/	94	*/
93	typedef struct {	95	typedef struct {
94	link_t fs_link;	96	link_t fs_link;
95	vfs_info_t vfs_info;	97	vfs_info_t vfs_info;
96	int fs_handle;	98	int fs_handle;
97	atomic_t phone_futex; /*< Phone serializing futex. /	99	atomic_t phone_futex; /*< Phone serializing futex. /
98	ipcarg_t phone;	100	ipcarg_t phone;
99	} fs_info_t;	101	} fs_info_t;
100		102
101	/**	103	/**
102	* VFS_PAIR uniquely represents a file system instance.	104	* VFS_PAIR uniquely represents a file system instance.
103	*/	105	*/
104	#define VFS_PAIR \	106	#define VFS_PAIR \
105	int fs_handle; \	107	int fs_handle; \
106	int dev_handle;	108	int dev_handle;
107		109
108	/**	110	/**
109	* VFS_TRIPLET uniquely identifies a file system node (e.g. directory, file) but	111	* VFS_TRIPLET uniquely identifies a file system node (e.g. directory, file) but
110	* doesn't contain any state. For a stateful structure, see vfs_node_t.	112	* doesn't contain any state. For a stateful structure, see vfs_node_t.
111	*	113	*
112	* @note fs_handle, dev_handle and index are meant to be returned in one	114	* @note fs_handle, dev_handle and index are meant to be returned in one
113	* IPC reply.	115	* IPC reply.
114	*/	116	*/
115	#define VFS_TRIPLET \	117	#define VFS_TRIPLET \
116	VFS_PAIR; \	118	VFS_PAIR; \
117	uint64_t index;	119	uint64_t index;
118		120
119	typedef struct {	121	typedef struct {
120	VFS_PAIR;	122	VFS_PAIR;
121	} vfs_pair_t;	123	} vfs_pair_t;
122		124
123	typedef struct {	125	typedef struct {
124	VFS_TRIPLET;	126	VFS_TRIPLET;
125	} vfs_triplet_t;	127	} vfs_triplet_t;
126		128
127	/**	129	/**
128	* Instances of this type represent an active, in-memory VFS node and any state	130	* Instances of this type represent an active, in-memory VFS node and any state
129	* which may be associated with it.	131	* which may be associated with it.
130	*/	132	*/
131	typedef struct {	133	typedef struct {
132	VFS_TRIPLET; /*< Identity of the node. /	134	VFS_TRIPLET; /*< Identity of the node. /
133	atomic_t refcnt; /*< Usage counter. /	135	unsigned refcnt; /*< Usage counter. /
-		136	link_t nh_link; /*< Node hash-table link. /
134	} vfs_node_t;	137	} vfs_node_t;
135		138
136	/**	139	/**
137	* Instances of this type represent an open file. If the file is opened by more	140	* Instances of this type represent an open file. If the file is opened by more
138	* than one task, there will be a separate structure allocated for each task.	141	* than one task, there will be a separate structure allocated for each task.
139	*/	142	*/
140	typedef struct {	143	typedef struct {
141	vfs_node_t *node;	144	vfs_node_t *node;
142		145
143	/** Number of file handles referencing this file. */	146	/** Number of file handles referencing this file. */
144	atomic_t refcnt;	147	unsigned refcnt;
145		148
146	/** Current position in the file. */	149	/** Current position in the file. */
147	off_t pos;	150	off_t pos;
148	} vfs_file_t;	151	} vfs_file_t;
149		152
150	extern link_t fs_head; /*< List of registered file systems. /	153	extern link_t fs_head; /*< List of registered file systems. /
151		154
152	extern vfs_triplet_t rootfs; /*< Root node of the root file system. /	155	extern vfs_triplet_t rootfs; /*< Root node of the root file system. /
153		156
154	#define MAX_PATH_LEN (64 * 1024)	157	#define MAX_PATH_LEN (64 * 1024)
155		158
156	#define PLB_SIZE (2 * MAX_PATH_LEN)	159	#define PLB_SIZE (2 * MAX_PATH_LEN)
157		160
158	/** Each instance of this type describes one path lookup in progress. */	161	/** Each instance of this type describes one path lookup in progress. */
159	typedef struct {	162	typedef struct {
160	link_t plb_link; /*< Active PLB entries list link. /	163	link_t plb_link; /*< Active PLB entries list link. /
161	unsigned index; /*< Index of the first character in PLB. /	164	unsigned index; /*< Index of the first character in PLB. /
162	size_t len; /*< Number of characters in this PLB entry. /	165	size_t len; /*< Number of characters in this PLB entry. /
163	} plb_entry_t;	166	} plb_entry_t;
164		167
165	extern atomic_t plb_futex; /*< Futex protecting plb and plb_head. /	168	extern atomic_t plb_futex; /*< Futex protecting plb and plb_head. /
166	extern uint8_t plb; /< Path Lookup Buffer /	169	extern uint8_t plb; /< Path Lookup Buffer /
167	extern link_t plb_head; /*< List of active PLB entries. /	170	extern link_t plb_head; /*< List of active PLB entries. /
168		171
-		172	extern atomic_t unlink_futex; /*< VFS_{CREATE\|OPEN\|UNLINK} serialization. /
-		173
169	extern int vfs_grab_phone(int);	174	extern int vfs_grab_phone(int);
170	extern void vfs_release_phone(int);	175	extern void vfs_release_phone(int);
171		176
172	extern int fs_name_to_handle(char *, bool);	177	extern int fs_name_to_handle(char *, bool);
173		178
174	extern int vfs_lookup_internal(char , size_t, vfs_triplet_t , vfs_pair_t *);	179	extern int vfs_lookup_internal(char , size_t, vfs_triplet_t , vfs_pair_t *);
-		180
-		181
175	extern vfs_node_t vfs_node_get(vfs_triplet_t );	182	extern vfs_node_t vfs_node_get(vfs_triplet_t );
-		183	extern void vfs_node_put(vfs_node_t *);
-		184
-		185	extern bool vfs_files_init(void);
-		186	extern vfs_file_t *vfs_file_get(int);
-		187	extern int vfs_fd_alloc(void);
-		188	extern void vfs_fd_free(int);
-		189
-		190	extern void vfs_file_addref(vfs_file_t *);
-		191	extern void vfs_file_delref(vfs_file_t *);
-		192
-		193	extern void vfs_node_addref(vfs_node_t *);
-		194	extern void vfs_node_delref(vfs_node_t *);
176		195
177	#define MAX_OPEN_FILES 128	196	#define MAX_OPEN_FILES 128
178		197
179	extern void vfs_register(ipc_callid_t, ipc_call_t *);	198	extern void vfs_register(ipc_callid_t, ipc_call_t *);
180	extern void vfs_mount(ipc_callid_t, ipc_call_t *);	199	extern void vfs_mount(ipc_callid_t, ipc_call_t *);
181	extern void vfs_open(ipc_callid_t, ipc_call_t *);	200	extern void vfs_open(ipc_callid_t, ipc_call_t *);
182		201
183	#endif	202	#endif
184		203
185	/**	204	/**
186	* @}	205	* @}
187	*/	206	*/
188		207

Subversion Repositories HelenOS

(root)/trunk/uspace/srv/vfs/vfs.h – Rev 2590 → 2593