Home | History | Annotate | Line # | Download | only in libperfuse
perfuse_priv.h revision 1.14
      1 /*  $NetBSD: perfuse_priv.h,v 1.14 2010/10/03 05:46:47 manu Exp $ */
      2 
      3 /*-
      4  *  Copyright (c) 2010 Emmanuel Dreyfus. All rights reserved.
      5  *
      6  *  Redistribution and use in source and binary forms, with or without
      7  *  modification, are permitted provided that the following conditions
      8  *  are met:
      9  *  1. Redistributions of source code must retain the above copyright
     10  *     notice, this list of conditions and the following disclaimer.
     11  *  2. Redistributions in binary form must reproduce the above copyright
     12  *     notice, this list of conditions and the following disclaimer in the
     13  *     documentation and/or other materials provided with the distribution.
     14  *
     15  *  THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     16  *  ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     17  *  TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     18  *  PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     19  *  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     20  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     21  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     22  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     23  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     24  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     25  *  POSSIBILITY OF SUCH DAMAGE.
     26  */
     27 
     28 #ifndef _PERFUSE_PRIV_H_
     29 #define _PERFUSE_PRIV_H_
     30 
     31 #include <syslog.h>
     32 #include <paths.h>
     33 #include <err.h>
     34 #include <sysexits.h>
     35 #include <puffs.h>
     36 
     37 #include "perfuse_if.h"
     38 #include "fuse.h"
     39 
     40 struct perfuse_state {
     41 	void *ps_private;	/* Private field for libperfuse user */
     42 	struct puffs_usermount *ps_pu;
     43 	struct puffs_node *ps_root;
     44 	uid_t ps_owner_uid;
     45 	int ps_flags;
     46 #define PS_NO_ACCESS	0x0001	/* access is unimplemented; */
     47 #define PS_NO_CREAT	0x0004	/* create is unimplemented */
     48 #define PS_INLOOP	0x0008	/* puffs mainloop started */
     49 	long ps_fsid;
     50 	uint32_t ps_max_readahead;
     51 	uint32_t ps_max_write;
     52 	uint64_t ps_syncreads;
     53 	uint64_t ps_syncwrites;
     54 	uint64_t ps_asyncreads;
     55 	uint64_t ps_asyncwrites;
     56 	char *ps_source;
     57 	char *ps_target;
     58 	char *ps_filesystemtype;
     59 	int ps_mountflags;
     60 	uint64_t ps_unique;
     61 	perfuse_new_msg_fn ps_new_msg;
     62 	perfuse_xchg_msg_fn ps_xchg_msg;
     63 	perfuse_destroy_msg_fn ps_destroy_msg;
     64 	perfuse_get_inhdr_fn ps_get_inhdr;
     65 	perfuse_get_inpayload_fn ps_get_inpayload;
     66 	perfuse_get_outhdr_fn ps_get_outhdr;
     67 	perfuse_get_outpayload_fn ps_get_outpayload;
     68 };
     69 
     70 
     71 enum perfuse_qtype {
     72 	PCQ_READDIR,
     73 	PCQ_READ,
     74 	PCQ_WRITE,
     75 	PCQ_AFTERWRITE,
     76 	PCQ_OPEN,
     77 	PCQ_AFTERXCHG
     78 };
     79 
     80 #ifdef PERFUSE_DEBUG
     81 extern const char *perfuse_qtypestr[];
     82 #endif
     83 
     84 struct perfuse_cc_queue {
     85 	enum perfuse_qtype pcq_type;
     86 	struct puffs_cc *pcq_cc;
     87 	TAILQ_ENTRY(perfuse_cc_queue) pcq_next;
     88 };
     89 
     90 struct perfuse_node_data {
     91 	uint64_t pnd_rfh;
     92 	uint64_t pnd_wfh;
     93 	uint64_t pnd_ino;			/* inode */
     94 	uint64_t pnd_nlookup;			/* vnode refcount */
     95 	uint64_t pnd_size;			/* file size */
     96 	uint64_t pnd_lock_owner;
     97 	struct dirent *pnd_dirent;		/* native buffer for readdir */
     98 	off_t pnd_dirent_len;
     99 	struct fuse_dirent *pnd_all_fd;		/* FUSE buffer for readdir */
    100 	size_t pnd_all_fd_len;
    101 	TAILQ_HEAD(,perfuse_cc_queue) pnd_pcq;	/* queued requests */
    102 	int pnd_flags;
    103 #define PND_RECLAIMED		0x001	/* reclaim pending */
    104 #define PND_INREADDIR		0x002	/* readdir in progress */
    105 #define PND_DIRTY		0x004	/* There is some data to sync */
    106 #define PND_RFH			0x008	/* Read FH allocated */
    107 #define PND_WFH			0x010	/* Write FH allocated */
    108 #define PND_REMOVED		0x020	/* Node was removed */
    109 #define PND_INWRITE		0x040	/* write in progress */
    110 #define PND_INOPEN		0x100	/* open in progress */
    111 #define PND_GOTSIZE		0x200	/* pnd_size was set */
    112 #define PND_INXCHG		0x400	/* FUSE exchange in progress */
    113 
    114 #define PND_OPEN		(PND_RFH|PND_WFH)	/* File is open */
    115 #define PND_BUSY		(PND_INREADDIR|PND_INWRITE|PND_INOPEN)
    116 	puffs_cookie_t pnd_parent;
    117 	int pnd_childcount;
    118 	time_t pnd_timestamp;
    119 	TAILQ_ENTRY(perfuse_node_data) pnd_next;
    120 	puffs_cookie_t pnd_pn;
    121 	char pnd_name[MAXPATHLEN];	/* node name */
    122 	TAILQ_HEAD(,perfuse_node_data) pnd_children;
    123 };
    124 
    125 #define PERFUSE_NODE_DATA(opc)	\
    126 	((struct perfuse_node_data *)puffs_pn_getpriv((struct puffs_node *)opc))
    127 
    128 
    129 #define UNSPEC_REPLY_LEN PERFUSE_UNSPEC_REPLY_LEN /* shorter! */
    130 #define NO_PAYLOAD_REPLY_LEN 0
    131 
    132 #define GET_INHDR(ps, pm) ps->ps_get_inhdr(pm)
    133 #define GET_INPAYLOAD(ps, pm, type) \
    134 	(struct type *)(void *)ps->ps_get_inpayload(pm)
    135 #define _GET_INPAYLOAD(ps, pm, type) (type)ps->ps_get_inpayload(pm)
    136 #define GET_OUTHDR(ps, pm) ps->ps_get_outhdr(pm)
    137 #define GET_OUTPAYLOAD(ps, pm, type) \
    138 	(struct type *)(void *)ps->ps_get_outpayload(pm)
    139 #define _GET_OUTPAYLOAD(ps, pm, type) (type)ps->ps_get_outpayload(pm)
    140 
    141 __BEGIN_DECLS
    142 
    143 struct puffs_node *perfuse_new_pn(struct puffs_usermount *, const char *,
    144     struct puffs_node *);
    145 void perfuse_destroy_pn(struct puffs_usermount *, struct puffs_node *);
    146 void perfuse_new_fh(puffs_cookie_t, uint64_t, int);
    147 void perfuse_destroy_fh(puffs_cookie_t, uint64_t);
    148 uint64_t perfuse_get_fh(puffs_cookie_t, int);
    149 uint64_t perfuse_next_unique(struct puffs_usermount *);
    150 char *perfuse_node_path(puffs_cookie_t);
    151 int perfuse_node_close_common(struct puffs_usermount *, puffs_cookie_t, int);
    152 
    153 char *perfuse_fs_mount(int, ssize_t);
    154 
    155 
    156 /*
    157  * opc.c - filesystem operations
    158  */
    159 int perfuse_fs_unmount(struct puffs_usermount *, int);
    160 int perfuse_fs_statvfs(struct puffs_usermount *, struct statvfs *);
    161 int perfuse_fs_sync(struct puffs_usermount *, int,
    162     const struct puffs_cred *);
    163 int perfuse_fs_fhtonode(struct puffs_usermount *, void *, size_t,
    164     struct puffs_newinfo *);
    165 int perfuse_fs_nodetofh(struct puffs_usermount *, puffs_cookie_t,
    166     void *, size_t *);
    167 void perfuse_fs_suspend(struct puffs_usermount *, int);
    168 int perfuse_node_lookup(struct puffs_usermount *,
    169     puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *);
    170 int perfuse_node_create(struct puffs_usermount *,
    171     puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *,
    172     const struct vattr *);
    173 int perfuse_node_mknod(struct puffs_usermount *,
    174     puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *,
    175     const struct vattr *);
    176 int perfuse_node_open(struct puffs_usermount *,
    177     puffs_cookie_t, int, const struct puffs_cred *);
    178 int perfuse_node_close(struct puffs_usermount *,
    179     puffs_cookie_t, int, const struct puffs_cred *);
    180 int perfuse_node_access(struct puffs_usermount *,
    181     puffs_cookie_t, int, const struct puffs_cred *);
    182 int perfuse_node_getattr(struct puffs_usermount *,
    183     puffs_cookie_t, struct vattr *, const struct puffs_cred *);
    184 int perfuse_node_setattr(struct puffs_usermount *,
    185     puffs_cookie_t, const struct vattr *, const struct puffs_cred *);
    186 int perfuse_node_poll(struct puffs_usermount *, puffs_cookie_t, int *);
    187 int perfuse_node_mmap(struct puffs_usermount *,
    188     puffs_cookie_t, vm_prot_t, const struct puffs_cred *);
    189 int perfuse_node_fsync(struct puffs_usermount *,
    190     puffs_cookie_t, const struct puffs_cred *, int, off_t, off_t);
    191 int perfuse_node_seek(struct puffs_usermount *,
    192     puffs_cookie_t, off_t, off_t, const struct puffs_cred *);
    193 int perfuse_node_remove(struct puffs_usermount *,
    194     puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *);
    195 int perfuse_node_link(struct puffs_usermount *,
    196     puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *);
    197 int perfuse_node_rename(struct puffs_usermount *,
    198     puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *,
    199     puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *);
    200 int perfuse_node_mkdir(struct puffs_usermount *,
    201     puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *,
    202     const struct vattr *);
    203 int perfuse_node_rmdir(struct puffs_usermount *,
    204     puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *);
    205 int perfuse_node_symlink(struct puffs_usermount *,
    206     puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *,
    207     const struct vattr *, const char *);
    208 int perfuse_node_readdir(struct puffs_usermount *,
    209     puffs_cookie_t, struct dirent *, off_t *, size_t *,
    210     const struct puffs_cred *, int *, off_t *, size_t *);
    211 int perfuse_node_readlink(struct puffs_usermount *,
    212     puffs_cookie_t, const struct puffs_cred *, char *, size_t *);
    213 int perfuse_node_reclaim(struct puffs_usermount *, puffs_cookie_t);
    214 int perfuse_node_inactive(struct puffs_usermount *, puffs_cookie_t);
    215 int perfuse_node_print(struct puffs_usermount *, puffs_cookie_t);
    216 int perfuse_node_pathconf(struct puffs_usermount *,
    217     puffs_cookie_t, int, int *);
    218 int perfuse_node_advlock(struct puffs_usermount *,
    219     puffs_cookie_t, void *, int, struct flock *, int);
    220 int perfuse_node_read(struct puffs_usermount *, puffs_cookie_t,
    221     uint8_t *, off_t, size_t *, const struct puffs_cred *, int);
    222 int perfuse_node_write(struct puffs_usermount *, puffs_cookie_t,
    223     uint8_t *, off_t, size_t *, const struct puffs_cred *, int);
    224 void perfuse_cache_write(struct puffs_usermount *,
    225     puffs_cookie_t, size_t, struct puffs_cacherun *);
    226 
    227 __END_DECLS
    228 
    229 #endif /* _PERFUSE_PRIV_H_ */
    230