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>
 
#define dprintf(...)    printf(__VA_ARGS__)
 
#define VFS_FIRST   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;
    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 void vfs_register(ipc_callid_t, ipc_call_t *);
extern void vfs_lookup(ipc_callid_t, ipc_call_t *);
 
#endif
 
/**
 * @}
 */
 

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

Subversion Repositories HelenOS

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