1 /* $NetBSD: perfuse_priv.h,v 1.26 2012/03/08 14:58:57 manu Exp $ */ 2 3 /*- 4 * Copyright (c) 2010-2011 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 #define PERFUSE_TRACECOUNT_MAX 4096 41 #define PERFUSE_TRACEPATH_MAX 256 42 struct perfuse_trace { 43 int pt_opcode; 44 char pt_path[PERFUSE_TRACEPATH_MAX]; 45 char pt_extra[BUFSIZ]; 46 int pt_error; 47 enum { inxchg, done } pt_status; 48 struct timespec pt_start; 49 struct timespec pt_end; 50 TAILQ_ENTRY(perfuse_trace) pt_list; 51 }; 52 53 struct perfuse_state { 54 void *ps_private; /* Private field for libperfuse user */ 55 struct puffs_usermount *ps_pu; 56 struct puffs_node *ps_root; 57 uid_t ps_owner_uid; 58 int ps_flags; 59 #define PS_NO_ACCESS 0x0001 /* access is unimplemented; */ 60 #define PS_NO_CREAT 0x0004 /* create is unimplemented */ 61 #define PS_INLOOP 0x0008 /* puffs mainloop started */ 62 uint64_t ps_fsid; 63 uint32_t ps_max_readahead; 64 uint32_t ps_max_write; 65 uint64_t ps_syncreads; 66 uint64_t ps_syncwrites; 67 uint64_t ps_asyncreads; 68 uint64_t ps_asyncwrites; 69 char *ps_source; 70 char *ps_target; 71 char *ps_filesystemtype; 72 int ps_mountflags; 73 uint64_t ps_unique; 74 perfuse_new_msg_fn ps_new_msg; 75 perfuse_xchg_msg_fn ps_xchg_msg; 76 perfuse_destroy_msg_fn ps_destroy_msg; 77 perfuse_get_inhdr_fn ps_get_inhdr; 78 perfuse_get_inpayload_fn ps_get_inpayload; 79 perfuse_get_outhdr_fn ps_get_outhdr; 80 perfuse_get_outpayload_fn ps_get_outpayload; 81 perfuse_umount_fn ps_umount; 82 TAILQ_HEAD(,perfuse_trace) ps_trace; 83 uint64_t ps_tracecount; 84 }; 85 86 87 enum perfuse_qtype { 88 PCQ_READDIR, 89 PCQ_READ, 90 PCQ_WRITE, 91 PCQ_AFTERWRITE, 92 PCQ_OPEN, 93 PCQ_AFTERXCHG, 94 PCQ_RESIZE 95 }; 96 97 #ifdef PERFUSE_DEBUG 98 extern const char *perfuse_qtypestr[]; 99 #endif 100 101 struct perfuse_cc_queue { 102 enum perfuse_qtype pcq_type; 103 struct puffs_cc *pcq_cc; 104 TAILQ_ENTRY(perfuse_cc_queue) pcq_next; 105 }; 106 107 struct perfuse_node_data { 108 uint64_t pnd_rfh; 109 uint64_t pnd_wfh; 110 uint64_t pnd_nodeid; /* nodeid, this is not inode */ 111 uint64_t pnd_fuse_nlookup; /* vnode refcount */ 112 int pnd_puffs_nlookup; /* vnode refcount */ 113 uint64_t pnd_lock_owner; 114 struct dirent *pnd_dirent; /* native buffer for readdir */ 115 off_t pnd_dirent_len; 116 struct fuse_dirent *pnd_all_fd; /* FUSE buffer for readdir */ 117 size_t pnd_all_fd_len; 118 uint64_t pnd_fd_cookie; /* opaque readdir ref from fs */ 119 TAILQ_HEAD(,perfuse_cc_queue) pnd_pcq; /* queued requests */ 120 int pnd_flags; 121 #define PND_RECLAIMED 0x001 /* reclaim pending */ 122 #define PND_INREADDIR 0x002 /* readdir in progress */ 123 #define PND_DIRTY 0x004 /* There is some data to sync */ 124 #define PND_RFH 0x008 /* Read FH allocated */ 125 #define PND_WFH 0x010 /* Write FH allocated */ 126 #define PND_REMOVED 0x020 /* Node was removed */ 127 #define PND_INWRITE 0x040 /* write in progress */ 128 #define PND_INOPEN 0x100 /* open in progress */ 129 #define PND_INXCHG 0x400 /* FUSE exchange in progress */ 130 #define PND_INRESIZE 0x800 /* resize in progress */ 131 132 #define PND_OPEN (PND_RFH|PND_WFH) /* File is open */ 133 #define PND_BUSY (PND_INREADDIR|PND_INWRITE|PND_INOPEN) 134 puffs_cookie_t pnd_parent; 135 int pnd_childcount; 136 TAILQ_ENTRY(perfuse_node_data) pnd_next; 137 puffs_cookie_t pnd_pn; 138 char pnd_name[MAXPATHLEN]; /* node name */ 139 TAILQ_HEAD(,perfuse_node_data) pnd_children; 140 struct timespec pnd_entry_expire; 141 struct timespec pnd_attr_expire; 142 }; 143 144 #define PERFUSE_NODE_DATA(opc) \ 145 ((struct perfuse_node_data *)puffs_pn_getpriv((struct puffs_node *)opc)) 146 147 148 #define UNSPEC_REPLY_LEN PERFUSE_UNSPEC_REPLY_LEN /* shorter! */ 149 #define NO_PAYLOAD_REPLY_LEN 0 150 151 #define GET_INHDR(ps, pm) ps->ps_get_inhdr(pm) 152 #define GET_INPAYLOAD(ps, pm, type) \ 153 (struct type *)(void *)ps->ps_get_inpayload(pm) 154 #define _GET_INPAYLOAD(ps, pm, type) (type)ps->ps_get_inpayload(pm) 155 #define GET_OUTHDR(ps, pm) ps->ps_get_outhdr(pm) 156 #define GET_OUTPAYLOAD(ps, pm, type) \ 157 (struct type *)(void *)ps->ps_get_outpayload(pm) 158 #define _GET_OUTPAYLOAD(ps, pm, type) (type)ps->ps_get_outpayload(pm) 159 160 __BEGIN_DECLS 161 162 struct puffs_node *perfuse_new_pn(struct puffs_usermount *, const char *, 163 struct puffs_node *); 164 void perfuse_destroy_pn(struct puffs_node *); 165 void perfuse_new_fh(puffs_cookie_t, uint64_t, int); 166 void perfuse_destroy_fh(puffs_cookie_t, uint64_t); 167 uint64_t perfuse_get_fh(puffs_cookie_t, int); 168 uint64_t perfuse_next_unique(struct puffs_usermount *); 169 char *perfuse_node_path(puffs_cookie_t); 170 int perfuse_node_close_common(struct puffs_usermount *, puffs_cookie_t, int); 171 const char *perfuse_native_ns(const int, const char *, char *); 172 173 char *perfuse_fs_mount(int, ssize_t); 174 175 176 /* 177 * ops.c - filesystem operations 178 */ 179 int perfuse_fs_unmount(struct puffs_usermount *, int); 180 int perfuse_fs_statvfs(struct puffs_usermount *, struct statvfs *); 181 int perfuse_fs_sync(struct puffs_usermount *, int, 182 const struct puffs_cred *); 183 int perfuse_fs_fhtonode(struct puffs_usermount *, void *, size_t, 184 struct puffs_newinfo *); 185 int perfuse_fs_nodetofh(struct puffs_usermount *, puffs_cookie_t, 186 void *, size_t *); 187 void perfuse_fs_suspend(struct puffs_usermount *, int); 188 int perfuse_node_lookup(struct puffs_usermount *, 189 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *); 190 int perfuse_node_create(struct puffs_usermount *, 191 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *, 192 const struct vattr *); 193 int perfuse_node_mknod(struct puffs_usermount *, 194 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *, 195 const struct vattr *); 196 int perfuse_node_open(struct puffs_usermount *, 197 puffs_cookie_t, int, const struct puffs_cred *); 198 int perfuse_node_close(struct puffs_usermount *, 199 puffs_cookie_t, int, const struct puffs_cred *); 200 int perfuse_node_access(struct puffs_usermount *, 201 puffs_cookie_t, int, const struct puffs_cred *); 202 int perfuse_node_getattr(struct puffs_usermount *, 203 puffs_cookie_t, struct vattr *, const struct puffs_cred *); 204 int perfuse_node_setattr(struct puffs_usermount *, 205 puffs_cookie_t, const struct vattr *, const struct puffs_cred *); 206 int perfuse_node_poll(struct puffs_usermount *, puffs_cookie_t, int *); 207 int perfuse_node_mmap(struct puffs_usermount *, 208 puffs_cookie_t, vm_prot_t, const struct puffs_cred *); 209 int perfuse_node_fsync(struct puffs_usermount *, 210 puffs_cookie_t, const struct puffs_cred *, int, off_t, off_t); 211 int perfuse_node_seek(struct puffs_usermount *, 212 puffs_cookie_t, off_t, off_t, const struct puffs_cred *); 213 int perfuse_node_remove(struct puffs_usermount *, 214 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *); 215 int perfuse_node_link(struct puffs_usermount *, 216 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *); 217 int perfuse_node_rename(struct puffs_usermount *, 218 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *, 219 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *); 220 int perfuse_node_mkdir(struct puffs_usermount *, 221 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *, 222 const struct vattr *); 223 int perfuse_node_rmdir(struct puffs_usermount *, 224 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *); 225 int perfuse_node_symlink(struct puffs_usermount *, 226 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *, 227 const struct vattr *, const char *); 228 int perfuse_node_readdir(struct puffs_usermount *, 229 puffs_cookie_t, struct dirent *, off_t *, size_t *, 230 const struct puffs_cred *, int *, off_t *, size_t *); 231 int perfuse_node_readlink(struct puffs_usermount *, 232 puffs_cookie_t, const struct puffs_cred *, char *, size_t *); 233 int perfuse_node_reclaim(struct puffs_usermount *, puffs_cookie_t); 234 int perfuse_node_inactive(struct puffs_usermount *, puffs_cookie_t); 235 int perfuse_node_print(struct puffs_usermount *, puffs_cookie_t); 236 int perfuse_node_pathconf(struct puffs_usermount *, 237 puffs_cookie_t, int, int *); 238 int perfuse_node_advlock(struct puffs_usermount *, 239 puffs_cookie_t, void *, int, struct flock *, int); 240 int perfuse_node_read(struct puffs_usermount *, puffs_cookie_t, 241 uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 242 int perfuse_node_write(struct puffs_usermount *, puffs_cookie_t, 243 uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 244 void perfuse_cache_write(struct puffs_usermount *, 245 puffs_cookie_t, size_t, struct puffs_cacherun *); 246 int perfuse_node_getextattr(struct puffs_usermount *, puffs_cookie_t, 247 int, const char *, size_t *, uint8_t *, size_t *, 248 const struct puffs_cred *); 249 int perfuse_node_setextattr(struct puffs_usermount *, puffs_cookie_t, 250 int, const char *, uint8_t *, size_t *, const struct puffs_cred *); 251 int perfuse_node_listextattr(struct puffs_usermount *, puffs_cookie_t, 252 int, size_t *, uint8_t *, size_t *, int, const struct puffs_cred *); 253 int perfuse_node_deleteextattr(struct puffs_usermount *, puffs_cookie_t, 254 int, const char *, const struct puffs_cred *); 255 256 struct perfuse_trace *perfuse_trace_begin(struct perfuse_state *, 257 puffs_cookie_t, perfuse_msg_t *); 258 void perfuse_trace_end(struct perfuse_state *, struct perfuse_trace *, int); 259 char *perfuse_opdump_in(struct perfuse_state *, perfuse_msg_t *); 260 261 __END_DECLS 262 263 #endif /* _PERFUSE_PRIV_H_ */ 264