WebSVN – HelenOS – Diff – /branches/dynload/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_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;
 
/**
 * Instances of this type represent a file system node (e.g. directory, file).
 * They are abstracted away from any file system implementation and contain just
 * enough bits to uniquely identify the object in its file system instance.
 *
 * @note    fs_handle, dev_handle and index are meant to be returned in one
 *      IPC reply.
 */
typedef struct {
    int fs_handle;      /**< Global file system ID. */
    int dev_handle;     /**< Global mount device devno. */
    uint64_t index;     /**< Index of the node on its file system. */
} 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. */
    atomic_t refcnt;
 
    /** Current position in the file. */
    off_t pos;
} vfs_file_t;
 
extern link_t fs_head;      /**< List of registered file systems. */
 
extern vfs_node_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 int vfs_grab_phone(int);
extern void vfs_release_phone(int);
 
extern int fs_name_to_handle(char *name, bool lock);
 
extern int vfs_lookup_internal(char *path, size_t len, vfs_node_t *result,
    vfs_node_t *altroot);
 
extern void vfs_register(ipc_callid_t, ipc_call_t *);
extern void vfs_mount(ipc_callid_t, ipc_call_t *);
 
#endif
 
/**
 * @}
 */
 

Rev 2549	Rev 2550
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		41
41	#define dprintf(...) printf(__VA_ARGS__)	42	#define dprintf(...) printf(__VA_ARGS__)
42		43
43	#define VFS_FIRST FIRST_USER_METHOD	44	#define VFS_FIRST IPC_FIRST_USER_METHOD
44		45
45	#define IPC_METHOD_TO_VFS_OP(m) ((m) - VFS_FIRST)	46	#define IPC_METHOD_TO_VFS_OP(m) ((m) - VFS_FIRST)
46		47
47	typedef enum {	48	typedef enum {
48	VFS_REGISTER = VFS_FIRST,	49	VFS_REGISTER = VFS_FIRST,
49	VFS_MOUNT,	50	VFS_MOUNT,
50	VFS_UNMOUNT,	51	VFS_UNMOUNT,
51	VFS_LOOKUP,	52	VFS_LOOKUP,
52	VFS_OPEN,	53	VFS_OPEN,
53	VFS_CREATE,	54	VFS_CREATE,
54	VFS_CLOSE,	55	VFS_CLOSE,
55	VFS_READ,	56	VFS_READ,
56	VFS_WRITE,	57	VFS_WRITE,
57	VFS_SEEK,	58	VFS_SEEK,
58	VFS_LAST, /* keep this the last member of the enum */	59	VFS_LAST, /* keep this the last member of the enum */
59	} vfs_request_t;	60	} vfs_request_t;
60		61
61		62
62	/**	63	/**
63	* An instance of this structure is associated with a particular FS operation.	64	* An instance of this structure is associated with a particular FS operation.
64	* It tells VFS if the FS supports the operation or maybe if a default one	65	* It tells VFS if the FS supports the operation or maybe if a default one
65	* should be used.	66	* should be used.
66	*/	67	*/
67	typedef enum {	68	typedef enum {
68	VFS_OP_NULL = 0,	69	VFS_OP_NULL = 0,
69	VFS_OP_DEFAULT,	70	VFS_OP_DEFAULT,
70	VFS_OP_DEFINED	71	VFS_OP_DEFINED
71	} vfs_op_t;	72	} vfs_op_t;
72		73
73	#define FS_NAME_MAXLEN 20	74	#define FS_NAME_MAXLEN 20
74		75
75	/**	76	/**
76	* A structure like this is passed to VFS by each individual FS upon its	77	* A structure like this is passed to VFS by each individual FS upon its
77	* registration. It assosiates a human-readable identifier with each	78	* registration. It assosiates a human-readable identifier with each
78	* registered FS. More importantly, through this structure, the FS announces	79	* registered FS. More importantly, through this structure, the FS announces
79	* what operations it supports.	80	* what operations it supports.
80	*/	81	*/
81	typedef struct {	82	typedef struct {
82	/** Unique identifier of the fs. */	83	/** Unique identifier of the fs. */
83	char name[FS_NAME_MAXLEN];	84	char name[FS_NAME_MAXLEN];
84		85
85	/** Operations. */	86	/** Operations. */
86	vfs_op_t ops[VFS_LAST - VFS_FIRST];	87	vfs_op_t ops[VFS_LAST - VFS_FIRST];
87	} vfs_info_t;	88	} vfs_info_t;
88		89
89	/**	90	/**
90	* A structure like this will be allocated for each registered file system.	91	* A structure like this will be allocated for each registered file system.
91	*/	92	*/
92	typedef struct {	93	typedef struct {
93	link_t fs_link;	94	link_t fs_link;
94	vfs_info_t vfs_info;	95	vfs_info_t vfs_info;
95	int fs_handle;	96	int fs_handle;
96	atomic_t phone_futex; /*< Phone serializing futex. /	97	atomic_t phone_futex; /*< Phone serializing futex. /
97	ipcarg_t phone;	98	ipcarg_t phone;
98	} fs_info_t;	99	} fs_info_t;
99		100
100	/**	101	/**
101	* Instances of this type represent a file system node (e.g. directory, file).	102	* Instances of this type represent a file system node (e.g. directory, file).
102	* They are abstracted away from any file system implementation and contain just	103	* They are abstracted away from any file system implementation and contain just
103	* enough bits to uniquely identify the object in its file system instance.	104	* enough bits to uniquely identify the object in its file system instance.
104	*	105	*
105	* @note fs_handle, dev_handle and index are meant to be returned in one	106	* @note fs_handle, dev_handle and index are meant to be returned in one
106	* IPC reply.	107	* IPC reply.
107	*/	108	*/
108	typedef struct {	109	typedef struct {
109	int fs_handle; /*< Global file system ID. /	110	int fs_handle; /*< Global file system ID. /
110	int dev_handle; /*< Global mount device devno. /	111	int dev_handle; /*< Global mount device devno. /
111	uint64_t index; /*< Index of the node on its file system. /	112	uint64_t index; /*< Index of the node on its file system. /
112	} vfs_node_t;	113	} vfs_node_t;
113		114
114	/**	115	/**
115	* Instances of this type represent an open file. If the file is opened by more	116	* Instances of this type represent an open file. If the file is opened by more
116	* than one task, there will be a separate structure allocated for each task.	117	* than one task, there will be a separate structure allocated for each task.
117	*/	118	*/
118	typedef struct {	119	typedef struct {
119	vfs_node_t *node;	120	vfs_node_t *node;
120		121
121	/** Number of file handles referencing this file. */	122	/** Number of file handles referencing this file. */
122	atomic_t refcnt;	123	atomic_t refcnt;
123		124
124	/** Current position in the file. */	125	/** Current position in the file. */
125	off_t pos;	126	off_t pos;
126	} vfs_file_t;	127	} vfs_file_t;
127		128
128	extern link_t fs_head; /*< List of registered file systems. /	129	extern link_t fs_head; /*< List of registered file systems. /
129		130
130	extern vfs_node_t rootfs; /< Root node of the root file system. /	131	extern vfs_node_t rootfs; /< Root node of the root file system. /
131		132
132	#define MAX_PATH_LEN (64 * 1024)	133	#define MAX_PATH_LEN (64 * 1024)
133		134
134	#define PLB_SIZE (2 * MAX_PATH_LEN)	135	#define PLB_SIZE (2 * MAX_PATH_LEN)
135		136
136	/** Each instance of this type describes one path lookup in progress. */	137	/** Each instance of this type describes one path lookup in progress. */
137	typedef struct {	138	typedef struct {
138	link_t plb_link; /*< Active PLB entries list link. /	139	link_t plb_link; /*< Active PLB entries list link. /
139	unsigned index; /*< Index of the first character in PLB. /	140	unsigned index; /*< Index of the first character in PLB. /
140	size_t len; /*< Number of characters in this PLB entry. /	141	size_t len; /*< Number of characters in this PLB entry. /
141	} plb_entry_t;	142	} plb_entry_t;
142		143
143	extern atomic_t plb_futex; /*< Futex protecting plb and plb_head. /	144	extern atomic_t plb_futex; /*< Futex protecting plb and plb_head. /
144	extern uint8_t plb; /< Path Lookup Buffer /	145	extern uint8_t plb; /< Path Lookup Buffer /
145	extern link_t plb_head; /*< List of active PLB entries. /	146	extern link_t plb_head; /*< List of active PLB entries. /
146		147
147	extern int vfs_grab_phone(int);	148	extern int vfs_grab_phone(int);
148	extern void vfs_release_phone(int);	149	extern void vfs_release_phone(int);
149		150
150	extern int fs_name_to_handle(char *name, bool lock);	151	extern int fs_name_to_handle(char *name, bool lock);
151		152
152	extern int vfs_lookup_internal(char path, size_t len, vfs_node_t result,	153	extern int vfs_lookup_internal(char path, size_t len, vfs_node_t result,
153	vfs_node_t *altroot);	154	vfs_node_t *altroot);
154		155
155	extern void vfs_register(ipc_callid_t, ipc_call_t *);	156	extern void vfs_register(ipc_callid_t, ipc_call_t *);
156	extern void vfs_mount(ipc_callid_t, ipc_call_t *);	157	extern void vfs_mount(ipc_callid_t, ipc_call_t *);
157		158
158	#endif	159	#endif
159		160
160	/**	161	/**
161	* @}	162	* @}
162	*/	163	*/
163		164

Subversion Repositories HelenOS

(root)/branches/dynload/uspace/srv/vfs/vfs.h @ 3674 – Rev 2549 → 2550