1 /* $NetBSD: perfuse_priv.h,v 1.36 2014/10/31 15:12:15 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 <unistd.h> 32 #include <syslog.h> 33 #include <paths.h> 34 #include <err.h> 35 #include <sysexits.h> 36 #include <signal.h> 37 #include <puffs.h> 38 39 #include "perfuse_if.h" 40 #include "fuse.h" 41 42 /* From src/sys/fs/puffs/puffs_vfsops.c */ 43 #ifndef PUFFS_PNODEBUCKETS 44 #define PUFFS_PNODEBUCKETS 256 45 #endif /* PUFFS_PNODEBUCKETS */ 46 47 #define PERFUSE_TRACECOUNT_MAX 4096 48 #define PERFUSE_TRACEPATH_MAX 256 49 struct perfuse_trace { 50 int pt_opcode; 51 char pt_path[PERFUSE_TRACEPATH_MAX]; 52 char pt_extra[BUFSIZ]; 53 int pt_error; 54 enum { inxchg, done } pt_status; 55 struct timespec pt_start; 56 struct timespec pt_end; 57 TAILQ_ENTRY(perfuse_trace) pt_list; 58 }; 59 60 LIST_HEAD(perfuse_node_hashlist, perfuse_node_data); 61 struct perfuse_state { 62 void *ps_private; /* Private field for libperfuse user */ 63 struct puffs_usermount *ps_pu; 64 struct puffs_node *ps_root; 65 uid_t ps_owner_uid; 66 int ps_flags; 67 #define PS_NO_ACCESS 0x0001 /* access is unimplemented; */ 68 #define PS_NO_CREAT 0x0004 /* create is unimplemented */ 69 #define PS_INLOOP 0x0008 /* puffs mainloop started */ 70 #define PS_NO_FALLOCATE 0x0010 /* fallocate is unimplemented */ 71 uint64_t ps_fsid; 72 uint32_t ps_max_readahead; 73 uint32_t ps_max_write; 74 uint64_t ps_syncreads; 75 uint64_t ps_syncwrites; 76 uint64_t ps_asyncreads; 77 uint64_t ps_asyncwrites; 78 char *ps_source; 79 char *ps_target; 80 char *ps_filesystemtype; 81 int ps_mountflags; 82 uint64_t ps_unique; 83 perfuse_new_msg_fn ps_new_msg; 84 perfuse_xchg_msg_fn ps_xchg_msg; 85 perfuse_destroy_msg_fn ps_destroy_msg; 86 perfuse_get_inhdr_fn ps_get_inhdr; 87 perfuse_get_inpayload_fn ps_get_inpayload; 88 perfuse_get_outhdr_fn ps_get_outhdr; 89 perfuse_get_outpayload_fn ps_get_outpayload; 90 perfuse_umount_fn ps_umount; 91 TAILQ_HEAD(,perfuse_trace) ps_trace; 92 uint64_t ps_tracecount; 93 struct perfuse_node_hashlist *ps_nidhash; 94 int ps_nnidhash; 95 int ps_nodecount; 96 int ps_nodeleakcount; 97 int ps_xchgcount; 98 }; 99 100 101 enum perfuse_qtype { 102 PCQ_READDIR, 103 PCQ_READ, 104 PCQ_WRITE, 105 PCQ_AFTERWRITE, 106 PCQ_OPEN, 107 PCQ_AFTERXCHG, 108 PCQ_RESIZE, 109 PCQ_REF 110 }; 111 112 #ifdef PERFUSE_DEBUG 113 extern const char * const perfuse_qtypestr[]; 114 #endif 115 116 struct perfuse_cc_queue { 117 enum perfuse_qtype pcq_type; 118 struct puffs_cc *pcq_cc; 119 TAILQ_ENTRY(perfuse_cc_queue) pcq_next; 120 const char *pcq_func; 121 int pcq_line; 122 }; 123 124 struct perfuse_node_data { 125 uint64_t pnd_rfh; 126 uint64_t pnd_wfh; 127 uint64_t pnd_nodeid; /* nodeid, this is not inode */ 128 uint64_t pnd_parent_nodeid; /* parent's nodeid */ 129 uint32_t pnd_hashidx; /* node hash index */ 130 uint64_t pnd_fuse_nlookup; /* vnode refcount */ 131 int pnd_puffs_nlookup; /* vnode refcount */ 132 uint64_t pnd_lock_owner; 133 struct dirent *pnd_dirent; /* native buffer for readdir */ 134 off_t pnd_dirent_len; 135 struct fuse_dirent *pnd_all_fd; /* FUSE buffer for readdir */ 136 size_t pnd_all_fd_len; 137 uint64_t pnd_fd_cookie; /* opaque readdir ref from fs */ 138 TAILQ_HEAD(,perfuse_cc_queue) pnd_pcq; /* queued requests */ 139 int pnd_flags; 140 #define PND_RECLAIMED 0x001 /* reclaim pending */ 141 #define PND_INREADDIR 0x002 /* readdir in progress */ 142 #define PND_DIRTY 0x004 /* There is some data to sync */ 143 #define PND_RFH 0x008 /* Read FH allocated */ 144 #define PND_WFH 0x010 /* Write FH allocated */ 145 #define PND_REMOVED 0x020 /* Node was removed */ 146 #define PND_INWRITE 0x040 /* write in progress */ 147 #define PND_INOPEN 0x100 /* open in progress */ 148 #define PND_NODELEAK 0x200 /* node reclaim ignored */ 149 #define PND_INVALID 0x400 /* node freed, usage is a bug */ 150 #define PND_INRESIZE 0x800 /* resize in progress */ 151 152 #define PND_OPEN (PND_RFH|PND_WFH) /* File is open */ 153 #define PND_BUSY (PND_INREADDIR|PND_INWRITE|PND_INOPEN) 154 155 LIST_ENTRY(perfuse_node_data) pnd_nident; 156 puffs_cookie_t pnd_pn; 157 char pnd_name[MAXPATHLEN]; /* node name */ 158 struct timespec pnd_cn_expire; 159 int pnd_inxchg; 160 int pnd_ref; 161 }; 162 163 #define PERFUSE_NODE_DATA(opc) \ 164 ((struct perfuse_node_data *)puffs_pn_getpriv((struct puffs_node *)opc)) 165 166 167 #define UNSPEC_REPLY_LEN PERFUSE_UNSPEC_REPLY_LEN /* shorter! */ 168 #define NO_PAYLOAD_REPLY_LEN 0 169 170 #define GET_INHDR(ps, pm) ps->ps_get_inhdr(pm) 171 #define GET_INPAYLOAD(ps, pm, type) \ 172 (struct type *)(void *)ps->ps_get_inpayload(pm) 173 #define _GET_INPAYLOAD(ps, pm, type) (type)ps->ps_get_inpayload(pm) 174 #define GET_OUTHDR(ps, pm) ps->ps_get_outhdr(pm) 175 #define GET_OUTPAYLOAD(ps, pm, type) \ 176 (struct type *)(void *)ps->ps_get_outpayload(pm) 177 #define _GET_OUTPAYLOAD(ps, pm, type) (type)ps->ps_get_outpayload(pm) 178 179 __BEGIN_DECLS 180 181 struct puffs_node *perfuse_new_pn(struct puffs_usermount *, const char *, 182 struct puffs_node *); 183 void perfuse_destroy_pn(struct puffs_usermount *, struct puffs_node *); 184 void perfuse_new_fh(puffs_cookie_t, uint64_t, int); 185 void perfuse_destroy_fh(puffs_cookie_t, uint64_t); 186 uint64_t perfuse_get_fh(puffs_cookie_t, int); 187 uint64_t perfuse_next_unique(struct puffs_usermount *); 188 char *perfuse_node_path(struct perfuse_state *, puffs_cookie_t); 189 int perfuse_node_close_common(struct puffs_usermount *, puffs_cookie_t, int); 190 int perfuse_ns_match(const int, const char *); 191 const char *perfuse_native_ns(const int, const char *, char *); 192 193 char *perfuse_fs_mount(int, ssize_t); 194 195 196 /* 197 * ops.c - filesystem operations 198 */ 199 int perfuse_fs_unmount(struct puffs_usermount *, int); 200 int perfuse_fs_statvfs(struct puffs_usermount *, struct statvfs *); 201 int perfuse_fs_sync(struct puffs_usermount *, int, 202 const struct puffs_cred *); 203 int perfuse_fs_fhtonode(struct puffs_usermount *, void *, size_t, 204 struct puffs_newinfo *); 205 int perfuse_fs_nodetofh(struct puffs_usermount *, puffs_cookie_t, 206 void *, size_t *); 207 void perfuse_fs_suspend(struct puffs_usermount *, int); 208 int perfuse_node_lookup(struct puffs_usermount *, 209 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *); 210 int perfuse_node_create(struct puffs_usermount *, 211 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *, 212 const struct vattr *); 213 int perfuse_node_mknod(struct puffs_usermount *, 214 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *, 215 const struct vattr *); 216 int perfuse_node_open(struct puffs_usermount *, 217 puffs_cookie_t, int, const struct puffs_cred *); 218 int perfuse_node_close(struct puffs_usermount *, 219 puffs_cookie_t, int, const struct puffs_cred *); 220 int perfuse_node_access(struct puffs_usermount *, 221 puffs_cookie_t, int, const struct puffs_cred *); 222 int perfuse_node_getattr(struct puffs_usermount *, 223 puffs_cookie_t, struct vattr *, const struct puffs_cred *); 224 int perfuse_node_setattr(struct puffs_usermount *, 225 puffs_cookie_t, const struct vattr *, const struct puffs_cred *); 226 int perfuse_node_poll(struct puffs_usermount *, puffs_cookie_t, int *); 227 int perfuse_node_fsync(struct puffs_usermount *, 228 puffs_cookie_t, const struct puffs_cred *, int, off_t, off_t); 229 int perfuse_node_remove(struct puffs_usermount *, 230 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *); 231 int perfuse_node_link(struct puffs_usermount *, 232 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *); 233 int perfuse_node_rename(struct puffs_usermount *, 234 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *, 235 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *); 236 int perfuse_node_mkdir(struct puffs_usermount *, 237 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *, 238 const struct vattr *); 239 int perfuse_node_rmdir(struct puffs_usermount *, 240 puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *); 241 int perfuse_node_symlink(struct puffs_usermount *, 242 puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *, 243 const struct vattr *, const char *); 244 int perfuse_node_readdir(struct puffs_usermount *, 245 puffs_cookie_t, struct dirent *, off_t *, size_t *, 246 const struct puffs_cred *, int *, off_t *, size_t *); 247 int perfuse_node_readlink(struct puffs_usermount *, 248 puffs_cookie_t, const struct puffs_cred *, char *, size_t *); 249 int perfuse_node_reclaim(struct puffs_usermount *, puffs_cookie_t); 250 int perfuse_node_inactive(struct puffs_usermount *, puffs_cookie_t); 251 int perfuse_node_print(struct puffs_usermount *, puffs_cookie_t); 252 int perfuse_node_pathconf(struct puffs_usermount *, 253 puffs_cookie_t, int, register_t *); 254 int perfuse_node_advlock(struct puffs_usermount *, 255 puffs_cookie_t, void *, int, struct flock *, int); 256 int perfuse_node_read(struct puffs_usermount *, puffs_cookie_t, 257 uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 258 int perfuse_node_write(struct puffs_usermount *, puffs_cookie_t, 259 uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 260 int perfuse_node_write2(struct puffs_usermount *, puffs_cookie_t, 261 uint8_t *, off_t, size_t *, const struct puffs_cred *, int, int); 262 int perfuse_node_open2(struct puffs_usermount *, 263 puffs_cookie_t, int, const struct puffs_cred *, int *); 264 void perfuse_cache_write(struct puffs_usermount *, 265 puffs_cookie_t, size_t, struct puffs_cacherun *); 266 int perfuse_node_getextattr(struct puffs_usermount *, puffs_cookie_t, 267 int, const char *, size_t *, uint8_t *, size_t *, 268 const struct puffs_cred *); 269 int perfuse_node_setextattr(struct puffs_usermount *, puffs_cookie_t, 270 int, const char *, uint8_t *, size_t *, const struct puffs_cred *); 271 int perfuse_node_listextattr(struct puffs_usermount *, puffs_cookie_t, 272 int, size_t *, uint8_t *, size_t *, int, const struct puffs_cred *); 273 int perfuse_node_deleteextattr(struct puffs_usermount *, puffs_cookie_t, 274 int, const char *, const struct puffs_cred *); 275 int perfuse_node_getattr_ttl(struct puffs_usermount *, 276 puffs_cookie_t, struct vattr *, const struct puffs_cred *, 277 struct timespec *); 278 int perfuse_node_setattr_ttl(struct puffs_usermount *, 279 puffs_cookie_t, struct vattr *, const struct puffs_cred *, 280 struct timespec *, int); 281 int perfuse_node_fallocate(struct puffs_usermount *, 282 puffs_cookie_t, off_t, off_t); 283 284 struct perfuse_trace *perfuse_trace_begin(struct perfuse_state *, 285 puffs_cookie_t, perfuse_msg_t *); 286 void perfuse_trace_end(struct perfuse_state *, struct perfuse_trace *, int); 287 char *perfuse_opdump_in(struct perfuse_state *, perfuse_msg_t *); 288 struct perfuse_node_data *perfuse_node_bynodeid(struct perfuse_state *, 289 uint64_t); 290 void perfuse_node_cache(struct perfuse_state *, puffs_cookie_t); 291 void perfuse_cache_flush(puffs_cookie_t); 292 293 __END_DECLS 294 295 #endif /* _PERFUSE_PRIV_H_ */ 296