WebSVN – HelenOS – Diff – /branches/network/uspace/lib/libfs/libfs.h


/*
 * Copyright (c) 2009 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 libfs
 * @{
 */
/**
 * @file
 */
 
#ifndef LIBFS_LIBFS_H_
#define LIBFS_LIBFS_H_
 
#include <ipc/vfs.h>
#include <stdint.h>
#include <ipc/ipc.h>
#include <async.h>
#include <devmap.h>
 
typedef struct {
    bool mp_active;
    int phone;
    fs_handle_t fs_handle;
    dev_handle_t dev_handle;
} mp_data_t;
 
typedef struct {
    mp_data_t mp_data;  /**< Mount point info. */
    void *data;         /**< Data of the file system implementation. */
} fs_node_t;
 
typedef struct {
    fs_node_t * (* match)(fs_node_t *, const char *);
    fs_node_t * (* node_get)(dev_handle_t, fs_index_t);
    void (* node_put)(fs_node_t *);
    fs_node_t * (* create)(dev_handle_t, int);
    int (* destroy)(fs_node_t *);
    int (* link)(fs_node_t *, fs_node_t *, const char *);
    int (* unlink)(fs_node_t *, fs_node_t *, const char *);
    fs_index_t (* index_get)(fs_node_t *);
    size_t (* size_get)(fs_node_t *);
    unsigned (* lnkcnt_get)(fs_node_t *);
    bool (* has_children)(fs_node_t *);
    fs_node_t *(* root_get)(dev_handle_t);
    char (* plb_get_char)(unsigned pos);
    bool (* is_directory)(fs_node_t *);
    bool (* is_file)(fs_node_t *);
} libfs_ops_t;
 
typedef struct {
    int fs_handle;           /**< File system handle. */
    ipcarg_t vfs_phonehash;  /**< Initial VFS phonehash. */
    uint8_t *plb_ro;         /**< Read-only PLB view. */
} fs_reg_t;
 
extern int fs_register(int, fs_reg_t *, vfs_info_t *, async_client_conn_t);
 
extern void fs_node_initialize(fs_node_t *);
 
extern void libfs_mount(libfs_ops_t *, fs_handle_t, ipc_callid_t, ipc_call_t *);
extern void libfs_lookup(libfs_ops_t *, fs_handle_t, ipc_callid_t, ipc_call_t *);
extern void libfs_stat(libfs_ops_t *, fs_handle_t, ipc_callid_t, ipc_call_t *);
extern void libfs_open_node(libfs_ops_t *, fs_handle_t, ipc_callid_t,
    ipc_call_t *);
 
#endif
 
/** @}
 */
 

Subversion Repositories HelenOS

(root)/branches/network/uspace/lib/libfs/libfs.h – Rev 4581 → 4718

