[apple/xnu.git] / bsd / sys / fsctl.h

/*
 * Copyright (c) 2000-2014 Apple Computer, 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) 1982, 1986, 1990, 1993, 1994
 *	The Regents of the University of California.  All rights reserved.
 * (c) UNIX System Laboratories, Inc.
 * All or some portions of this file are derived from material licensed
 * to the University of California by American Telephone and Telegraph
 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
 * the permission of UNIX System Laboratories, Inc.
 *
 * 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.
 *
 *	@(#)fsctl.h	8.6 (Berkeley) 3/28/94
 */

#ifndef	_SYS_FSCTL_H_
#define	_SYS_FSCTL_H_

#include <sys/ioccom.h>
#include <sys/mount.h>

#ifdef XNU_KERNEL_PRIVATE

/* Userland structs for namespace handler */
typedef struct user64_namespace_handler_info {
	user64_addr_t  token;
	user64_addr_t  flags;
	user64_addr_t  fdptr;
} user64_namespace_handler_info;

typedef struct user32_namespace_handler_info {
	user32_addr_t  token;
	user32_addr_t  flags;
	user32_addr_t  fdptr;
} user32_namespace_handler_info;


/* Kernel-internal of namespace handler info */
typedef struct namespace_handler_info {
	user_addr_t  token;
	user_addr_t  flags;
	user_addr_t  fdptr;
} namespace_handler_info;


/* Userland structs for extended namespace handler */
typedef struct user64_namespace_handler_info_ext {
	user64_addr_t  token;
	user64_addr_t  flags;
	user64_addr_t  fdptr;
	user64_addr_t  infoptr;
} user64_namespace_handler_info_ext;

typedef struct user32_namespace_handler_info_ext {
	user32_addr_t  token;
	user32_addr_t  flags;
	user32_addr_t  fdptr;
	user32_addr_t  infoptr;
} user32_namespace_handler_info_ext;


/* Kernel-internal of extended namespace handler */
typedef struct namespace_handler_info_ext {
	user_addr_t  token;
	user_addr_t  flags;
	user_addr_t  fdptr;
	user_addr_t  infoptr;
} namespace_handler_info_ext;

/* Size-Augmented namespace_handler_info */
/* 64 bit userland*/
typedef struct user64_namespace_handler_data {
	user64_addr_t token;
	user64_addr_t flags;
	user64_addr_t fdptr;
	user64_addr_t infoptr;
	user64_addr_t objid;
	user64_addr_t reserved1;
	user64_addr_t reserved2;
	user64_addr_t reserved3;
} user64_namespace_handler_data;

/*32 bit userland*/
typedef struct user32_namespace_handler_data {
	user32_addr_t token;
	user32_addr_t flags;
	user32_addr_t fdptr;
	user32_addr_t infoptr;
	user32_addr_t objid;
	user32_addr_t reserved1;
	user32_addr_t reserved2;
	user32_addr_t reserved3;
} user32_namespace_handler_data;

/* kernel-internal */
typedef struct namespace_handler_data {
	user_addr_t token;
	user_addr_t flags;
	user_addr_t fdptr;
	user_addr_t infoptr;
	user_addr_t objid;
	user_addr_t reserved1;
	user_addr_t reserved2;
	user_addr_t reserved3;
} namespace_handler_data;


extern int resolve_nspace_item_ext(struct vnode *vp, uint64_t op, void *arg);
extern int get_nspace_item_status(struct vnode *vp, int32_t *status);

#else

typedef struct namespace_handler_info {
	int32_t    *token;
	int64_t    *flags;
	int32_t    *fdptr;
} namespace_handler_info;

typedef struct namespace_handler_info_ext {
	int32_t    *token;
	int64_t    *flags;
	int32_t    *fdptr;
	int64_t    *infoptr;     // for snapshot write events, the kernel puts an offset/length pair here
} namespace_handler_info_ext;

typedef struct namespace_handler_data {
	int32_t *token;
	int64_t *flags;
	int32_t *fdptr;
	int64_t *infoptr;     // for snapshot write events, the kernel puts an offset/length pair here
	int64_t *objid;
	uint32_t *reserved1;
	uint32_t *reserved2;
	uint32_t *reserved3;
} namespace_handler_data;

#endif /* XNU_KERNEL_PRIVATE */

#ifdef KERNEL_PRIVATE

