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