1d8a5ba45SMiklos Szeredi /* 2d8a5ba45SMiklos Szeredi FUSE: Filesystem in Userspace 31729a16cSMiklos Szeredi Copyright (C) 2001-2008 Miklos Szeredi <miklos@szeredi.hu> 4d8a5ba45SMiklos Szeredi 5d8a5ba45SMiklos Szeredi This program can be distributed under the terms of the GNU GPL. 6d8a5ba45SMiklos Szeredi See the file COPYING. 7d8a5ba45SMiklos Szeredi */ 8d8a5ba45SMiklos Szeredi 929d434b3STejun Heo #ifndef _FS_FUSE_I_H 1029d434b3STejun Heo #define _FS_FUSE_I_H 1129d434b3STejun Heo 12d8a5ba45SMiklos Szeredi #include <linux/fuse.h> 13d8a5ba45SMiklos Szeredi #include <linux/fs.h> 1451eb01e7SMiklos Szeredi #include <linux/mount.h> 15d8a5ba45SMiklos Szeredi #include <linux/wait.h> 16d8a5ba45SMiklos Szeredi #include <linux/list.h> 17d8a5ba45SMiklos Szeredi #include <linux/spinlock.h> 18d8a5ba45SMiklos Szeredi #include <linux/mm.h> 19d8a5ba45SMiklos Szeredi #include <linux/backing-dev.h> 20bafa9654SMiklos Szeredi #include <linux/mutex.h> 213be5a52bSMiklos Szeredi #include <linux/rwsem.h> 2295668a69STejun Heo #include <linux/rbtree.h> 2395668a69STejun Heo #include <linux/poll.h> 245a18ec17SMiklos Szeredi #include <linux/workqueue.h> 25744742d6SSeth Forshee #include <linux/kref.h> 2660bcc88aSSeth Forshee #include <linux/xattr.h> 270b6e9ea0SSeth Forshee #include <linux/pid_namespace.h> 284e8c2eb5SElena Reshetova #include <linux/refcount.h> 298cb08329SEric W. Biederman #include <linux/user_namespace.h> 30d8a5ba45SMiklos Szeredi 315da784ccSConstantine Shulyupin /** Default max number of pages that can be used in a single read request */ 325da784ccSConstantine Shulyupin #define FUSE_DEFAULT_MAX_PAGES_PER_REQ 32 335da784ccSConstantine Shulyupin 345da784ccSConstantine Shulyupin /** Maximum of max_pages received in init_out */ 355da784ccSConstantine Shulyupin #define FUSE_MAX_MAX_PAGES 256 36334f485dSMiklos Szeredi 373be5a52bSMiklos Szeredi /** Bias for fi->writectr, meaning new writepages must not be sent */ 383be5a52bSMiklos Szeredi #define FUSE_NOWRITE INT_MIN 393be5a52bSMiklos Szeredi 401d3d752bSMiklos Szeredi /** It could be as large as PATH_MAX, but would that have any uses? */ 411d3d752bSMiklos Szeredi #define FUSE_NAME_MAX 1024 421d3d752bSMiklos Szeredi 43bafa9654SMiklos Szeredi /** Number of dentries for each connection in the control filesystem */ 4479a9d994SCsaba Henk #define FUSE_CTL_NUM_DENTRIES 5 45bafa9654SMiklos Szeredi 464250c066SMaxim Patlasov /** Number of page pointers embedded in fuse_req */ 474250c066SMaxim Patlasov #define FUSE_REQ_INLINE_PAGES 1 484250c066SMaxim Patlasov 49bafa9654SMiklos Szeredi /** List of active connections */ 50bafa9654SMiklos Szeredi extern struct list_head fuse_conn_list; 51bafa9654SMiklos Szeredi 52bafa9654SMiklos Szeredi /** Global mutex protecting fuse_conn_list and the control filesystem */ 53bafa9654SMiklos Szeredi extern struct mutex fuse_mutex; 54413ef8cbSMiklos Szeredi 5579a9d994SCsaba Henk /** Module parameters */ 5679a9d994SCsaba Henk extern unsigned max_user_bgreq; 5779a9d994SCsaba Henk extern unsigned max_user_congthresh; 5879a9d994SCsaba Henk 5907e77dcaSMiklos Szeredi /* One forget request */ 6007e77dcaSMiklos Szeredi struct fuse_forget_link { 6102c048b9SMiklos Szeredi struct fuse_forget_one forget_one; 6207e77dcaSMiklos Szeredi struct fuse_forget_link *next; 6307e77dcaSMiklos Szeredi }; 6407e77dcaSMiklos Szeredi 65d8a5ba45SMiklos Szeredi /** FUSE inode */ 66d8a5ba45SMiklos Szeredi struct fuse_inode { 67d8a5ba45SMiklos Szeredi /** Inode data */ 68d8a5ba45SMiklos Szeredi struct inode inode; 69d8a5ba45SMiklos Szeredi 70d8a5ba45SMiklos Szeredi /** Unique ID, which identifies the inode between userspace 71d8a5ba45SMiklos Szeredi * and kernel */ 72d8a5ba45SMiklos Szeredi u64 nodeid; 73d8a5ba45SMiklos Szeredi 749e6268dbSMiklos Szeredi /** Number of lookups on this inode */ 759e6268dbSMiklos Szeredi u64 nlookup; 769e6268dbSMiklos Szeredi 77e5e5558eSMiklos Szeredi /** The request used for sending the FORGET message */ 7807e77dcaSMiklos Szeredi struct fuse_forget_link *forget; 79e5e5558eSMiklos Szeredi 80d8a5ba45SMiklos Szeredi /** Time in jiffies until the file attributes are valid */ 810a0898cfSMiklos Szeredi u64 i_time; 82ebc14c4dSMiklos Szeredi 832f1e8196SMiklos Szeredi /* Which attributes are invalid */ 842f1e8196SMiklos Szeredi u32 inval_mask; 852f1e8196SMiklos Szeredi 86ebc14c4dSMiklos Szeredi /** The sticky bit in inode->i_mode may have been removed, so 87ebc14c4dSMiklos Szeredi preserve the original mode */ 88541af6a0SAl Viro umode_t orig_i_mode; 891fb69e78SMiklos Szeredi 9045c72cd7SPavel Shilovsky /** 64 bit inode number */ 9145c72cd7SPavel Shilovsky u64 orig_ino; 9245c72cd7SPavel Shilovsky 931fb69e78SMiklos Szeredi /** Version of last attribute change */ 941fb69e78SMiklos Szeredi u64 attr_version; 9593a8c3cdSMiklos Szeredi 96ab2257e9SMiklos Szeredi union { 97ab2257e9SMiklos Szeredi /* Write related fields (regular file only) */ 98ab2257e9SMiklos Szeredi struct { 99ab2257e9SMiklos Szeredi /* Files usable in writepage. Protected by fc->lock */ 10093a8c3cdSMiklos Szeredi struct list_head write_files; 1013be5a52bSMiklos Szeredi 102ab2257e9SMiklos Szeredi /* Writepages pending on truncate or fsync */ 1033be5a52bSMiklos Szeredi struct list_head queued_writes; 1043be5a52bSMiklos Szeredi 105ab2257e9SMiklos Szeredi /* Number of sent writes, a negative bias 106ab2257e9SMiklos Szeredi * (FUSE_NOWRITE) means more writes are blocked */ 1073be5a52bSMiklos Szeredi int writectr; 1083be5a52bSMiklos Szeredi 109ab2257e9SMiklos Szeredi /* Waitq for writepage completion */ 1103be5a52bSMiklos Szeredi wait_queue_head_t page_waitq; 1113be5a52bSMiklos Szeredi 112ab2257e9SMiklos Szeredi /* List of writepage requestst (pending or sent) */ 1133be5a52bSMiklos Szeredi struct list_head writepages; 114ab2257e9SMiklos Szeredi }; 1154582a4abSFeng Shuo 116ab2257e9SMiklos Szeredi /* readdir cache (directory only) */ 11769e34551SMiklos Szeredi struct { 11869e34551SMiklos Szeredi /* true if fully cached */ 11969e34551SMiklos Szeredi bool cached; 12069e34551SMiklos Szeredi 12169e34551SMiklos Szeredi /* size of cache */ 12269e34551SMiklos Szeredi loff_t size; 12369e34551SMiklos Szeredi 12469e34551SMiklos Szeredi /* position at end of cache (position of next entry) */ 12569e34551SMiklos Szeredi loff_t pos; 12669e34551SMiklos Szeredi 1273494927eSMiklos Szeredi /* version of the cache */ 1283494927eSMiklos Szeredi u64 version; 1293494927eSMiklos Szeredi 130ab2257e9SMiklos Szeredi /* modification time of directory when cache was 131ab2257e9SMiklos Szeredi * started */ 1327118883bSMiklos Szeredi struct timespec64 mtime; 1337118883bSMiklos Szeredi 134261aaba7SMiklos Szeredi /* iversion of directory when cache was started */ 135261aaba7SMiklos Szeredi u64 iversion; 136261aaba7SMiklos Szeredi 13769e34551SMiklos Szeredi /* protects above fields */ 13869e34551SMiklos Szeredi spinlock_t lock; 13969e34551SMiklos Szeredi } rdc; 140ab2257e9SMiklos Szeredi }; 14169e34551SMiklos Szeredi 1424582a4abSFeng Shuo /** Miscellaneous bits describing inode state */ 1434582a4abSFeng Shuo unsigned long state; 1445c672ab3SMiklos Szeredi 1455c672ab3SMiklos Szeredi /** Lock for serializing lookup and readdir for back compatibility*/ 1465c672ab3SMiklos Szeredi struct mutex mutex; 1474582a4abSFeng Shuo }; 1484582a4abSFeng Shuo 1494582a4abSFeng Shuo /** FUSE inode state bits */ 1504582a4abSFeng Shuo enum { 1514582a4abSFeng Shuo /** Advise readdirplus */ 1524582a4abSFeng Shuo FUSE_I_ADVISE_RDPLUS, 1536314efeeSMiklos Szeredi /** Initialized with readdirplus */ 1546314efeeSMiklos Szeredi FUSE_I_INIT_RDPLUS, 15506a7c3c2SMaxim Patlasov /** An operation changing file size is in progress */ 15606a7c3c2SMaxim Patlasov FUSE_I_SIZE_UNSTABLE, 157d8a5ba45SMiklos Szeredi }; 158d8a5ba45SMiklos Szeredi 159da5e4714SMiklos Szeredi struct fuse_conn; 160da5e4714SMiklos Szeredi 161b6aeadedSMiklos Szeredi /** FUSE specific file data */ 162b6aeadedSMiklos Szeredi struct fuse_file { 163da5e4714SMiklos Szeredi /** Fuse connection for this file */ 164da5e4714SMiklos Szeredi struct fuse_conn *fc; 165da5e4714SMiklos Szeredi 166b6aeadedSMiklos Szeredi /** Request reserved for flush and release */ 16733649c91SMiklos Szeredi struct fuse_req *reserved_req; 168b6aeadedSMiklos Szeredi 169acf99433STejun Heo /** Kernel file handle guaranteed to be unique */ 170acf99433STejun Heo u64 kh; 171acf99433STejun Heo 172b6aeadedSMiklos Szeredi /** File handle used by userspace */ 173b6aeadedSMiklos Szeredi u64 fh; 174c756e0a4SMiklos Szeredi 175da5e4714SMiklos Szeredi /** Node id of this file */ 176da5e4714SMiklos Szeredi u64 nodeid; 177da5e4714SMiklos Szeredi 178c756e0a4SMiklos Szeredi /** Refcount */ 1794e8c2eb5SElena Reshetova refcount_t count; 18093a8c3cdSMiklos Szeredi 181c7b7143cSMiklos Szeredi /** FOPEN_* flags returned by open */ 182c7b7143cSMiklos Szeredi u32 open_flags; 183c7b7143cSMiklos Szeredi 18493a8c3cdSMiklos Szeredi /** Entry on inode's write_files list */ 18593a8c3cdSMiklos Szeredi struct list_head write_entry; 18695668a69STejun Heo 1875d7bc7e8SMiklos Szeredi /* Readdir related */ 1885d7bc7e8SMiklos Szeredi struct { 1895d7bc7e8SMiklos Szeredi /* 1905d7bc7e8SMiklos Szeredi * Protects below fields against (crazy) parallel readdir on 1915d7bc7e8SMiklos Szeredi * same open file. Uncontended in the normal case. 1925d7bc7e8SMiklos Szeredi */ 1935d7bc7e8SMiklos Szeredi struct mutex lock; 1945d7bc7e8SMiklos Szeredi 1955d7bc7e8SMiklos Szeredi /* Dir stream position */ 1965d7bc7e8SMiklos Szeredi loff_t pos; 1975d7bc7e8SMiklos Szeredi 1985d7bc7e8SMiklos Szeredi /* Offset in cache */ 1995d7bc7e8SMiklos Szeredi loff_t cache_off; 2003494927eSMiklos Szeredi 2013494927eSMiklos Szeredi /* Version of cache we are reading */ 2023494927eSMiklos Szeredi u64 version; 2033494927eSMiklos Szeredi 2045d7bc7e8SMiklos Szeredi } readdir; 2055d7bc7e8SMiklos Szeredi 20695668a69STejun Heo /** RB node to be linked on fuse_conn->polled_files */ 20795668a69STejun Heo struct rb_node polled_node; 20895668a69STejun Heo 20995668a69STejun Heo /** Wait queue head for poll */ 21095668a69STejun Heo wait_queue_head_t poll_wait; 21137fb3a30SMiklos Szeredi 21237fb3a30SMiklos Szeredi /** Has flock been performed on this file? */ 21337fb3a30SMiklos Szeredi bool flock:1; 214b6aeadedSMiklos Szeredi }; 215b6aeadedSMiklos Szeredi 216334f485dSMiklos Szeredi /** One input argument of a request */ 217334f485dSMiklos Szeredi struct fuse_in_arg { 218334f485dSMiklos Szeredi unsigned size; 219334f485dSMiklos Szeredi const void *value; 220334f485dSMiklos Szeredi }; 221334f485dSMiklos Szeredi 222334f485dSMiklos Szeredi /** The request input */ 223334f485dSMiklos Szeredi struct fuse_in { 224334f485dSMiklos Szeredi /** The request header */ 225334f485dSMiklos Szeredi struct fuse_in_header h; 226334f485dSMiklos Szeredi 227334f485dSMiklos Szeredi /** True if the data for the last argument is in req->pages */ 228334f485dSMiklos Szeredi unsigned argpages:1; 229334f485dSMiklos Szeredi 230334f485dSMiklos Szeredi /** Number of arguments */ 231334f485dSMiklos Szeredi unsigned numargs; 232334f485dSMiklos Szeredi 233334f485dSMiklos Szeredi /** Array of arguments */ 234334f485dSMiklos Szeredi struct fuse_in_arg args[3]; 235334f485dSMiklos Szeredi }; 236334f485dSMiklos Szeredi 237334f485dSMiklos Szeredi /** One output argument of a request */ 238334f485dSMiklos Szeredi struct fuse_arg { 239334f485dSMiklos Szeredi unsigned size; 240334f485dSMiklos Szeredi void *value; 241334f485dSMiklos Szeredi }; 242334f485dSMiklos Szeredi 243334f485dSMiklos Szeredi /** The request output */ 244334f485dSMiklos Szeredi struct fuse_out { 245334f485dSMiklos Szeredi /** Header returned from userspace */ 246334f485dSMiklos Szeredi struct fuse_out_header h; 247334f485dSMiklos Szeredi 248095da6cbSMiklos Szeredi /* 249095da6cbSMiklos Szeredi * The following bitfields are not changed during the request 250095da6cbSMiklos Szeredi * processing 251095da6cbSMiklos Szeredi */ 252095da6cbSMiklos Szeredi 253334f485dSMiklos Szeredi /** Last argument is variable length (can be shorter than 254334f485dSMiklos Szeredi arg->size) */ 255334f485dSMiklos Szeredi unsigned argvar:1; 256334f485dSMiklos Szeredi 257334f485dSMiklos Szeredi /** Last argument is a list of pages to copy data to */ 258334f485dSMiklos Szeredi unsigned argpages:1; 259334f485dSMiklos Szeredi 260334f485dSMiklos Szeredi /** Zero partially or not copied pages */ 261334f485dSMiklos Szeredi unsigned page_zeroing:1; 262334f485dSMiklos Szeredi 263ce534fb0SMiklos Szeredi /** Pages may be replaced with new ones */ 264ce534fb0SMiklos Szeredi unsigned page_replace:1; 265ce534fb0SMiklos Szeredi 266334f485dSMiklos Szeredi /** Number or arguments */ 267334f485dSMiklos Szeredi unsigned numargs; 268334f485dSMiklos Szeredi 269334f485dSMiklos Szeredi /** Array of arguments */ 270f704dcb5SMiklos Szeredi struct fuse_arg args[2]; 271334f485dSMiklos Szeredi }; 272334f485dSMiklos Szeredi 273b2430d75SMaxim Patlasov /** FUSE page descriptor */ 274b2430d75SMaxim Patlasov struct fuse_page_desc { 275b2430d75SMaxim Patlasov unsigned int length; 276b2430d75SMaxim Patlasov unsigned int offset; 277b2430d75SMaxim Patlasov }; 278b2430d75SMaxim Patlasov 2797078187aSMiklos Szeredi struct fuse_args { 2807078187aSMiklos Szeredi struct { 2817078187aSMiklos Szeredi struct { 2827078187aSMiklos Szeredi uint32_t opcode; 2837078187aSMiklos Szeredi uint64_t nodeid; 2847078187aSMiklos Szeredi } h; 2857078187aSMiklos Szeredi unsigned numargs; 2867078187aSMiklos Szeredi struct fuse_in_arg args[3]; 2877078187aSMiklos Szeredi 2887078187aSMiklos Szeredi } in; 2897078187aSMiklos Szeredi struct { 2907078187aSMiklos Szeredi unsigned argvar:1; 2917078187aSMiklos Szeredi unsigned numargs; 2927078187aSMiklos Szeredi struct fuse_arg args[2]; 2937078187aSMiklos Szeredi } out; 2947078187aSMiklos Szeredi }; 2957078187aSMiklos Szeredi 2967078187aSMiklos Szeredi #define FUSE_ARGS(args) struct fuse_args args = {} 2977078187aSMiklos Szeredi 29801e9d11aSMaxim Patlasov /** The request IO state (for asynchronous processing) */ 29901e9d11aSMaxim Patlasov struct fuse_io_priv { 300744742d6SSeth Forshee struct kref refcnt; 30101e9d11aSMaxim Patlasov int async; 30201e9d11aSMaxim Patlasov spinlock_t lock; 30301e9d11aSMaxim Patlasov unsigned reqs; 30401e9d11aSMaxim Patlasov ssize_t bytes; 30501e9d11aSMaxim Patlasov size_t size; 30601e9d11aSMaxim Patlasov __u64 offset; 30701e9d11aSMaxim Patlasov bool write; 30861c12b49SAshish Samant bool should_dirty; 30901e9d11aSMaxim Patlasov int err; 31001e9d11aSMaxim Patlasov struct kiocb *iocb; 3119d5722b7SChristoph Hellwig struct completion *done; 3127879c4e5SAshish Sangwan bool blocking; 31301e9d11aSMaxim Patlasov }; 31401e9d11aSMaxim Patlasov 315e1c0eecbSMiklos Szeredi #define FUSE_IO_PRIV_SYNC(i) \ 316744742d6SSeth Forshee { \ 3171e24edcaSPeter Zijlstra .refcnt = KREF_INIT(1), \ 318744742d6SSeth Forshee .async = 0, \ 319e1c0eecbSMiklos Szeredi .iocb = i, \ 320744742d6SSeth Forshee } 321744742d6SSeth Forshee 322334f485dSMiklos Szeredi /** 323825d6d33SMiklos Szeredi * Request flags 324825d6d33SMiklos Szeredi * 325825d6d33SMiklos Szeredi * FR_ISREPLY: set if the request has reply 326825d6d33SMiklos Szeredi * FR_FORCE: force sending of the request even if interrupted 327825d6d33SMiklos Szeredi * FR_BACKGROUND: request is sent in the background 328825d6d33SMiklos Szeredi * FR_WAITING: request is counted as "waiting" 329825d6d33SMiklos Szeredi * FR_ABORTED: the request was aborted 330825d6d33SMiklos Szeredi * FR_INTERRUPTED: the request has been interrupted 331825d6d33SMiklos Szeredi * FR_LOCKED: data is being copied to/from the request 33233e14b4dSMiklos Szeredi * FR_PENDING: request is not yet in userspace 33333e14b4dSMiklos Szeredi * FR_SENT: request is in userspace, waiting for an answer 33433e14b4dSMiklos Szeredi * FR_FINISHED: request is finished 33577cd9d48SMiklos Szeredi * FR_PRIVATE: request is on private list 336825d6d33SMiklos Szeredi */ 337825d6d33SMiklos Szeredi enum fuse_req_flag { 338825d6d33SMiklos Szeredi FR_ISREPLY, 339825d6d33SMiklos Szeredi FR_FORCE, 340825d6d33SMiklos Szeredi FR_BACKGROUND, 341825d6d33SMiklos Szeredi FR_WAITING, 342825d6d33SMiklos Szeredi FR_ABORTED, 343825d6d33SMiklos Szeredi FR_INTERRUPTED, 344825d6d33SMiklos Szeredi FR_LOCKED, 34533e14b4dSMiklos Szeredi FR_PENDING, 34633e14b4dSMiklos Szeredi FR_SENT, 34733e14b4dSMiklos Szeredi FR_FINISHED, 34877cd9d48SMiklos Szeredi FR_PRIVATE, 349825d6d33SMiklos Szeredi }; 350825d6d33SMiklos Szeredi 351825d6d33SMiklos Szeredi /** 352334f485dSMiklos Szeredi * A request to the client 353dc00809aSMiklos Szeredi * 354dc00809aSMiklos Szeredi * .waitq.lock protects the following fields: 355dc00809aSMiklos Szeredi * - FR_ABORTED 356dc00809aSMiklos Szeredi * - FR_LOCKED (may also be modified under fc->lock, tested under both) 357334f485dSMiklos Szeredi */ 358334f485dSMiklos Szeredi struct fuse_req { 359ce1d5a49SMiklos Szeredi /** This can be on either pending processing or io lists in 360ce1d5a49SMiklos Szeredi fuse_conn */ 361334f485dSMiklos Szeredi struct list_head list; 362334f485dSMiklos Szeredi 363a4d27e75SMiklos Szeredi /** Entry on the interrupts list */ 364a4d27e75SMiklos Szeredi struct list_head intr_entry; 365a4d27e75SMiklos Szeredi 366334f485dSMiklos Szeredi /** refcount */ 367ec99f6d3SElena Reshetova refcount_t count; 368334f485dSMiklos Szeredi 369825d6d33SMiklos Szeredi /* Request flags, updated with test/set/clear_bit() */ 370825d6d33SMiklos Szeredi unsigned long flags; 3719bc5dddaSMiklos Szeredi 372334f485dSMiklos Szeredi /** The request input */ 373334f485dSMiklos Szeredi struct fuse_in in; 374334f485dSMiklos Szeredi 375334f485dSMiklos Szeredi /** The request output */ 376334f485dSMiklos Szeredi struct fuse_out out; 377334f485dSMiklos Szeredi 378334f485dSMiklos Szeredi /** Used to wake up the task waiting for completion of request*/ 379334f485dSMiklos Szeredi wait_queue_head_t waitq; 380334f485dSMiklos Szeredi 381334f485dSMiklos Szeredi /** Data for asynchronous requests */ 382334f485dSMiklos Szeredi union { 383b57d4264SMiklos Szeredi struct { 384b57d4264SMiklos Szeredi struct fuse_release_in in; 385baebccbeSMiklos Szeredi struct inode *inode; 386b57d4264SMiklos Szeredi } release; 3873ec870d5SMiklos Szeredi struct fuse_init_in init_in; 3883ec870d5SMiklos Szeredi struct fuse_init_out init_out; 38908cbf542STejun Heo struct cuse_init_in cuse_init_in; 3905c5c5e51SMiklos Szeredi struct { 3915c5c5e51SMiklos Szeredi struct fuse_read_in in; 3925c5c5e51SMiklos Szeredi u64 attr_ver; 3935c5c5e51SMiklos Szeredi } read; 394b25e82e5SMiklos Szeredi struct { 395b25e82e5SMiklos Szeredi struct fuse_write_in in; 396b25e82e5SMiklos Szeredi struct fuse_write_out out; 3978b284dc4SMiklos Szeredi struct fuse_req *next; 398b25e82e5SMiklos Szeredi } write; 3992d45ba38SMiklos Szeredi struct fuse_notify_retrieve_in retrieve_in; 400334f485dSMiklos Szeredi } misc; 401334f485dSMiklos Szeredi 402334f485dSMiklos Szeredi /** page vector */ 4034250c066SMaxim Patlasov struct page **pages; 4044250c066SMaxim Patlasov 405b2430d75SMaxim Patlasov /** page-descriptor vector */ 406b2430d75SMaxim Patlasov struct fuse_page_desc *page_descs; 407b2430d75SMaxim Patlasov 4084250c066SMaxim Patlasov /** size of the 'pages' array */ 4094250c066SMaxim Patlasov unsigned max_pages; 4104250c066SMaxim Patlasov 4114250c066SMaxim Patlasov /** inline page vector */ 4124250c066SMaxim Patlasov struct page *inline_pages[FUSE_REQ_INLINE_PAGES]; 413334f485dSMiklos Szeredi 414b2430d75SMaxim Patlasov /** inline page-descriptor vector */ 415b2430d75SMaxim Patlasov struct fuse_page_desc inline_page_descs[FUSE_REQ_INLINE_PAGES]; 416b2430d75SMaxim Patlasov 417334f485dSMiklos Szeredi /** number of pages in vector */ 418334f485dSMiklos Szeredi unsigned num_pages; 419334f485dSMiklos Szeredi 420334f485dSMiklos Szeredi /** File used in the request (or NULL) */ 421c756e0a4SMiklos Szeredi struct fuse_file *ff; 42264c6d8edSMiklos Szeredi 4233be5a52bSMiklos Szeredi /** Inode used in the request or NULL */ 4243be5a52bSMiklos Szeredi struct inode *inode; 4253be5a52bSMiklos Szeredi 42601e9d11aSMaxim Patlasov /** AIO control block */ 42701e9d11aSMaxim Patlasov struct fuse_io_priv *io; 42801e9d11aSMaxim Patlasov 4293be5a52bSMiklos Szeredi /** Link on fi->writepages */ 4303be5a52bSMiklos Szeredi struct list_head writepages_entry; 4313be5a52bSMiklos Szeredi 43264c6d8edSMiklos Szeredi /** Request completion callback */ 43364c6d8edSMiklos Szeredi void (*end)(struct fuse_conn *, struct fuse_req *); 43433649c91SMiklos Szeredi 43533649c91SMiklos Szeredi /** Request is stolen from fuse_file->reserved_req */ 43633649c91SMiklos Szeredi struct file *stolen_file; 437334f485dSMiklos Szeredi }; 438334f485dSMiklos Szeredi 439f88996a9SMiklos Szeredi struct fuse_iqueue { 440e16714d8SMiklos Szeredi /** Connection established */ 441e16714d8SMiklos Szeredi unsigned connected; 442e16714d8SMiklos Szeredi 443f88996a9SMiklos Szeredi /** Readers of the connection are waiting on this */ 444f88996a9SMiklos Szeredi wait_queue_head_t waitq; 445f88996a9SMiklos Szeredi 446f88996a9SMiklos Szeredi /** The next unique request id */ 447f88996a9SMiklos Szeredi u64 reqctr; 448f88996a9SMiklos Szeredi 449f88996a9SMiklos Szeredi /** The list of pending requests */ 450f88996a9SMiklos Szeredi struct list_head pending; 451f88996a9SMiklos Szeredi 452f88996a9SMiklos Szeredi /** Pending interrupts */ 453f88996a9SMiklos Szeredi struct list_head interrupts; 454f88996a9SMiklos Szeredi 455f88996a9SMiklos Szeredi /** Queue of pending forgets */ 456f88996a9SMiklos Szeredi struct fuse_forget_link forget_list_head; 457f88996a9SMiklos Szeredi struct fuse_forget_link *forget_list_tail; 458f88996a9SMiklos Szeredi 459f88996a9SMiklos Szeredi /** Batching of FORGET requests (positive indicates FORGET batch) */ 460f88996a9SMiklos Szeredi int forget_batch; 461f88996a9SMiklos Szeredi 462f88996a9SMiklos Szeredi /** O_ASYNC requests */ 463f88996a9SMiklos Szeredi struct fasync_struct *fasync; 464f88996a9SMiklos Szeredi }; 465f88996a9SMiklos Szeredi 466be2ff42cSKirill Tkhai #define FUSE_PQ_HASH_BITS 8 467be2ff42cSKirill Tkhai #define FUSE_PQ_HASH_SIZE (1 << FUSE_PQ_HASH_BITS) 468be2ff42cSKirill Tkhai 4693a2b5b9cSMiklos Szeredi struct fuse_pqueue { 470e96edd94SMiklos Szeredi /** Connection established */ 471e96edd94SMiklos Szeredi unsigned connected; 472e96edd94SMiklos Szeredi 47345a91cb1SMiklos Szeredi /** Lock protecting accessess to members of this structure */ 47445a91cb1SMiklos Szeredi spinlock_t lock; 47545a91cb1SMiklos Szeredi 476be2ff42cSKirill Tkhai /** Hash table of requests being processed */ 477be2ff42cSKirill Tkhai struct list_head *processing; 4783a2b5b9cSMiklos Szeredi 4793a2b5b9cSMiklos Szeredi /** The list of requests under I/O */ 4803a2b5b9cSMiklos Szeredi struct list_head io; 4813a2b5b9cSMiklos Szeredi }; 4823a2b5b9cSMiklos Szeredi 483d8a5ba45SMiklos Szeredi /** 484cc080e9eSMiklos Szeredi * Fuse device instance 485cc080e9eSMiklos Szeredi */ 486cc080e9eSMiklos Szeredi struct fuse_dev { 487cc080e9eSMiklos Szeredi /** Fuse connection for this device */ 488cc080e9eSMiklos Szeredi struct fuse_conn *fc; 489cc080e9eSMiklos Szeredi 490c3696046SMiklos Szeredi /** Processing queue */ 491c3696046SMiklos Szeredi struct fuse_pqueue pq; 492c3696046SMiklos Szeredi 493cc080e9eSMiklos Szeredi /** list entry on fc->devices */ 494cc080e9eSMiklos Szeredi struct list_head entry; 495cc080e9eSMiklos Szeredi }; 496cc080e9eSMiklos Szeredi 497cc080e9eSMiklos Szeredi /** 498d8a5ba45SMiklos Szeredi * A Fuse connection. 499d8a5ba45SMiklos Szeredi * 500d8a5ba45SMiklos Szeredi * This structure is created, when the filesystem is mounted, and is 501d8a5ba45SMiklos Szeredi * destroyed, when the client device is closed and the filesystem is 502d8a5ba45SMiklos Szeredi * unmounted. 503d8a5ba45SMiklos Szeredi */ 504d8a5ba45SMiklos Szeredi struct fuse_conn { 505d7133114SMiklos Szeredi /** Lock protecting accessess to members of this structure */ 506d7133114SMiklos Szeredi spinlock_t lock; 507d7133114SMiklos Szeredi 508bafa9654SMiklos Szeredi /** Refcount */ 509095fc40aSElena Reshetova refcount_t count; 510bafa9654SMiklos Szeredi 511c3696046SMiklos Szeredi /** Number of fuse_dev's */ 512c3696046SMiklos Szeredi atomic_t dev_count; 513c3696046SMiklos Szeredi 514dd3e2c55SAl Viro struct rcu_head rcu; 515dd3e2c55SAl Viro 516d8a5ba45SMiklos Szeredi /** The user id for this mount */ 517499dcf20SEric W. Biederman kuid_t user_id; 518d8a5ba45SMiklos Szeredi 51987729a55SMiklos Szeredi /** The group id for this mount */ 520499dcf20SEric W. Biederman kgid_t group_id; 52187729a55SMiklos Szeredi 5220b6e9ea0SSeth Forshee /** The pid namespace for this mount */ 5230b6e9ea0SSeth Forshee struct pid_namespace *pid_ns; 5240b6e9ea0SSeth Forshee 5258cb08329SEric W. Biederman /** The user namespace for this mount */ 5268cb08329SEric W. Biederman struct user_namespace *user_ns; 5278cb08329SEric W. Biederman 528db50b96cSMiklos Szeredi /** Maximum read size */ 529db50b96cSMiklos Szeredi unsigned max_read; 530db50b96cSMiklos Szeredi 531413ef8cbSMiklos Szeredi /** Maximum write size */ 532413ef8cbSMiklos Szeredi unsigned max_write; 533413ef8cbSMiklos Szeredi 5345da784ccSConstantine Shulyupin /** Maxmum number of pages that can be used in a single request */ 5355da784ccSConstantine Shulyupin unsigned int max_pages; 5365da784ccSConstantine Shulyupin 537f88996a9SMiklos Szeredi /** Input queue */ 538f88996a9SMiklos Szeredi struct fuse_iqueue iq; 539334f485dSMiklos Szeredi 540acf99433STejun Heo /** The next unique kernel file handle */ 541acf99433STejun Heo u64 khctr; 542acf99433STejun Heo 54395668a69STejun Heo /** rbtree of fuse_files waiting for poll events indexed by ph */ 54495668a69STejun Heo struct rb_root polled_files; 54595668a69STejun Heo 5467a6d3c8bSCsaba Henk /** Maximum number of outstanding background requests */ 5477a6d3c8bSCsaba Henk unsigned max_background; 5487a6d3c8bSCsaba Henk 5497a6d3c8bSCsaba Henk /** Number of background requests at which congestion starts */ 5507a6d3c8bSCsaba Henk unsigned congestion_threshold; 5517a6d3c8bSCsaba Henk 55208a53cdcSMiklos Szeredi /** Number of requests currently in the background */ 55308a53cdcSMiklos Szeredi unsigned num_background; 55408a53cdcSMiklos Szeredi 555d12def1bSMiklos Szeredi /** Number of background requests currently queued for userspace */ 556d12def1bSMiklos Szeredi unsigned active_background; 557d12def1bSMiklos Szeredi 558d12def1bSMiklos Szeredi /** The list of background requests set aside for later queuing */ 559d12def1bSMiklos Szeredi struct list_head bg_queue; 560d12def1bSMiklos Szeredi 561ae2dffa3SKirill Tkhai /** Protects: max_background, congestion_threshold, num_background, 562ae2dffa3SKirill Tkhai * active_background, bg_queue, blocked */ 563ae2dffa3SKirill Tkhai spinlock_t bg_lock; 564ae2dffa3SKirill Tkhai 565796523fbSMaxim Patlasov /** Flag indicating that INIT reply has been received. Allocating 566796523fbSMaxim Patlasov * any fuse request will be suspended until the flag is set */ 567796523fbSMaxim Patlasov int initialized; 568796523fbSMaxim Patlasov 56908a53cdcSMiklos Szeredi /** Flag indicating if connection is blocked. This will be 57008a53cdcSMiklos Szeredi the case before the INIT reply is received, and if there 57108a53cdcSMiklos Szeredi are too many outstading backgrounds requests */ 57208a53cdcSMiklos Szeredi int blocked; 57308a53cdcSMiklos Szeredi 57408a53cdcSMiklos Szeredi /** waitq for blocked connection */ 57508a53cdcSMiklos Szeredi wait_queue_head_t blocked_waitq; 57608a53cdcSMiklos Szeredi 577de5e3decSMiklos Szeredi /** waitq for reserved requests */ 578de5e3decSMiklos Szeredi wait_queue_head_t reserved_req_waitq; 579de5e3decSMiklos Szeredi 58069a53bf2SMiklos Szeredi /** Connection established, cleared on umount, connection 58169a53bf2SMiklos Szeredi abort and device release */ 582095da6cbSMiklos Szeredi unsigned connected; 5831e9a4ed9SMiklos Szeredi 5843b7008b2SSzymon Lukasz /** Connection aborted via sysfs */ 5853b7008b2SSzymon Lukasz bool aborted; 5863b7008b2SSzymon Lukasz 587095da6cbSMiklos Szeredi /** Connection failed (version mismatch). Cannot race with 588095da6cbSMiklos Szeredi setting other bitfields since it is only set once in INIT 589095da6cbSMiklos Szeredi reply, before any other request, and never cleared */ 590334f485dSMiklos Szeredi unsigned conn_error:1; 591334f485dSMiklos Szeredi 5920ec7ca41SMiklos Szeredi /** Connection successful. Only set in INIT */ 5930ec7ca41SMiklos Szeredi unsigned conn_init:1; 5940ec7ca41SMiklos Szeredi 5959cd68455SMiklos Szeredi /** Do readpages asynchronously? Only set in INIT */ 5969cd68455SMiklos Szeredi unsigned async_read:1; 5979cd68455SMiklos Szeredi 5983b7008b2SSzymon Lukasz /** Return an unique read error after abort. Only set in INIT */ 5993b7008b2SSzymon Lukasz unsigned abort_err:1; 6003b7008b2SSzymon Lukasz 6016ff958edSMiklos Szeredi /** Do not send separate SETATTR request before open(O_TRUNC) */ 6026ff958edSMiklos Szeredi unsigned atomic_o_trunc:1; 6036ff958edSMiklos Szeredi 60433670fa2SMiklos Szeredi /** Filesystem supports NFS exporting. Only set in INIT */ 60533670fa2SMiklos Szeredi unsigned export_support:1; 60633670fa2SMiklos Szeredi 607d5cd66c5SPavel Emelyanov /** write-back cache policy (default is write-through) */ 608d5cd66c5SPavel Emelyanov unsigned writeback_cache:1; 609d5cd66c5SPavel Emelyanov 6105c672ab3SMiklos Szeredi /** allow parallel lookups and readdir (default is serialized) */ 6115c672ab3SMiklos Szeredi unsigned parallel_dirops:1; 6125c672ab3SMiklos Szeredi 6135e940c1dSMiklos Szeredi /** handle fs handles killing suid/sgid/cap on write/chown/trunc */ 6145e940c1dSMiklos Szeredi unsigned handle_killpriv:1; 6155e940c1dSMiklos Szeredi 6165571f1e6SDan Schatzberg /** cache READLINK responses in page cache */ 6175571f1e6SDan Schatzberg unsigned cache_symlinks:1; 6185571f1e6SDan Schatzberg 619095da6cbSMiklos Szeredi /* 620095da6cbSMiklos Szeredi * The following bitfields are only for optimization purposes 621095da6cbSMiklos Szeredi * and hence races in setting them will not cause malfunction 622095da6cbSMiklos Szeredi */ 623095da6cbSMiklos Szeredi 6247678ac50SAndrew Gallagher /** Is open/release not implemented by fs? */ 6257678ac50SAndrew Gallagher unsigned no_open:1; 6267678ac50SAndrew Gallagher 627b6aeadedSMiklos Szeredi /** Is fsync not implemented by fs? */ 628b6aeadedSMiklos Szeredi unsigned no_fsync:1; 629b6aeadedSMiklos Szeredi 63082547981SMiklos Szeredi /** Is fsyncdir not implemented by fs? */ 63182547981SMiklos Szeredi unsigned no_fsyncdir:1; 63282547981SMiklos Szeredi 633b6aeadedSMiklos Szeredi /** Is flush not implemented by fs? */ 634b6aeadedSMiklos Szeredi unsigned no_flush:1; 635b6aeadedSMiklos Szeredi 63692a8780eSMiklos Szeredi /** Is setxattr not implemented by fs? */ 63792a8780eSMiklos Szeredi unsigned no_setxattr:1; 63892a8780eSMiklos Szeredi 63992a8780eSMiklos Szeredi /** Is getxattr not implemented by fs? */ 64092a8780eSMiklos Szeredi unsigned no_getxattr:1; 64192a8780eSMiklos Szeredi 64292a8780eSMiklos Szeredi /** Is listxattr not implemented by fs? */ 64392a8780eSMiklos Szeredi unsigned no_listxattr:1; 64492a8780eSMiklos Szeredi 64592a8780eSMiklos Szeredi /** Is removexattr not implemented by fs? */ 64692a8780eSMiklos Szeredi unsigned no_removexattr:1; 64792a8780eSMiklos Szeredi 64837fb3a30SMiklos Szeredi /** Are posix file locking primitives not implemented by fs? */ 64971421259SMiklos Szeredi unsigned no_lock:1; 65071421259SMiklos Szeredi 65131d40d74SMiklos Szeredi /** Is access not implemented by fs? */ 65231d40d74SMiklos Szeredi unsigned no_access:1; 65331d40d74SMiklos Szeredi 654fd72faacSMiklos Szeredi /** Is create not implemented by fs? */ 655fd72faacSMiklos Szeredi unsigned no_create:1; 656fd72faacSMiklos Szeredi 657a4d27e75SMiklos Szeredi /** Is interrupt not implemented by fs? */ 658a4d27e75SMiklos Szeredi unsigned no_interrupt:1; 659a4d27e75SMiklos Szeredi 660b2d2272fSMiklos Szeredi /** Is bmap not implemented by fs? */ 661b2d2272fSMiklos Szeredi unsigned no_bmap:1; 662b2d2272fSMiklos Szeredi 66395668a69STejun Heo /** Is poll not implemented by fs? */ 66495668a69STejun Heo unsigned no_poll:1; 66595668a69STejun Heo 66678bb6cb9SMiklos Szeredi /** Do multi-page cached writes */ 66778bb6cb9SMiklos Szeredi unsigned big_writes:1; 66878bb6cb9SMiklos Szeredi 669e0a43ddcSMiklos Szeredi /** Don't apply umask to creation modes */ 670e0a43ddcSMiklos Szeredi unsigned dont_mask:1; 671e0a43ddcSMiklos Szeredi 67237fb3a30SMiklos Szeredi /** Are BSD file locking primitives not implemented by fs? */ 67337fb3a30SMiklos Szeredi unsigned no_flock:1; 67437fb3a30SMiklos Szeredi 675519c6040SMiklos Szeredi /** Is fallocate not implemented by fs? */ 676519c6040SMiklos Szeredi unsigned no_fallocate:1; 677519c6040SMiklos Szeredi 6781560c974SMiklos Szeredi /** Is rename with flags implemented by fs? */ 6791560c974SMiklos Szeredi unsigned no_rename2:1; 6801560c974SMiklos Szeredi 68172d0d248SBrian Foster /** Use enhanced/automatic page cache invalidation. */ 68272d0d248SBrian Foster unsigned auto_inval_data:1; 68372d0d248SBrian Foster 684634734b6SEric Wong /** Does the filesystem support readdirplus? */ 6850b05b183SAnand V. Avati unsigned do_readdirplus:1; 6860b05b183SAnand V. Avati 687634734b6SEric Wong /** Does the filesystem want adaptive readdirplus? */ 688634734b6SEric Wong unsigned readdirplus_auto:1; 689634734b6SEric Wong 69060b9df7aSMiklos Szeredi /** Does the filesystem support asynchronous direct-IO submission? */ 69160b9df7aSMiklos Szeredi unsigned async_dio:1; 69260b9df7aSMiklos Szeredi 6930b5da8dbSRavishankar N /** Is lseek not implemented by fs? */ 6940b5da8dbSRavishankar N unsigned no_lseek:1; 6950b5da8dbSRavishankar N 69660bcc88aSSeth Forshee /** Does the filesystem support posix acls? */ 69760bcc88aSSeth Forshee unsigned posix_acl:1; 69860bcc88aSSeth Forshee 69929433a29SMiklos Szeredi /** Check permissions based on the file mode or not? */ 70029433a29SMiklos Szeredi unsigned default_permissions:1; 70129433a29SMiklos Szeredi 70229433a29SMiklos Szeredi /** Allow other than the mounter user to access the filesystem ? */ 70329433a29SMiklos Szeredi unsigned allow_other:1; 70429433a29SMiklos Szeredi 70588bc7d50SNiels de Vos /** Does the filesystem support copy_file_range? */ 70688bc7d50SNiels de Vos unsigned no_copy_file_range:1; 70788bc7d50SNiels de Vos 7080cd5b885SMiklos Szeredi /** The number of requests waiting for completion */ 7090cd5b885SMiklos Szeredi atomic_t num_waiting; 7100cd5b885SMiklos Szeredi 71145714d65SMiklos Szeredi /** Negotiated minor version */ 71245714d65SMiklos Szeredi unsigned minor; 71345714d65SMiklos Szeredi 714bafa9654SMiklos Szeredi /** Entry on the fuse_conn_list */ 715bafa9654SMiklos Szeredi struct list_head entry; 716bafa9654SMiklos Szeredi 717b6f2fcbcSMiklos Szeredi /** Device ID from super block */ 718b6f2fcbcSMiklos Szeredi dev_t dev; 719bafa9654SMiklos Szeredi 720bafa9654SMiklos Szeredi /** Dentries in the control filesystem */ 721bafa9654SMiklos Szeredi struct dentry *ctl_dentry[FUSE_CTL_NUM_DENTRIES]; 722bafa9654SMiklos Szeredi 723bafa9654SMiklos Szeredi /** number of dentries used in the above array */ 724bafa9654SMiklos Szeredi int ctl_ndents; 725385a17bfSJeff Dike 7269c8ef561SMiklos Szeredi /** Key for lock owner ID scrambling */ 7279c8ef561SMiklos Szeredi u32 scramble_key[4]; 7280ec7ca41SMiklos Szeredi 7290ec7ca41SMiklos Szeredi /** Reserved request for the DESTROY message */ 7300ec7ca41SMiklos Szeredi struct fuse_req *destroy_req; 7311fb69e78SMiklos Szeredi 7321fb69e78SMiklos Szeredi /** Version counter for attribute changes */ 7331fb69e78SMiklos Szeredi u64 attr_version; 73443901aabSTejun Heo 73543901aabSTejun Heo /** Called on final put */ 73643901aabSTejun Heo void (*release)(struct fuse_conn *); 7373b463ae0SJohn Muir 7383b463ae0SJohn Muir /** Super block for this connection. */ 7393b463ae0SJohn Muir struct super_block *sb; 7403b463ae0SJohn Muir 7413b463ae0SJohn Muir /** Read/write semaphore to hold when accessing sb. */ 7423b463ae0SJohn Muir struct rw_semaphore killsb; 743cc080e9eSMiklos Szeredi 744cc080e9eSMiklos Szeredi /** List of device instances belonging to this connection */ 745cc080e9eSMiklos Szeredi struct list_head devices; 746d8a5ba45SMiklos Szeredi }; 747d8a5ba45SMiklos Szeredi 748d8a5ba45SMiklos Szeredi static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb) 749d8a5ba45SMiklos Szeredi { 7506383bdaaSMiklos Szeredi return sb->s_fs_info; 751d8a5ba45SMiklos Szeredi } 752d8a5ba45SMiklos Szeredi 753d8a5ba45SMiklos Szeredi static inline struct fuse_conn *get_fuse_conn(struct inode *inode) 754d8a5ba45SMiklos Szeredi { 755d8a5ba45SMiklos Szeredi return get_fuse_conn_super(inode->i_sb); 756d8a5ba45SMiklos Szeredi } 757d8a5ba45SMiklos Szeredi 758d8a5ba45SMiklos Szeredi static inline struct fuse_inode *get_fuse_inode(struct inode *inode) 759d8a5ba45SMiklos Szeredi { 760d8a5ba45SMiklos Szeredi return container_of(inode, struct fuse_inode, inode); 761d8a5ba45SMiklos Szeredi } 762d8a5ba45SMiklos Szeredi 763d8a5ba45SMiklos Szeredi static inline u64 get_node_id(struct inode *inode) 764d8a5ba45SMiklos Szeredi { 765d8a5ba45SMiklos Szeredi return get_fuse_inode(inode)->nodeid; 766d8a5ba45SMiklos Szeredi } 767d8a5ba45SMiklos Szeredi 768d123d8e1SMiklos Szeredi static inline int invalid_nodeid(u64 nodeid) 769d123d8e1SMiklos Szeredi { 770d123d8e1SMiklos Szeredi return !nodeid || nodeid == FUSE_ROOT_ID; 771d123d8e1SMiklos Szeredi } 772d123d8e1SMiklos Szeredi 773334f485dSMiklos Szeredi /** Device operations */ 7744b6f5d20SArjan van de Ven extern const struct file_operations fuse_dev_operations; 775334f485dSMiklos Szeredi 7764269590aSAl Viro extern const struct dentry_operations fuse_dentry_operations; 7770ce267ffSMiklos Szeredi extern const struct dentry_operations fuse_root_dentry_operations; 778dbd561d2SMiklos Szeredi 779d8a5ba45SMiklos Szeredi /** 7803b463ae0SJohn Muir * Inode to nodeid comparison. 7813b463ae0SJohn Muir */ 7823b463ae0SJohn Muir int fuse_inode_eq(struct inode *inode, void *_nodeidp); 7833b463ae0SJohn Muir 7843b463ae0SJohn Muir /** 785e5e5558eSMiklos Szeredi * Get a filled in inode 786e5e5558eSMiklos Szeredi */ 787b48badf0SMiklos Szeredi struct inode *fuse_iget(struct super_block *sb, u64 nodeid, 7881fb69e78SMiklos Szeredi int generation, struct fuse_attr *attr, 7891fb69e78SMiklos Szeredi u64 attr_valid, u64 attr_version); 790e5e5558eSMiklos Szeredi 79113983d06SAl Viro int fuse_lookup_name(struct super_block *sb, u64 nodeid, const struct qstr *name, 79233670fa2SMiklos Szeredi struct fuse_entry_out *outarg, struct inode **inode); 79333670fa2SMiklos Szeredi 794e5e5558eSMiklos Szeredi /** 795e5e5558eSMiklos Szeredi * Send FORGET command 796e5e5558eSMiklos Szeredi */ 79707e77dcaSMiklos Szeredi void fuse_queue_forget(struct fuse_conn *fc, struct fuse_forget_link *forget, 798b48badf0SMiklos Szeredi u64 nodeid, u64 nlookup); 799e5e5558eSMiklos Szeredi 80007e77dcaSMiklos Szeredi struct fuse_forget_link *fuse_alloc_forget(void); 80107e77dcaSMiklos Szeredi 8020b05b183SAnand V. Avati /* Used by READDIRPLUS */ 8030b05b183SAnand V. Avati void fuse_force_forget(struct file *file, u64 nodeid); 8040b05b183SAnand V. Avati 805e5e5558eSMiklos Szeredi /** 806361b1eb5SMiklos Szeredi * Initialize READ or READDIR request 80704730fefSMiklos Szeredi */ 808a6643094SMiklos Szeredi void fuse_read_fill(struct fuse_req *req, struct file *file, 8092106cb18SMiklos Szeredi loff_t pos, size_t count, int opcode); 81004730fefSMiklos Szeredi 81104730fefSMiklos Szeredi /** 81204730fefSMiklos Szeredi * Send OPEN or OPENDIR request 81304730fefSMiklos Szeredi */ 81491fe96b4SMiklos Szeredi int fuse_open_common(struct inode *inode, struct file *file, bool isdir); 81504730fefSMiklos Szeredi 816acf99433STejun Heo struct fuse_file *fuse_file_alloc(struct fuse_conn *fc); 817fd72faacSMiklos Szeredi void fuse_file_free(struct fuse_file *ff); 818c7b7143cSMiklos Szeredi void fuse_finish_open(struct inode *inode, struct file *file); 819fd72faacSMiklos Szeredi 8208b0797a4SMiklos Szeredi void fuse_sync_release(struct fuse_file *ff, int flags); 821c756e0a4SMiklos Szeredi 82204730fefSMiklos Szeredi /** 82304730fefSMiklos Szeredi * Send RELEASE or RELEASEDIR request 82404730fefSMiklos Szeredi */ 8258b0797a4SMiklos Szeredi void fuse_release_common(struct file *file, int opcode); 82604730fefSMiklos Szeredi 82704730fefSMiklos Szeredi /** 82882547981SMiklos Szeredi * Send FSYNC or FSYNCDIR request 82982547981SMiklos Szeredi */ 83002c24a82SJosef Bacik int fuse_fsync_common(struct file *file, loff_t start, loff_t end, 831*a9c2d1e8SMiklos Szeredi int datasync, int opcode); 83282547981SMiklos Szeredi 83382547981SMiklos Szeredi /** 83495668a69STejun Heo * Notify poll wakeup 83595668a69STejun Heo */ 83695668a69STejun Heo int fuse_notify_poll_wakeup(struct fuse_conn *fc, 83795668a69STejun Heo struct fuse_notify_poll_wakeup_out *outarg); 83895668a69STejun Heo 83995668a69STejun Heo /** 8401779381dSMiklos Szeredi * Initialize file operations on a regular file 841b6aeadedSMiklos Szeredi */ 842b6aeadedSMiklos Szeredi void fuse_init_file_inode(struct inode *inode); 843b6aeadedSMiklos Szeredi 844b6aeadedSMiklos Szeredi /** 8451779381dSMiklos Szeredi * Initialize inode operations on regular files and special files 846e5e5558eSMiklos Szeredi */ 847e5e5558eSMiklos Szeredi void fuse_init_common(struct inode *inode); 848e5e5558eSMiklos Szeredi 849e5e5558eSMiklos Szeredi /** 8501779381dSMiklos Szeredi * Initialize inode and file operations on a directory 851e5e5558eSMiklos Szeredi */ 852e5e5558eSMiklos Szeredi void fuse_init_dir(struct inode *inode); 853e5e5558eSMiklos Szeredi 854e5e5558eSMiklos Szeredi /** 8551779381dSMiklos Szeredi * Initialize inode operations on a symlink 856e5e5558eSMiklos Szeredi */ 857e5e5558eSMiklos Szeredi void fuse_init_symlink(struct inode *inode); 858e5e5558eSMiklos Szeredi 859e5e5558eSMiklos Szeredi /** 860e5e5558eSMiklos Szeredi * Change attributes of an inode 861e5e5558eSMiklos Szeredi */ 8621fb69e78SMiklos Szeredi void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr, 8631fb69e78SMiklos Szeredi u64 attr_valid, u64 attr_version); 864e5e5558eSMiklos Szeredi 8653be5a52bSMiklos Szeredi void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr, 8663be5a52bSMiklos Szeredi u64 attr_valid); 8673be5a52bSMiklos Szeredi 868e5e5558eSMiklos Szeredi /** 869334f485dSMiklos Szeredi * Initialize the client device 870334f485dSMiklos Szeredi */ 871334f485dSMiklos Szeredi int fuse_dev_init(void); 872334f485dSMiklos Szeredi 873334f485dSMiklos Szeredi /** 874334f485dSMiklos Szeredi * Cleanup the client device 875334f485dSMiklos Szeredi */ 876334f485dSMiklos Szeredi void fuse_dev_cleanup(void); 877334f485dSMiklos Szeredi 878bafa9654SMiklos Szeredi int fuse_ctl_init(void); 8797736e8ccSFabian Frederick void __exit fuse_ctl_cleanup(void); 880bafa9654SMiklos Szeredi 881334f485dSMiklos Szeredi /** 882334f485dSMiklos Szeredi * Allocate a request 883334f485dSMiklos Szeredi */ 8844250c066SMaxim Patlasov struct fuse_req *fuse_request_alloc(unsigned npages); 885334f485dSMiklos Szeredi 8864250c066SMaxim Patlasov struct fuse_req *fuse_request_alloc_nofs(unsigned npages); 8873be5a52bSMiklos Szeredi 888e52a8250SMiklos Szeredi bool fuse_req_realloc_pages(struct fuse_conn *fc, struct fuse_req *req, 889e52a8250SMiklos Szeredi gfp_t flags); 890e52a8250SMiklos Szeredi 891e52a8250SMiklos Szeredi 892334f485dSMiklos Szeredi /** 893334f485dSMiklos Szeredi * Free a request 894334f485dSMiklos Szeredi */ 895334f485dSMiklos Szeredi void fuse_request_free(struct fuse_req *req); 896334f485dSMiklos Szeredi 897334f485dSMiklos Szeredi /** 898b111c8c0SMaxim Patlasov * Get a request, may fail with -ENOMEM, 899b111c8c0SMaxim Patlasov * caller should specify # elements in req->pages[] explicitly 900334f485dSMiklos Szeredi */ 901b111c8c0SMaxim Patlasov struct fuse_req *fuse_get_req(struct fuse_conn *fc, unsigned npages); 9028b41e671SMaxim Patlasov struct fuse_req *fuse_get_req_for_background(struct fuse_conn *fc, 9038b41e671SMaxim Patlasov unsigned npages); 904b111c8c0SMaxim Patlasov 90536cf66edSMaxim Patlasov /* 90636cf66edSMaxim Patlasov * Increment reference count on request 90736cf66edSMaxim Patlasov */ 90836cf66edSMaxim Patlasov void __fuse_get_request(struct fuse_req *req); 90936cf66edSMaxim Patlasov 910b111c8c0SMaxim Patlasov /** 91133649c91SMiklos Szeredi * Gets a requests for a file operation, always succeeds 91233649c91SMiklos Szeredi */ 913b111c8c0SMaxim Patlasov struct fuse_req *fuse_get_req_nofail_nopages(struct fuse_conn *fc, 914b111c8c0SMaxim Patlasov struct file *file); 91533649c91SMiklos Szeredi 91633649c91SMiklos Szeredi /** 917ce1d5a49SMiklos Szeredi * Decrement reference count of a request. If count goes to zero free 918ce1d5a49SMiklos Szeredi * the request. 919334f485dSMiklos Szeredi */ 920334f485dSMiklos Szeredi void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req); 921334f485dSMiklos Szeredi 922334f485dSMiklos Szeredi /** 9237c352bdfSMiklos Szeredi * Send a request (synchronous) 924334f485dSMiklos Szeredi */ 925b93f858aSTejun Heo void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req); 926334f485dSMiklos Szeredi 927334f485dSMiklos Szeredi /** 9287078187aSMiklos Szeredi * Simple request sending that does request allocation and freeing 9297078187aSMiklos Szeredi */ 9307078187aSMiklos Szeredi ssize_t fuse_simple_request(struct fuse_conn *fc, struct fuse_args *args); 9317078187aSMiklos Szeredi 9327078187aSMiklos Szeredi /** 933334f485dSMiklos Szeredi * Send a request in the background 934334f485dSMiklos Szeredi */ 935b93f858aSTejun Heo void fuse_request_send_background(struct fuse_conn *fc, struct fuse_req *req); 93663825b4eSKirill Tkhai bool fuse_request_queue_background(struct fuse_conn *fc, struct fuse_req *req); 9373be5a52bSMiklos Szeredi 9385a5fb1eaSMiklos Szeredi /* Abort all requests */ 9393b7008b2SSzymon Lukasz void fuse_abort_conn(struct fuse_conn *fc, bool is_abort); 940b8f95e5dSMiklos Szeredi void fuse_wait_aborted(struct fuse_conn *fc); 94169a53bf2SMiklos Szeredi 9421e9a4ed9SMiklos Szeredi /** 943e5e5558eSMiklos Szeredi * Invalidate inode attributes 944e5e5558eSMiklos Szeredi */ 945e5e5558eSMiklos Szeredi void fuse_invalidate_attr(struct inode *inode); 946bafa9654SMiklos Szeredi 947dbd561d2SMiklos Szeredi void fuse_invalidate_entry_cache(struct dentry *entry); 948dbd561d2SMiklos Szeredi 949451418fcSAndrew Gallagher void fuse_invalidate_atime(struct inode *inode); 950451418fcSAndrew Gallagher 951d123d8e1SMiklos Szeredi u64 entry_attr_timeout(struct fuse_entry_out *o); 952d123d8e1SMiklos Szeredi void fuse_change_entry_timeout(struct dentry *entry, struct fuse_entry_out *o); 953d123d8e1SMiklos Szeredi 954bafa9654SMiklos Szeredi /** 955bafa9654SMiklos Szeredi * Acquire reference to fuse_conn 956bafa9654SMiklos Szeredi */ 957bafa9654SMiklos Szeredi struct fuse_conn *fuse_conn_get(struct fuse_conn *fc); 958bafa9654SMiklos Szeredi 959bafa9654SMiklos Szeredi /** 9600d179aa5STejun Heo * Initialize fuse_conn 9610d179aa5STejun Heo */ 9628cb08329SEric W. Biederman void fuse_conn_init(struct fuse_conn *fc, struct user_namespace *user_ns); 9630d179aa5STejun Heo 9640d179aa5STejun Heo /** 965bafa9654SMiklos Szeredi * Release reference to fuse_conn 966bafa9654SMiklos Szeredi */ 967bafa9654SMiklos Szeredi void fuse_conn_put(struct fuse_conn *fc); 968bafa9654SMiklos Szeredi 969cc080e9eSMiklos Szeredi struct fuse_dev *fuse_dev_alloc(struct fuse_conn *fc); 970cc080e9eSMiklos Szeredi void fuse_dev_free(struct fuse_dev *fud); 971cc080e9eSMiklos Szeredi 972bafa9654SMiklos Szeredi /** 973bafa9654SMiklos Szeredi * Add connection to control filesystem 974bafa9654SMiklos Szeredi */ 975bafa9654SMiklos Szeredi int fuse_ctl_add_conn(struct fuse_conn *fc); 976bafa9654SMiklos Szeredi 977bafa9654SMiklos Szeredi /** 978bafa9654SMiklos Szeredi * Remove connection from control filesystem 979bafa9654SMiklos Szeredi */ 980bafa9654SMiklos Szeredi void fuse_ctl_remove_conn(struct fuse_conn *fc); 981a5bfffacSTimo Savola 982a5bfffacSTimo Savola /** 983a5bfffacSTimo Savola * Is file type valid? 984a5bfffacSTimo Savola */ 985a5bfffacSTimo Savola int fuse_valid_type(int m); 986e57ac683SMiklos Szeredi 987e57ac683SMiklos Szeredi /** 988c2132c1bSAnatol Pomozov * Is current process allowed to perform filesystem operation? 989e57ac683SMiklos Szeredi */ 990c2132c1bSAnatol Pomozov int fuse_allow_current_process(struct fuse_conn *fc); 991f3332114SMiklos Szeredi 992f3332114SMiklos Szeredi u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id); 993bcb4be80SMiklos Szeredi 994703c7362SSeth Forshee void fuse_update_ctime(struct inode *inode); 995703c7362SSeth Forshee 9965b97eeacSMiklos Szeredi int fuse_update_attributes(struct inode *inode, struct file *file); 9973be5a52bSMiklos Szeredi 9983be5a52bSMiklos Szeredi void fuse_flush_writepages(struct inode *inode); 9993be5a52bSMiklos Szeredi 10003be5a52bSMiklos Szeredi void fuse_set_nowrite(struct inode *inode); 10013be5a52bSMiklos Szeredi void fuse_release_nowrite(struct inode *inode); 10025c5c5e51SMiklos Szeredi 10035c5c5e51SMiklos Szeredi u64 fuse_get_attr_version(struct fuse_conn *fc); 100429d434b3STejun Heo 10053b463ae0SJohn Muir /** 10063b463ae0SJohn Muir * File-system tells the kernel to invalidate cache for the given node id. 10073b463ae0SJohn Muir */ 10083b463ae0SJohn Muir int fuse_reverse_inval_inode(struct super_block *sb, u64 nodeid, 10093b463ae0SJohn Muir loff_t offset, loff_t len); 10103b463ae0SJohn Muir 10113b463ae0SJohn Muir /** 10123b463ae0SJohn Muir * File-system tells the kernel to invalidate parent attributes and 10133b463ae0SJohn Muir * the dentry matching parent/name. 1014451d0f59SJohn Muir * 1015451d0f59SJohn Muir * If the child_nodeid is non-zero and: 1016451d0f59SJohn Muir * - matches the inode number for the dentry matching parent/name, 1017451d0f59SJohn Muir * - is not a mount point 1018451d0f59SJohn Muir * - is a file or oan empty directory 1019451d0f59SJohn Muir * then the dentry is unhashed (d_delete()). 10203b463ae0SJohn Muir */ 10213b463ae0SJohn Muir int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid, 1022451d0f59SJohn Muir u64 child_nodeid, struct qstr *name); 10233b463ae0SJohn Muir 102408cbf542STejun Heo int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file, 102508cbf542STejun Heo bool isdir); 1026ea8cd333SPavel Emelyanov 1027ea8cd333SPavel Emelyanov /** 1028ea8cd333SPavel Emelyanov * fuse_direct_io() flags 1029ea8cd333SPavel Emelyanov */ 1030ea8cd333SPavel Emelyanov 1031ea8cd333SPavel Emelyanov /** If set, it is WRITE; otherwise - READ */ 1032ea8cd333SPavel Emelyanov #define FUSE_DIO_WRITE (1 << 0) 1033ea8cd333SPavel Emelyanov 1034ea8cd333SPavel Emelyanov /** CUSE pass fuse_direct_io() a file which f_mapping->host is not from FUSE */ 1035ea8cd333SPavel Emelyanov #define FUSE_DIO_CUSE (1 << 1) 1036ea8cd333SPavel Emelyanov 1037d22a943fSAl Viro ssize_t fuse_direct_io(struct fuse_io_priv *io, struct iov_iter *iter, 1038d22a943fSAl Viro loff_t *ppos, int flags); 103908cbf542STejun Heo long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg, 104008cbf542STejun Heo unsigned int flags); 1041b18da0c5SMiklos Szeredi long fuse_ioctl_common(struct file *file, unsigned int cmd, 1042b18da0c5SMiklos Szeredi unsigned long arg, unsigned int flags); 1043076ccb76SAl Viro __poll_t fuse_file_poll(struct file *file, poll_table *wait); 104408cbf542STejun Heo int fuse_dev_release(struct inode *inode, struct file *file); 104508cbf542STejun Heo 1046b0aa7606SMaxim Patlasov bool fuse_write_update_size(struct inode *inode, loff_t pos); 1047b0aa7606SMaxim Patlasov 1048ab9e13f7SMaxim Patlasov int fuse_flush_times(struct inode *inode, struct fuse_file *ff); 10491e18bda8SMiklos Szeredi int fuse_write_inode(struct inode *inode, struct writeback_control *wbc); 1050a1d75f25SMiklos Szeredi 105162490330SJan Kara int fuse_do_setattr(struct dentry *dentry, struct iattr *attr, 1052efb9fa9eSMaxim Patlasov struct file *file); 1053efb9fa9eSMaxim Patlasov 10549759bd51SMiklos Szeredi void fuse_set_initialized(struct fuse_conn *fc); 10559759bd51SMiklos Szeredi 105663576c13SMiklos Szeredi void fuse_unlock_inode(struct inode *inode, bool locked); 105763576c13SMiklos Szeredi bool fuse_lock_inode(struct inode *inode); 10585c672ab3SMiklos Szeredi 105960bcc88aSSeth Forshee int fuse_setxattr(struct inode *inode, const char *name, const void *value, 106060bcc88aSSeth Forshee size_t size, int flags); 106160bcc88aSSeth Forshee ssize_t fuse_getxattr(struct inode *inode, const char *name, void *value, 106260bcc88aSSeth Forshee size_t size); 1063703c7362SSeth Forshee ssize_t fuse_listxattr(struct dentry *entry, char *list, size_t size); 106460bcc88aSSeth Forshee int fuse_removexattr(struct inode *inode, const char *name); 1065703c7362SSeth Forshee extern const struct xattr_handler *fuse_xattr_handlers[]; 106660bcc88aSSeth Forshee extern const struct xattr_handler *fuse_acl_xattr_handlers[]; 1067e45b2546SEric W. Biederman extern const struct xattr_handler *fuse_no_acl_xattr_handlers[]; 106860bcc88aSSeth Forshee 106960bcc88aSSeth Forshee struct posix_acl; 107060bcc88aSSeth Forshee struct posix_acl *fuse_get_acl(struct inode *inode, int type); 107160bcc88aSSeth Forshee int fuse_set_acl(struct inode *inode, struct posix_acl *acl, int type); 1072703c7362SSeth Forshee 1073d123d8e1SMiklos Szeredi 1074d123d8e1SMiklos Szeredi /* readdir.c */ 1075d123d8e1SMiklos Szeredi int fuse_readdir(struct file *file, struct dir_context *ctx); 1076d123d8e1SMiklos Szeredi 107729d434b3STejun Heo #endif /* _FS_FUSE_I_H */ 1078