Home | History | Annotate | Line # | Download | only in libukfs
ukfs.h revision 1.8 
      1 /*	$NetBSD: ukfs.h,v 1.8 2009/04/26 22:23: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 */
     39 struct vnode;
     40 struct stat;
     41 struct timeval;
     42 
     43 struct ukfs;
     44 struct ukfs_dircookie;
     45 
     46 #define UKFS_DEFAULTMP "/"
     47 
     48 #define UKFS_RELFLAG_NOUNMOUNT	0x01
     49 
     50 #define UKFS_VERSION	001 /* sector 001 */
     51 #define	ukfs_init()	_ukfs_init(UKFS_VERSION)
     52 
     53 __BEGIN_DECLS
     54 
     55 int		_ukfs_init(int);
     56 struct ukfs	*ukfs_mount(const char *, const char *, const char *,
     57 			  int, void *, size_t);
     58 void		ukfs_release(struct ukfs *, int);
     59 
     60 int		ukfs_opendir(struct ukfs *, const char *,
     61 			     struct ukfs_dircookie **);
     62 int		ukfs_getdents(struct ukfs *, const char *, off_t *,
     63 			      uint8_t *, size_t);
     64 int		ukfs_getdents_cookie(struct ukfs *, struct ukfs_dircookie *,
     65 				     off_t *, uint8_t *, size_t);
     66 int		ukfs_closedir(struct ukfs *, struct ukfs_dircookie *);
     67 
     68 int		ukfs_open(struct ukfs *, const char *, int);
     69 ssize_t		ukfs_read(struct ukfs *, const char *, off_t,
     70 			      uint8_t *, size_t);
     71 ssize_t		ukfs_read_fd(struct ukfs *, int, off_t, uint8_t *, size_t);
     72 ssize_t		ukfs_write(struct ukfs *, const char *, off_t,
     73 			       uint8_t *, size_t);
     74 ssize_t		ukfs_write_fd(struct ukfs *, int, off_t, uint8_t *, size_t,int);
     75 int		ukfs_close(struct ukfs *, int);
     76 
     77 ssize_t		ukfs_readlink(struct ukfs *, const char *, char *, size_t);
     78 
     79 int		ukfs_create(struct ukfs *, const char *, mode_t);
     80 int		ukfs_mkdir(struct ukfs *, const char *, mode_t);
     81 int		ukfs_mknod(struct ukfs *, const char *, mode_t, dev_t);
     82 int		ukfs_mkfifo(struct ukfs *, const char *, mode_t);
     83 int		ukfs_symlink(struct ukfs *, const char *, const char *);
     84 
     85 int		ukfs_remove(struct ukfs *, const char *);
     86 int		ukfs_rmdir(struct ukfs *, const char *);
     87 
     88 int		ukfs_link(struct ukfs *, const char *, const char *);
     89 int		ukfs_rename(struct ukfs *, const char *, const char *);
     90 
     91 int		ukfs_chdir(struct ukfs *, const char *);
     92 
     93 int		ukfs_stat(struct ukfs *, const char *, struct stat *);
     94 int		ukfs_lstat(struct ukfs *, const char *, struct stat *);
     95 
     96 int		ukfs_chmod(struct ukfs *, const char *, mode_t);
     97 int		ukfs_lchmod(struct ukfs *, const char *, mode_t);
     98 int		ukfs_chown(struct ukfs *, const char *, uid_t, gid_t);
     99 int		ukfs_lchown(struct ukfs *, const char *, uid_t, gid_t);
    100 int		ukfs_chflags(struct ukfs *, const char *, u_long);
    101 int		ukfs_lchflags(struct ukfs *, const char *, u_long);
    102 
    103 int		ukfs_utimes(struct ukfs *, const char *,
    104 			    const struct timeval *);
    105 int		ukfs_lutimes(struct ukfs *, const char *,
    106 			     const struct timeval *);
    107 
    108 struct mount	*ukfs_getmp(struct ukfs *);
    109 struct vnode	*ukfs_getrvp(struct ukfs *);
    110 
    111 /* dynamic loading of library modules */
    112 int		ukfs_modload(const char *);
    113 int		ukfs_modload_dir(const char *);
    114 ssize_t		ukfs_vfstypes(char *, size_t);
    115 
    116 /* Utilities */
    117 int		ukfs_util_builddirs(struct ukfs *, const char *, mode_t);
    118 
    119 __END_DECLS
    120 
    121 #endif /* _RUMP_UKFS_H_ */
    122