ukfs.h revision 1.11 1 /* $NetBSD: ukfs.h,v 1.11 2009/10/07 20:51:00 pooka 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
46 #define UKFS_DEFAULTMP "/ukfs"
47
48 #define UKFS_RELFLAG_NOUNMOUNT 0x01
49 #define UKFS_RELFLAG_FORCE 0x02
50
51 #define UKFS_VERSION 002 /* secret ukfs 002 */
52 #define ukfs_init() _ukfs_init(UKFS_VERSION)
53
54 __BEGIN_DECLS
55
56 int _ukfs_init(int);
57 struct ukfs *ukfs_mount(const char *, const char *, const char *,
58 int, void *, size_t);
59 struct ukfs *ukfs_mount_disk(const char *, const char *, int,
60 const char *, int, void *, size_t);
61 int ukfs_release(struct ukfs *, int);
62
63 int ukfs_opendir(struct ukfs *, const char *,
64 struct ukfs_dircookie **);
65 int ukfs_getdents(struct ukfs *, const char *, off_t *,
66 uint8_t *, size_t);
67 int ukfs_getdents_cookie(struct ukfs *, struct ukfs_dircookie *,
68 off_t *, uint8_t *, size_t);
69 int ukfs_closedir(struct ukfs *, struct ukfs_dircookie *);
70
71 int ukfs_open(struct ukfs *, const char *, int);
72 ssize_t ukfs_read(struct ukfs *, const char *, off_t,
73 uint8_t *, size_t);
74 ssize_t ukfs_read_fd(struct ukfs *, int, off_t, uint8_t *, size_t);
75 ssize_t ukfs_write(struct ukfs *, const char *, off_t,
76 uint8_t *, size_t);
77 ssize_t ukfs_write_fd(struct ukfs *, int, off_t, uint8_t *, size_t,int);
78 int ukfs_close(struct ukfs *, int);
79
80 ssize_t ukfs_readlink(struct ukfs *, const char *, char *, size_t);
81
82 int ukfs_create(struct ukfs *, const char *, mode_t);
83 int ukfs_mkdir(struct ukfs *, const char *, mode_t);
84 int ukfs_mknod(struct ukfs *, const char *, mode_t, dev_t);
85 int ukfs_mkfifo(struct ukfs *, const char *, mode_t);
86 int ukfs_symlink(struct ukfs *, const char *, const char *);
87
88 int ukfs_remove(struct ukfs *, const char *);
89 int ukfs_rmdir(struct ukfs *, const char *);
90
91 int ukfs_link(struct ukfs *, const char *, const char *);
92 int ukfs_rename(struct ukfs *, const char *, const char *);
93
94 int ukfs_chdir(struct ukfs *, const char *);
95
96 int ukfs_stat(struct ukfs *, const char *, struct stat *);
97 int ukfs_lstat(struct ukfs *, const char *, struct stat *);
98
99 int ukfs_chmod(struct ukfs *, const char *, mode_t);
100 int ukfs_lchmod(struct ukfs *, const char *, mode_t);
101 int ukfs_chown(struct ukfs *, const char *, uid_t, gid_t);
102 int ukfs_lchown(struct ukfs *, const char *, uid_t, gid_t);
103 int ukfs_chflags(struct ukfs *, const char *, u_long);
104 int ukfs_lchflags(struct ukfs *, const char *, u_long);
105
106 int ukfs_utimes(struct ukfs *, const char *,
107 const struct timeval *);
108 int ukfs_lutimes(struct ukfs *, const char *,
109 const struct timeval *);
110
111 struct mount *ukfs_getmp(struct ukfs *);
112 struct vnode *ukfs_getrvp(struct ukfs *);
113 void ukfs_setspecific(struct ukfs *, void *);
114 void * ukfs_getspecific(struct ukfs *);
115
116 /* partition magic in device names */
117 #define UKFS_PARTITION_SCANMAGIC "%PART:"
118 #define UKFS_PARTITION_MAGICLEN (sizeof(UKFS_PARTITION_SCANMAGIC "a%")-1)
119 #define UKFS_PARTITION_MAXPATHLEN (MAXPATHLEN+UKFS_PARTITION_MAGICLEN)
120 #define UKFS_PARTITION_NONE (-1)
121 #define UKFS_PARTITION_NA (-2)
122 #define UKFS_USEPARTITION(a) \
123 ((a) != UKFS_PARTITION_NONE && (a) != UKFS_PARTITION_NA)
124 #define UKFS_PARTITION_ARGVPROBE(part) \
125 do { \
126 if (argc >= 3) \
127 ukfs_partition_probe(argv[argc-2], &part); \
128 } while (/*CONSTCOND*/0)
129
130 int ukfs_partition_probe(char *, int *);
131
132 /* dynamic loading of library modules */
133 int ukfs_modload(const char *);
134 int ukfs_modload_dir(const char *);
135 ssize_t ukfs_vfstypes(char *, size_t);
136
137 /* Utilities */
138 int ukfs_util_builddirs(struct ukfs *, const char *, mode_t);
139
140 __END_DECLS
141
142 #endif /* _RUMP_UKFS_H_ */
143