WebSVN – HelenOS – Diff – /branches/tracing/uspace/lib/libc/include/ipc/vfs.h


/*
 * Copyright (c) 2009 Martin Decky
 * 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 libcipc
 * @{
 */
/** @file
 */
 
#ifndef LIBC_IPC_VFS_H_
#define LIBC_IPC_VFS_H_
 
#include <sys/types.h>
#include <ipc/ipc.h>
 
#define FS_NAME_MAXLEN  20
#define MAX_PATH_LEN    (64 * 1024)
#define PLB_SIZE        (2 * MAX_PATH_LEN)
 
/* Basic types. */
typedef int16_t fs_handle_t;
typedef uint32_t fs_index_t;
 
/**
 * 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.
 */
typedef struct {
    /** Unique identifier of the fs. */
    char name[FS_NAME_MAXLEN + 1];
} vfs_info_t;
 
typedef enum {
    VFS_IN_OPEN = IPC_FIRST_USER_METHOD,
    VFS_IN_OPEN_NODE,
    VFS_IN_READ,
    VFS_IN_WRITE,
    VFS_IN_SEEK,
    VFS_IN_TRUNCATE,
    VFS_IN_FSTAT,
    VFS_IN_CLOSE,
    VFS_IN_MOUNT,
    VFS_IN_UNMOUNT,
    VFS_IN_SYNC,
    VFS_IN_REGISTER,
    VFS_IN_MKDIR,
    VFS_IN_UNLINK,
    VFS_IN_RENAME,
    VFS_IN_STAT
} vfs_in_request_t;
 
typedef enum {
    VFS_OUT_OPEN_NODE = IPC_FIRST_USER_METHOD,
    VFS_OUT_READ,
    VFS_OUT_WRITE,
    VFS_OUT_TRUNCATE,
    VFS_OUT_CLOSE,
    VFS_OUT_MOUNT,
    VFS_OUT_MOUNTED,
    VFS_OUT_UNMOUNT,
    VFS_OUT_SYNC,
    VFS_OUT_STAT,
    VFS_OUT_LOOKUP,
    VFS_OUT_DESTROY,
    VFS_OUT_LAST
} vfs_out_request_t;
 
/*
 * Lookup flags.
 */
 
/**
 * No lookup flags used.
 */
#define L_NONE  0
 
/**
 * Lookup will succeed only if the object is a regular file.  If L_CREATE is
 * specified, an empty file will be created. This flag is mutually exclusive
 * with L_DIRECTORY.
 */
#define L_FILE  1
 
/**
 * Lookup wil succeed only if the object is a directory. If L_CREATE is
 * specified, an empty directory will be created. This flag is mutually
 * exclusive with L_FILE.
 */
#define L_DIRECTORY  2
 
/**
 * When used with L_CREATE, L_EXCLUSIVE will cause the lookup to fail if the
 * object already exists. L_EXCLUSIVE is implied when L_DIRECTORY is used.
 */
#define L_EXCLUSIVE  4
 
/**
 * L_CREATE is used for creating both regular files and directories.
 */
#define L_CREATE  8
 
/**
 * L_LINK is used for linking to an already existing nodes.
 */
#define L_LINK  16
 
/**
 * L_UNLINK is used to remove leaves from the file system namespace. This flag
 * cannot be passed directly by the client, but will be set by VFS during
 * VFS_UNLINK.
 */
#define L_UNLINK  32
 
/**
 * L_OPEN is used to indicate that the lookup operation is a part of VFS_OPEN
 * call from the client. This means that the server might allocate some
 * resources for the opened file. This flag cannot be passed directly by the
 * client.
 */
#define L_OPEN  64
 
#endif
 
/** @}
 */
 

