xref: /linux/fs/fuse/dev.h (revision ca46a4aca6f703c53e59b6fd1a88d49c3eb5c186)
1f1434857SMiklos Szeredi /* SPDX-License-Identifier: GPL-2.0 */
2f1434857SMiklos Szeredi 
3f1434857SMiklos Szeredi #ifndef _FS_FUSE_DEV_H
4f1434857SMiklos Szeredi #define _FS_FUSE_DEV_H
5f1434857SMiklos Szeredi 
6a73a7883SMiklos Szeredi #include <linux/cleanup.h>
7a73a7883SMiklos Szeredi 
82b07cbc4SMiklos Szeredi /** Maximum number of outstanding background requests */
92b07cbc4SMiklos Szeredi #define FUSE_DEFAULT_MAX_BACKGROUND 12
102b07cbc4SMiklos Szeredi 
11f1434857SMiklos Szeredi struct fuse_conn;
12a73a7883SMiklos Szeredi struct fuse_chan;
13d8189630SMiklos Szeredi struct fuse_dev;
14794e811dSMiklos Szeredi struct fuse_args;
15*ca46a4acSMiklos Szeredi struct fuse_copy_state;
16b6d83d4eSMiklos Szeredi struct file;
17*ca46a4acSMiklos Szeredi struct folio;
18*ca46a4acSMiklos Szeredi enum fuse_notify_code;
19a73a7883SMiklos Szeredi 
20a73a7883SMiklos Szeredi struct fuse_chan *fuse_chan_new(void);
21b88fb2b9SMiklos Szeredi struct fuse_chan *fuse_dev_chan_new(void);
22b88fb2b9SMiklos Szeredi void fuse_chan_release(struct fuse_chan *fch);
23a73a7883SMiklos Szeredi void fuse_chan_free(struct fuse_chan *fch);
24b6d83d4eSMiklos Szeredi unsigned int fuse_chan_num_background(struct fuse_chan *fch);
25b6d83d4eSMiklos Szeredi unsigned int fuse_chan_max_background(struct fuse_chan *fch);
26b6d83d4eSMiklos Szeredi void fuse_chan_max_background_set(struct fuse_chan *fch, unsigned int val);
27b6d83d4eSMiklos Szeredi unsigned int fuse_chan_num_waiting(struct fuse_chan *fch);
28b6d83d4eSMiklos Szeredi void fuse_chan_set_fc(struct fuse_chan *fch, struct fuse_conn *fc);
29b6d83d4eSMiklos Szeredi void fuse_chan_set_initialized(struct fuse_chan *fch);
30b6d83d4eSMiklos Szeredi void fuse_chan_io_uring_enable(struct fuse_chan *fch);
31794e811dSMiklos Szeredi ssize_t fuse_chan_send(struct fuse_chan *fch, struct fuse_args *args);
32794e811dSMiklos Szeredi int fuse_chan_send_bg(struct fuse_chan *fch, struct fuse_args *args, gfp_t gfp_flags);
33794e811dSMiklos Szeredi int fuse_chan_send_notify_reply(struct fuse_chan *fch, struct fuse_args *args, u64 unique);
34*ca46a4acSMiklos Szeredi void fuse_chan_resend(struct fuse_chan *fch);
35b6d83d4eSMiklos Szeredi 
364f5f0038SMiklos Szeredi struct fuse_forget_link *fuse_alloc_forget(void);
374f5f0038SMiklos Szeredi void fuse_chan_queue_forget(struct fuse_chan *fch, struct fuse_forget_link *forget,
384f5f0038SMiklos Szeredi 			    u64 nodeid, u64 nlookup);
394f5f0038SMiklos Szeredi 
40a73a7883SMiklos Szeredi DEFINE_FREE(fuse_chan_free, struct fuse_chan *, if (_T) fuse_chan_free(_T))
41f1434857SMiklos Szeredi 
42994d8079SMiklos Szeredi void fuse_dev_install(struct fuse_dev *fud, struct fuse_chan *fch);
43994d8079SMiklos Szeredi bool fuse_dev_verify(struct fuse_dev *fud, struct fuse_chan *fch);
44d8189630SMiklos Szeredi void fuse_dev_put(struct fuse_dev *fud);
45b6d83d4eSMiklos Szeredi bool fuse_dev_is_installed(struct fuse_dev *fud);
46b6d83d4eSMiklos Szeredi bool fuse_dev_is_sync_init(struct fuse_dev *fud);
47b6d83d4eSMiklos Szeredi struct fuse_dev *fuse_dev_grab(struct file *file);
48d8189630SMiklos Szeredi 
4956b4332eSMiklos Szeredi void fuse_init_server_timeout(struct fuse_chan *fch, unsigned int timeout);
50f1434857SMiklos Szeredi 
51a3a3e06bSMiklos Szeredi /* Abort all requests */
524eeb5e6cSMiklos Szeredi void fuse_chan_abort(struct fuse_chan *fch, bool abort_with_err);
534eeb5e6cSMiklos Szeredi void fuse_chan_wait_aborted(struct fuse_chan *fch);
54a3a3e06bSMiklos Szeredi 
55b8b072cbSMiklos Szeredi void fuse_end_polls(struct fuse_conn *fc);
56*ca46a4acSMiklos Szeredi int fuse_notify(struct fuse_conn *fc, enum fuse_notify_code code,
57*ca46a4acSMiklos Szeredi 		unsigned int size, struct fuse_copy_state *cs);
58*ca46a4acSMiklos Szeredi 
59*ca46a4acSMiklos Szeredi int fuse_copy_one(struct fuse_copy_state *cs, void *val, unsigned size);
60*ca46a4acSMiklos Szeredi int fuse_copy_folio(struct fuse_copy_state *cs, struct folio **foliop,
61*ca46a4acSMiklos Szeredi 		    unsigned offset, unsigned count, int zeroing);
62*ca46a4acSMiklos Szeredi void fuse_copy_finish(struct fuse_copy_state *cs);
63b8b072cbSMiklos Szeredi 
64b6d83d4eSMiklos Szeredi #ifdef CONFIG_FUSE_IO_URING
65b6d83d4eSMiklos Szeredi bool fuse_uring_enabled(void);
66b6d83d4eSMiklos Szeredi void fuse_uring_destruct(struct fuse_chan *fch);
67b6d83d4eSMiklos Szeredi #else /* CONFIG_FUSE_IO_URING */
68b6d83d4eSMiklos Szeredi static inline bool fuse_uring_enabled(void)
69b6d83d4eSMiklos Szeredi {
70b6d83d4eSMiklos Szeredi 	return false;
71b6d83d4eSMiklos Szeredi }
72b6d83d4eSMiklos Szeredi 
73b6d83d4eSMiklos Szeredi static inline void fuse_uring_destruct(struct fuse_chan *fch)
74b6d83d4eSMiklos Szeredi {
75b6d83d4eSMiklos Szeredi }
76b6d83d4eSMiklos Szeredi #endif /* CONFIG_FUSE_IO_URING */
77b6d83d4eSMiklos Szeredi 
78f1434857SMiklos Szeredi #endif /* _FS_FUSE_DEV_H */
79