xref: /xnu-11417.140.69/bsd/sys/fsctl.h (revision 43a90889846e00bfb5cf1d255cdc0a701a1e05a4)

/*
 * Copyright (c) 2000-2020 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;


#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 vfs_materialize_file(struct vnode *vp, uint64_t op, int64_t offset, int64_t size);
int vfs_materialize_dir(struct vnode *vp, uint64_t op, char *file_name, size_t namelen);
int vfs_materialize_reparent(struct vnode *vp, struct vnode *tdvp);

#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_LOOKUP_OP           0x4000

#define NAMESPACE_HANDLER_EVENT_TYPE_MASK (NAMESPACE_HANDLER_NSPACE_EVENT | NAMESPACE_HANDLER_SNAPSHOT_EVENT | NAMESPACE_HANDLER_TRACK_EVENT)


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;

/* Disk conditioner configuration */
typedef struct disk_conditioner_info {
	int enabled;
	uint64_t access_time_usec; // maximum latency until transfer begins
	uint64_t read_throughput_mbps; // maximum throughput for reads
	uint64_t write_throughput_mbps; // maximum throughput for writes
	int is_ssd; // behave like an SSD

	/* revision 2 */
	uint32_t ioqueue_depth;
	uint32_t maxreadcnt;
	uint32_t maxwritecnt;
	uint32_t segreadcnt;
	uint32_t segwritecnt;
} disk_conditioner_info;

/*
 * BSD flags manipulation arguments.
 *
 * This provides a safe way to update the BSD flags field of an inode,
 * which has some user components as well as some system components.
 * What it provides is a compare-and-swap operation, whereby the caller
 * fetches what the expected flags are, computes the new set, and then
 * provides the old along with the new.  If the old that's provided matches
 * what's actually in the inode, the new value is set.  The actual inode
 * value is returned to the caller, and expected == actual is how the
 * caller can determine that the operation succeeded.
 *
 * Some BSD flags (e.g. UF_COMPRESSED) can only be manipulated via this
 * safe mechanism.
 */
struct fsioc_cas_bsdflags {
	uint32_t expected_flags;        /* [IN] expected flags */
	uint32_t new_flags;             /* [IN] new value to set */
	uint32_t actual_flags;          /* [OUT] the actual flags in inode */
};

#define FSIOC_GRAFT_VERSION          2

/* Grafting flags */
#define FSCTL_GRAFT_PRESERVE_MOUNT              0x0001  /* Preserve underlying mount until shutdown */
#define FSCTL_GRAFT_ALTERNATE_SHARED_REGION     0x0002  /* Binaries within should use alternate shared region */
#define FSCTL_GRAFT_SYSTEM_CONTENT              0x0004  /* Cryptex contains system content */
#define FSCTL_GRAFT_PANIC_ON_AUTHFAIL           0x0008  /* On failure to authenticate, panic */
#define FSCTL_GRAFT_STRICT_AUTH                 0x0010  /* Strict authentication mode */
#define FSCTL_GRAFT_PRESERVE_GRAFT              0x0020  /* Preserve graft itself until unmount */

/* Ungrafting flags */
#define FSCTL_UNGRAFT_UNGRAFTALL                0x0001  /* Ungraft all currently grafted filesystems */

#ifdef KERNEL

typedef struct fsioc_graft_fs {
	uint32_t graft_version;
	uint32_t graft_type;
	uint32_t graft_4cc;
	uint64_t graft_flags;
	uint64_t dir_ino;

	void *authentic_manifest;
	size_t authentic_manifest_size;
	void *user_manifest;
	size_t user_manifest_size;
	void *payload;
	size_t payload_size;
} fsioc_graft_fs_t;

typedef struct fsioc_ungraft_fs {
	uint64_t ungraft_flags;
} fsioc_ungraft_fs_t;

/* auth fs flags */
#define AUTH_FS_ALLOW_UNAUTH_ROOT_HASH          0x0001  /* Allow a sealed volume with an unauthenticated root hash */

typedef struct fsioc_auth_fs {
	vnode_t authvp;
	uint64_t flags;
} fsioc_auth_fs_t;

#endif /* KERNEL */

/* exclave fs filesystem tags */
typedef enum {
	EFT_EXCLAVE,
	EFT_SYSTEM,
	EFT_EXCLAVE_MAIN,
	EFT_FS_NUM_TAGS,
} exclave_fs_tag_t;

typedef struct fsioc_exclave_fs_register {
	uint32_t fs_tag;
} fsioc_exclave_fs_register_t;

#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)

/* 4 - 9 was used for NAMESPACE handler operation to support dataless file faults
 * no and no longer user */

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

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

/* 13 was used for FSIOC_SNAPSHOT_HANDLER_GET_EXT and now been removed */

/* 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)

/* ioctls to support SEEK_HOLE SEEK_DATA */
#define FSIOC_FIOSEEKHOLE                                         _IOWR('A', 16, off_t)
#define FSCTL_FIOSEEKHOLE                                         IOCBASECMD(FSIOC_FIOSEEKHOLE)
#define FSIOC_FIOSEEKDATA                                         _IOWR('A', 17, off_t)
#define FSCTL_FIOSEEKDATA                                         IOCBASECMD(FSIOC_FIOSEEKDATA)

