ukfs.h revision 1.10 
1/*	$NetBSD: ukfs.h,v 1.10 2009/10/02 09:32:01 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 */
39struct vnode;
40struct stat;
41struct timeval;
42
43struct ukfs;
44struct 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
56int		_ukfs_init(int);
57struct ukfs	*ukfs_mount(const char *, const char *, const char *,
58			  int, void *, size_t);
59int		ukfs_release(struct ukfs *, int);
60
61int		ukfs_opendir(struct ukfs *, const char *,
62			     struct ukfs_dircookie **);
63int		ukfs_getdents(struct ukfs *, const char *, off_t *,
64			      uint8_t *, size_t);
65int		ukfs_getdents_cookie(struct ukfs *, struct ukfs_dircookie *,
66				     off_t *, uint8_t *, size_t);
67int		ukfs_closedir(struct ukfs *, struct ukfs_dircookie *);
68
69int		ukfs_open(struct ukfs *, const char *, int);
70ssize_t		ukfs_read(struct ukfs *, const char *, off_t,
71			      uint8_t *, size_t);
72ssize_t		ukfs_read_fd(struct ukfs *, int, off_t, uint8_t *, size_t);
73ssize_t		ukfs_write(struct ukfs *, const char *, off_t,
74			       uint8_t *, size_t);
75ssize_t		ukfs_write_fd(struct ukfs *, int, off_t, uint8_t *, size_t,int);
76int		ukfs_close(struct ukfs *, int);
77
78ssize_t		ukfs_readlink(struct ukfs *, const char *, char *, size_t);
79
80int		ukfs_create(struct ukfs *, const char *, mode_t);
81int		ukfs_mkdir(struct ukfs *, const char *, mode_t);
82int		ukfs_mknod(struct ukfs *, const char *, mode_t, dev_t);
83int		ukfs_mkfifo(struct ukfs *, const char *, mode_t);
84int		ukfs_symlink(struct ukfs *, const char *, const char *);
85
86int		ukfs_remove(struct ukfs *, const char *);
87int		ukfs_rmdir(struct ukfs *, const char *);
88
89int		ukfs_link(struct ukfs *, const char *, const char *);
90int		ukfs_rename(struct ukfs *, const char *, const char *);
91
92int		ukfs_chdir(struct ukfs *, const char *);
93
94int		ukfs_stat(struct ukfs *, const char *, struct stat *);
95int		ukfs_lstat(struct ukfs *, const char *, struct stat *);
96
97int		ukfs_chmod(struct ukfs *, const char *, mode_t);
98int		ukfs_lchmod(struct ukfs *, const char *, mode_t);
99int		ukfs_chown(struct ukfs *, const char *, uid_t, gid_t);
100int		ukfs_lchown(struct ukfs *, const char *, uid_t, gid_t);
101int		ukfs_chflags(struct ukfs *, const char *, u_long);
102int		ukfs_lchflags(struct ukfs *, const char *, u_long);
103
104int		ukfs_utimes(struct ukfs *, const char *,
105			    const struct timeval *);
106int		ukfs_lutimes(struct ukfs *, const char *,
107			     const struct timeval *);
108
109struct mount	*ukfs_getmp(struct ukfs *);
110struct vnode	*ukfs_getrvp(struct ukfs *);
111void		ukfs_setspecific(struct ukfs *, void *);
112void *		ukfs_getspecific(struct ukfs *);
113
114/* dynamic loading of library modules */
115int		ukfs_modload(const char *);
116int		ukfs_modload_dir(const char *);
117ssize_t		ukfs_vfstypes(char *, size_t);
118
119/* Utilities */
120int		ukfs_util_builddirs(struct ukfs *, const char *, mode_t);
121
122__END_DECLS
123
124#endif /* _RUMP_UKFS_H_ */
125