This repository has been archived by the owner on May 22, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
mount.h
1491 lines (1316 loc) · 61.9 KB
/
mount.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 2000-2018 Apple Inc. All rights reserved.
*
* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* compliance with the License. The rights granted to you under the License
* may not be used to create, or enable the creation or redistribution of,
* unlawful or unlicensed copies of an Apple operating system, or to
* circumvent, violate, or enable the circumvention or violation of, any
* terms of an Apple operating system software license agreement.
*
* Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
*
* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
*/
/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
/*
* Copyright (c) 1989, 1991, 1993
* The Regents of the University of California. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed by the University of
* California, Berkeley and its contributors.
* 4. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* @(#)mount.h 8.21 (Berkeley) 5/20/95
*/
/*
* NOTICE: This file was modified by SPARTA, Inc. in 2005 to introduce
* support for mandatory and extensible security protections. This notice
* is included in support of clause 2.2 (b) of the Apple Public License,
* Version 2.0.
*/
#ifndef _SYS_MOUNT_H_
#define _SYS_MOUNT_H_
#include <sys/appleapiopts.h>
#include <sys/cdefs.h>
#include <sys/attr.h> /* needed for vol_capabilities_attr_t */
#include <os/base.h>
#ifndef KERNEL
#include <stdint.h>
#include <sys/ucred.h>
#include <sys/queue.h> /* XXX needed for user builds */
#include <Availability.h>
#else
#include <sys/kernel_types.h>
#include <uuid/uuid.h>
#endif
#include <sys/_types/_fsid_t.h> /* file system id type */
/*
* file system statistics
*/
#define MFSNAMELEN 15 /* length of fs type name, not inc. null */
#define MFSTYPENAMELEN 16 /* length of fs type name including null */
#if __DARWIN_64_BIT_INO_T
#define MNAMELEN MAXPATHLEN /* length of buffer for returned name */
#else /* ! __DARWIN_64_BIT_INO_T */
#define MNAMELEN 90 /* length of buffer for returned name */
#endif /* __DARWIN_64_BIT_INO_T */
#define MNT_EXT_ROOT_DATA_VOL 0x00000001 /* Data volume of root volume group */
#define __DARWIN_STRUCT_STATFS64 { \
uint32_t f_bsize; /* fundamental file system block size */ \
int32_t f_iosize; /* optimal transfer block size */ \
uint64_t f_blocks; /* total data blocks in file system */ \
uint64_t f_bfree; /* free blocks in fs */ \
uint64_t f_bavail; /* free blocks avail to non-superuser */ \
uint64_t f_files; /* total file nodes in file system */ \
uint64_t f_ffree; /* free file nodes in fs */ \
fsid_t f_fsid; /* file system id */ \
uid_t f_owner; /* user that mounted the filesystem */ \
uint32_t f_type; /* type of filesystem */ \
uint32_t f_flags; /* copy of mount exported flags */ \
uint32_t f_fssubtype; /* fs sub-type (flavor) */ \
char f_fstypename[MFSTYPENAMELEN]; /* fs type name */ \
char f_mntonname[MAXPATHLEN]; /* directory on which mounted */ \
char f_mntfromname[MAXPATHLEN]; /* mounted filesystem */ \
uint32_t f_flags_ext; /* extended flags */ \
uint32_t f_reserved[7]; /* For future use */ \
}
#if !__DARWIN_ONLY_64_BIT_INO_T
struct statfs64 __DARWIN_STRUCT_STATFS64;
#endif /* !__DARWIN_ONLY_64_BIT_INO_T */
#if __DARWIN_64_BIT_INO_T
struct statfs __DARWIN_STRUCT_STATFS64;
#else /* !__DARWIN_64_BIT_INO_T */
/*
* LP64 - WARNING - must be kept in sync with struct user_statfs in mount_internal.h.
*/
struct statfs {
short f_otype; /* TEMPORARY SHADOW COPY OF f_type */
short f_oflags; /* TEMPORARY SHADOW COPY OF f_flags */
long f_bsize; /* fundamental file system block size */
long f_iosize; /* optimal transfer block size */
long f_blocks; /* total data blocks in file system */
long f_bfree; /* free blocks in fs */
long f_bavail; /* free blocks avail to non-superuser */
long f_files; /* total file nodes in file system */
long f_ffree; /* free file nodes in fs */
fsid_t f_fsid; /* file system id */
uid_t f_owner; /* user that mounted the filesystem */
short f_reserved1; /* spare for later */
short f_type; /* type of filesystem */
long f_flags; /* copy of mount exported flags */
long f_reserved2[2]; /* reserved for future use */
char f_fstypename[MFSNAMELEN]; /* fs type name */
char f_mntonname[MNAMELEN]; /* directory on which mounted */
char f_mntfromname[MNAMELEN];/* mounted filesystem */
char f_reserved3; /* For alignment */
long f_reserved4[4]; /* For future use */
};
#endif /* __DARWIN_64_BIT_INO_T */
#pragma pack(4)
struct vfsstatfs {
uint32_t f_bsize; /* fundamental file system block size */
size_t f_iosize; /* optimal transfer block size */
uint64_t f_blocks; /* total data blocks in file system */
uint64_t f_bfree; /* free blocks in fs */
uint64_t f_bavail; /* free blocks avail to non-superuser */
uint64_t f_bused; /* free blocks avail to non-superuser */
uint64_t f_files; /* total file nodes in file system */
uint64_t f_ffree; /* free file nodes in fs */
fsid_t f_fsid; /* file system id */
uid_t f_owner; /* user that mounted the filesystem */
uint64_t f_flags; /* copy of mount exported flags */
char f_fstypename[MFSTYPENAMELEN];/* fs type name inclus */
char f_mntonname[MAXPATHLEN];/* directory on which mounted */
char f_mntfromname[MAXPATHLEN];/* mounted filesystem */
uint32_t f_fssubtype; /* fs sub-type (flavor) */
void *f_reserved[2]; /* For future use == 0 */
};
#pragma pack()
#ifdef KERNEL
/*
* Kernel level support for the VFS_GETATTR(), VFS_SETATTR() for use in
* implementation of filesystem KEXTs, and by the vfs_getattr() and
* vfs_setattr() KPIs.
*/
#define VFSATTR_INIT(s) ((s)->f_supported = (s)->f_active = 0LL)
#define VFSATTR_SET_SUPPORTED(s, a) ((s)->f_supported |= VFSATTR_ ## a)
#define VFSATTR_IS_SUPPORTED(s, a) ((s)->f_supported & VFSATTR_ ## a)
#define VFSATTR_CLEAR_ACTIVE(s, a) ((s)->f_active &= ~VFSATTR_ ## a)
#define VFSATTR_IS_ACTIVE(s, a) ((s)->f_active & VFSATTR_ ## a)
#define VFSATTR_ALL_SUPPORTED(s) (((s)->f_active & (s)->f_supported) == (s)->f_active)
#define VFSATTR_WANTED(s, a) ((s)->f_active |= VFSATTR_ ## a)
#define VFSATTR_RETURN(s, a, x) do { (s)-> a = (x); VFSATTR_SET_SUPPORTED(s, a);} while(0)
#define VFSATTR_f_objcount (1LL<< 0)
#define VFSATTR_f_filecount (1LL<< 1)
#define VFSATTR_f_dircount (1LL<< 2)
#define VFSATTR_f_maxobjcount (1LL<< 3)
#define VFSATTR_f_bsize (1LL<< 4)
#define VFSATTR_f_iosize (1LL<< 5)
#define VFSATTR_f_blocks (1LL<< 6)
#define VFSATTR_f_bfree (1LL<< 7)
#define VFSATTR_f_bavail (1LL<< 8)
#define VFSATTR_f_bused (1LL<< 9)
#define VFSATTR_f_files (1LL<< 10)
#define VFSATTR_f_ffree (1LL<< 11)
#define VFSATTR_f_fsid (1LL<< 12)
#define VFSATTR_f_owner (1LL<< 13)
#define VFSATTR_f_capabilities (1LL<< 14)
#define VFSATTR_f_attributes (1LL<< 15)
#define VFSATTR_f_create_time (1LL<< 16)
#define VFSATTR_f_modify_time (1LL<< 17)
#define VFSATTR_f_access_time (1LL<< 18)
#define VFSATTR_f_backup_time (1LL<< 19)
#define VFSATTR_f_fssubtype (1LL<< 20)
#define VFSATTR_f_vol_name (1LL<< 21)
#define VFSATTR_f_signature (1LL<< 22)
#define VFSATTR_f_carbon_fsid (1LL<< 23)
#define VFSATTR_f_uuid (1LL<< 24)
#define VFSATTR_f_quota (1LL<< 25)
#define VFSATTR_f_reserved (1LL<< 26)
/*
* Argument structure.
*/
#pragma pack(4)
/*
* Note: the size of the vfs_attr structure can change.
* A kext should only reference the fields that are
* marked as active; it should not depend on the actual
* size of the structure or attempt to copy it.
*/
struct vfs_attr {
uint64_t f_supported;
uint64_t f_active;
uint64_t f_objcount; /* number of filesystem objects in volume */
uint64_t f_filecount; /* ... files */
uint64_t f_dircount; /* ... directories */
uint64_t f_maxobjcount; /* maximum number of filesystem objects */
uint32_t f_bsize; /* block size for the below size values */
size_t f_iosize; /* optimal transfer block size */
uint64_t f_blocks; /* total data blocks in file system */
uint64_t f_bfree; /* free blocks in fs */
uint64_t f_bavail; /* free blocks avail to non-superuser */
uint64_t f_bused; /* blocks in use */
uint64_t f_files; /* total file nodes in file system */
uint64_t f_ffree; /* free file nodes in fs */
fsid_t f_fsid; /* file system id */
uid_t f_owner; /* user that mounted the filesystem */
vol_capabilities_attr_t f_capabilities;
vol_attributes_attr_t f_attributes;
struct timespec f_create_time; /* creation time */
struct timespec f_modify_time; /* last modification time */
struct timespec f_access_time; /* time of last access */
struct timespec f_backup_time; /* last backup time */
uint32_t f_fssubtype; /* filesystem subtype */
char *f_vol_name; /* volume name */
uint16_t f_signature; /* used for ATTR_VOL_SIGNATURE, Carbon's FSVolumeInfo.signature */
uint16_t f_carbon_fsid; /* same as Carbon's FSVolumeInfo.filesystemID */
uuid_t f_uuid; /* file system UUID (version 3 or 5), available in 10.6 and later */
uint64_t f_quota; /* total quota data blocks in file system */
uint64_t f_reserved; /* total reserved data blocks in file system */
};
#pragma pack()
#endif /* KERNEL */
/*
* User specifiable flags.
*
* Unmount uses MNT_FORCE flag.
*/
#define MNT_RDONLY 0x00000001 /* read only filesystem */
#define MNT_SYNCHRONOUS 0x00000002 /* file system written synchronously */
#define MNT_NOEXEC 0x00000004 /* can't exec from filesystem */
#define MNT_NOSUID 0x00000008 /* don't honor setuid bits on fs */
#define MNT_NODEV 0x00000010 /* don't interpret special files */
#define MNT_UNION 0x00000020 /* union with underlying filesystem */
#define MNT_ASYNC 0x00000040 /* file system written asynchronously */
#define MNT_CPROTECT 0x00000080 /* file system supports content protection */
/*
* NFS export related mount flags.
*/
#define MNT_EXPORTED 0x00000100 /* file system is exported */
/*
* Denotes storage which can be removed from the system by the user.
*/
#define MNT_REMOVABLE 0x00000200
/*
* MAC labeled / "quarantined" flag
*/
#define MNT_QUARANTINE 0x00000400 /* file system is quarantined */
/*
* Flags set by internal operations.
*/
#define MNT_LOCAL 0x00001000 /* filesystem is stored locally */
#define MNT_QUOTA 0x00002000 /* quotas are enabled on filesystem */
#define MNT_ROOTFS 0x00004000 /* identifies the root filesystem */
#define MNT_DOVOLFS 0x00008000 /* FS supports volfs (deprecated flag in Mac OS X 10.5) */
#define MNT_DONTBROWSE 0x00100000 /* file system is not appropriate path to user data */
#define MNT_IGNORE_OWNERSHIP 0x00200000 /* VFS will ignore ownership information on filesystem objects */
#define MNT_AUTOMOUNTED 0x00400000 /* filesystem was mounted by automounter */
#define MNT_JOURNALED 0x00800000 /* filesystem is journaled */
#define MNT_NOUSERXATTR 0x01000000 /* Don't allow user extended attributes */
#define MNT_DEFWRITE 0x02000000 /* filesystem should defer writes */
#define MNT_MULTILABEL 0x04000000 /* MAC support for individual labels */
#define MNT_NOATIME 0x10000000 /* disable update of file access time */
#define MNT_SNAPSHOT 0x40000000 /* The mount is a snapshot */
#define MNT_STRICTATIME 0x80000000 /* enable strict update of file access time */
#ifdef BSD_KERNEL_PRIVATE
/* #define MNT_IMGSRC_BY_INDEX 0x20000000 see sys/imgsrc.h */
#endif /* BSD_KERNEL_PRIVATE */
/* backwards compatibility only */
#define MNT_UNKNOWNPERMISSIONS MNT_IGNORE_OWNERSHIP
/*
* XXX I think that this could now become (~(MNT_CMDFLAGS))
* but the 'mount' program may need changing to handle this.
*/
#define MNT_VISFLAGMASK (MNT_RDONLY | MNT_SYNCHRONOUS | MNT_NOEXEC | \
MNT_NOSUID | MNT_NODEV | MNT_UNION | \
MNT_ASYNC | MNT_EXPORTED | MNT_QUARANTINE | \
MNT_LOCAL | MNT_QUOTA | MNT_REMOVABLE | \
MNT_ROOTFS | MNT_DOVOLFS | MNT_DONTBROWSE | \
MNT_IGNORE_OWNERSHIP | MNT_AUTOMOUNTED | MNT_JOURNALED | \
MNT_NOUSERXATTR | MNT_DEFWRITE | MNT_MULTILABEL | \
MNT_NOATIME | MNT_STRICTATIME | MNT_SNAPSHOT | MNT_CPROTECT)
/*
* External filesystem command modifier flags.
* Unmount can use the MNT_FORCE flag.
* XXX These are not STATES and really should be somewhere else.
* External filesystem control flags.
*/
#define MNT_UPDATE 0x00010000 /* not a real mount, just an update */
#define MNT_NOBLOCK 0x00020000 /* don't block unmount if not responding */
#define MNT_RELOAD 0x00040000 /* reload filesystem data */
#define MNT_FORCE 0x00080000 /* force unmount or readonly change */
#define MNT_CMDFLAGS (MNT_UPDATE|MNT_NOBLOCK|MNT_RELOAD|MNT_FORCE)
/*
* Sysctl CTL_VFS definitions.
*
* Second level identifier specifies which filesystem. Second level
* identifier VFS_GENERIC returns information about all filesystems.
*/
#define VFS_GENERIC 0 /* generic filesystem information */
#define VFS_NUMMNTOPS 1 /* int: total num of vfs mount/unmount operations */
/*
* Third level identifiers for VFS_GENERIC are given below; third
* level identifiers for specific filesystems are given in their
* mount specific header files.
*/
#define VFS_MAXTYPENUM 1 /* int: highest defined filesystem type */
#define VFS_CONF 2 /* struct: vfsconf for filesystem given
* as next argument */
/*
* Flags for various system call interfaces.
*
* waitfor flags to vfs_sync() and getfsstat()
*/
#define MNT_WAIT 1 /* synchronized I/O file integrity completion */
#define MNT_NOWAIT 2 /* start all I/O, but do not wait for it */
#define MNT_DWAIT 4 /* synchronized I/O data integrity completion */
#ifdef KERNEL
/* only for VFS_SYNC */
#define MNT_VOLUME 8 /* sync on a single mounted filesystem */
#endif
#if !defined(KERNEL) && !defined(_KERN_SYS_KERNELTYPES_H_) /* also defined in kernel_types.h */
struct mount;
typedef struct mount * mount_t;
struct vnode;
typedef struct vnode * vnode_t;
#endif
/* Reserved fields preserve binary compatibility */
struct vfsconf {
uint32_t vfc_reserved1; /* opaque */
char vfc_name[MFSNAMELEN]; /* filesystem type name */
int vfc_typenum; /* historic filesystem type number */
int vfc_refcount; /* number mounted of this type */
int vfc_flags; /* permanent flags */
uint32_t vfc_reserved2; /* opaque */
uint32_t vfc_reserved3; /* opaque */
};
struct vfsidctl {
int vc_vers; /* should be VFSIDCTL_VERS1 (below) */
fsid_t vc_fsid; /* fsid to operate on. */
void *vc_ptr; /* pointer to data structure. */
size_t vc_len; /* sizeof said structure. */
u_int32_t vc_spare[12]; /* spare (must be zero). */
};
/* vfsidctl API version. */
#define VFS_CTL_VERS1 0x01
#ifdef KERNEL
struct user_vfsidctl {
int vc_vers; /* should be VFSIDCTL_VERS1 (below) */
fsid_t vc_fsid; /* fsid to operate on. */
user_addr_t vc_ptr __attribute((aligned(8))); /* pointer to data structure. */
user_size_t vc_len; /* sizeof said structure. */
u_int32_t vc_spare[12]; /* spare (must be zero). */
};
struct user32_vfsidctl {
int vc_vers; /* should be VFSIDCTL_VERS1 (below) */
fsid_t vc_fsid; /* fsid to operate on. */
user32_addr_t vc_ptr; /* pointer to data structure. */
user32_size_t vc_len; /* sizeof said structure. */
u_int32_t vc_spare[12]; /* spare (must be zero). */
};
union union_vfsidctl { /* the fields vc_vers and vc_fsid are compatible */
struct user32_vfsidctl vc32;
struct user_vfsidctl vc64;
};
#endif /* KERNEL */
/*
* New style VFS sysctls, do not reuse/conflict with the namespace for
* private sysctls.
*/
#define VFS_CTL_OSTATFS 0x00010001 /* old legacy statfs */
#define VFS_CTL_UMOUNT 0x00010002 /* unmount */
#define VFS_CTL_QUERY 0x00010003 /* anything wrong? (vfsquery) */
#define VFS_CTL_NEWADDR 0x00010004 /* reconnect to new address */
#define VFS_CTL_TIMEO 0x00010005 /* set timeout for vfs notification */
#define VFS_CTL_NOLOCKS 0x00010006 /* disable file locking */
#define VFS_CTL_SADDR 0x00010007 /* get server address */
#define VFS_CTL_DISC 0x00010008 /* server disconnected */
#define VFS_CTL_SERVERINFO 0x00010009 /* information about fs server */
#define VFS_CTL_NSTATUS 0x0001000A /* netfs mount status */
#define VFS_CTL_STATFS64 0x0001000B /* statfs64 */
#ifndef KERNEL
/*
* Automatically select the correct VFS_CTL_*STATFS* flavor based
* on what "struct statfs" layout the client will use.
*/
#if __DARWIN_64_BIT_INO_T
#define VFS_CTL_STATFS VFS_CTL_STATFS64
#else
#define VFS_CTL_STATFS VFS_CTL_OSTATFS
#endif
#endif /* ! KERNEL */
struct vfsquery {
u_int32_t vq_flags;
u_int32_t vq_spare[31];
};
struct vfs_server {
int32_t vs_minutes; /* minutes until server goes down. */
u_int8_t vs_server_name[MAXHOSTNAMELEN * 3]; /* UTF8 server name to display (null terminated) */
};
/*
* NetFS mount status - returned by VFS_CTL_NSTATUS
*/
struct netfs_status {
u_int32_t ns_status; // Current status of mount (vfsquery flags)
char ns_mountopts[512]; // Significant mount options
uint32_t ns_waittime; // Time waiting for reply (sec)
uint32_t ns_threadcount; // Number of threads blocked on network calls
uint64_t ns_threadids[0]; // Thread IDs of those blocked threads
};
/* vfsquery flags */
#define VQ_NOTRESP 0x0001 /* server down */
#define VQ_NEEDAUTH 0x0002 /* server bad auth */
#define VQ_LOWDISK 0x0004 /* we're low on space */
#define VQ_MOUNT 0x0008 /* new filesystem arrived */
#define VQ_UNMOUNT 0x0010 /* filesystem has left */
#define VQ_DEAD 0x0020 /* filesystem is dead, needs force unmount */
#define VQ_ASSIST 0x0040 /* filesystem needs assistance from external program */
#define VQ_NOTRESPLOCK 0x0080 /* server lockd down */
#define VQ_UPDATE 0x0100 /* filesystem information has changed */
#define VQ_VERYLOWDISK 0x0200 /* file system has *very* little disk space left */
#define VQ_SYNCEVENT 0x0400 /* a sync just happened (not set by kernel starting Mac OS X 10.9) */
#define VQ_SERVEREVENT 0x0800 /* server issued notification/warning */
#define VQ_QUOTA 0x1000 /* a user quota has been hit */
#define VQ_NEARLOWDISK 0x2000 /* Above lowdisk and below desired disk space */
#define VQ_DESIRED_DISK 0x4000 /* the desired disk space */
#define VQ_FREE_SPACE_CHANGE 0x8000 /* free disk space has significantly changed */
#define VQ_FLAG10000 0x10000 /* placeholder */
#ifdef KERNEL
/* Structure for setting device IO parameters per mount point */
struct vfsioattr {
u_int32_t io_maxreadcnt; /* Max. byte count for read */
u_int32_t io_maxwritecnt; /* Max. byte count for write */
u_int32_t io_segreadcnt; /* Max. segment count for read */
u_int32_t io_segwritecnt; /* Max. segment count for write */
u_int32_t io_maxsegreadsize; /* Max. segment read size */
u_int32_t io_maxsegwritesize; /* Max. segment write size */
u_int32_t io_devblocksize; /* the underlying device block size */
u_int32_t io_flags; /* flags for underlying device */
union {
int64_t io_max_swappin_available;
// On 32 bit architectures, we don't have any spare
void *io_reserved[2];
};
};
#define VFS_IOATTR_FLAGS_FUA 0x00000001 /* Write-through cache supported */
#define VFS_IOATTR_FLAGS_UNMAP 0x00000002 /* Unmap (trim) supported */
#define VFS_IOATTR_FLAGS_SWAPPIN_SUPPORTED 0x00000010 /* Pinning swap file supported */
/*
* Filesystem Registration information
*/
#define VFS_TBLTHREADSAFE 0x0001 /* Only threadsafe filesystems are supported */
#define VFS_TBLFSNODELOCK 0x0002 /* Only threadsafe filesystems are supported */
#define VFS_TBLNOTYPENUM 0x0008
#define VFS_TBLLOCALVOL 0x0010
#define VFS_TBL64BITREADY 0x0020
#define VFS_TBLNATIVEXATTR 0x0040
#define VFS_TBLDIRLINKS 0x0080
#define VFS_TBLUNMOUNT_PREFLIGHT 0x0100 /* does a preflight check before unmounting */
#define VFS_TBLGENERICMNTARGS 0x0200 /* force generic mount args for local fs */
#define VFS_TBLREADDIR_EXTENDED 0x0400 /* fs supports VNODE_READDIR_EXTENDED */
#define VFS_TBLNOMACLABEL 0x1000
#define VFS_TBLVNOP_PAGEINV2 0x2000
#define VFS_TBLVNOP_PAGEOUTV2 0x4000
#define VFS_TBLVNOP_NOUPDATEID_RENAME 0x8000 /* vfs should not call vnode_update_ident on rename */
#define VFS_TBLVNOP_SECLUDE_RENAME 0x10000
#define VFS_TBLCANMOUNTROOT 0x20000
struct vfs_fsentry {
struct vfsops * vfe_vfsops; /* vfs operations */
int vfe_vopcnt; /* # of vnodeopv_desc being registered (reg, spec, fifo ...) */
struct vnodeopv_desc ** vfe_opvdescs; /* null terminated; */
int vfe_fstypenum; /* historic filesystem type number */
char vfe_fsname[MFSNAMELEN]; /* filesystem type name */
uint32_t vfe_flags; /* defines the FS capabilities */
void * vfe_reserv[2];/* reserved for future use; set this to zero*/
};
struct vfsops {
/*!
* @field vfs_mount
* @abstract Perform filesystem-specific operations required for mounting.
* @discussion Typical operations include setting the mount-specific data with vfs_setfsprivate().
* Note that if a mount call fails, the filesystem must clean up any state it has constructed, because
* vfs-level mount code will not clean it up.
* @param mp Mount structure for the newly mounted filesystem.
* @param devvp Device that the filesystem is mounted from.
* @param data Filesystem-specific data passed down from userspace.
* @param context Context to authenticate for mount.
* @return 0 for success, else an error code. Once success is returned, the filesystem should be ready to go active;
* VFS will not ask again.
*/
int (*vfs_mount)(struct mount *mp, vnode_t devvp, user_addr_t data, vfs_context_t context);
/*!
* @field vfs_start
* @abstract Mark a mount as ready to be used.
* @discussion After receiving this calldown, a filesystem will be hooked into the mount list and should expect
* calls down from the VFS layer.
* @param mp Mount structure being activated.
* @param flags Unused.
* @param context Context to authenticate for mount.
* @return Return value is ignored.
*/
int (*vfs_start)(struct mount *mp, int flags, vfs_context_t context);
/*!
* @field vfs_unmount
* @abstract Perform filesystem-specific cleanup as part of unmount.
* @discussion If the unmount downcall succeeds, VFS considers itself authorized to destroy all
* state related to the mount.
* @param mp Mount structure to unmount.
* @param mntflags MNT_FORCE indicates that we wish to unmount even if there are active vnodes.
* @param context Context to authenticate for unmount.
* @return 0 for success, else an error code.
*/
int (*vfs_unmount)(struct mount *mp, int mntflags, vfs_context_t context);
/*!
* @field vfs_root
* @abstract Get the root vnode of a filesystem.
* @discussion Upon success, should return with an iocount held on the root vnode which the caller will
* drop with vnode_put().
* @param mp Mount for which to get the root.
* @param vpp Destination for root vnode.
* @param context Context to authenticate for getting the root.
* @return 0 for success, else an error code.
*/
int (*vfs_root)(struct mount *mp, struct vnode **vpp, vfs_context_t context);
/*!
* @field vfs_quotactl
* @abstract Manipulate quotas for a volume.
* @param mp Mount for which to manipulate quotas.
* @param cmds Detailed in "quotactl" manual page.
* @param uid Detailed in "quotactl" manual page.
* @param arg Detailed in "quotactl" manual page.
* @param context Context to authenticate for changing quotas.
* @return 0 for success, else an error code.
*/
int (*vfs_quotactl)(struct mount *mp, int cmds, uid_t uid, caddr_t arg, vfs_context_t context);
/*!
* @field vfs_getattr
* @abstract Get filesystem attributes.
* @discussion See VFSATTR_RETURN, VFSATTR_ACTIVE, VFSATTR_SET_SUPPORTED, VFSATTR_WANTED macros.
* @param mp Mount for which to get parameters.
* @param vfa Container for specifying which attributes are desired and which attributes the filesystem
* supports, as well as for returning results.
* @param ctx Context to authenticate for getting filesystem attributes.
* @return 0 for success, else an error code.
*/
int (*vfs_getattr)(struct mount *mp, struct vfs_attr *, vfs_context_t context);
/* int (*vfs_statfs)(struct mount *mp, struct vfsstatfs *sbp, vfs_context_t context);*/
/*!
* @field vfs_sync
* @abstract Flush all filesystem data to backing store.
* @discussion vfs_sync will be called as part of the sync() system call and during unmount.
* @param mp Mountpoint to sync.
* @param waitfor MNT_WAIT: flush synchronously, waiting for all data to be written before returning. MNT_NOWAIT: start I/O but do not wait for it.
* @param ctx Context to authenticate for the sync.
* @return 0 for success, else an error code.
*/
int (*vfs_sync)(struct mount *mp, int waitfor, vfs_context_t context);
/*!
* @field vfs_vget
* @abstract Get a vnode by file id (inode number).
* @discussion This routine is chiefly used to build paths to vnodes. Result should be turned with an iocount that the
* caller will drop with vnode_put().
* @param mp Mount against which to look up inode number.
* @param ino File ID for desired file, as found through a readdir.
* @param vpp Destination for vnode.
* @return 0 for success, else an error code.
*/
int (*vfs_vget)(struct mount *mp, ino64_t ino, struct vnode **vpp, vfs_context_t context);
/*!
* @field vfs_fhtovp
* @abstract Get the vnode corresponding to a file handle.
* @discussion Filesystems can return handles to files which are independent of their (transient) vnode identities.
* vfs_thtovp converts that persistent handle back to a vnode. The vnode should be returned with an iocount which
* the caller will drop with vnode_put().
* @param mp Mount against which to look up file handle.
* @param fhlen Size of file handle structure, as returned by vfs_vptofh.
* @param fhp Pointer to handle.
* @param vpp Destination for vnode.
* @param ctx Context against which to authenticate the file-handle conversion.
* @return 0 for success, else an error code.
*/
int (*vfs_fhtovp)(struct mount *mp, int fhlen, unsigned char *fhp, struct vnode **vpp,
vfs_context_t context);
/*!
* @field vfs_vptofh
* @abstract Get a persistent handle corresponding to a vnode.
* @param mp Mount against which to convert the vnode to a handle.
* @param fhlen Size of buffer provided for handle; set to size of actual handle returned.
* @param fhp Pointer to buffer in which to place handle data.
* @param ctx Context against which to authenticate the file-handle request.
* @return 0 for success, else an error code.
*/
int (*vfs_vptofh)(struct vnode *vp, int *fhlen, unsigned char *fhp, vfs_context_t context);
/*!
* @field vfs_init
* @abstract Prepare a filesystem for having instances mounted.
* @discussion This routine is called once, before any particular instance of a filesystem
* is mounted; it allows the filesystem to initialize whatever global data structures
* are shared across all mounts. If this returns successfully, a filesystem should be ready to have
* instances mounted.
* @param vfsconf Configuration information. Currently, the only useful data are the filesystem name,
* typenum, and flags. The flags field will be either 0 or MNT_LOCAL. Many filesystems ignore this
* parameter.
* @return 0 for success, else an error code.
*/
int (*vfs_init)(struct vfsconf *);
/*!
* @field vfs_sysctl
* @abstract Broad interface for querying and controlling filesystem.
* @discussion VFS defines VFS_CTL_QUERY as a generic status request which is answered
* with the VQ_* macros in a "struct vfsquery."
* A filesystem may also define implementation-specific commands. See "man 3 sysctl"
* for the meaning of sysctl parameters.
* @param context Context against which to authenticate command.
* @return 0 for success, else an error code.
*/
int (*vfs_sysctl)(int *, u_int, user_addr_t, size_t *, user_addr_t, size_t, vfs_context_t context);
/*!
* @field vfs_setattr
* @abstract Set filesystem attributes.
* @discussion The other side of the vfs_getattr coin. Currently only called to set volume name.
* @param mp Mount on which to set attributes.
* @param vfa VFS attribute structure containing requested attributes to set and their values. Currently
* will only be called with f_vol_name set.
* @param context Context against which to authenticate attribute change.
* @return 0 for success, else an error code.
*/
int (*vfs_setattr)(struct mount *mp, struct vfs_attr *, vfs_context_t context);
/*!
* @field vfs_ioctl
* @abstract File system control operations.
* @discussion Unlike vfs_sysctl, this is specific to a particular volume.
* @param mp The mount to execute the command on.
* @param command Identifier for action to take. The command used here
* should be in the same namespace as VNOP ioctl commands.
* @param data Pointer to data; this can be an integer constant (of 32 bits
* only) or an address to be read from or written to, depending on "command."
* If it is an address, it is valid and resides in the kernel; callers of
* VFS_IOCTL() are responsible for copying to and from userland.
* @param flags Reserved for future use, set to zero
* @param ctx Context against which to authenticate ioctl request.
* @return 0 for success, else an error code.
*/
int (*vfs_ioctl)(struct mount *mp, u_long command, caddr_t data,
int flags, vfs_context_t context);
/*!
* @field vfs_vget_snapdir
* @abstract Get the vnode for the snapshot directory of a filesystem.
* @discussion Upon success, should return with an iocount held on the root vnode which the caller will
* drop with vnode_put().
* @param mp Mount for which to get the root.
* @param vpp Destination for snapshot directory vnode.
* @param context Context to authenticate for getting the snapshot directory.
* @return 0 for success, else an error code.
*/
int (*vfs_vget_snapdir)(struct mount *mp, struct vnode **vpp, vfs_context_t context);
void *vfs_reserved5;
void *vfs_reserved4;
void *vfs_reserved3;
void *vfs_reserved2;
void *vfs_reserved1;
};
#ifdef KERNEL
/*
* Commands for vfs_ioctl. While they are encoded the same way as for ioctl(2),
* there is no generic interface for them from userspace like ioctl(2).
*/
struct fs_snapshot_mount_args {
mount_t sm_mp;
struct componentname *sm_cnp;
};
#define VFSIOC_MOUNT_SNAPSHOT _IOW('V', 1, struct fs_snapshot_mount_args)
struct fs_snapshot_revert_args {
struct componentname *sr_cnp;
};
#define VFSIOC_REVERT_SNAPSHOT _IOW('V', 2, struct fs_snapshot_revert_args)
struct fs_snapshot_root_args {
struct componentname *sr_cnp;
};
#define VFSIOC_ROOT_SNAPSHOT _IOW('V', 3, struct fs_snapshot_root_args)
typedef struct fs_role_mount_args {
mount_t root_mp;
uint32_t mount_role;
} fs_role_mount_args_t;
OS_ENUM(vfs_roles, uint32_t,
VFS_SYSTEM_ROLE = 1,
VFS_RECOVERY_ROLE = 4,
VFS_VM_ROLE = 8,
VFS_PREBOOT_ROLE = 16,
VFS_DATA_ROLE = 64);
#define VFSIOC_MOUNT_BYROLE _IOW('V', 4, fs_role_mount_args_t)
// When this is defined, it is safe to use VFS_RECOVERY_ROLE and
// VFS_PREBOOT_ROLE.
#define VFSIOC_MOUNT_BYROLE_has_recovery 1
#endif /* KERNEL */
/*
* flags passed into vfs_iterate
*/
#ifdef PRIVATE
#define VFS_ITERATE_TAIL_FIRST (1 << 0)
#define VFS_ITERATE_CB_DROPREF (1 << 1) // Callback will drop the iterref
#define VFS_ITERATE_NOSKIP_UNMOUNT (1 << 2) /* Callback will be made on FS in unmount.
* The callback cannot make any calls
* into the Filesystem when this is set. */
#endif /* PRIVATE */
/*
* return values from callback
*/
#define VFS_RETURNED 0 /* done with vnode, reference can be dropped */
#define VFS_RETURNED_DONE 1 /* done with vnode, reference can be dropped, terminate iteration */
#define VFS_CLAIMED 2 /* don't drop reference */
#define VFS_CLAIMED_DONE 3 /* don't drop reference, terminate iteration */
__BEGIN_DECLS
#ifdef BSD_KERNEL_PRIVATE
extern int VFS_MOUNT(mount_t, vnode_t, user_addr_t, vfs_context_t);
extern int VFS_START(mount_t, int, vfs_context_t);
extern int VFS_UNMOUNT(mount_t, int, vfs_context_t);
extern int VFS_ROOT(mount_t, vnode_t *, vfs_context_t);
extern int VFS_QUOTACTL(mount_t, int, uid_t, caddr_t, vfs_context_t);
extern int VFS_GETATTR(mount_t, struct vfs_attr *, vfs_context_t);
extern int VFS_SETATTR(mount_t, struct vfs_attr *, vfs_context_t);
extern int VFS_SYNC(mount_t, int, vfs_context_t);
extern int VFS_VGET(mount_t, ino64_t, vnode_t *, vfs_context_t);
extern int VFS_FHTOVP(mount_t, int, unsigned char *, vnode_t *, vfs_context_t);
extern int VFS_VPTOFH(vnode_t, int *, unsigned char *, vfs_context_t);
extern int VFS_IOCTL(mount_t mp, u_long command, caddr_t data,
int flags, vfs_context_t context);
extern int VFS_VGET_SNAPDIR(mount_t, vnode_t *, vfs_context_t);
#endif /* BSD_KERNEL_PRIVATE */
/*
* prototypes for exported VFS operations
*/
/*!
* @function vfs_fsadd
* @abstract Register a filesystem with VFS.
* @discussion Typically called by a filesystem Kernel Extension when it is loaded.
* @param vfe Filesystem information: table of vfs operations, list of vnode operation tables,
* filesystem type number (can be omitted with VFS_TBLNOTYPENUM flag), name, flags.
* @param handle Opaque handle which will be passed to vfs_fsremove.
* @return 0 for success, else an error code.
*/
int vfs_fsadd(struct vfs_fsentry *vfe, vfstable_t *handle);
/*!
* @function vfs_fsremove
* @abstract Unregister a filesystem with VFS.
* @discussion Typically called by a filesystem Kernel Extension when it is unloaded.
* @param handle Handle which was returned by vfs_fsadd.
* @return 0 for success, else an error code.
*/
int vfs_fsremove(vfstable_t handle);
/*!
* @function vfs_iterate
* @abstract Iterate over all mountpoints with a callback. Used, for example, by sync().
* @param flags Unused.
* @param callout Function which takes a mount and arbitrary passed-in "arg," and returns one of VFS_RETURNED_DONE or VFS_CLAIMED_DONE: end
* iteration and return success. VFS_RETURNED or VFS_CLAIMED: continue iterating. Anything else: continue iterating.
* @param arg Arbitrary data to pass to callback.
* @return 0 for success, else an error code.
*/
int vfs_iterate(int flags, int (*callout)(struct mount *, void *), void *arg);
/*!
* @function vfs_init_io_attributes
* @abstract Set I/O attributes on a mountpoint based on device properties.
* @param devvp Block device vnode from which a filesystem is being mounted.
* @param mp Mountpoint whose I/O parameters to initialize.
* @return 0 for success, else an error code.
*/
int vfs_init_io_attributes(vnode_t devvp, mount_t mp);
/*!
* @function vfs_flags
* @abstract Retrieve mount flags.
* @discussion Results will be in the bitwise "OR" of MNT_VISFLAGMASK and MNT_CMDFLAGS.
* @param mp Mount whose flags to grab.
* @return Flags.
*/
uint64_t vfs_flags(mount_t mp);
/*!
* @function vfs_setflags
* @abstract Set flags on a mount.
* @discussion Sets mount flags to the bitwise "OR" of their current value and the specified bits. Often
* used by a filesystem as part of the mount process.
* @param mp Mount whose flags to set.
* @param flags Flags to activate. Must be in the bitwise "OR" of MNT_VISFLAGMASK and MNT_CMDFLAGS.
*/
void vfs_setflags(mount_t mp, uint64_t flags);
/*!
* @function vfs_clearflags
* @abstract Clear flags on a mount.
* @discussion Sets mount flags to the bitwise "AND" of their current value and the complement of the specified bits.
* @param mp Mount whose flags to set.
* @param flags Flags to deactivate. Must be in the bitwise "OR" of MNT_VISFLAGMASK and MNT_CMDFLAGS.
*/
void vfs_clearflags(mount_t mp, uint64_t flags);
/*!
* @function vfs_issynchronous
* @abstract Determine if writes to a filesystem occur synchronously.
* @param mp Mount to test.
* @return Nonzero if writes occur synchronously, else 0.
*/
int vfs_issynchronous(mount_t mp);
/*!
* @function vfs_iswriteupgrade
* @abstract Determine if a filesystem is mounted read-only but a request has been made to upgrade
* to read-write.
* @param mp Mount to test.
* @return Nonzero if a request has been made to update from read-only to read-write, else 0.
*/
int vfs_iswriteupgrade(mount_t mp);
/*!
* @function vfs_isupdate
* @abstract Determine if a mount update is in progress.
* @param mp Mount to test.
* @return Nonzero if a mount update is in progress, 0 otherwise.
*/
int vfs_isupdate(mount_t mp);
/*!
* @function vfs_isreload
* @abstract Determine if a reload of filesystem data is in progress. This can only be the case
* for a read-only filesystem; all data is brought in from secondary storage.
* @param mp Mount to test.
* @return Nonzero if a request has been made to reload data, else 0.
*/
int vfs_isreload(mount_t mp);
/*!
* @function vfs_isforce
* @abstract Determine if a forced unmount is in progress.
* @discussion A forced unmount invalidates open files.
* @param mp Mount to test.
* @return Nonzero if a request has been made to forcibly unmount, else 0.
*/
int vfs_isforce(mount_t mp);
/*!
* @function vfs_isunmount
* @abstract Determine if an unmount is in progress.
* @discussion This is an unsynchronized snapshot of the mount state. It should only be called
* if the mount is known to be valid, e.g. there are known to be live files on that volume.
* @param mp Mount to test.
* @return Nonzero if an unmount is in progress, else zero.
*/
int vfs_isunmount(mount_t mp);
/*!
* @function vfs_isrdonly
* @abstract Determine if a filesystem is mounted read-only.
* @param mp Mount to test.
* @return Nonzero if filesystem is mounted read-only, else 0.
*/
int vfs_isrdonly(mount_t mp);
/*!
* @function vfs_isrdwr
* @abstract Determine if a filesystem is mounted with writes enabled.
* @param mp Mount to test.
* @return Nonzero if filesystem is mounted read-write, else 0.
*/
int vfs_isrdwr(mount_t mp);