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