^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) * fs/cifs/smbfsctl.h: SMB, CIFS, SMB2 FSCTL definitions
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) * Copyright (c) International Business Machines Corp., 2002,2013
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) * Author(s): Steve French (sfrench@us.ibm.com)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) * This library is free software; you can redistribute it and/or modify
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) * it under the terms of the GNU Lesser General Public License as published
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) * by the Free Software Foundation; either version 2.1 of the License, or
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) * (at your option) any later version.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) * This library is distributed in the hope that it will be useful,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) * but WITHOUT ANY WARRANTY; without even the implied warranty of
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) * the GNU Lesser General Public License for more details.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) * You should have received a copy of the GNU Lesser General Public License
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) * along with this library; if not, write to the Free Software
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) /* IOCTL information */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) * List of ioctl/fsctl function codes that are or could be useful in the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) * future to remote clients like cifs or SMB2/SMB3 client. This is probably
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) * a slightly larger set of fsctls that NTFS local filesystem could handle,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) * including the seven below that we do not have struct definitions for.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) * Even with protocol definitions for most of these now available, we still
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) * need to do some experimentation to identify which are practical to do
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) * remotely. Some of the following, such as the encryption/compression ones
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) * could be invoked from tools via a specialized hook into the VFS rather
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) * than via the standard vfs entry points
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) * See MS-SMB2 Section 2.2.31 (last checked June 2013, all of that list are
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) * below). Additional detail on less common ones can be found in MS-FSCC
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) * section 2.3.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) * FSCTL values are 32 bits and are constructed as
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) * <device 16bits> <access 2bits> <function 12bits> <method 2bits>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) /* Device */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) #define FSCTL_DEVICE_DFS (0x0006 << 16)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) #define FSCTL_DEVICE_FILE_SYSTEM (0x0009 << 16)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) #define FSCTL_DEVICE_NAMED_PIPE (0x0011 << 16)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) #define FSCTL_DEVICE_NETWORK_FILE_SYSTEM (0x0014 << 16)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) #define FSCTL_DEVICE_MASK 0xffff0000
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) /* Access */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) #define FSCTL_DEVICE_ACCESS_FILE_ANY_ACCESS (0x00 << 14)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) #define FSCTL_DEVICE_ACCESS_FILE_READ_ACCESS (0x01 << 14)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) #define FSCTL_DEVICE_ACCESS_FILE_WRITE_ACCESS (0x02 << 14)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) #define FSCTL_DEVICE_ACCESS_FILE_READ_WRITE_ACCESS (0x03 << 14)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) #define FSCTL_DEVICE_ACCESS_MASK 0x0000c000
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) /* Function */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) #define FSCTL_DEVICE_FUNCTION_MASK 0x00003ffc
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) /* Method */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) #define FSCTL_DEVICE_METHOD_BUFFERED 0x00
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) #define FSCTL_DEVICE_METHOD_IN_DIRECT 0x01
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) #define FSCTL_DEVICE_METHOD_OUT_DIRECT 0x02
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) #define FSCTL_DEVICE_METHOD_NEITHER 0x03
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) #define FSCTL_DEVICE_METHOD_MASK 0x00000003
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) #define FSCTL_DFS_GET_REFERRALS 0x00060194
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) #define FSCTL_DFS_GET_REFERRALS_EX 0x000601B0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) #define FSCTL_REQUEST_OPLOCK_LEVEL_1 0x00090000
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) #define FSCTL_REQUEST_OPLOCK_LEVEL_2 0x00090004
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) #define FSCTL_REQUEST_BATCH_OPLOCK 0x00090008
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) #define FSCTL_LOCK_VOLUME 0x00090018
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) #define FSCTL_UNLOCK_VOLUME 0x0009001C
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) #define FSCTL_IS_PATHNAME_VALID 0x0009002C /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) #define FSCTL_GET_COMPRESSION 0x0009003C /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) #define FSCTL_SET_COMPRESSION 0x0009C040 /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) #define FSCTL_QUERY_FAT_BPB 0x00090058 /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) /* Verify the next FSCTL number, we had it as 0x00090090 before */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) #define FSCTL_FILESYSTEM_GET_STATS 0x00090060 /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) #define FSCTL_GET_NTFS_VOLUME_DATA 0x00090064 /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) #define FSCTL_GET_RETRIEVAL_POINTERS 0x00090073 /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) #define FSCTL_IS_VOLUME_DIRTY 0x00090078 /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) #define FSCTL_ALLOW_EXTENDED_DASD_IO 0x00090083 /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) #define FSCTL_REQUEST_FILTER_OPLOCK 0x0009008C
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) #define FSCTL_FIND_FILES_BY_SID 0x0009008F /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) #define FSCTL_SET_OBJECT_ID 0x00090098 /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) #define FSCTL_GET_OBJECT_ID 0x0009009C /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) #define FSCTL_DELETE_OBJECT_ID 0x000900A0 /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) #define FSCTL_SET_REPARSE_POINT 0x000900A4 /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) #define FSCTL_GET_REPARSE_POINT 0x000900A8 /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) #define FSCTL_DELETE_REPARSE_POINT 0x000900AC /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) #define FSCTL_SET_OBJECT_ID_EXTENDED 0x000900BC /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) #define FSCTL_CREATE_OR_GET_OBJECT_ID 0x000900C0 /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) #define FSCTL_SET_SPARSE 0x000900C4 /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) #define FSCTL_SET_ZERO_DATA 0x000980C8
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) #define FSCTL_SET_ENCRYPTION 0x000900D7 /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) #define FSCTL_ENCRYPTION_FSCTL_IO 0x000900DB /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) #define FSCTL_WRITE_RAW_ENCRYPTED 0x000900DF /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) #define FSCTL_READ_RAW_ENCRYPTED 0x000900E3 /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) #define FSCTL_READ_FILE_USN_DATA 0x000900EB /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) #define FSCTL_WRITE_USN_CLOSE_RECORD 0x000900EF /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) #define FSCTL_SIS_COPYFILE 0x00090100 /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) #define FSCTL_RECALL_FILE 0x00090117 /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) #define FSCTL_QUERY_SPARING_INFO 0x00090138 /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) #define FSCTL_SET_ZERO_ON_DEALLOC 0x00090194 /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) #define FSCTL_SET_SHORT_NAME_BEHAVIOR 0x000901B4 /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) #define FSCTL_GET_INTEGRITY_INFORMATION 0x0009027C
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) #define FSCTL_GET_RETRIEVAL_POINTERS_AND_REFCOUNT 0x000903d3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) #define FSCTL_GET_RETRIEVAL_POINTER_COUNT 0x0009042b
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) #define FSCTL_QUERY_ALLOCATED_RANGES 0x000940CF
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) #define FSCTL_SET_DEFECT_MANAGEMENT 0x00098134 /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) #define FSCTL_FILE_LEVEL_TRIM 0x00098208 /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) #define FSCTL_DUPLICATE_EXTENTS_TO_FILE 0x00098344
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) #define FSCTL_SIS_LINK_FILES 0x0009C104
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) #define FSCTL_SET_INTEGRITY_INFORMATION 0x0009C280
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) #define FSCTL_PIPE_PEEK 0x0011400C /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) #define FSCTL_PIPE_TRANSCEIVE 0x0011C017 /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) /* strange that the number for this op is not sequential with previous op */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) #define FSCTL_PIPE_WAIT 0x00110018 /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) /* Enumerate previous versions of a file */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) #define FSCTL_SRV_ENUMERATE_SNAPSHOTS 0x00144064
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) /* Retrieve an opaque file reference for server-side data movement ie copy */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) #define FSCTL_SRV_REQUEST_RESUME_KEY 0x00140078
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) #define FSCTL_LMR_REQUEST_RESILIENCY 0x001401D4
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) #define FSCTL_LMR_GET_LINK_TRACK_INF 0x001400E8 /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) #define FSCTL_LMR_SET_LINK_TRACK_INF 0x001400EC /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) #define FSCTL_VALIDATE_NEGOTIATE_INFO 0x00140204
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) /* Perform server-side data movement */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) #define FSCTL_SRV_COPYCHUNK 0x001440F2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) #define FSCTL_SRV_COPYCHUNK_WRITE 0x001480F2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) #define FSCTL_QUERY_NETWORK_INTERFACE_INFO 0x001401FC /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) #define FSCTL_SRV_READ_HASH 0x001441BB /* BB add struct */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) /* See FSCC 2.1.2.5 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) #define IO_REPARSE_TAG_MOUNT_POINT 0xA0000003
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) #define IO_REPARSE_TAG_HSM 0xC0000004
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) #define IO_REPARSE_TAG_SIS 0x80000007
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) #define IO_REPARSE_TAG_HSM2 0x80000006
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) #define IO_REPARSE_TAG_DRIVER_EXTENDER 0x80000005
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) /* Used by the DFS filter. See MS-DFSC */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) #define IO_REPARSE_TAG_DFS 0x8000000A
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) /* Used by the DFS filter See MS-DFSC */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) #define IO_REPARSE_TAG_DFSR 0x80000012
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) #define IO_REPARSE_TAG_FILTER_MANAGER 0x8000000B
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) /* See section MS-FSCC 2.1.2.4 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) #define IO_REPARSE_TAG_SYMLINK 0xA000000C
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) #define IO_REPARSE_TAG_DEDUP 0x80000013
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) #define IO_REPARSE_APPXSTREAM 0xC0000014
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) /* NFS symlinks, Win 8/SMB3 and later */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) #define IO_REPARSE_TAG_NFS 0x80000014
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) * AzureFileSync - see
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) * https://docs.microsoft.com/en-us/azure/storage/files/storage-sync-cloud-tiering
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) #define IO_REPARSE_TAG_AZ_FILE_SYNC 0x8000001e
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) /* WSL reparse tags */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) #define IO_REPARSE_TAG_LX_SYMLINK 0xA000001D
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) #define IO_REPARSE_TAG_AF_UNIX 0x80000023
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) #define IO_REPARSE_TAG_LX_FIFO 0x80000024
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) #define IO_REPARSE_TAG_LX_CHR 0x80000025
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) #define IO_REPARSE_TAG_LX_BLK 0x80000026
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) /* fsctl flags */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) /* If Flags is set to this value, the request is an FSCTL not ioctl request */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) #define SMB2_0_IOCTL_IS_FSCTL 0x00000001
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164)