xref: /xnu-12377.1.9/bsd/sys/snapshot.h (revision f6217f891ac0bb64f3d375211650a4c1ff8ca1ea)
1 /*
2  * Copyright (c) 2016 Apple Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
6  * This file contains Original Code and/or Modifications of Original Code
7  * as defined in and that are subject to the Apple Public Source License
8  * Version 2.0 (the 'License'). You may not use this file except in
9  * compliance with the License. The rights granted to you under the License
10  * may not be used to create, or enable the creation or redistribution of,
11  * unlawful or unlicensed copies of an Apple operating system, or to
12  * circumvent, violate, or enable the circumvention or violation of, any
13  * terms of an Apple operating system software license agreement.
14  *
15  * Please obtain a copy of the License at
16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17  *
18  * The Original Code and all software distributed under the License are
19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23  * Please see the License for the specific language governing rights and
24  * limitations under the License.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 
29 #ifndef _SYS_SNAPSHOT_H_
30 #define _SYS_SNAPSHOT_H_
31 
32 #ifndef KERNEL
33 
34 #include <sys/cdefs.h>
35 #include <machine/_types.h>
36 #include <sys/_types/_size_t.h>
37 #include <_types/_uint32_t.h>
38 #include <sys/attr.h>
39 #include <Availability.h>
40 
41 __BEGIN_DECLS
42 
43 int fs_snapshot_create(int, const char *, uint32_t) __OSX_AVAILABLE(10.12) __IOS_AVAILABLE(10.0) __TVOS_AVAILABLE(10.0) __WATCHOS_AVAILABLE(3.0);
44 
45 int fs_snapshot_list(int, struct attrlist  *, void *, size_t, uint32_t) __OSX_AVAILABLE(10.12) __IOS_AVAILABLE(10.0) __TVOS_AVAILABLE(10.0) __WATCHOS_AVAILABLE(3.0);
46 
47 int fs_snapshot_delete(int, const char *, uint32_t) __OSX_AVAILABLE(10.12) __IOS_AVAILABLE(10.0) __TVOS_AVAILABLE(10.0) __WATCHOS_AVAILABLE(3.0);
48 
49 int fs_snapshot_rename(int, const char *, const char *, uint32_t) __OSX_AVAILABLE(10.12) __IOS_AVAILABLE(10.0) __TVOS_AVAILABLE(10.0) __WATCHOS_AVAILABLE(3.0);
50 
51 #endif /* !KERNEL */
52 
53 /* fs_snapshot_mount() supported flags */
54 #define SNAPSHOT_MNT_RESERVED1          0x00000001    /* same as MNT_RDONLY */
55 #define SNAPSHOT_MNT_NOEXEC             0x00000004    /* same as MNT_NOEXEC */
56 #define SNAPSHOT_MNT_NOSUID             0x00000008    /* same as MNT_NOSUID */
57 #define SNAPSHOT_MNT_NODEV              0x00000010    /* same as MNT_NODEV */
58 #define SNAPSHOT_MNT_DONTBROWSE         0x00100000    /* same as MNT_DONTBROWSE */
59 #define SNAPSHOT_MNT_IGNORE_OWNERSHIP   0x00200000    /* same as MNT_IGNORE_OWNERSHIP */
60 #define SNAPSHOT_MNT_NOFOLLOW           0x08000000    /* same as MNT_NOFOLLOW */
61 
62 #define SNAPSHOT_MNT_VALIDMASK          0x0830001d
63 
64 #ifndef KERNEL
65 
66 int fs_snapshot_mount(int, const char *, const char *, uint32_t) __OSX_AVAILABLE(10.12) __IOS_AVAILABLE(10.0)       __TVOS_AVAILABLE(10.0) __WATCHOS_AVAILABLE(3.0);
67 
68 int fs_snapshot_revert(int, const char *, uint32_t) __OSX_AVAILABLE(10.12) __IOS_AVAILABLE(10.0) __TVOS_AVAILABLE(10.0) __WATCHOS_AVAILABLE(3.0);
69 
70 #ifdef PRIVATE
71 int fs_snapshot_root(int, const char *, uint32_t) __OSX_AVAILABLE(10.12.4) __IOS_AVAILABLE(10.3) __TVOS_AVAILABLE(10.3) __WATCHOS_AVAILABLE(3.3);
72 #endif
73 
74 __END_DECLS
75 
76 #endif /* !KERNEL */
77 
78 #ifdef PRIVATE
79 
80 #define SNAPSHOT_OP_CREATE 0x01
81 #define SNAPSHOT_OP_DELETE 0x02
82 #define SNAPSHOT_OP_RENAME 0x03
83 #define SNAPSHOT_OP_MOUNT  0x04
84 #define SNAPSHOT_OP_REVERT 0x05
85 #define SNAPSHOT_OP_ROOT   0x06
86 
87 #endif
88 
89 #endif /* !_SYS_SNAPSHOT_H_ */
90