xref: /netbsd/external/bsd/iscsi/dist/include/virtdir.h (revision 6550d01e)
1 /*
2  * Copyright � 2007 Alistair Crooks.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  * 3. The name of the author may not be used to endorse or promote
13  *    products derived from this software without specific prior written
14  *    permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
17  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
22  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
25  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 #ifndef FUSE_TREE_H_
29 #define FUSE_TREE_H_	20070405
30 
31 #include <sys/types.h>
32 #include <sys/stat.h>
33 
34 #include <fuse.h>
35 
36 #include "defs.h"
37 
38 /* this struct keeps a note of all the info related to a virtual directory entry */
39 typedef struct virt_dirent_t {
40 	char		*name;		/* entry name - used as key */
41 	size_t		 namelen;	/* length of name */
42 	char		*d_name;	/* component in this directory */
43 	char		*tgt;		/* any symlink target */
44 	size_t		 tgtlen;	/* length of symlink target */
45 	uint8_t		 type;		/* entry type - file, dir, lnk */
46 	ino_t		 ino;		/* inode number */
47 } virt_dirent_t;
48 
49 /* this defines the list of virtual directory entries,
50    sorted in name alpha order */
51 typedef struct virtdir_t {
52 	uint32_t	 c;		/* count of entries */
53 	uint32_t	 size;		/* size of allocated list */
54 	virt_dirent_t	*v;		/* list */
55 	char		*rootdir;	/* root directory of virtual fs */
56 	struct stat	 file;		/* stat struct for file entries */
57 	struct stat	 dir;		/* stat struct for dir entries */
58 	struct stat	 lnk;		/* stat struct for symlinks */
59 } virtdir_t;
60 
61 /* this struct is used to walk through directories */
62 typedef struct VIRTDIR {
63 	char		*dirname;	/* directory name */
64 	int		 dirnamelen;	/* length of directory name */
65 	virtdir_t	*tp;		/* the directory tree */
66 	unsigned	 i;		/* current offset in dir tree */
67 } VIRTDIR;
68 
69 int virtdir_init(virtdir_t *, const char *, struct stat *, struct stat *, struct stat *);
70 int virtdir_add(virtdir_t *, const char *, size_t, uint8_t, const char *, size_t);
71 int virtdir_del(virtdir_t *, const char *, size_t);
72 virt_dirent_t *virtdir_find(virtdir_t *, const char *, size_t);
73 virt_dirent_t *virtdir_find_tgt(virtdir_t *, const char *, size_t);
74 void virtdir_drop(virtdir_t *);
75 char *virtdir_rootdir(virtdir_t *);
76 
77 VIRTDIR *openvirtdir(virtdir_t *, const char *);
78 virt_dirent_t *readvirtdir(VIRTDIR *);
79 void closevirtdir(VIRTDIR *);
80 
81 int virtdir_offset(virtdir_t *, virt_dirent_t *);
82 
83 #endif
84