1 /* SPDX-License-Identifier: GPL-2.0 */ 2 3 #ifndef _FS_FUSE_DEV_H 4 #define _FS_FUSE_DEV_H 5 6 #include <linux/cleanup.h> 7 8 /** Maximum number of outstanding background requests */ 9 #define FUSE_DEFAULT_MAX_BACKGROUND 12 10 11 struct fuse_conn; 12 struct fuse_chan; 13 struct fuse_dev; 14 struct fuse_args; 15 struct fuse_copy_state; 16 struct fuse_backing_map; 17 struct file; 18 struct folio; 19 enum fuse_notify_code; 20 21 struct fuse_chan_param { 22 unsigned int minor; 23 unsigned int max_write; 24 unsigned int max_pages; 25 }; 26 27 struct fuse_chan *fuse_chan_new(void); 28 struct fuse_chan *fuse_dev_chan_new(void); 29 void fuse_chan_release(struct fuse_chan *fch); 30 void fuse_chan_free(struct fuse_chan *fch); 31 unsigned int fuse_chan_num_background(struct fuse_chan *fch); 32 unsigned int fuse_chan_max_background(struct fuse_chan *fch); 33 void fuse_chan_max_background_set(struct fuse_chan *fch, unsigned int val); 34 unsigned int fuse_chan_num_waiting(struct fuse_chan *fch); 35 void fuse_chan_set_fc(struct fuse_chan *fch, struct fuse_conn *fc); 36 void fuse_chan_set_initialized(struct fuse_chan *fch, struct fuse_chan_param *param); 37 void fuse_chan_io_uring_enable(struct fuse_chan *fch); 38 ssize_t fuse_chan_send(struct fuse_chan *fch, struct fuse_args *args); 39 int fuse_chan_send_bg(struct fuse_chan *fch, struct fuse_args *args, gfp_t gfp_flags); 40 int fuse_chan_send_notify_reply(struct fuse_chan *fch, struct fuse_args *args, u64 unique); 41 void fuse_chan_resend(struct fuse_chan *fch); 42 43 struct fuse_forget_link *fuse_alloc_forget(void); 44 void fuse_chan_queue_forget(struct fuse_chan *fch, struct fuse_forget_link *forget, 45 u64 nodeid, u64 nlookup); 46 47 DEFINE_FREE(fuse_chan_free, struct fuse_chan *, if (_T) fuse_chan_free(_T)) 48 49 /** 50 * Initialize the client device 51 */ 52 int fuse_dev_init(void); 53 54 /** 55 * Cleanup the client device 56 */ 57 void fuse_dev_cleanup(void); 58 59 void fuse_dev_install(struct fuse_dev *fud, struct fuse_chan *fch); 60 bool fuse_dev_verify(struct fuse_dev *fud, struct fuse_chan *fch); 61 void fuse_dev_put(struct fuse_dev *fud); 62 bool fuse_dev_is_installed(struct fuse_dev *fud); 63 bool fuse_dev_is_sync_init(struct fuse_dev *fud); 64 struct fuse_dev *fuse_dev_grab(struct file *file); 65 66 void fuse_init_server_timeout(struct fuse_chan *fch, unsigned int timeout); 67 68 /* Abort all requests */ 69 void fuse_chan_abort(struct fuse_chan *fch, bool abort_with_err); 70 void fuse_chan_wait_aborted(struct fuse_chan *fch); 71 72 /** 73 * Acquire reference to fuse_conn 74 */ 75 struct fuse_conn *fuse_conn_get(struct fuse_conn *fc); 76 77 /** 78 * Release reference to fuse_conn 79 */ 80 void fuse_conn_put(struct fuse_conn *fc); 81 82 dev_t fuse_conn_get_id(struct fuse_conn *fc); 83 84 void fuse_end_polls(struct fuse_conn *fc); 85 int fuse_notify(struct fuse_conn *fc, enum fuse_notify_code code, 86 unsigned int size, struct fuse_copy_state *cs); 87 88 int fuse_backing_open(struct fuse_conn *fc, struct fuse_backing_map *map); 89 int fuse_backing_close(struct fuse_conn *fc, int backing_id); 90 91 int fuse_copy_one(struct fuse_copy_state *cs, void *val, unsigned size); 92 int fuse_copy_folio(struct fuse_copy_state *cs, struct folio **foliop, 93 unsigned offset, unsigned count, int zeroing); 94 void fuse_copy_finish(struct fuse_copy_state *cs); 95 96 #ifdef CONFIG_FUSE_IO_URING 97 bool fuse_uring_enabled(void); 98 void fuse_uring_destruct(struct fuse_chan *fch); 99 #else /* CONFIG_FUSE_IO_URING */ 100 static inline bool fuse_uring_enabled(void) 101 { 102 return false; 103 } 104 105 static inline void fuse_uring_destruct(struct fuse_chan *fch) 106 { 107 } 108 #endif /* CONFIG_FUSE_IO_URING */ 109 110 #endif /* _FS_FUSE_DEV_H */ 111