xref: /netbsd-src/lib/libukfs/ukfs.h (revision 404fbe5fb94ca1e054339640cabb2801ce52dd30)
1 /*	$NetBSD: ukfs.h,v 1.7 2008/10/07 23:16:59 pooka Exp $	*/
2 
3 /*
4  * Copyright (c) 2007, 2008  Antti Kantee.  All Rights Reserved.
5  *
6  * Development of this software was supported by the
7  * Finnish Cultural Foundation.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
19  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  */
30 
31 #ifndef _RUMP_UKFS_H_
32 #define _RUMP_UKFS_H_
33 
34 #include <sys/types.h>
35 
36 #include <stdint.h>
37 
38 /* don't include NetBSD <sys/header.h> for portability */
39 struct vnode;
40 struct stat;
41 struct timeval;
42 
43 struct ukfs;
44 
45 #define UKFS_DEFAULTMP "/"
46 
47 #define UKFS_RELFLAG_NOUNMOUNT	0x01
48 
49 #define UKFS_VERSION	001 /* sector 001 */
50 #define	ukfs_init()	_ukfs_init(UKFS_VERSION)
51 
52 __BEGIN_DECLS
53 
54 int		_ukfs_init(int);
55 struct ukfs	*ukfs_mount(const char *, const char *, const char *,
56 			  int, void *, size_t);
57 void		ukfs_release(struct ukfs *, int);
58 
59 int		ukfs_getdents(struct ukfs *, const char *, off_t *,
60 			      uint8_t *, size_t);
61 ssize_t		ukfs_read(struct ukfs *, const char *, off_t,
62 			      uint8_t *, size_t);
63 ssize_t		ukfs_write(struct ukfs *, const char *, off_t,
64 			       uint8_t *, size_t);
65 ssize_t		ukfs_readlink(struct ukfs *, const char *, char *, size_t);
66 
67 int		ukfs_create(struct ukfs *, const char *, mode_t);
68 int		ukfs_mkdir(struct ukfs *, const char *, mode_t);
69 int		ukfs_mknod(struct ukfs *, const char *, mode_t, dev_t);
70 int		ukfs_mkfifo(struct ukfs *, const char *, mode_t);
71 int		ukfs_symlink(struct ukfs *, const char *, const char *);
72 
73 int		ukfs_remove(struct ukfs *, const char *);
74 int		ukfs_rmdir(struct ukfs *, const char *);
75 
76 int		ukfs_link(struct ukfs *, const char *, const char *);
77 int		ukfs_rename(struct ukfs *, const char *, const char *);
78 
79 int		ukfs_chdir(struct ukfs *, const char *);
80 
81 int		ukfs_stat(struct ukfs *, const char *, struct stat *);
82 int		ukfs_lstat(struct ukfs *, const char *, struct stat *);
83 
84 int		ukfs_chmod(struct ukfs *, const char *, mode_t);
85 int		ukfs_lchmod(struct ukfs *, const char *, mode_t);
86 int		ukfs_chown(struct ukfs *, const char *, uid_t, gid_t);
87 int		ukfs_lchown(struct ukfs *, const char *, uid_t, gid_t);
88 int		ukfs_chflags(struct ukfs *, const char *, u_long);
89 int		ukfs_lchflags(struct ukfs *, const char *, u_long);
90 
91 int		ukfs_utimes(struct ukfs *, const char *,
92 			    const struct timeval *);
93 int		ukfs_lutimes(struct ukfs *, const char *,
94 			     const struct timeval *);
95 
96 struct mount	*ukfs_getmp(struct ukfs *);
97 struct vnode	*ukfs_getrvp(struct ukfs *);
98 
99 /* dynamic loading of library modules */
100 int		ukfs_modload(const char *);
101 int		ukfs_modload_dir(const char *);
102 ssize_t		ukfs_vfstypes(char *, size_t);
103 
104 /* Utilities */
105 int		ukfs_util_builddirs(struct ukfs *, const char *, mode_t);
106 
107 __END_DECLS
108 
109 #endif /* _RUMP_UKFS_H_ */
110