1
2
3
4
5
6
7
8
9#ifndef _FS_FUSE_I_H
10#define _FS_FUSE_I_H
11
12#ifndef pr_fmt
13# define pr_fmt(fmt) "fuse: " fmt
14#endif
15
16#include <linux/fuse.h>
17#include <linux/fs.h>
18#include <linux/mount.h>
19#include <linux/wait.h>
20#include <linux/list.h>
21#include <linux/spinlock.h>
22#include <linux/mm.h>
23#include <linux/backing-dev.h>
24#include <linux/mutex.h>
25#include <linux/rwsem.h>
26#include <linux/rbtree.h>
27#include <linux/poll.h>
28#include <linux/workqueue.h>
29#include <linux/kref.h>
30#include <linux/xattr.h>
31#include <linux/pid_namespace.h>
32#include <linux/refcount.h>
33#include <linux/user_namespace.h>
34
35
36#define FUSE_DEFAULT_MAX_PAGES_PER_REQ 32
37
38
39#define FUSE_MAX_MAX_PAGES 256
40
41
42#define FUSE_NOWRITE INT_MIN
43
44
45#define FUSE_NAME_MAX 1024
46
47
48#define FUSE_CTL_NUM_DENTRIES 5
49
50
51extern struct list_head fuse_conn_list;
52
53
54extern struct mutex fuse_mutex;
55
56
57extern unsigned max_user_bgreq;
58extern unsigned max_user_congthresh;
59
60
61struct fuse_forget_link {
62 struct fuse_forget_one forget_one;
63 struct fuse_forget_link *next;
64};
65
66
67struct fuse_inode {
68
69 struct inode inode;
70
71
72
73 u64 nodeid;
74
75
76 u64 nlookup;
77
78
79 struct fuse_forget_link *forget;
80
81
82 u64 i_time;
83
84
85 u32 inval_mask;
86
87
88
89 umode_t orig_i_mode;
90
91
92 u64 orig_ino;
93
94
95 u64 attr_version;
96
97 union {
98
99 struct {
100
101 struct list_head write_files;
102
103
104 struct list_head queued_writes;
105
106
107
108 int writectr;
109
110
111 wait_queue_head_t page_waitq;
112
113
114 struct list_head writepages;
115 };
116
117
118 struct {
119
120 bool cached;
121
122
123 loff_t size;
124
125
126 loff_t pos;
127
128
129 u64 version;
130
131
132
133 struct timespec64 mtime;
134
135
136 u64 iversion;
137
138
139 spinlock_t lock;
140 } rdc;
141 };
142
143
144 unsigned long state;
145
146
147 struct mutex mutex;
148
149
150 spinlock_t lock;
151};
152
153
154enum {
155
156 FUSE_I_ADVISE_RDPLUS,
157
158 FUSE_I_INIT_RDPLUS,
159
160 FUSE_I_SIZE_UNSTABLE,
161};
162
163struct fuse_conn;
164struct fuse_release_args;
165
166
167struct fuse_file {
168
169 struct fuse_conn *fc;
170
171
172 struct fuse_release_args *release_args;
173
174
175 u64 kh;
176
177
178 u64 fh;
179
180
181 u64 nodeid;
182
183
184 refcount_t count;
185
186
187 u32 open_flags;
188
189
190 struct list_head write_entry;
191
192
193 struct {
194
195
196
197
198 struct mutex lock;
199
200
201 loff_t pos;
202
203
204 loff_t cache_off;
205
206
207 u64 version;
208
209 } readdir;
210
211
212 struct rb_node polled_node;
213
214
215 wait_queue_head_t poll_wait;
216
217
218 bool flock:1;
219};
220
221
222struct fuse_in_arg {
223 unsigned size;
224 const void *value;
225};
226
227
228struct fuse_arg {
229 unsigned size;
230 void *value;
231};
232
233
234struct fuse_page_desc {
235 unsigned int length;
236 unsigned int offset;
237};
238
239struct fuse_args {
240 uint64_t nodeid;
241 uint32_t opcode;
242 unsigned short in_numargs;
243 unsigned short out_numargs;
244 bool force:1;
245 bool noreply:1;
246 bool nocreds:1;
247 bool in_pages:1;
248 bool out_pages:1;
249 bool out_argvar:1;
250 bool page_zeroing:1;
251 bool page_replace:1;
252 struct fuse_in_arg in_args[3];
253 struct fuse_arg out_args[2];
254 void (*end)(struct fuse_conn *fc, struct fuse_args *args, int error);
255};
256
257struct fuse_args_pages {
258 struct fuse_args args;
259 struct page **pages;
260 struct fuse_page_desc *descs;
261 unsigned int num_pages;
262};
263
264#define FUSE_ARGS(args) struct fuse_args args = {}
265
266
267struct fuse_io_priv {
268 struct kref refcnt;
269 int async;
270 spinlock_t lock;
271 unsigned reqs;
272 ssize_t bytes;
273 size_t size;
274 __u64 offset;
275 bool write;
276 bool should_dirty;
277 int err;
278 struct kiocb *iocb;
279 struct completion *done;
280 bool blocking;
281};
282
283#define FUSE_IO_PRIV_SYNC(i) \
284{ \
285 .refcnt = KREF_INIT(1), \
286 .async = 0, \
287 .iocb = i, \
288}
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305enum fuse_req_flag {
306 FR_ISREPLY,
307 FR_FORCE,
308 FR_BACKGROUND,
309 FR_WAITING,
310 FR_ABORTED,
311 FR_INTERRUPTED,
312 FR_LOCKED,
313 FR_PENDING,
314 FR_SENT,
315 FR_FINISHED,
316 FR_PRIVATE,
317};
318
319
320
321
322
323
324
325
326struct fuse_req {
327
328
329 struct list_head list;
330
331
332 struct list_head intr_entry;
333
334
335 struct fuse_args *args;
336
337
338 refcount_t count;
339
340
341 unsigned long flags;
342
343
344 struct {
345 struct fuse_in_header h;
346 } in;
347
348
349 struct {
350 struct fuse_out_header h;
351 } out;
352
353
354 wait_queue_head_t waitq;
355
356#if IS_ENABLED(CONFIG_VIRTIO_FS)
357
358 void *argbuf;
359#endif
360};
361
362struct fuse_iqueue;
363
364
365
366
367
368
369
370
371
372struct fuse_iqueue_ops {
373
374
375
376 void (*wake_forget_and_unlock)(struct fuse_iqueue *fiq)
377 __releases(fiq->lock);
378
379
380
381
382 void (*wake_interrupt_and_unlock)(struct fuse_iqueue *fiq)
383 __releases(fiq->lock);
384
385
386
387
388 void (*wake_pending_and_unlock)(struct fuse_iqueue *fiq)
389 __releases(fiq->lock);
390
391
392
393
394 void (*release)(struct fuse_iqueue *fiq);
395};
396
397
398extern const struct fuse_iqueue_ops fuse_dev_fiq_ops;
399
400struct fuse_iqueue {
401
402 unsigned connected;
403
404
405 spinlock_t lock;
406
407
408 wait_queue_head_t waitq;
409
410
411 u64 reqctr;
412
413
414 struct list_head pending;
415
416
417 struct list_head interrupts;
418
419
420 struct fuse_forget_link forget_list_head;
421 struct fuse_forget_link *forget_list_tail;
422
423
424 int forget_batch;
425
426
427 struct fasync_struct *fasync;
428
429
430 const struct fuse_iqueue_ops *ops;
431
432
433 void *priv;
434};
435
436#define FUSE_PQ_HASH_BITS 8
437#define FUSE_PQ_HASH_SIZE (1 << FUSE_PQ_HASH_BITS)
438
439struct fuse_pqueue {
440
441 unsigned connected;
442
443
444 spinlock_t lock;
445
446
447 struct list_head *processing;
448
449
450 struct list_head io;
451};
452
453
454
455
456struct fuse_dev {
457
458 struct fuse_conn *fc;
459
460
461 struct fuse_pqueue pq;
462
463
464 struct list_head entry;
465};
466
467struct fuse_fs_context {
468 int fd;
469 unsigned int rootmode;
470 kuid_t user_id;
471 kgid_t group_id;
472 bool is_bdev:1;
473 bool fd_present:1;
474 bool rootmode_present:1;
475 bool user_id_present:1;
476 bool group_id_present:1;
477 bool default_permissions:1;
478 bool allow_other:1;
479 bool destroy:1;
480 bool no_control:1;
481 bool no_force_umount:1;
482 bool no_mount_options:1;
483 unsigned int max_read;
484 unsigned int blksize;
485 const char *subtype;
486
487
488 void **fudptr;
489};
490
491
492
493
494
495
496
497
498struct fuse_conn {
499
500 spinlock_t lock;
501
502
503 refcount_t count;
504
505
506 atomic_t dev_count;
507
508 struct rcu_head rcu;
509
510
511 kuid_t user_id;
512
513
514 kgid_t group_id;
515
516
517 struct pid_namespace *pid_ns;
518
519
520 struct user_namespace *user_ns;
521
522
523 unsigned max_read;
524
525
526 unsigned max_write;
527
528
529 unsigned int max_pages;
530
531
532 struct fuse_iqueue iq;
533
534
535 atomic64_t khctr;
536
537
538 struct rb_root polled_files;
539
540
541 unsigned max_background;
542
543
544 unsigned congestion_threshold;
545
546
547 unsigned num_background;
548
549
550 unsigned active_background;
551
552
553 struct list_head bg_queue;
554
555
556
557 spinlock_t bg_lock;
558
559
560
561 int initialized;
562
563
564
565
566 int blocked;
567
568
569 wait_queue_head_t blocked_waitq;
570
571
572
573 unsigned connected;
574
575
576 bool aborted;
577
578
579
580
581 unsigned conn_error:1;
582
583
584 unsigned conn_init:1;
585
586
587 unsigned async_read:1;
588
589
590 unsigned abort_err:1;
591
592
593 unsigned atomic_o_trunc:1;
594
595
596 unsigned export_support:1;
597
598
599 unsigned writeback_cache:1;
600
601
602 unsigned parallel_dirops:1;
603
604
605 unsigned handle_killpriv:1;
606
607
608 unsigned cache_symlinks:1;
609
610
611
612
613
614
615
616 unsigned no_open:1;
617
618
619 unsigned no_opendir:1;
620
621
622 unsigned no_fsync:1;
623
624
625 unsigned no_fsyncdir:1;
626
627
628 unsigned no_flush:1;
629
630
631 unsigned no_setxattr:1;
632
633
634 unsigned no_getxattr:1;
635
636
637 unsigned no_listxattr:1;
638
639
640 unsigned no_removexattr:1;
641
642
643 unsigned no_lock:1;
644
645
646 unsigned no_access:1;
647
648
649 unsigned no_create:1;
650
651
652 unsigned no_interrupt:1;
653
654
655 unsigned no_bmap:1;
656
657
658 unsigned no_poll:1;
659
660
661 unsigned big_writes:1;
662
663
664 unsigned dont_mask:1;
665
666
667 unsigned no_flock:1;
668
669
670 unsigned no_fallocate:1;
671
672
673 unsigned no_rename2:1;
674
675
676 unsigned auto_inval_data:1;
677
678
679 unsigned explicit_inval_data:1;
680
681
682 unsigned do_readdirplus:1;
683
684
685 unsigned readdirplus_auto:1;
686
687
688 unsigned async_dio:1;
689
690
691 unsigned no_lseek:1;
692
693
694 unsigned posix_acl:1;
695
696
697 unsigned default_permissions:1;
698
699
700 unsigned allow_other:1;
701
702
703 unsigned no_copy_file_range:1;
704
705
706 unsigned int destroy:1;
707
708
709 unsigned int delete_stale:1;
710
711
712 unsigned int no_control:1;
713
714
715 unsigned int no_force_umount:1;
716
717
718 unsigned int no_mount_options:1;
719
720
721 atomic_t num_waiting;
722
723
724 unsigned minor;
725
726
727 struct list_head entry;
728
729
730 dev_t dev;
731
732
733 struct dentry *ctl_dentry[FUSE_CTL_NUM_DENTRIES];
734
735
736 int ctl_ndents;
737
738
739 u32 scramble_key[4];
740
741
742 atomic64_t attr_version;
743
744
745 void (*release)(struct fuse_conn *);
746
747
748 struct super_block *sb;
749
750
751 struct rw_semaphore killsb;
752
753
754 struct list_head devices;
755};
756
757static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
758{
759 return sb->s_fs_info;
760}
761
762static inline struct fuse_conn *get_fuse_conn(struct inode *inode)
763{
764 return get_fuse_conn_super(inode->i_sb);
765}
766
767static inline struct fuse_inode *get_fuse_inode(struct inode *inode)
768{
769 return container_of(inode, struct fuse_inode, inode);
770}
771
772static inline u64 get_node_id(struct inode *inode)
773{
774 return get_fuse_inode(inode)->nodeid;
775}
776
777static inline int invalid_nodeid(u64 nodeid)
778{
779 return !nodeid || nodeid == FUSE_ROOT_ID;
780}
781
782static inline u64 fuse_get_attr_version(struct fuse_conn *fc)
783{
784 return atomic64_read(&fc->attr_version);
785}
786
787
788extern const struct file_operations fuse_dev_operations;
789
790extern const struct dentry_operations fuse_dentry_operations;
791extern const struct dentry_operations fuse_root_dentry_operations;
792
793
794
795
796int fuse_inode_eq(struct inode *inode, void *_nodeidp);
797
798
799
800
801struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
802 int generation, struct fuse_attr *attr,
803 u64 attr_valid, u64 attr_version);
804
805int fuse_lookup_name(struct super_block *sb, u64 nodeid, const struct qstr *name,
806 struct fuse_entry_out *outarg, struct inode **inode);
807
808
809
810
811void fuse_queue_forget(struct fuse_conn *fc, struct fuse_forget_link *forget,
812 u64 nodeid, u64 nlookup);
813
814struct fuse_forget_link *fuse_alloc_forget(void);
815
816struct fuse_forget_link *fuse_dequeue_forget(struct fuse_iqueue *fiq,
817 unsigned int max,
818 unsigned int *countp);
819
820
821
822
823struct fuse_io_args {
824 union {
825 struct {
826 struct fuse_read_in in;
827 u64 attr_ver;
828 } read;
829 struct {
830 struct fuse_write_in in;
831 struct fuse_write_out out;
832 } write;
833 };
834 struct fuse_args_pages ap;
835 struct fuse_io_priv *io;
836 struct fuse_file *ff;
837};
838
839void fuse_read_args_fill(struct fuse_io_args *ia, struct file *file, loff_t pos,
840 size_t count, int opcode);
841
842
843
844
845
846int fuse_open_common(struct inode *inode, struct file *file, bool isdir);
847
848struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
849void fuse_file_free(struct fuse_file *ff);
850void fuse_finish_open(struct inode *inode, struct file *file);
851
852void fuse_sync_release(struct fuse_inode *fi, struct fuse_file *ff, int flags);
853
854
855
856
857void fuse_release_common(struct file *file, bool isdir);
858
859
860
861
862int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
863 int datasync, int opcode);
864
865
866
867
868int fuse_notify_poll_wakeup(struct fuse_conn *fc,
869 struct fuse_notify_poll_wakeup_out *outarg);
870
871
872
873
874void fuse_init_file_inode(struct inode *inode);
875
876
877
878
879void fuse_init_common(struct inode *inode);
880
881
882
883
884void fuse_init_dir(struct inode *inode);
885
886
887
888
889void fuse_init_symlink(struct inode *inode);
890
891
892
893
894void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
895 u64 attr_valid, u64 attr_version);
896
897void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
898 u64 attr_valid);
899
900
901
902
903int fuse_dev_init(void);
904
905
906
907
908void fuse_dev_cleanup(void);
909
910int fuse_ctl_init(void);
911void __exit fuse_ctl_cleanup(void);
912
913
914
915
916ssize_t fuse_simple_request(struct fuse_conn *fc, struct fuse_args *args);
917int fuse_simple_background(struct fuse_conn *fc, struct fuse_args *args,
918 gfp_t gfp_flags);
919
920
921
922
923void fuse_request_end(struct fuse_conn *fc, struct fuse_req *req);
924
925
926void fuse_abort_conn(struct fuse_conn *fc);
927void fuse_wait_aborted(struct fuse_conn *fc);
928
929
930
931
932void fuse_invalidate_attr(struct inode *inode);
933
934void fuse_invalidate_entry_cache(struct dentry *entry);
935
936void fuse_invalidate_atime(struct inode *inode);
937
938u64 entry_attr_timeout(struct fuse_entry_out *o);
939void fuse_change_entry_timeout(struct dentry *entry, struct fuse_entry_out *o);
940
941
942
943
944struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);
945
946
947
948
949void fuse_conn_init(struct fuse_conn *fc, struct user_namespace *user_ns,
950 const struct fuse_iqueue_ops *fiq_ops, void *fiq_priv);
951
952
953
954
955void fuse_conn_put(struct fuse_conn *fc);
956
957struct fuse_dev *fuse_dev_alloc_install(struct fuse_conn *fc);
958struct fuse_dev *fuse_dev_alloc(void);
959void fuse_dev_install(struct fuse_dev *fud, struct fuse_conn *fc);
960void fuse_dev_free(struct fuse_dev *fud);
961void fuse_send_init(struct fuse_conn *fc);
962
963
964
965
966
967
968int fuse_fill_super_common(struct super_block *sb, struct fuse_fs_context *ctx);
969
970
971
972
973
974
975void fuse_kill_sb_anon(struct super_block *sb);
976
977
978
979
980int fuse_ctl_add_conn(struct fuse_conn *fc);
981
982
983
984
985void fuse_ctl_remove_conn(struct fuse_conn *fc);
986
987
988
989
990int fuse_valid_type(int m);
991
992bool fuse_invalid_attr(struct fuse_attr *attr);
993
994
995
996
997int fuse_allow_current_process(struct fuse_conn *fc);
998
999u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id);
1000
1001void fuse_update_ctime(struct inode *inode);
1002
1003int fuse_update_attributes(struct inode *inode, struct file *file);
1004
1005void fuse_flush_writepages(struct inode *inode);
1006
1007void fuse_set_nowrite(struct inode *inode);
1008void fuse_release_nowrite(struct inode *inode);
1009
1010
1011
1012
1013int fuse_reverse_inval_inode(struct super_block *sb, u64 nodeid,
1014 loff_t offset, loff_t len);
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid,
1027 u64 child_nodeid, struct qstr *name);
1028
1029int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
1030 bool isdir);
1031
1032
1033
1034
1035
1036
1037#define FUSE_DIO_WRITE (1 << 0)
1038
1039
1040#define FUSE_DIO_CUSE (1 << 1)
1041
1042ssize_t fuse_direct_io(struct fuse_io_priv *io, struct iov_iter *iter,
1043 loff_t *ppos, int flags);
1044long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
1045 unsigned int flags);
1046long fuse_ioctl_common(struct file *file, unsigned int cmd,
1047 unsigned long arg, unsigned int flags);
1048__poll_t fuse_file_poll(struct file *file, poll_table *wait);
1049int fuse_dev_release(struct inode *inode, struct file *file);
1050
1051bool fuse_write_update_size(struct inode *inode, loff_t pos);
1052
1053int fuse_flush_times(struct inode *inode, struct fuse_file *ff);
1054int fuse_write_inode(struct inode *inode, struct writeback_control *wbc);
1055
1056int fuse_do_setattr(struct dentry *dentry, struct iattr *attr,
1057 struct file *file);
1058
1059void fuse_set_initialized(struct fuse_conn *fc);
1060
1061void fuse_unlock_inode(struct inode *inode, bool locked);
1062bool fuse_lock_inode(struct inode *inode);
1063
1064int fuse_setxattr(struct inode *inode, const char *name, const void *value,
1065 size_t size, int flags);
1066ssize_t fuse_getxattr(struct inode *inode, const char *name, void *value,
1067 size_t size);
1068ssize_t fuse_listxattr(struct dentry *entry, char *list, size_t size);
1069int fuse_removexattr(struct inode *inode, const char *name);
1070extern const struct xattr_handler *fuse_xattr_handlers[];
1071extern const struct xattr_handler *fuse_acl_xattr_handlers[];
1072extern const struct xattr_handler *fuse_no_acl_xattr_handlers[];
1073
1074struct posix_acl;
1075struct posix_acl *fuse_get_acl(struct inode *inode, int type);
1076int fuse_set_acl(struct inode *inode, struct posix_acl *acl, int type);
1077
1078
1079
1080int fuse_readdir(struct file *file, struct dir_context *ctx);
1081
1082
1083
1084
1085unsigned int fuse_len_args(unsigned int numargs, struct fuse_arg *args);
1086
1087
1088
1089
1090u64 fuse_get_unique(struct fuse_iqueue *fiq);
1091void fuse_free_conn(struct fuse_conn *fc);
1092
1093#endif
1094