/* Disk conditioner */
#define DISK_CONDITIONER_IOC_GET                  _IOR('A', 18, disk_conditioner_info)
#define DISK_CONDITIONER_FSCTL_GET                IOCBASECMD(DISK_CONDITIONER_IOC_GET)
#define DISK_CONDITIONER_IOC_SET                  _IOW('A', 19, disk_conditioner_info)
#define DISK_CONDITIONER_FSCTL_SET                IOCBASECMD(DISK_CONDITIONER_IOC_SET)

/* Set the value of a file's BSD flags in a safe way. */
#define FSIOC_CAS_BSDFLAGS      _IOWR('A', 20, struct fsioc_cas_bsdflags)

/* Check if a file is only open once (pass zero for the extra arg) */
#define FSIOC_FD_ONLY_OPEN_ONCE _IOWR('A', 21, uint32_t)

#ifdef KERNEL

/* Graft a filesystem onto a directory in its parent filesystem */
#define FSIOC_GRAFT_FS _IOW('A', 22, fsioc_graft_fs_t)

/* Ungraft filesystem(s) */
#define FSIOC_UNGRAFT_FS _IOW('A', 23, fsioc_ungraft_fs_t)

/* Check if a file is on an authenticated volume/Cryptex */
#define FSIOC_AUTH_FS _IOW('A', 24, fsioc_auth_fs_t)

#endif /* KERNEL */

/* Register an exclave fs base directory */
#define FSIOC_EXCLAVE_FS_REGISTER _IOW('A', 25, fsioc_exclave_fs_register_t)

/* Unregister an exclave fs base directory (pass zero for the extra arg)  */
#define FSIOC_EXCLAVE_FS_UNREGISTER _IOW('A', 26, uint32_t)

typedef struct {
	uint32_t fs_tag;       // exclave fs tag associated with base directory
	fsid_t fsid;           // fsid of volume which contains base directory
	uint64_t base_dir;     // inode number of base directory
	uint64_t graft_file;   // inode number of graft file (0 if not a graft)
} exclave_fs_base_dir_t;

typedef struct {
	uint32_t count;       // input: number of records that can be written to output buffer
	                      // output: if output buffer is null, number of registered base dirs
	                      //         if non-null, number of entries written to base_dirs buffer
	exclave_fs_base_dir_t *base_dirs; // output buffer (base directory entries)
} exclave_fs_get_base_dirs_t;

#define EXCLAVE_FS_GET_BASE_DIRS_MAX_COUNT (10 * 1024)

#define FSIOC_EXCLAVE_FS_GET_BASE_DIRS _IOWR('A', 27, exclave_fs_get_base_dirs_t)

typedef struct {
	uint64_t        gi_graft_file;            // inode number of graft file
	uint64_t        gi_graft_dir;             // inode number of graft directory
	uint64_t        gi_inum_base;             // base of inode range allocated to graft
	uint64_t        gi_inum_len:56;           // length of inode range allocated to graft
	uint64_t        gi_graft_lut_reduction:8; // reduction in lut size when switching to metadata based (in percents)
	uint64_t        gi_graft_flags;           // FSCTL_GRAFT_* flags from bsd/sys/fsctl.h
} fsioc_graft_info_t;

typedef struct {
	uint16_t        ggi_count;       // input: number of records that can be written to output buffer
	                                 // output: if output buffer is null, number of grafts in volume
	                                 // if non-null, number of records written to buffer
	uint16_t        ggi_graft_index; // output: if inode is in a graft and buffer is not null,
	                                 //         the index of the graft which contains this inode, 0 otherwise
	uint8_t         ggi_is_in_graft; // output: 1 if inode in a graft, 0 otherwise
	uint8_t         ggi_padding[3];  // padding, should be zero
#ifdef KERNEL
	user64_addr_t   ggi_buffer;      // graft info records buffer
#else
	void            *ggi_buffer;
#if __SIZEOF_POINTER__ == 4
	uint32_t        padding;
#endif
#endif
} fsioc_get_graft_info_t;

/* This used to be defined in APFS, we keep the group as 'J' for backward compatability */
#define FSIOC_GET_GRAFT_INFO _IOWR('J', 102, fsioc_get_graft_info_t)

//
// 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 APFS support these calls.
//
// 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)

/* Mark file's extents as "frozen" because someone has references to physical address */
#define FSIOC_FREEZE_EXTENTS                            _IO('h', 20)
#define FSCTL_FREEZE_EXTENTS                            IOCBASECMD(FSIOC_FREEZE_EXTENTS)

/* Clear the "frozen" status of file's extents */
#define FSIOC_THAW_EXTENTS                              _IO('h', 21)
#define FSCTL_THAW_EXTENTS                              IOCBASECMD(FSIOC_THAW_EXTENTS)

/* Selectors on 'h' from 22 -> 49 are defined in HFS repo */

#define FSIOC_EVAL_ROOTAUTH                              _IO('h', 50)
#define FSCTL_EVAL_ROOTAUTH                              IOCBASECMD(FSIOC_EVAL_ROOTAUTH)

/* This op should only be invoked from within the kernel */
#define FSIOC_KERNEL_ROOTAUTH                            _IOW('h', 51, uint32_t)

#define FIRMLINK_STRUCT_LEN 1032
typedef struct generic_firmlink {
	uint8_t array[FIRMLINK_STRUCT_LEN];
} generic_firmlink_t;

#define FSIOC_FIRMLINK_CTL _IOWR ('J', 60, generic_firmlink_t)

/* For testing /dev/fsevents FSE_ACCESS_GRANTED. */
#define FSIOC_TEST_FSE_ACCESS_GRANTED                    _IO('h', 52)

#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_ */