1/*
2 * Copyright (c) 2000-2014 Apple Computer, 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/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
29/*-
30 * Copyright (c) 1982, 1986, 1990, 1993, 1994
31 * The Regents of the University of California. All rights reserved.
32 * (c) UNIX System Laboratories, Inc.
33 * All or some portions of this file are derived from material licensed
34 * to the University of California by American Telephone and Telegraph
35 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
36 * the permission of UNIX System Laboratories, Inc.
37 *
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
40 * are met:
41 * 1. Redistributions of source code must retain the above copyright
42 * notice, this list of conditions and the following disclaimer.
43 * 2. Redistributions in binary form must reproduce the above copyright
44 * notice, this list of conditions and the following disclaimer in the
45 * documentation and/or other materials provided with the distribution.
46 * 3. All advertising materials mentioning features or use of this software
47 * must display the following acknowledgement:
48 * This product includes software developed by the University of
49 * California, Berkeley and its contributors.
50 * 4. Neither the name of the University nor the names of its contributors
51 * may be used to endorse or promote products derived from this software
52 * without specific prior written permission.
53 *
54 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
55 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
56 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
57 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
58 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
59 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
60 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
61 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
62 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
63 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
64 * SUCH DAMAGE.
65 *
66 * @(#)fsctl.h 8.6 (Berkeley) 3/28/94
67 */
68
69#ifndef _SYS_FSCTL_H_
70#define _SYS_FSCTL_H_
71
72#include <sys/ioccom.h>
73#include <sys/mount.h>
74
75#ifdef XNU_KERNEL_PRIVATE
76
77/* Userland structs for namespace handler */
78typedef struct user64_namespace_handler_info {
79 user64_addr_t token;
80 user64_addr_t flags;
81 user64_addr_t fdptr;
82} user64_namespace_handler_info;
83
84typedef struct user32_namespace_handler_info {
85 user32_addr_t token;
86 user32_addr_t flags;
87 user32_addr_t fdptr;
88} user32_namespace_handler_info;
89
90
91/* Kernel-internal of namespace handler info */
92typedef struct namespace_handler_info {
93 user_addr_t token;
94 user_addr_t flags;
95 user_addr_t fdptr;
96} namespace_handler_info;
97
98
99/* Userland structs for extended namespace handler */
100typedef struct user64_namespace_handler_info_ext {
101 user64_addr_t token;
102 user64_addr_t flags;
103 user64_addr_t fdptr;
104 user64_addr_t infoptr;
105} user64_namespace_handler_info_ext;
106
107typedef struct user32_namespace_handler_info_ext {
108 user32_addr_t token;
109 user32_addr_t flags;
110 user32_addr_t fdptr;
111 user32_addr_t infoptr;
112} user32_namespace_handler_info_ext;
113
114
115/* Kernel-internal of extended namespace handler */
116typedef struct namespace_handler_info_ext {
117 user_addr_t token;
118 user_addr_t flags;
119 user_addr_t fdptr;
120 user_addr_t infoptr;
121} namespace_handler_info_ext;
122
123/* Size-Augmented namespace_handler_info */
124/* 64 bit userland*/
125typedef struct user64_namespace_handler_data {
126 user64_addr_t token;
127 user64_addr_t flags;
128 user64_addr_t fdptr;
129 user64_addr_t infoptr;
130 user64_addr_t objid;
131 user64_addr_t reserved1;
132 user64_addr_t reserved2;
133 user64_addr_t reserved3;
134} user64_namespace_handler_data;
135
136/*32 bit userland*/
137typedef struct user32_namespace_handler_data {
138 user32_addr_t token;
139 user32_addr_t flags;
140 user32_addr_t fdptr;
141 user32_addr_t infoptr;
142 user32_addr_t objid;
143 user32_addr_t reserved1;
144 user32_addr_t reserved2;
145 user32_addr_t reserved3;
146} user32_namespace_handler_data;
147
148/* kernel-internal */
149typedef struct namespace_handler_data {
150 user_addr_t token;
151 user_addr_t flags;
152 user_addr_t fdptr;
153 user_addr_t infoptr;
154 user_addr_t objid;
155 user_addr_t reserved1;
156 user_addr_t reserved2;
157 user_addr_t reserved3;
158} namespace_handler_data;
159
160
161extern int resolve_nspace_item_ext(struct vnode *vp, uint64_t op, void *arg);
162extern int get_nspace_item_status(struct vnode *vp, int32_t *status);
163
164#else
165
166typedef struct namespace_handler_info {
167 int32_t *token;
168 int64_t *flags;
169 int32_t *fdptr;
170} namespace_handler_info;
171
172typedef struct namespace_handler_info_ext {
173 int32_t *token;
174 int64_t *flags;
175 int32_t *fdptr;
176 int64_t *infoptr; // for snapshot write events, the kernel puts an offset/length pair here
177} namespace_handler_info_ext;
178
179typedef struct namespace_handler_data {
180 int32_t *token;
181 int64_t *flags;
182 int32_t *fdptr;
183 int64_t *infoptr; // for snapshot write events, the kernel puts an offset/length pair here
184 int64_t *objid;
185 uint32_t *reserved1;
186 uint32_t *reserved2;
187 uint32_t *reserved3;
188} namespace_handler_data;
189
190#endif /* XNU_KERNEL_PRIVATE */
191
192#ifdef KERNEL_PRIVATE
193
194#define NSPACE_REARM_NO_ARG ((void *)1)
195int resolve_nspace_item(struct vnode *vp, uint64_t op);
196int nspace_snapshot_event(vnode_t vp, time_t ctime, uint64_t op_type, void *arg);
197
198#endif // defined(KERNEL_PRIVATE)
199
200#define NAMESPACE_HANDLER_READ_OP 0x0001
201#define NAMESPACE_HANDLER_WRITE_OP 0x0002
202#define NAMESPACE_HANDLER_DELETE_OP 0x0004
203#define NAMESPACE_HANDLER_TRUNCATE_OP 0x0008
204#define NAMESPACE_HANDLER_RENAME_OP 0x0010
205#define NAMESPACE_HANDLER_METADATA_WRITE_OP 0x0020
206#define NAMESPACE_HANDLER_METADATA_DELETE_OP 0x0040
207#define NAMESPACE_HANDLER_METADATA_MOD 0x0080
208// #define NAMESPACE_HANDLER_OP_DO_NOT_USE 0x0100 // SNAPSHOT_EVENT uses this value
209#define NAMESPACE_HANDLER_LINK_CREATE 0x0200
210#define NAMESPACE_HANDLER_RENAME_SUCCESS_OP 0x0400
211#define NAMESPACE_HANDLER_RENAME_FAILED_OP 0x0800
212
213#define NAMESPACE_HANDLER_NSPACE_EVENT 0x1000
214#define NAMESPACE_HANDLER_SNAPSHOT_EVENT 0x0100
215#define NAMESPACE_HANDLER_TRACK_EVENT 0x2000
216
217#define NAMESPACE_HANDLER_EVENT_TYPE_MASK (NAMESPACE_HANDLER_NSPACE_EVENT | NAMESPACE_HANDLER_SNAPSHOT_EVENT | NAMESPACE_HANDLER_TRACK_EVENT)
218
219#define DATALESS_CMPFS_TYPE 0x80000001
220
221
222typedef int32_t nspace_handler_info[2];
223typedef char fstypename_t[MFSTYPENAMELEN];
224
225#ifdef KERNEL
226
227typedef struct user64_package_ext_info {
228 user64_addr_t strings;
229 uint32_t num_entries;
230 uint32_t max_width;
231} user64_package_ext_info;
232
233typedef struct user32_package_ext_info {
234 user32_addr_t strings;
235 uint32_t num_entries;
236 uint32_t max_width;
237} user32_package_ext_info;
238
239#endif // KERNEL
240
241typedef struct package_ext_info {
242 const char *strings;
243 uint32_t num_entries;
244 uint32_t max_width;
245} package_ext_info;
246
247/* Disk conditioner configuration */
248typedef struct disk_conditioner_info {
249 int enabled;
250 uint64_t access_time_usec; // maximum latency until transfer begins
251 uint64_t read_throughput_mbps; // maximum throughput for reads
252 uint64_t write_throughput_mbps; // maximum throughput for writes
253 int is_ssd; // behave like an SSD
254
255 /* revision 2 */
256 uint32_t ioqueue_depth;
257 uint32_t maxreadcnt;
258 uint32_t maxwritecnt;
259 uint32_t segreadcnt;
260 uint32_t segwritecnt;
261} disk_conditioner_info;
262
263#define FSCTL_SYNC_FULLSYNC (1<<0) /* Flush the data fully to disk, if supported by the filesystem */
264#define FSCTL_SYNC_WAIT (1<<1) /* Wait for the sync to complete */
265
266
267#define FSIOC_SYNC_VOLUME _IOW('A', 1, uint32_t)
268#define FSCTL_SYNC_VOLUME IOCBASECMD(FSIOC_SYNC_VOLUME)
269
270#define FSIOC_SET_PACKAGE_EXTS _IOW('A', 2, struct package_ext_info)
271#define FSCTL_SET_PACKAGE_EXTS IOCBASECMD(FSIOC_SET_PACKAGE_EXTS)
272
273/* Unsupported - previously FSIOC_WAIT_FOR_SYNC */
274#define FSIOC_UNSUPPORTED _IOR('A', 3, int32_t)
275
276#define FSIOC_NAMESPACE_HANDLER_GET _IOW('A', 4, struct namespace_handler_info)
277#define FSCTL_NAMESPACE_HANDLER_GET IOCBASECMD(FSIOC_NAMESPACE_HANDLER_GET)
278
279#define FSIOC_NAMESPACE_HANDLER_UPDATE _IOW('A', 5, nspace_handler_info)
280#define FSCTL_NAMESPACE_HANDLER_UPDATE IOCBASECMD(FSIOC_NAMESPACE_HANDLER_UPDATE)
281
282#define FSIOC_NAMESPACE_HANDLER_UNBLOCK _IOW('A', 6, nspace_handler_info)
283#define FSCTL_NAMESPACE_HANDLER_UNBLOCK IOCBASECMD(FSIOC_NAMESPACE_HANDLER_UNBLOCK)
284
285#define FSIOC_NAMESPACE_HANDLER_CANCEL _IOW('A', 7, nspace_handler_info)
286#define FSCTL_NAMESPACE_HANDLER_CANCEL IOCBASECMD(FSIOC_NAMESPACE_HANDLER_CANCEL)
287
288#define FSIOC_NAMESPACE_HANDLER_SET_SNAPSHOT_TIME _IOW('A', 8, int32_t)
289#define FSCTL_NAMESPACE_HANDLER_SET_SNAPSHOT_TIME IOCBASECMD(FSIOC_NAMESPACE_HANDLER_SET_SNAPSHOT_TIME)
290
291#define FSIOC_OLD_SNAPSHOT_HANDLER_GET _IOW('A', 9, struct namespace_handler_info)
292#define FSCTL_OLD_SNAPSHOT_HANDLER_GET IOCBASECMD(FSIOC_OLD_SNAPSHOT_HANDLER_GET)
293
294#define FSIOC_SET_FSTYPENAME_OVERRIDE _IOW('A', 10, fstypename_t)
295#define FSCTL_SET_FSTYPENAME_OVERRIDE IOCBASECMD(FSIOC_SET_FSTYPENAME_OVERRIDE)
296
297#define FSIOC_NAMESPACE_ALLOW_DMG_SNAPSHOT_EVENTS _IOW('A', 11, int32_t)
298#define FSCTL_NAMESPACE_ALLOW_DMG_SNAPSHOT_EVENTS IOCBASECMD(FSIOC_NAMESPACE_ALLOW_DMG_SNAPSHOT_EVENTS)
299
300/* 12 was used for TRACKED_HANDLER_GET which has now been removed
301 as it is no longer used. */
302
303#define FSIOC_SNAPSHOT_HANDLER_GET_EXT _IOW('A', 13, struct namespace_handler_info_ext)
304#define FSCTL_SNAPSHOT_HANDLER_GET_EXT IOCBASECMD(FSIOC_SNAPSHOT_HANDLER_GET_EXT)
305
306/* 14 was used for NAMESPACE_HANDLER_GETDATA which has now been
307 removed as it is no longer used. */
308
309#define FSIOC_ROUTEFS_SETROUTEID _IO('A', 15)
310#define FSCTL_ROUTEFS_SETROUTEID IOCBASECMD(FSIOC_ROUTEFS_SETROUTEID)
311
312/* ioctls to support SEEK_HOLE SEEK_DATA */
313#define FSIOC_FIOSEEKHOLE _IOWR('A', 16, off_t)
314#define FSCTL_FIOSEEKHOLE IOCBASECMD(FSIOC_FIOSEEKHOLE)
315#define FSIOC_FIOSEEKDATA _IOWR('A', 17, off_t)
316#define FSCTL_FIOSEEKDATA IOCBASECMD(FSIOC_FIOSEEKDATA)
317
318/* Disk conditioner */
319#define DISK_CONDITIONER_IOC_GET _IOR('A', 18, disk_conditioner_info)
320#define DISK_CONDITIONER_FSCTL_GET IOCBASECMD(DISK_CONDITIONER_IOC_GET)
321#define DISK_CONDITIONER_IOC_SET _IOW('A', 19, disk_conditioner_info)
322#define DISK_CONDITIONER_FSCTL_SET IOCBASECMD(DISK_CONDITIONER_IOC_SET)
323
324//
325// Spotlight and fseventsd use these fsctl()'s to find out
326// the mount time of a volume and the last time it was
327// unmounted. Both HFS and APFS support these calls.
328//
329// NOTE: the values for these defines should _not_ be changed
330// or else it will break binary compatibility with mds
331// and fseventsd.
332//
333#define SPOTLIGHT_IOC_GET_MOUNT_TIME _IOR('h', 18, u_int32_t)
334#define SPOTLIGHT_FSCTL_GET_MOUNT_TIME IOCBASECMD(SPOTLIGHT_IOC_GET_MOUNT_TIME)
335#define SPOTLIGHT_IOC_GET_LAST_MTIME _IOR('h', 19, u_int32_t)
336#define SPOTLIGHT_FSCTL_GET_LAST_MTIME IOCBASECMD(SPOTLIGHT_IOC_GET_LAST_MTIME)
337
338/* Mark file's extents as "frozen" because someone has references to physical address */
339#define FSIOC_FREEZE_EXTENTS _IO('h', 20)
340#define FSCTL_FREEZE_EXTENTS IOCBASECMD(FSIOC_FREEZE_EXTENTS)
341
342/* Clear the "frozen" status of file's extents */
343#define FSIOC_THAW_EXTENTS _IO('h', 21)
344#define FSCTL_THAW_EXTENTS IOCBASECMD(FSIOC_THAW_EXTENTS)
345
346#ifndef KERNEL
347
348#include <sys/cdefs.h>
349
350__BEGIN_DECLS
351
352int fsctl(const char *,unsigned long,void*,unsigned int);
353int ffsctl(int,unsigned long,void*,unsigned int);
354
355__END_DECLS
356
357#endif /* !KERNEL */
358#endif /* !_SYS_FSCTL_H_ */
359