1*a2d0d5b0Schristos /* $NetBSD: perfuse_priv.h,v 1.38 2019/09/23 12:00:57 christos Exp $ */ 27b1d1ee6Smanu 37b1d1ee6Smanu /*- 42c9a0a7dSmanu * Copyright (c) 2010-2011 Emmanuel Dreyfus. All rights reserved. 57b1d1ee6Smanu * 67b1d1ee6Smanu * Redistribution and use in source and binary forms, with or without 77b1d1ee6Smanu * modification, are permitted provided that the following conditions 87b1d1ee6Smanu * are met: 97b1d1ee6Smanu * 1. Redistributions of source code must retain the above copyright 107b1d1ee6Smanu * notice, this list of conditions and the following disclaimer. 117b1d1ee6Smanu * 2. Redistributions in binary form must reproduce the above copyright 127b1d1ee6Smanu * notice, this list of conditions and the following disclaimer in the 137b1d1ee6Smanu * documentation and/or other materials provided with the distribution. 147b1d1ee6Smanu * 157b1d1ee6Smanu * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 167b1d1ee6Smanu * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 177b1d1ee6Smanu * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 187b1d1ee6Smanu * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 197b1d1ee6Smanu * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 207b1d1ee6Smanu * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 217b1d1ee6Smanu * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 227b1d1ee6Smanu * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 237b1d1ee6Smanu * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 247b1d1ee6Smanu * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 257b1d1ee6Smanu * POSSIBILITY OF SUCH DAMAGE. 267b1d1ee6Smanu */ 277b1d1ee6Smanu 287b1d1ee6Smanu #ifndef _PERFUSE_PRIV_H_ 297b1d1ee6Smanu #define _PERFUSE_PRIV_H_ 307b1d1ee6Smanu 311a7b4c64Smanu #include <unistd.h> 327b1d1ee6Smanu #include <syslog.h> 337b1d1ee6Smanu #include <paths.h> 347b1d1ee6Smanu #include <err.h> 357b1d1ee6Smanu #include <sysexits.h> 361a7b4c64Smanu #include <signal.h> 377b1d1ee6Smanu #include <puffs.h> 387b1d1ee6Smanu 397b1d1ee6Smanu #include "perfuse_if.h" 407b1d1ee6Smanu #include "fuse.h" 417b1d1ee6Smanu 426049f7bbSmanu /* From src/sys/fs/puffs/puffs_vfsops.c */ 436049f7bbSmanu #ifndef PUFFS_PNODEBUCKETS 446049f7bbSmanu #define PUFFS_PNODEBUCKETS 256 456049f7bbSmanu #endif /* PUFFS_PNODEBUCKETS */ 466049f7bbSmanu 47480a290eSmanu #define PERFUSE_TRACECOUNT_MAX 4096 48480a290eSmanu #define PERFUSE_TRACEPATH_MAX 256 49480a290eSmanu struct perfuse_trace { 50480a290eSmanu int pt_opcode; 51480a290eSmanu char pt_path[PERFUSE_TRACEPATH_MAX]; 52480a290eSmanu char pt_extra[BUFSIZ]; 53480a290eSmanu int pt_error; 54480a290eSmanu enum { inxchg, done } pt_status; 55480a290eSmanu struct timespec pt_start; 56480a290eSmanu struct timespec pt_end; 57480a290eSmanu TAILQ_ENTRY(perfuse_trace) pt_list; 58480a290eSmanu }; 59480a290eSmanu 606049f7bbSmanu LIST_HEAD(perfuse_node_hashlist, perfuse_node_data); 617b1d1ee6Smanu struct perfuse_state { 627b1d1ee6Smanu void *ps_private; /* Private field for libperfuse user */ 637b1d1ee6Smanu struct puffs_usermount *ps_pu; 647b1d1ee6Smanu struct puffs_node *ps_root; 6513260297Smanu uid_t ps_owner_uid; 667b1d1ee6Smanu int ps_flags; 677b1d1ee6Smanu #define PS_NO_ACCESS 0x0001 /* access is unimplemented; */ 687b1d1ee6Smanu #define PS_NO_CREAT 0x0004 /* create is unimplemented */ 697b1d1ee6Smanu #define PS_INLOOP 0x0008 /* puffs mainloop started */ 706f289d5eSmanu #define PS_NO_FALLOCATE 0x0010 /* fallocate is unimplemented */ 712c9a0a7dSmanu uint64_t ps_fsid; 727b1d1ee6Smanu uint32_t ps_max_readahead; 737b1d1ee6Smanu uint32_t ps_max_write; 747b1d1ee6Smanu uint64_t ps_syncreads; 757b1d1ee6Smanu uint64_t ps_syncwrites; 767b1d1ee6Smanu uint64_t ps_asyncreads; 777b1d1ee6Smanu uint64_t ps_asyncwrites; 787b1d1ee6Smanu char *ps_source; 797b1d1ee6Smanu char *ps_target; 807b1d1ee6Smanu char *ps_filesystemtype; 817b1d1ee6Smanu int ps_mountflags; 827b1d1ee6Smanu uint64_t ps_unique; 837b1d1ee6Smanu perfuse_new_msg_fn ps_new_msg; 847b1d1ee6Smanu perfuse_xchg_msg_fn ps_xchg_msg; 857b1d1ee6Smanu perfuse_destroy_msg_fn ps_destroy_msg; 867b1d1ee6Smanu perfuse_get_inhdr_fn ps_get_inhdr; 877b1d1ee6Smanu perfuse_get_inpayload_fn ps_get_inpayload; 887b1d1ee6Smanu perfuse_get_outhdr_fn ps_get_outhdr; 897b1d1ee6Smanu perfuse_get_outpayload_fn ps_get_outpayload; 90af3ae9c1Smanu perfuse_umount_fn ps_umount; 91480a290eSmanu TAILQ_HEAD(,perfuse_trace) ps_trace; 92480a290eSmanu uint64_t ps_tracecount; 936049f7bbSmanu struct perfuse_node_hashlist *ps_nidhash; 946049f7bbSmanu int ps_nnidhash; 956049f7bbSmanu int ps_nodecount; 966049f7bbSmanu int ps_xchgcount; 977b1d1ee6Smanu }; 987b1d1ee6Smanu 997b1d1ee6Smanu 100bcf6f2f3Smanu enum perfuse_qtype { 101bcf6f2f3Smanu PCQ_READDIR, 102bcf6f2f3Smanu PCQ_READ, 103bcf6f2f3Smanu PCQ_WRITE, 104bcf6f2f3Smanu PCQ_AFTERWRITE, 105f7174423Smanu PCQ_OPEN, 106e02bfd0fSmanu PCQ_AFTERXCHG, 1076049f7bbSmanu PCQ_RESIZE, 1086049f7bbSmanu PCQ_REF 109bcf6f2f3Smanu }; 1103d6861b5Smanu 111e9a8a6acSmanu #ifdef PERFUSE_DEBUG 112bd8bd719Smatt extern const char * const perfuse_qtypestr[]; 113e9a8a6acSmanu #endif 1147b1d1ee6Smanu 1157b1d1ee6Smanu struct perfuse_cc_queue { 1167b1d1ee6Smanu enum perfuse_qtype pcq_type; 1177b1d1ee6Smanu struct puffs_cc *pcq_cc; 1187b1d1ee6Smanu TAILQ_ENTRY(perfuse_cc_queue) pcq_next; 1196049f7bbSmanu const char *pcq_func; 1206049f7bbSmanu int pcq_line; 1217b1d1ee6Smanu }; 1227b1d1ee6Smanu 1237b1d1ee6Smanu struct perfuse_node_data { 12428d5b640Smanu uint64_t pnd_rfh; 12528d5b640Smanu uint64_t pnd_wfh; 126f728f3dbSmanu uint64_t pnd_nodeid; /* nodeid, this is not inode */ 1276049f7bbSmanu uint64_t pnd_parent_nodeid; /* parent's nodeid */ 1286049f7bbSmanu uint32_t pnd_hashidx; /* node hash index */ 129630edce9Smanu uint64_t pnd_fuse_nlookup; /* vnode refcount */ 130630edce9Smanu int pnd_puffs_nlookup; /* vnode refcount */ 1317b1d1ee6Smanu uint64_t pnd_lock_owner; 1327b1d1ee6Smanu struct dirent *pnd_dirent; /* native buffer for readdir */ 1336f8501feSmanu off_t pnd_dirent_len; 1347b1d1ee6Smanu struct fuse_dirent *pnd_all_fd; /* FUSE buffer for readdir */ 1357b1d1ee6Smanu size_t pnd_all_fd_len; 136d68b52a6Smanu uint64_t pnd_fd_cookie; /* opaque readdir ref from fs */ 1377b1d1ee6Smanu TAILQ_HEAD(,perfuse_cc_queue) pnd_pcq; /* queued requests */ 1387b1d1ee6Smanu int pnd_flags; 1393d6861b5Smanu #define PND_RECLAIMED 0x001 /* reclaim pending */ 1403d6861b5Smanu #define PND_INREADDIR 0x002 /* readdir in progress */ 1413d6861b5Smanu #define PND_DIRTY 0x004 /* There is some data to sync */ 1423d6861b5Smanu #define PND_RFH 0x008 /* Read FH allocated */ 1433d6861b5Smanu #define PND_WFH 0x010 /* Write FH allocated */ 1443d6861b5Smanu #define PND_REMOVED 0x020 /* Node was removed */ 1453d6861b5Smanu #define PND_INWRITE 0x040 /* write in progress */ 146bcf6f2f3Smanu #define PND_INOPEN 0x100 /* open in progress */ 1476049f7bbSmanu #define PND_INVALID 0x400 /* node freed, usage is a bug */ 148e02bfd0fSmanu #define PND_INRESIZE 0x800 /* resize in progress */ 14928d5b640Smanu 15028d5b640Smanu #define PND_OPEN (PND_RFH|PND_WFH) /* File is open */ 151bcf6f2f3Smanu #define PND_BUSY (PND_INREADDIR|PND_INWRITE|PND_INOPEN) 1526049f7bbSmanu 1536049f7bbSmanu LIST_ENTRY(perfuse_node_data) pnd_nident; 1543d6861b5Smanu puffs_cookie_t pnd_pn; 1552ff0ea03Smanu char pnd_name[MAXPATHLEN]; /* node name */ 1566049f7bbSmanu struct timespec pnd_cn_expire; 1576049f7bbSmanu int pnd_inxchg; 1586049f7bbSmanu int pnd_ref; 1597b1d1ee6Smanu }; 1607b1d1ee6Smanu 1617b1d1ee6Smanu #define PERFUSE_NODE_DATA(opc) \ 1627b1d1ee6Smanu ((struct perfuse_node_data *)puffs_pn_getpriv((struct puffs_node *)opc)) 1637b1d1ee6Smanu 1647b1d1ee6Smanu 1657b1d1ee6Smanu #define UNSPEC_REPLY_LEN PERFUSE_UNSPEC_REPLY_LEN /* shorter! */ 1667b1d1ee6Smanu #define NO_PAYLOAD_REPLY_LEN 0 1677b1d1ee6Smanu 1687b1d1ee6Smanu #define GET_INHDR(ps, pm) ps->ps_get_inhdr(pm) 1697b1d1ee6Smanu #define GET_INPAYLOAD(ps, pm, type) \ 1707b1d1ee6Smanu (struct type *)(void *)ps->ps_get_inpayload(pm) 1717b1d1ee6Smanu #define _GET_INPAYLOAD(ps, pm, type) (type)ps->ps_get_inpayload(pm) 1727b1d1ee6Smanu #define GET_OUTHDR(ps, pm) ps->ps_get_outhdr(pm) 1737b1d1ee6Smanu #define GET_OUTPAYLOAD(ps, pm, type) \ 1747b1d1ee6Smanu (struct type *)(void *)ps->ps_get_outpayload(pm) 1757b1d1ee6Smanu #define _GET_OUTPAYLOAD(ps, pm, type) (type)ps->ps_get_outpayload(pm) 1767b1d1ee6Smanu 1777b1d1ee6Smanu __BEGIN_DECLS 1787b1d1ee6Smanu 1792ff0ea03Smanu struct puffs_node *perfuse_new_pn(struct puffs_usermount *, const char *, 1807b1d1ee6Smanu struct puffs_node *); 1816049f7bbSmanu void perfuse_destroy_pn(struct puffs_usermount *, struct puffs_node *); 182bcf6f2f3Smanu void perfuse_new_fh(puffs_cookie_t, uint64_t, int); 1837b1d1ee6Smanu void perfuse_destroy_fh(puffs_cookie_t, uint64_t); 18428d5b640Smanu uint64_t perfuse_get_fh(puffs_cookie_t, int); 1857b1d1ee6Smanu uint64_t perfuse_next_unique(struct puffs_usermount *); 1866049f7bbSmanu char *perfuse_node_path(struct perfuse_state *, puffs_cookie_t); 1873d6861b5Smanu int perfuse_node_close_common(struct puffs_usermount *, puffs_cookie_t, int); 188a707cfeaSmanu int perfuse_ns_match(const int, const char *); 1890cc5cbd9Smanu const char *perfuse_native_ns(const int, const char *, char *); 1907b1d1ee6Smanu 1917b1d1ee6Smanu char *perfuse_fs_mount(int, ssize_t); 1927b1d1ee6Smanu 1937b1d1ee6Smanu 1947b1d1ee6Smanu /* 1950cc5cbd9Smanu * ops.c - filesystem operations 1967b1d1ee6Smanu */ 1977b1d1ee6Smanu int perfuse_fs_unmount(struct puffs_usermount *, int); 198*a2d0d5b0Schristos int perfuse_fs_statvfs(struct puffs_usermount *, struct puffs_statvfs *); 1997b1d1ee6Smanu int perfuse_fs_sync(struct puffs_usermount *, int, 2007b1d1ee6Smanu const struct puffs_cred *); 2017b1d1ee6Smanu int perfuse_fs_fhtonode(struct puffs_usermount *, void *, size_t, 2027b1d1ee6Smanu struct puffs_newinfo *); 2037b1d1ee6Smanu int perfuse_fs_nodetofh(struct puffs_usermount *, puffs_cookie_t, 2047b1d1ee6Smanu void *, size_t *); 2057b1d1ee6Smanu void perfuse_fs_suspend(struct puffs_usermount *, int); 2067b1d1ee6Smanu int perfuse_node_lookup(struct puffs_usermount *, 2077b1d1ee6Smanu puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *); 2087b1d1ee6Smanu int perfuse_node_create(struct puffs_usermount *, 2097b1d1ee6Smanu puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *, 2107b1d1ee6Smanu const struct vattr *); 2117b1d1ee6Smanu int perfuse_node_mknod(struct puffs_usermount *, 2127b1d1ee6Smanu puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *, 2137b1d1ee6Smanu const struct vattr *); 2147b1d1ee6Smanu int perfuse_node_open(struct puffs_usermount *, 2157b1d1ee6Smanu puffs_cookie_t, int, const struct puffs_cred *); 2167b1d1ee6Smanu int perfuse_node_close(struct puffs_usermount *, 2177b1d1ee6Smanu puffs_cookie_t, int, const struct puffs_cred *); 2187b1d1ee6Smanu int perfuse_node_access(struct puffs_usermount *, 2197b1d1ee6Smanu puffs_cookie_t, int, const struct puffs_cred *); 2207b1d1ee6Smanu int perfuse_node_getattr(struct puffs_usermount *, 2217b1d1ee6Smanu puffs_cookie_t, struct vattr *, const struct puffs_cred *); 2227b1d1ee6Smanu int perfuse_node_setattr(struct puffs_usermount *, 2237b1d1ee6Smanu puffs_cookie_t, const struct vattr *, const struct puffs_cred *); 2247b1d1ee6Smanu int perfuse_node_poll(struct puffs_usermount *, puffs_cookie_t, int *); 2257b1d1ee6Smanu int perfuse_node_fsync(struct puffs_usermount *, 2267b1d1ee6Smanu puffs_cookie_t, const struct puffs_cred *, int, off_t, off_t); 2277b1d1ee6Smanu int perfuse_node_remove(struct puffs_usermount *, 2287b1d1ee6Smanu puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *); 2297b1d1ee6Smanu int perfuse_node_link(struct puffs_usermount *, 2307b1d1ee6Smanu puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *); 2317b1d1ee6Smanu int perfuse_node_rename(struct puffs_usermount *, 2327b1d1ee6Smanu puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *, 2337b1d1ee6Smanu puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *); 2347b1d1ee6Smanu int perfuse_node_mkdir(struct puffs_usermount *, 2357b1d1ee6Smanu puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *, 2367b1d1ee6Smanu const struct vattr *); 2377b1d1ee6Smanu int perfuse_node_rmdir(struct puffs_usermount *, 2387b1d1ee6Smanu puffs_cookie_t, puffs_cookie_t, const struct puffs_cn *); 2397b1d1ee6Smanu int perfuse_node_symlink(struct puffs_usermount *, 2407b1d1ee6Smanu puffs_cookie_t, struct puffs_newinfo *, const struct puffs_cn *, 2417b1d1ee6Smanu const struct vattr *, const char *); 2427b1d1ee6Smanu int perfuse_node_readdir(struct puffs_usermount *, 2437b1d1ee6Smanu puffs_cookie_t, struct dirent *, off_t *, size_t *, 2447b1d1ee6Smanu const struct puffs_cred *, int *, off_t *, size_t *); 2457b1d1ee6Smanu int perfuse_node_readlink(struct puffs_usermount *, 2467b1d1ee6Smanu puffs_cookie_t, const struct puffs_cred *, char *, size_t *); 2477b1d1ee6Smanu int perfuse_node_reclaim(struct puffs_usermount *, puffs_cookie_t); 2482f6f04a6Smanu int perfuse_node_reclaim2(struct puffs_usermount *, puffs_cookie_t, int); 2497b1d1ee6Smanu int perfuse_node_inactive(struct puffs_usermount *, puffs_cookie_t); 2507b1d1ee6Smanu int perfuse_node_print(struct puffs_usermount *, puffs_cookie_t); 2517b1d1ee6Smanu int perfuse_node_pathconf(struct puffs_usermount *, 2525c1d19cfSenami puffs_cookie_t, int, register_t *); 2537b1d1ee6Smanu int perfuse_node_advlock(struct puffs_usermount *, 2547b1d1ee6Smanu puffs_cookie_t, void *, int, struct flock *, int); 2557b1d1ee6Smanu int perfuse_node_read(struct puffs_usermount *, puffs_cookie_t, 2567b1d1ee6Smanu uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 2577b1d1ee6Smanu int perfuse_node_write(struct puffs_usermount *, puffs_cookie_t, 2587b1d1ee6Smanu uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 2596049f7bbSmanu int perfuse_node_write2(struct puffs_usermount *, puffs_cookie_t, 2606049f7bbSmanu uint8_t *, off_t, size_t *, const struct puffs_cred *, int, int); 261fdba4944Smanu int perfuse_node_open2(struct puffs_usermount *, 262fdba4944Smanu puffs_cookie_t, int, const struct puffs_cred *, int *); 2637b1d1ee6Smanu void perfuse_cache_write(struct puffs_usermount *, 2647b1d1ee6Smanu puffs_cookie_t, size_t, struct puffs_cacherun *); 2650cc5cbd9Smanu int perfuse_node_getextattr(struct puffs_usermount *, puffs_cookie_t, 2660cc5cbd9Smanu int, const char *, size_t *, uint8_t *, size_t *, 2670cc5cbd9Smanu const struct puffs_cred *); 2680cc5cbd9Smanu int perfuse_node_setextattr(struct puffs_usermount *, puffs_cookie_t, 2690cc5cbd9Smanu int, const char *, uint8_t *, size_t *, const struct puffs_cred *); 2700cc5cbd9Smanu int perfuse_node_listextattr(struct puffs_usermount *, puffs_cookie_t, 2714819c6d1Smanu int, size_t *, uint8_t *, size_t *, int, const struct puffs_cred *); 2720cc5cbd9Smanu int perfuse_node_deleteextattr(struct puffs_usermount *, puffs_cookie_t, 2730cc5cbd9Smanu int, const char *, const struct puffs_cred *); 27409d900bfSmanu int perfuse_node_getattr_ttl(struct puffs_usermount *, 27509d900bfSmanu puffs_cookie_t, struct vattr *, const struct puffs_cred *, 27609d900bfSmanu struct timespec *); 27709d900bfSmanu int perfuse_node_setattr_ttl(struct puffs_usermount *, 27809d900bfSmanu puffs_cookie_t, struct vattr *, const struct puffs_cred *, 2796049f7bbSmanu struct timespec *, int); 2806f289d5eSmanu int perfuse_node_fallocate(struct puffs_usermount *, 2816f289d5eSmanu puffs_cookie_t, off_t, off_t); 2827b1d1ee6Smanu 28397792123Smanu struct perfuse_trace *perfuse_trace_begin(struct perfuse_state *, 28497792123Smanu puffs_cookie_t, perfuse_msg_t *); 28597792123Smanu void perfuse_trace_end(struct perfuse_state *, struct perfuse_trace *, int); 286480a290eSmanu char *perfuse_opdump_in(struct perfuse_state *, perfuse_msg_t *); 2876049f7bbSmanu struct perfuse_node_data *perfuse_node_bynodeid(struct perfuse_state *, 2886049f7bbSmanu uint64_t); 2896049f7bbSmanu void perfuse_node_cache(struct perfuse_state *, puffs_cookie_t); 2906049f7bbSmanu void perfuse_cache_flush(puffs_cookie_t); 291480a290eSmanu 2927b1d1ee6Smanu __END_DECLS 2937b1d1ee6Smanu 2947b1d1ee6Smanu #endif /* _PERFUSE_PRIV_H_ */ 295