xref: /netbsd-src/lib/libukfs/ukfs.h (revision 388550b026d49b7f7b7480b1113bf82bb8d6a480)
1 /*	$NetBSD: ukfs.h,v 1.15 2022/04/19 20:32:17 rillig Exp $	*/
2 
3 /*
4  * Copyright (c) 2007, 2008, 2009  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 struct ukfs_dircookie;
45 struct ukfs_part;
46 
47 #define UKFS_DEFAULTMP "/ukfs"
48 
49 #define UKFS_RELFLAG_NOUNMOUNT	0x01
50 #define UKFS_RELFLAG_FORCE	0x02
51 
52 #define UKFS_VERSION	002 /* secret ukfs 002 */
53 #define	ukfs_init()	_ukfs_init(UKFS_VERSION)
54 
55 __BEGIN_DECLS
56 
57 int		_ukfs_init(int);
58 struct ukfs	*ukfs_mount(const char *, const char *, const char *,
59 			    int, void *, size_t);
60 struct ukfs	*ukfs_mount_disk(const char *, const char *, struct ukfs_part *,
61 				 const char *, int, void *, size_t);
62 int		ukfs_release(struct ukfs *, int);
63 
64 int		ukfs_opendir(struct ukfs *, const char *,
65 			     struct ukfs_dircookie **);
66 int		ukfs_getdents(struct ukfs *, const char *, off_t *,
67 			      uint8_t *, size_t);
68 int		ukfs_getdents_cookie(struct ukfs *, struct ukfs_dircookie *,
69 				     off_t *, uint8_t *, size_t);
70 int		ukfs_closedir(struct ukfs *, struct ukfs_dircookie *);
71 
72 int		ukfs_open(struct ukfs *, const char *, int);
73 ssize_t		ukfs_read(struct ukfs *, const char *, off_t,
74 			      uint8_t *, size_t);
75 ssize_t		ukfs_read_fd(struct ukfs *, int, off_t, uint8_t *, size_t);
76 ssize_t		ukfs_write(struct ukfs *, const char *, off_t,
77 			       uint8_t *, size_t);
78 ssize_t		ukfs_write_fd(struct ukfs *, int, off_t, uint8_t *, size_t,int);
79 int		ukfs_close(struct ukfs *, int);
80 
81 ssize_t		ukfs_readlink(struct ukfs *, const char *, char *, size_t);
82 
83 int		ukfs_create(struct ukfs *, const char *, mode_t);
84 int		ukfs_mkdir(struct ukfs *, const char *, mode_t);
85 int		ukfs_mknod(struct ukfs *, const char *, mode_t, dev_t);
86 int		ukfs_mkfifo(struct ukfs *, const char *, mode_t);
87 int		ukfs_symlink(struct ukfs *, const char *, const char *);
88 
89 int		ukfs_remove(struct ukfs *, const char *);
90 int		ukfs_rmdir(struct ukfs *, const char *);
91 
92 int		ukfs_link(struct ukfs *, const char *, const char *);
93 int		ukfs_rename(struct ukfs *, const char *, const char *);
94 
95 int		ukfs_chdir(struct ukfs *, const char *);
96 
97 int		ukfs_stat(struct ukfs *, const char *, struct stat *);
98 int		ukfs_lstat(struct ukfs *, const char *, struct stat *);
99 
100 int		ukfs_chmod(struct ukfs *, const char *, mode_t);
101 int		ukfs_lchmod(struct ukfs *, const char *, mode_t);
102 int		ukfs_chown(struct ukfs *, const char *, uid_t, gid_t);
103 int		ukfs_lchown(struct ukfs *, const char *, uid_t, gid_t);
104 int		ukfs_chflags(struct ukfs *, const char *, u_long);
105 int		ukfs_lchflags(struct ukfs *, const char *, u_long);
106 
107 int		ukfs_utimes(struct ukfs *, const char *,
108 			    const struct timeval *);
109 int		ukfs_lutimes(struct ukfs *, const char *,
110 			     const struct timeval *);
111 
112 struct mount	*ukfs_getmp(struct ukfs *);
113 struct vnode	*ukfs_getrvp(struct ukfs *);
114 void		ukfs_setspecific(struct ukfs *, void *);
115 void *		ukfs_getspecific(struct ukfs *);
116 
117 /* partition magic in device names */
118 extern struct ukfs_part *ukfs_part_none;
119 extern struct ukfs_part *ukfs_part_na;
120 #define UKFS_PARTITION_SCANMAGIC "%PART:" /* deprecated */
121 
122 #define UKFS_DISKLABEL_SCANMAGIC "%DISKLABEL:"
123 #define UKFS_DISKLABEL_MAGICLEN (sizeof(UKFS_DISKLABEL_SCANMAGIC "a%")-1)
124 
125 #define UKFS_OFFSET_SCANMAGIC "%OFFSET:"
126 #define UKFS_OFFSET_MINLEN (sizeof(UKFS_OFFSET_SCANMAGIC "512,512%")-1)
127 
128 #define UKFS_DEVICE_MAXSTR 128 /* unexact science ... */
129 #define UKFS_DEVICE_MAXPATHLEN (MAXPATHLEN+UKFS_DEVICE_MAXSTR)
130 
131 #define UKFS_DEVICE_ARGVPROBE(part)					\
132 do {									\
133 	if (argc < 3)							\
134 		*part = NULL;						\
135 	else if (ukfs_part_probe(argv[argc-2], part) == -1)		\
136 			err(1, "ukfs_part_probe");			\
137 } while (0)
138 
139 int		ukfs_part_probe(char *, struct ukfs_part **);
140 void		ukfs_part_release(struct ukfs_part *);
141 int		ukfs_part_tostring(struct ukfs_part *, char *, size_t);
142 
143 /* dynamic loading of library modules */
144 int		ukfs_modload(const char *);
145 int		ukfs_modload_dir(const char *);
146 ssize_t		ukfs_vfstypes(char *, size_t);
147 
148 /* Utilities */
149 int		ukfs_util_builddirs(struct ukfs *, const char *, mode_t);
150 
151 __END_DECLS
152 
153 #endif /* _RUMP_UKFS_H_ */
154