Rev 4609	Rev 4692
1	/*	1	/*
2	* Copyright (c) 2009 Martin Decky	2	* Copyright (c) 2009 Martin Decky
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 libcipc	29	/** @addtogroup libcipc
30	* @{	30	* @{
31	*/	31	*/
32	/** @file	32	/** @file
33	*/	33	*/
34		34
35	#ifndef LIBC_IPC_VFS_H_	35	#ifndef LIBC_IPC_VFS_H_
36	#define LIBC_IPC_VFS_H_	36	#define LIBC_IPC_VFS_H_
37		37
38	#include <sys/types.h>	38	#include <sys/types.h>
39	#include <ipc/ipc.h>	39	#include <ipc/ipc.h>
40		40
41	#define FS_NAME_MAXLEN 20	41	#define FS_NAME_MAXLEN 20
42	#define MAX_PATH_LEN (64 * 1024)	42	#define MAX_PATH_LEN (64 * 1024)
43	#define PLB_SIZE (2 * MAX_PATH_LEN)	43	#define PLB_SIZE (2 * MAX_PATH_LEN)
44		44
45	/* Basic types. */	45	/* Basic types. */
46	typedef int16_t fs_handle_t;	46	typedef int16_t fs_handle_t;
47	typedef uint32_t fs_index_t;	47	typedef uint32_t fs_index_t;
48		48
49	/**	49	/**
50	* A structure like this is passed to VFS by each individual FS upon its	50	* A structure like this is passed to VFS by each individual FS upon its
51	* registration. It assosiates a human-readable identifier with each	51	* registration. It assosiates a human-readable identifier with each
52	* registered FS.	52	* registered FS.
53	*/	53	*/
54	typedef struct {	54	typedef struct {
55	/** Unique identifier of the fs. */	55	/** Unique identifier of the fs. */
56	char name[FS_NAME_MAXLEN + 1];	56	char name[FS_NAME_MAXLEN + 1];
57	} vfs_info_t;	57	} vfs_info_t;
58		58
59	typedef enum {	59	typedef enum {
60	VFS_IN_OPEN = IPC_FIRST_USER_METHOD,	60	VFS_IN_OPEN = IPC_FIRST_USER_METHOD,
61	VFS_IN_OPEN_NODE,	61	VFS_IN_OPEN_NODE,
62	VFS_IN_READ,	62	VFS_IN_READ,
63	VFS_IN_WRITE,	63	VFS_IN_WRITE,
64	VFS_IN_SEEK,	64	VFS_IN_SEEK,
65	VFS_IN_TRUNCATE,	65	VFS_IN_TRUNCATE,
66	VFS_IN_FSTAT,	66	VFS_IN_FSTAT,
67	VFS_IN_CLOSE,	67	VFS_IN_CLOSE,
68	VFS_IN_MOUNT,	68	VFS_IN_MOUNT,
69	VFS_IN_UNMOUNT,	69	VFS_IN_UNMOUNT,
70	VFS_IN_SYNC,	70	VFS_IN_SYNC,
71	VFS_IN_REGISTER,	71	VFS_IN_REGISTER,
72	VFS_IN_MKDIR,	72	VFS_IN_MKDIR,
73	VFS_IN_UNLINK,	73	VFS_IN_UNLINK,
74	VFS_IN_RENAME,	74	VFS_IN_RENAME,
75	VFS_IN_STAT	75	VFS_IN_STAT
76	} vfs_in_request_t;	76	} vfs_in_request_t;
77		77
78	typedef enum {	78	typedef enum {
79	VFS_OUT_OPEN_NODE = IPC_FIRST_USER_METHOD,	79	VFS_OUT_OPEN_NODE = IPC_FIRST_USER_METHOD,
80	VFS_OUT_READ,	80	VFS_OUT_READ,
81	VFS_OUT_WRITE,	81	VFS_OUT_WRITE,
82	VFS_OUT_TRUNCATE,	82	VFS_OUT_TRUNCATE,
83	VFS_OUT_CLOSE,	83	VFS_OUT_CLOSE,
84	VFS_OUT_MOUNT,	84	VFS_OUT_MOUNT,
85	VFS_OUT_MOUNTED,	85	VFS_OUT_MOUNTED,
86	VFS_OUT_UNMOUNT,	86	VFS_OUT_UNMOUNT,
87	VFS_OUT_SYNC,	87	VFS_OUT_SYNC,
88	VFS_OUT_STAT,	88	VFS_OUT_STAT,
89	VFS_OUT_LOOKUP,	89	VFS_OUT_LOOKUP,
90	VFS_OUT_DESTROY,	90	VFS_OUT_DESTROY,
91	VFS_OUT_LAST	91	VFS_OUT_LAST
92	} vfs_out_request_t;	92	} vfs_out_request_t;
93		93
94	/*	94	/*
95	* Lookup flags.	95	* Lookup flags.
96	*/	96	*/
97		97
98	/**	98	/**
99	* No lookup flags used.	99	* No lookup flags used.
100	*/	100	*/
101	#define L_NONE 0	101	#define L_NONE 0
102		102
103	/**	103	/**
104	* Lookup will succeed only if the object is a regular file. If L_CREATE is	104	* Lookup will succeed only if the object is a regular file. If L_CREATE is
105	* specified, an empty file will be created. This flag is mutually exclusive	105	* specified, an empty file will be created. This flag is mutually exclusive
106	* with L_DIRECTORY.	106	* with L_DIRECTORY.
107	*/	107	*/
108	#define L_FILE 1	108	#define L_FILE 1
109		109
110	/**	110	/**
111	* Lookup wil succeed only if the object is a directory. If L_CREATE is	111	* Lookup wil succeed only if the object is a directory. If L_CREATE is
112	* specified, an empty directory will be created. This flag is mutually	112	* specified, an empty directory will be created. This flag is mutually
113	* exclusive with L_FILE.	113	* exclusive with L_FILE.
114	*/	114	*/
115	#define L_DIRECTORY 2	115	#define L_DIRECTORY 2
116		116
117	/**	117	/**
118	* When used with L_CREATE, L_EXCLUSIVE will cause the lookup to fail if the	118	* When used with L_CREATE, L_EXCLUSIVE will cause the lookup to fail if the
119	* object already exists. L_EXCLUSIVE is implied when L_DIRECTORY is used.	119	* object already exists. L_EXCLUSIVE is implied when L_DIRECTORY is used.
120	*/	120	*/
121	#define L_EXCLUSIVE 4	121	#define L_EXCLUSIVE 4
122		122
123	/**	123	/**
124	* L_CREATE is used for creating both regular files and directories.	124	* L_CREATE is used for creating both regular files and directories.
125	*/	125	*/
126	#define L_CREATE 8	126	#define L_CREATE 8
127		127
128	/**	128	/**
129	* L_LINK is used for linking to an already existing nodes.	129	* L_LINK is used for linking to an already existing nodes.
130	*/	130	*/
131	#define L_LINK 16	131	#define L_LINK 16
132		132
133	/**	133	/**
134	* L_UNLINK is used to remove leaves from the file system namespace. This flag	134	* L_UNLINK is used to remove leaves from the file system namespace. This flag
135	* cannot be passed directly by the client, but will be set by VFS during	135	* cannot be passed directly by the client, but will be set by VFS during
136	* VFS_UNLINK.	136	* VFS_UNLINK.
137	*/	137	*/
138	#define L_UNLINK 32	138	#define L_UNLINK 32
139		139
140	/**	140	/**
141	* L_OPEN is used to indicate that the lookup operation is a part of VFS_OPEN	141	* L_OPEN is used to indicate that the lookup operation is a part of VFS_OPEN
142	* call from the client. This means that the server might allocate some	142	* call from the client. This means that the server might allocate some
143	* resources for the opened file. This flag cannot be passed directly by the	143	* resources for the opened file. This flag cannot be passed directly by the
144	* client.	144	* client.
145	*/	145	*/
146	#define L_OPEN 64	146	#define L_OPEN 64
147		147
148	#endif	148	#endif
149		149
150	/** @}	150	/** @}
151	*/	151	*/
152		152

Subversion Repositories HelenOS

(root)/branches/tracing/uspace/lib/libc/include/ipc/vfs.h – Rev 4609 → 4692