#define NSPACE_REARM_NO_ARG ((void *)1)
int resolve_nspace_item(struct vnode *vp, uint64_t op);
int nspace_snapshot_event(vnode_t vp, time_t ctime, uint64_t op_type, void *arg);

#endif // defined(KERNEL_PRIVATE)

#define NAMESPACE_HANDLER_READ_OP             0x0001
#define NAMESPACE_HANDLER_WRITE_OP            0x0002
#define NAMESPACE_HANDLER_DELETE_OP           0x0004
#define NAMESPACE_HANDLER_TRUNCATE_OP         0x0008
#define NAMESPACE_HANDLER_RENAME_OP           0x0010
#define NAMESPACE_HANDLER_METADATA_WRITE_OP   0x0020
#define NAMESPACE_HANDLER_METADATA_DELETE_OP  0x0040
#define NAMESPACE_HANDLER_METADATA_MOD        0x0080
// #define NAMESPACE_HANDLER_OP_DO_NOT_USE    0x0100   // SNAPSHOT_EVENT uses this value
#define NAMESPACE_HANDLER_LINK_CREATE         0x0200
#define NAMESPACE_HANDLER_RENAME_SUCCESS_OP   0x0400
#define NAMESPACE_HANDLER_RENAME_FAILED_OP    0x0800

#define NAMESPACE_HANDLER_NSPACE_EVENT        0x1000
#define NAMESPACE_HANDLER_SNAPSHOT_EVENT      0x0100
#define NAMESPACE_HANDLER_TRACK_EVENT         0x2000

#define NAMESPACE_HANDLER_EVENT_TYPE_MASK (NAMESPACE_HANDLER_NSPACE_EVENT | NAMESPACE_HANDLER_SNAPSHOT_EVENT | NAMESPACE_HANDLER_TRACK_EVENT)

#define DATALESS_CMPFS_TYPE     0x80000001


typedef int32_t nspace_handler_info[2];
typedef char fstypename_t[MFSTYPENAMELEN];

#ifdef KERNEL

typedef struct user64_package_ext_info {
    user64_addr_t strings;
    uint32_t      num_entries;
    uint32_t      max_width;
} user64_package_ext_info;

typedef struct user32_package_ext_info {
    user32_addr_t strings;
    uint32_t      num_entries;
    uint32_t      max_width;
} user32_package_ext_info;

#endif  // KERNEL

typedef struct package_ext_info {
    const char *strings;
    uint32_t    num_entries;
    uint32_t    max_width;
} package_ext_info;

#define	FSCTL_SYNC_FULLSYNC	(1<<0)	/* Flush the data fully to disk, if supported by the filesystem */
#define	FSCTL_SYNC_WAIT		(1<<1)	/* Wait for the sync to complete */


#define FSIOC_SYNC_VOLUME			  _IOW('A', 1, uint32_t)
#define	FSCTL_SYNC_VOLUME			  IOCBASECMD(FSIOC_SYNC_VOLUME)

#define FSIOC_SET_PACKAGE_EXTS			  _IOW('A', 2, struct package_ext_info)
#define	FSCTL_SET_PACKAGE_EXTS			  IOCBASECMD(FSIOC_SET_PACKAGE_EXTS)

/* Unsupported - previously FSIOC_WAIT_FOR_SYNC */
#define FSIOC_UNSUPPORTED 			  _IOR('A', 3, int32_t)

#define FSIOC_NAMESPACE_HANDLER_GET		  _IOW('A', 4, struct namespace_handler_info)
#define	FSCTL_NAMESPACE_HANDLER_GET		  IOCBASECMD(FSIOC_NAMESPACE_HANDLER_GET)

#define FSIOC_NAMESPACE_HANDLER_UPDATE		  _IOW('A', 5, nspace_handler_info)
#define	FSCTL_NAMESPACE_HANDLER_UPDATE		  IOCBASECMD(FSIOC_NAMESPACE_HANDLER_UPDATE)

#define FSIOC_NAMESPACE_HANDLER_UNBLOCK		  _IOW('A', 6, nspace_handler_info)
#define	FSCTL_NAMESPACE_HANDLER_UNBLOCK		  IOCBASECMD(FSIOC_NAMESPACE_HANDLER_UNBLOCK)

#define FSIOC_NAMESPACE_HANDLER_CANCEL		  _IOW('A', 7, nspace_handler_info)
#define	FSCTL_NAMESPACE_HANDLER_CANCEL		  IOCBASECMD(FSIOC_NAMESPACE_HANDLER_CANCEL)

