smbfsctl.h 8.0 KB

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