ukfs.h revision 1.12
1/* $NetBSD: ukfs.h,v 1.12 2009/11/05 14:22:54 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 */ 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); 59struct ukfs *ukfs_mount_disk(const char *, const char *, int, 60 const char *, int, void *, size_t); 61int ukfs_release(struct ukfs *, int); 62 63int ukfs_opendir(struct ukfs *, const char *, 64 struct ukfs_dircookie **); 65int ukfs_getdents(struct ukfs *, const char *, off_t *, 66 uint8_t *, size_t); 67int ukfs_getdents_cookie(struct ukfs *, struct ukfs_dircookie *, 68 off_t *, uint8_t *, size_t); 69int ukfs_closedir(struct ukfs *, struct ukfs_dircookie *); 70 71int ukfs_open(struct ukfs *, const char *, int); 72ssize_t ukfs_read(struct ukfs *, const char *, off_t, 73 uint8_t *, size_t); 74ssize_t ukfs_read_fd(struct ukfs *, int, off_t, uint8_t *, size_t); 75ssize_t ukfs_write(struct ukfs *, const char *, off_t, 76 uint8_t *, size_t); 77ssize_t ukfs_write_fd(struct ukfs *, int, off_t, uint8_t *, size_t,int); 78int ukfs_close(struct ukfs *, int); 79 80ssize_t ukfs_readlink(struct ukfs *, const char *, char *, size_t); 81 82int ukfs_create(struct ukfs *, const char *, mode_t); 83int ukfs_mkdir(struct ukfs *, const char *, mode_t); 84int ukfs_mknod(struct ukfs *, const char *, mode_t, dev_t); 85int ukfs_mkfifo(struct ukfs *, const char *, mode_t); 86int ukfs_symlink(struct ukfs *, const char *, const char *); 87 88int ukfs_remove(struct ukfs *, const char *); 89int ukfs_rmdir(struct ukfs *, const char *); 90 91int ukfs_link(struct ukfs *, const char *, const char *); 92int ukfs_rename(struct ukfs *, const char *, const char *); 93 94int ukfs_chdir(struct ukfs *, const char *); 95 96int ukfs_stat(struct ukfs *, const char *, struct stat *); 97int ukfs_lstat(struct ukfs *, const char *, struct stat *); 98 99int ukfs_chmod(struct ukfs *, const char *, mode_t); 100int ukfs_lchmod(struct ukfs *, const char *, mode_t); 101int ukfs_chown(struct ukfs *, const char *, uid_t, gid_t); 102int ukfs_lchown(struct ukfs *, const char *, uid_t, gid_t); 103int ukfs_chflags(struct ukfs *, const char *, u_long); 104int ukfs_lchflags(struct ukfs *, const char *, u_long); 105 106int ukfs_utimes(struct ukfs *, const char *, 107 const struct timeval *); 108int ukfs_lutimes(struct ukfs *, const char *, 109 const struct timeval *); 110 111struct mount *ukfs_getmp(struct ukfs *); 112struct vnode *ukfs_getrvp(struct ukfs *); 113void ukfs_setspecific(struct ukfs *, void *); 114void * 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) \ 125do { \ 126 part = UKFS_PARTITION_NONE; \ 127 if (argc >= 3) \ 128 ukfs_partition_probe(argv[argc-2], &part); \ 129} while (/*CONSTCOND*/0) 130 131int ukfs_partition_probe(char *, int *); 132 133/* dynamic loading of library modules */ 134int ukfs_modload(const char *); 135int ukfs_modload_dir(const char *); 136ssize_t ukfs_vfstypes(char *, size_t); 137 138/* Utilities */ 139int ukfs_util_builddirs(struct ukfs *, const char *, mode_t); 140 141__END_DECLS 142 143#endif /* _RUMP_UKFS_H_ */ 144