#define FSIOC_NAMESPACE_HANDLER_SET_SNAPSHOT_TIME _IOW('A', 8, int32_t)
#define	FSCTL_NAMESPACE_HANDLER_SET_SNAPSHOT_TIME IOCBASECMD(FSIOC_NAMESPACE_HANDLER_SET_SNAPSHOT_TIME)

#define FSIOC_OLD_SNAPSHOT_HANDLER_GET		  _IOW('A', 9, struct namespace_handler_info)
#define FSCTL_OLD_SNAPSHOT_HANDLER_GET		  IOCBASECMD(FSIOC_OLD_SNAPSHOT_HANDLER_GET)

#define FSIOC_SET_FSTYPENAME_OVERRIDE		  _IOW('A', 10, fstypename_t)
#define	FSCTL_SET_FSTYPENAME_OVERRIDE	          IOCBASECMD(FSIOC_SET_FSTYPENAME_OVERRIDE)

#define FSIOC_NAMESPACE_ALLOW_DMG_SNAPSHOT_EVENTS _IOW('A', 11, int32_t)
#define	FSCTL_NAMESPACE_ALLOW_DMG_SNAPSHOT_EVENTS IOCBASECMD(FSIOC_NAMESPACE_ALLOW_DMG_SNAPSHOT_EVENTS)

/* 12 was used for TRACKED_HANDLER_GET which has now been removed
   as it is no longer used. */

#define FSIOC_SNAPSHOT_HANDLER_GET_EXT		  _IOW('A', 13, struct namespace_handler_info_ext)
#define FSCTL_SNAPSHOT_HANDLER_GET_EXT		  IOCBASECMD(FSIOC_SNAPSHOT_HANDLER_GET_EXT)

/* 14 was used for NAMESPACE_HANDLER_GETDATA which has now been
   removed as it is no longer used. */

#define FSIOC_ROUTEFS_SETROUTEID			  _IO('A', 15)
#define	FSCTL_ROUTEFS_SETROUTEID			  IOCBASECMD(FSIOC_ROUTEFS_SETROUTEID)

//
// IO commands 16 and 17 are currently unused
//

//
// Spotlight and fseventsd use these fsctl()'s to find out 
// the mount time of a volume and the last time it was 
// unmounted.  Both HFS and ZFS support these calls.
//
// User space code should pass the "_IOC_" macros while the 
// kernel should test for the "_FSCTL_" variant of the macro 
// in its vnop_ioctl function.
//
// NOTE: the values for these defines should _not_ be changed
//       or else it will break binary compatibility with mds
//       and fseventsd.
//
#define SPOTLIGHT_IOC_GET_MOUNT_TIME		  _IOR('h', 18, u_int32_t)
#define SPOTLIGHT_FSCTL_GET_MOUNT_TIME		  IOCBASECMD(SPOTLIGHT_IOC_GET_MOUNT_TIME)
#define SPOTLIGHT_IOC_GET_LAST_MTIME		  _IOR('h', 19, u_int32_t)
#define SPOTLIGHT_FSCTL_GET_LAST_MTIME		  IOCBASECMD(SPOTLIGHT_IOC_GET_LAST_MTIME)


#ifndef KERNEL

#include <sys/cdefs.h>

__BEGIN_DECLS

int	fsctl(const char *,unsigned long,void*,unsigned int);
int	ffsctl(int,unsigned long,void*,unsigned int);

__END_DECLS

#endif /* !KERNEL */
#endif /* !_SYS_FSCTL_H_ */
Commit	Line	Data
1c79356b	1	/*
fe8ab488	2	* Copyright (c) 2000-2014 Apple Computer, Inc. All rights reserved.
5d5c5d0d	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	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>
6d2010ae	73	#include <sys/mount.h>
1c79356b	74
6d2010ae	75	#ifdef XNU_KERNEL_PRIVATE
b0d623f7	76
39236c6e	77	/* Userland structs for namespace handler */
6d2010ae A	78	typedef 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
	84	typedef 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
39236c6e A	90
39236c6e A	91	/* Kernel-internal of namespace handler info */
6d2010ae A	92	typedef struct namespace_handler_info {
	93	user_addr_t token;
	94	user_addr_t flags;
	95	user_addr_t fdptr;
	96	} namespace_handler_info;
	97