Rev 4581		Rev 4718
1	/*	1	/*
2	* Copyright (c) 2009 Jakub Jermar	2	* Copyright (c) 2009 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 libfs	29	/** @addtogroup libfs
30	* @{	30	* @{
31	*/	31	*/
32	/**	32	/**
33	* @file	33	* @file
34	*/	34	*/
35		35
36	#ifndef LIBFS_LIBFS_H_	36	#ifndef LIBFS_LIBFS_H_
37	#define LIBFS_LIBFS_H_	37	#define LIBFS_LIBFS_H_
38		38
39	#include <ipc/vfs.h>	39	#include <ipc/vfs.h>
40	#include <stdint.h>	40	#include <stdint.h>
41	#include <ipc/ipc.h>	41	#include <ipc/ipc.h>
42	#include <async.h>	42	#include <async.h>
43	#include <devmap.h>	43	#include <devmap.h>
44		44
45	typedef struct {	45	typedef struct {
46	bool mp_active;	46	bool mp_active;
47	int phone;	47	int phone;
48	fs_handle_t fs_handle;	48	fs_handle_t fs_handle;
49	dev_handle_t dev_handle;	49	dev_handle_t dev_handle;
50	} mp_data_t;	50	} mp_data_t;
51		51
52	typedef struct {	52	typedef struct {
53	mp_data_t mp_data; /*< Mount point info. /	53	mp_data_t mp_data; /*< Mount point info. /
54	void data; /< Data of the file system implementation. /	54	void data; /< Data of the file system implementation. /
55	} fs_node_t;	55	} fs_node_t;
56		56
57	typedef struct {	57	typedef struct {
58	fs_node_t * (* match)(fs_node_t , const char );	58	fs_node_t * (* match)(fs_node_t , const char );
59	fs_node_t * (* node_get)(dev_handle_t, fs_index_t);	59	fs_node_t * (* node_get)(dev_handle_t, fs_index_t);
60	void (* node_put)(fs_node_t *);	60	void (* node_put)(fs_node_t *);
61	fs_node_t * (* create)(dev_handle_t, int);	61	fs_node_t * (* create)(dev_handle_t, int);
62	int (* destroy)(fs_node_t *);	62	int (* destroy)(fs_node_t *);
63	int (* link)(fs_node_t , fs_node_t , const char *);	63	int (* link)(fs_node_t , fs_node_t , const char *);
64	int (* unlink)(fs_node_t , fs_node_t , const char *);	64	int (* unlink)(fs_node_t , fs_node_t , const char *);
65	fs_index_t (* index_get)(fs_node_t *);	65	fs_index_t (* index_get)(fs_node_t *);
66	size_t (* size_get)(fs_node_t *);	66	size_t (* size_get)(fs_node_t *);
67	unsigned (* lnkcnt_get)(fs_node_t *);	67	unsigned (* lnkcnt_get)(fs_node_t *);
68	bool (* has_children)(fs_node_t *);	68	bool (* has_children)(fs_node_t *);
69	fs_node_t ( root_get)(dev_handle_t);	69	fs_node_t ( root_get)(dev_handle_t);
70	char (* plb_get_char)(unsigned pos);	70	char (* plb_get_char)(unsigned pos);
71	bool (* is_directory)(fs_node_t *);	71	bool (* is_directory)(fs_node_t *);
72	bool (* is_file)(fs_node_t *);	72	bool (* is_file)(fs_node_t *);
73	} libfs_ops_t;	73	} libfs_ops_t;
74		74
75	typedef struct {	75	typedef struct {
76	int fs_handle; /*< File system handle. /	76	int fs_handle; /*< File system handle. /
77	ipcarg_t vfs_phonehash; /*< Initial VFS phonehash. /	77	ipcarg_t vfs_phonehash; /*< Initial VFS phonehash. /
78	uint8_t plb_ro; /< Read-only PLB view. /	78	uint8_t plb_ro; /< Read-only PLB view. /
79	} fs_reg_t;	79	} fs_reg_t;
80		80
81	extern int fs_register(int, fs_reg_t , vfs_info_t , async_client_conn_t);	81	extern int fs_register(int, fs_reg_t , vfs_info_t , async_client_conn_t);
82		82
83	extern void fs_node_initialize(fs_node_t *);	83	extern void fs_node_initialize(fs_node_t *);
84		84
85	extern void libfs_mount(libfs_ops_t , fs_handle_t, ipc_callid_t, ipc_call_t );	85	extern void libfs_mount(libfs_ops_t , fs_handle_t, ipc_callid_t, ipc_call_t );
86	extern void libfs_lookup(libfs_ops_t , fs_handle_t, ipc_callid_t, ipc_call_t );	86	extern void libfs_lookup(libfs_ops_t , fs_handle_t, ipc_callid_t, ipc_call_t );
-		87	extern void libfs_stat(libfs_ops_t , fs_handle_t, ipc_callid_t, ipc_call_t );
87	extern void libfs_open_node(libfs_ops_t *, fs_handle_t, ipc_callid_t,	88	extern void libfs_open_node(libfs_ops_t *, fs_handle_t, ipc_callid_t,
88	ipc_call_t *);	89	ipc_call_t *);
89		90
90	#endif	91	#endif
91		92
92	/** @}	93	/** @}
93	*/	94	*/
94		95