39236c6e A	98
39236c6e A	99	/* Userland structs for extended namespace handler */
6d2010ae A	100	typedef 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
	107	typedef 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
39236c6e A	114
39236c6e A	115	/* Kernel-internal of extended namespace handler */
6d2010ae A	116	typedef 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
39236c6e A	123	/* Size-Augmented namespace_handler_info */
	124	/* 64 bit userland*/
	125	typedef 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/
	137	typedef 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 */
	149	typedef 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
6d2010ae A	161	extern int resolve_nspace_item_ext(struct vnode vp, uint64_t op, void arg);
	162	extern int get_nspace_item_status(struct vnode vp, int32_t status);
	163
	164	#else
	165
	166	typedef struct namespace_handler_info {
	167	int32_t *token;
	168	int64_t *flags;
	169	int32_t *fdptr;
	170	} namespace_handler_info;
	171
	172	typedef 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
39236c6e A	179	typedef 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;
6d2010ae A	189
	190	#endif /* XNU_KERNEL_PRIVATE */
	191
39037602 A	192	#ifdef KERNEL_PRIVATE
	193
	194	#define NSPACE_REARM_NO_ARG ((void *)1)
	195	int resolve_nspace_item(struct vnode *vp, uint64_t op);
	196	int nspace_snapshot_event(vnode_t vp, time_t ctime, uint64_t op_type, void *arg);
	197
	198	#endif // defined(KERNEL_PRIVATE)
	199
6d2010ae A	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
39236c6e	208	// #define NAMESPACE_HANDLER_OP_DO_NOT_USE 0x0100 // SNAPSHOT_EVENT uses this value
6d2010ae	209	#define NAMESPACE_HANDLER_LINK_CREATE 0x0200
39236c6e A	210	#define NAMESPACE_HANDLER_RENAME_SUCCESS_OP 0x0400
39236c6e A	211	#define NAMESPACE_HANDLER_RENAME_FAILED_OP 0x0800
6d2010ae A	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
b0d623f7 A	220
b0d623f7 A	221
6d2010ae A	222	typedef int32_t nspace_handler_info[2];
	223	typedef char fstypename_t[MFSTYPENAMELEN];
	224
	225	#ifdef KERNEL
	226
	227	typedef 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
	233	typedef 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
b0d623f7 A	241	typedef struct package_ext_info {
	242	const char *strings;
	243	uint32_t num_entries;
	244	uint32_t max_width;
	245	} package_ext_info;
	246
6d2010ae A	247	#define FSCTL_SYNC_FULLSYNC (1<<0) /* Flush the data fully to disk, if supported by the filesystem */
	248	#define FSCTL_SYNC_WAIT (1<<1) /* Wait for the sync to complete */
	249
	250
	251	#define FSIOC_SYNC_VOLUME _IOW('A', 1, uint32_t)
	252	#define FSCTL_SYNC_VOLUME IOCBASECMD(FSIOC_SYNC_VOLUME)
	253
	254	#define FSIOC_SET_PACKAGE_EXTS _IOW('A', 2, struct package_ext_info)
	255	#define FSCTL_SET_PACKAGE_EXTS IOCBASECMD(FSIOC_SET_PACKAGE_EXTS)
	256
39236c6e A	257	/* Unsupported - previously FSIOC_WAIT_FOR_SYNC */
39236c6e A	258	#define FSIOC_UNSUPPORTED _IOR('A', 3, int32_t)
6d2010ae A	259
	260	#define FSIOC_NAMESPACE_HANDLER_GET _IOW('A', 4, struct namespace_handler_info)
	261	#define FSCTL_NAMESPACE_HANDLER_GET IOCBASECMD(FSIOC_NAMESPACE_HANDLER_GET)
	262
	263	#define FSIOC_NAMESPACE_HANDLER_UPDATE _IOW('A', 5, nspace_handler_info)
	264	#define FSCTL_NAMESPACE_HANDLER_UPDATE IOCBASECMD(FSIOC_NAMESPACE_HANDLER_UPDATE)
	265
	266	#define FSIOC_NAMESPACE_HANDLER_UNBLOCK _IOW('A', 6, nspace_handler_info)
	267	#define FSCTL_NAMESPACE_HANDLER_UNBLOCK IOCBASECMD(FSIOC_NAMESPACE_HANDLER_UNBLOCK)
b0d623f7	268
6d2010ae A	269	#define FSIOC_NAMESPACE_HANDLER_CANCEL _IOW('A', 7, nspace_handler_info)
6d2010ae A	270	#define FSCTL_NAMESPACE_HANDLER_CANCEL IOCBASECMD(FSIOC_NAMESPACE_HANDLER_CANCEL)
b0d623f7	271
6d2010ae A	272	#define FSIOC_NAMESPACE_HANDLER_SET_SNAPSHOT_TIME _IOW('A', 8, int32_t)
	273	#define FSCTL_NAMESPACE_HANDLER_SET_SNAPSHOT_TIME IOCBASECMD(FSIOC_NAMESPACE_HANDLER_SET_SNAPSHOT_TIME)
	274
	275	#define FSIOC_OLD_SNAPSHOT_HANDLER_GET _IOW('A', 9, struct namespace_handler_info)
	276	#define FSCTL_OLD_SNAPSHOT_HANDLER_GET IOCBASECMD(FSIOC_OLD_SNAPSHOT_HANDLER_GET)
	277
	278	#define FSIOC_SET_FSTYPENAME_OVERRIDE _IOW('A', 10, fstypename_t)
	279	#define FSCTL_SET_FSTYPENAME_OVERRIDE IOCBASECMD(FSIOC_SET_FSTYPENAME_OVERRIDE)
	280
	281	#define FSIOC_NAMESPACE_ALLOW_DMG_SNAPSHOT_EVENTS _IOW('A', 11, int32_t)
	282	#define FSCTL_NAMESPACE_ALLOW_DMG_SNAPSHOT_EVENTS IOCBASECMD(FSIOC_NAMESPACE_ALLOW_DMG_SNAPSHOT_EVENTS)
	283
fe8ab488 A	284	/* 12 was used for TRACKED_HANDLER_GET which has now been removed
fe8ab488 A	285	as it is no longer used. */
6d2010ae A	286
	287	#define FSIOC_SNAPSHOT_HANDLER_GET_EXT _IOW('A', 13, struct namespace_handler_info_ext)
	288	#define FSCTL_SNAPSHOT_HANDLER_GET_EXT IOCBASECMD(FSIOC_SNAPSHOT_HANDLER_GET_EXT)
	289
fe8ab488 A	290	/* 14 was used for NAMESPACE_HANDLER_GETDATA which has now been
fe8ab488 A	291	removed as it is no longer used. */
39236c6e	292
490019cf A	293	#define FSIOC_ROUTEFS_SETROUTEID _IO('A', 15)
	294	#define FSCTL_ROUTEFS_SETROUTEID IOCBASECMD(FSIOC_ROUTEFS_SETROUTEID)
	295
6d2010ae	296	//
490019cf	297	// IO commands 16 and 17 are currently unused
6d2010ae	298	//
b0d623f7 A	299
	300	//
	301	// Spotlight and fseventsd use these fsctl()'s to find out
	302	// the mount time of a volume and the last time it was
	303	// unmounted. Both HFS and ZFS support these calls.
	304	//
	305	// User space code should pass the "_IOC_" macros while the
	306	// kernel should test for the "_FSCTL_" variant of the macro
	307	// in its vnop_ioctl function.
	308	//
	309	// NOTE: the values for these defines should _not_ be changed
	310	// or else it will break binary compatibility with mds
	311	// and fseventsd.
	312	//
6d2010ae A	313	#define SPOTLIGHT_IOC_GET_MOUNT_TIME _IOR('h', 18, u_int32_t)
	314	#define SPOTLIGHT_FSCTL_GET_MOUNT_TIME IOCBASECMD(SPOTLIGHT_IOC_GET_MOUNT_TIME)
	315	#define SPOTLIGHT_IOC_GET_LAST_MTIME _IOR('h', 19, u_int32_t)
	316	#define SPOTLIGHT_FSCTL_GET_LAST_MTIME IOCBASECMD(SPOTLIGHT_IOC_GET_LAST_MTIME)
b0d623f7 A	317
b0d623f7 A	318
1c79356b A	319	#ifndef KERNEL
	320
	321	#include <sys/cdefs.h>
	322
	323	__BEGIN_DECLS
b0d623f7 A	324
	325	int fsctl(const char ,unsigned long,void,unsigned int);
	326	int ffsctl(int,unsigned long,void*,unsigned int);
	327
1c79356b A	328	__END_DECLS
	329
	330	#endif /* !KERNEL */
	331	#endif /* !_SYS_FSCTL_H_ */