2 * Copyright (c) 2008-2011 Kernel Drivers, LLC.
3 * Copyright (c) 2009-2011 Your File System, Inc.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * - Redistributions of source code must retain the above copyright notice,
11 * this list of conditions and the following disclaimer.
12 * - Redistributions in binary form must reproduce the above copyright
14 * this list of conditions and the following disclaimer in the
16 * and/or other materials provided with the distribution.
17 * - Neither the name of Kernel Drivers, LLC nor the names of its
19 * used to endorse or promote products derived from this software without
20 * specific prior written permission from Kernel Drivers, LLC
21 * and Your File System, Inc.
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
25 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
26 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
27 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
28 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
29 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
30 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
31 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 #ifndef _AFS_USER_STRUCT_H
37 #define _AFS_USER_STRUCT_H
39 typedef struct _AFS_FILE_ID
55 // This control structure is the request block passed to the filter. The filter will populate the structure
56 // when it requires a request to be handled by the service.
59 typedef struct _AFS_COMM_REQUEST_BLOCK
62 AFSFileID FileId; /* Initialize unused elements to 0 */
66 ULONG RequestIndex; /* Must return to caller */
68 ULONG RequestFlags; /* AFS_REQUEST_FLAG_xxxx */
70 ULONG NameLength; // Length of the name in bytes
72 ULONG DataOffset; // This offset is from the end of the structure, including the name
76 GUID AuthGroup; // Length: sizeof(GUID) */
78 ULONG ResultBufferLength; /* Do not exceed this length in response */
80 LONG QueueCount; // Current outstanding requests in the queue
88 // This is the result block passed back to the redirector after a request has been handled
91 typedef struct _AFS_COMM_RESULT_BLOCK
94 ULONG RequestIndex; /* Must match the AFSCommRequest value */
96 ULONG ResultStatus; /* NTSTATUS_xxx */
98 ULONG ResultBufferLength; /* Not to exceed AFSCommRequest ResultBufferLength */
100 ULONG Reserved; /* To ease Quad Alignment */
107 // Control block passed to IOCTL_AFS_INITIALIZE_REDIRECTOR_DEVICE
110 #define AFS_REDIR_INIT_FLAG_HIDE_DOT_FILES 0x00000001
112 #define AFS_REDIR_INIT_NO_PAGING_FILE 0x00000002
114 typedef struct _AFS_REDIR_INIT_INFO_CB
119 ULONG MaximumChunkLength; // Maximum RPC length issued so we should limit
120 // requests for data to this length
122 AFSFileID GlobalFileId; // AFS FID of the Global root.afs volume
124 LARGE_INTEGER ExtentCount; // Number of extents in the current data cache
126 ULONG CacheBlockSize; // Size, in bytes, of the current cache block
128 ULONG MaxPathLinkCount; // Number of symlinks / mountpoints that may
129 // be cross during the evaluation of any path
131 ULONG NameArrayLength; // Number of components that should be allocated
132 // in each name array chunk. Name arrays are
133 // dynamic and will be increased in size as
134 // needed by this amount
136 LARGE_INTEGER MemoryCacheOffset; // The offset in the afsd_service process memory
137 // space at which the extents are allocated
138 LARGE_INTEGER MemoryCacheLength; // and the length of the allocated region
140 ULONG DumpFileLocationOffset; // Offset from the beginning of this structure to
141 // the start of the directory where dump files
142 // are to be stored. The path must be fully
143 // qualified such as C:\Windows\Temp
145 ULONG DumpFileLocationLength; // Length, in bytes, of the DumpFileLocation path
147 ULONG CacheFileNameLength; // size, in bytes, of the cache file name
149 WCHAR CacheFileName[ 1]; // Fully qualified cache file name in the form
150 // C:\OPenAFSDir\CacheFile.dat
152 } AFSRedirectorInitInfo;
155 // Directory query CB
158 typedef struct _AFS_DIR_QUERY_CB
161 ULONG_PTR EnumHandle; // If this is 0 then it is a new query,
162 // otherwise it is the FileIndex of the last
168 // Directory enumeration control block
169 // Entries are aligned on a QuadWord boundary
172 typedef struct _AFS_DIR_ENUM_ENTRY
177 ULONG FileIndex; /* Incremented */
179 LARGE_INTEGER Expiration; /* FILETIME */
181 LARGE_INTEGER DataVersion;
183 ULONG FileType; /* File, Dir, MountPoint, Symlink */
185 LARGE_INTEGER CreationTime; /* FILETIME */
187 LARGE_INTEGER LastAccessTime; /* FILETIME */
189 LARGE_INTEGER LastWriteTime; /* FILETIME */
191 LARGE_INTEGER ChangeTime; /* FILETIME */
193 LARGE_INTEGER EndOfFile;
195 LARGE_INTEGER AllocationSize;
197 ULONG FileAttributes; /* NTFS FILE_ATTRIBUTE_xxxx see below */
199 ULONG FileNameLength;
205 ULONG FileNameOffset; /* From beginning of this structure */
207 ULONG TargetNameOffset; /* From beginning of this structure */
209 ULONG TargetNameLength;
211 AFSFileID TargetFileId; /* Target fid for mp's and symlinks */
213 CCHAR ShortNameLength;
217 /* Long Filename and Target (Symlink and MountPoint only) to follow without NULs */
222 typedef struct _AFS_DIR_ENUM_RESP
225 ULONG_PTR EnumHandle;
227 AFSDirEnumEntry Entry[ 1]; /* Each entry is Quad aligned */
232 // Volume information CB passed in the create request
235 typedef struct _AFS_VOLUME_INFORMATION
238 LARGE_INTEGER TotalAllocationUnits; /* Partition Max Blocks */
240 LARGE_INTEGER AvailableAllocationUnits; /* Partition Blocks Avail */
242 LARGE_INTEGER VolumeCreationTime; /* AFS Last Update - Not Creation */
244 ULONG Characteristics; /* FILE_READ_ONLY_DEVICE (if readonly)
245 * FILE_REMOTE_DEVICE (always)
248 ULONG FileSystemAttributes; /* FILE_CASE_PRESERVED_NAMES (always)
249 FILE_UNICODE_ON_DISK (always) */
251 ULONG SectorsPerAllocationUnit; /* = 1 */
253 ULONG BytesPerSector; /* = 1024 */
255 ULONG CellID; /* AFS Cell ID */
257 ULONG VolumeID; /* AFS Volume ID */
259 ULONG VolumeLabelLength;
261 WCHAR VolumeLabel[20]; /* Volume:Cell */
269 typedef struct _AFS_FILE_CREATE_CB
274 LARGE_INTEGER AllocationSize;
276 ULONG FileAttributes;
284 typedef struct _AFS_FILE_CREATE_RESULT_CB
287 LARGE_INTEGER ParentDataVersion;
289 AFSDirEnumEntry DirEnum;
291 } AFSFileCreateResultCB;
297 typedef struct _AFS_FILE_OPEN_CB
308 ULONGLONG Identifier;
312 typedef struct _AFS_FILE_OPEN_RESULT_CB
319 } AFSFileOpenResultCB;
321 typedef struct _AFS_FILE_ACCESS_RELEASE_CB
328 ULONGLONG Identifier;
330 } AFSFileAccessReleaseCB;
333 // IO Interace control blocks for extent processing when performing
334 // queries via the AFS_REQUEST_TYPE_REQUEST_FILE_EXTENTS or synchronous
335 // results from the service
338 typedef struct _AFS_FILE_EXTENT_CB
345 LARGE_INTEGER FileOffset;
347 LARGE_INTEGER CacheOffset;
357 typedef struct _AFS_REQUEST_EXTENTS_CB
362 LARGE_INTEGER ByteOffset;
366 } AFSRequestExtentsCB;
369 // Extent processing when the file system calls the service to
370 // release extents through the AFS_REQUEST_TYPE_RELEASE_FILE_EXTENTS interface
373 typedef struct _AFS_RELEASE_EXTENTS_CB
380 LARGE_INTEGER LastAccessTime;
382 LARGE_INTEGER LastWriteTime;
384 LARGE_INTEGER ChangeTime;
386 LARGE_INTEGER CreateTime;
388 LARGE_INTEGER AllocationSize;
390 AFSFileExtentCB FileExtents[ 1];
392 } AFSReleaseExtentsCB;
395 // This is the control structure used when the service passes the extent
396 // information via the IOCTL_AFS_SET_FILE_EXTENTS interface
399 typedef struct _AFS_SET_FILE_EXTENTS_CB
408 AFSFileExtentCB FileExtents[ 1];
410 } AFSSetFileExtentsCB;
413 // This is the control structure used when the service passes the extent
414 // information via the IOCTL_AFS_RELEASE_FILE_EXTENTS interface
417 #define AFS_RELEASE_EXTENTS_FLAGS_RELEASE_ALL 0x00000001
419 typedef struct _AFS_RELEASE_FILE_EXTENTS_CB
428 LARGE_INTEGER HeldExtentCount;
430 AFSFileExtentCB FileExtents[ 1];
432 } AFSReleaseFileExtentsCB;
435 // These are the control structures that the filesystem returns from a
436 // IOCTL_AFS_RELEASE_FILE_EXTENTS
439 typedef struct _AFS_RELEASE_FILE_EXTENTS_RESULT_FILE_CB
445 GUID AuthGroup; /* Length: sizeof(GUID) */
449 LARGE_INTEGER LastAccessTime;
451 LARGE_INTEGER LastWriteTime;
453 LARGE_INTEGER ChangeTime;
455 LARGE_INTEGER CreateTime;
457 LARGE_INTEGER AllocationSize;
459 AFSFileExtentCB FileExtents[ 1];
461 } AFSReleaseFileExtentsResultFileCB;
463 typedef struct _AFS_RELEASE_FILE_EXTENTS_RESULT_CB
471 AFSReleaseFileExtentsResultFileCB Files[ 1];
473 } AFSReleaseFileExtentsResultCB;
476 typedef struct _AFS_EXTENT_FAILURE_CB
483 } AFSExtentFailureCB;
489 typedef struct _AFS_FILE_UPDATE_CB
494 LARGE_INTEGER LastAccessTime;
496 LARGE_INTEGER LastWriteTime;
498 LARGE_INTEGER ChangeTime;
500 LARGE_INTEGER CreateTime;
502 LARGE_INTEGER AllocationSize;
504 ULONG FileAttributes;
513 // File update CB result
516 typedef struct _AFS_FILE_UPDATE_RESULT_CB
519 AFSDirEnumEntry DirEnum;
521 } AFSFileUpdateResultCB;
527 typedef struct _AFS_FILE_DELETE_CB
530 AFSFileID ParentId; /* Must be directory */
534 /* File Name and FileID in Common Request Block */
538 typedef struct _AFS_FILE_DELETE_RESULT_CB
541 LARGE_INTEGER ParentDataVersion;
543 } AFSFileDeleteResultCB;
549 typedef struct _AFS_FILE_RENAME_CB
552 AFSFileID SourceParentId; /* Must be directory */
554 AFSFileID TargetParentId; /* Must be directory */
556 /* Source Name and FileID in Common Request Block */
558 USHORT TargetNameLength;
560 WCHAR TargetName[ 1];
564 typedef struct _AFS_FILE_RENAME_RESULT_CB
567 LARGE_INTEGER SourceParentDataVersion;
569 LARGE_INTEGER TargetParentDataVersion;
571 AFSDirEnumEntry DirEnum;
573 } AFSFileRenameResultCB;
577 // Control structures for AFS_REQUEST_TYPE_EVAL_TARGET_BY_ID
578 // and AFS_REQUEST_TYPE_EVAL_TARGET_BY_NAME
580 // The response to these requests is a AFSDirEnumEntry
583 typedef struct _AFS_FILE_EVAL_TARGET_CB
592 // Control structure for read and write requests through the PIOCtl interface
594 // CommRequest FileId field contains the active directory
596 typedef struct _AFS_PIOCTL_IO_CB
606 } AFSPIOCtlIORequestCB;
609 // The returned information for the IO Request
612 typedef struct _AFS_PIOCTL_IO_RESULT_CB
615 ULONG BytesProcessed;
617 } AFSPIOCtlIOResultCB;
621 // Control structure for open and close requests through the PIOCtl interface
623 // CommRequest FileId field contains the active directory
625 // There is no return structure.
627 typedef struct _AFS_PIOCTL_OPEN_CLOSE_CB
634 } AFSPIOCtlOpenCloseRequestCB;
637 // Cache invalidation control block
640 typedef struct _AFS_INVALIDATE_CACHE_CB
651 } AFSInvalidateCacheCB;
654 // Network Status Control Block
657 typedef struct _AFS_NETWORK_STATUS_CB
662 } AFSNetworkStatusCB;
665 // Volume Status Control Block
668 typedef struct _AFS_VOLUME_STATUS_CB
671 AFSFileID FileID; // only cell and volume fields are set
678 typedef struct _AFS_SYSNAME
681 ULONG Length; /* bytes */
683 WCHAR String[AFS_MAX_SYSNAME_LENGTH];
688 // SysName Notification Control Block
689 // Sent as the buffer with IOCTL_AFS_SYSNAME_NOTIFICATION
690 // There is no response
693 typedef struct _AFS_SYSNAME_NOTIFICATION_CB
700 AFSSysName SysNames[1];
702 } AFSSysNameNotificationCB;
706 // File System Status Query Control Block
707 // Received as a response to IOCTL_AFS_STATUS_REQUEST
709 typedef struct _AFS_DRIVER_STATUS_RESPONSE_CB
712 ULONG Status; // bit flags - see below
714 } AFSDriverStatusRespCB;
717 #define AFS_DRIVER_STATUS_READY 0
718 #define AFS_DRIVER_STATUS_NOT_READY 1
719 #define AFS_DRIVER_STATUS_NO_SERVICE 2
722 // Byte Range Lock Request
724 typedef struct _AFS_BYTE_RANGE_LOCK_REQUEST
728 LARGE_INTEGER Offset;
730 LARGE_INTEGER Length;
732 } AFSByteRangeLockRequest;
734 #define AFS_BYTE_RANGE_LOCK_TYPE_SHARED 0
735 #define AFS_BYTE_RANGE_LOCK_TYPE_EXCL 1
739 // Byte Range Lock Request Control Block
741 // Set ProcessId and FileId in the Comm Request Block
743 typedef struct _AFS_BYTE_RANGE_LOCK_REQUEST_CB
750 AFSByteRangeLockRequest Request[1];
752 } AFSByteRangeLockRequestCB;
755 // Byte Range Lock Result
757 typedef struct _AFS_BYTE_RANGE_LOCK_RESULT
762 LARGE_INTEGER Offset;
764 LARGE_INTEGER Length;
768 } AFSByteRangeLockResult;
771 // Byte Range Lock Results Control Block
774 typedef struct _AFS_BYTE_RANGE_LOCK_RESULT_CB
781 AFSByteRangeLockResult Result[1];
783 } AFSByteRangeLockResultCB;
786 // Set Byte Range Lock Results Control Block
789 typedef struct _AFS_SET_BYTE_RANGE_LOCK_RESULT_CB
798 AFSByteRangeLockResult Result[1];
800 } AFSSetByteRangeLockResultCB;
804 // Byte Range Unlock Request Control Block
807 typedef struct _AFS_BYTE_RANGE_UNLOCK_CB
814 AFSByteRangeLockRequest Request[1];
816 } AFSByteRangeUnlockRequestCB;
820 // Byte Range Unlock Request Control Block
823 typedef struct _AFS_BYTE_RANGE_UNLOCK_RESULT_CB
828 AFSByteRangeLockResult Result[1];
830 } AFSByteRangeUnlockResultCB;
834 // Control structure for read and write requests through the PIPE interface
836 // CommRequest FileId field contains the active directory
838 typedef struct _AFS_PIPE_IO_CB
846 } AFSPipeIORequestCB; // For read requests the buffer is mapped in the request cb block.
847 // For write requests, the buffer immediately follows this structure
850 // The returned information for the Pipe IO Request. Note that this is
851 // only returned in the write request. Read request info is returned in
855 typedef struct _AFS_PIPE_IO_RESULT_CB
858 ULONG BytesProcessed;
863 // Control structure for set and query info requests through the PIPE interface
866 typedef struct _AFS_PIPE_INFO_CB
873 ULONG InformationClass;
877 } AFSPipeInfoRequestCB; // For query info requests the buffer is mapped in the request cb block.
878 // For set info requests, the buffer immediately follows this structure
881 // Control structure for open and close requests through the Pipe interface
883 // CommRequest FileId field contains the active directory
885 // There is no return structure.
887 typedef struct _AFS_PIPE_OPEN_CLOSE_CB
894 } AFSPipeOpenCloseRequestCB;
898 // Hold Fid Request Control Block
901 typedef struct _AFS_HOLD_FID_REQUEST_CB
906 AFSFileID FileID[ 1];
908 } AFSHoldFidRequestCB;
911 typedef struct _AFS_FID_RESULT
920 typedef struct _AFS_HOLD_FID_RESULT_CB
925 AFSFidResult Result[ 1];
927 } AFSHoldFidResultCB;
931 // Release Fid Request Control Block
934 typedef struct _AFS_RELEASE_FID_REQUEST_CB
939 AFSFileID FileID[ 1];
941 } AFSReleaseFidRequestCB;
943 typedef struct _AFS_RELEASE_FID_RESULT_CB
948 AFSFidResult Result[ 1];
950 } AFSReleaseFidResultCB;
957 typedef struct _AFS_FILE_CLEANUP_CB
962 LARGE_INTEGER LastAccessTime;
964 LARGE_INTEGER LastWriteTime;
966 LARGE_INTEGER ChangeTime;
968 LARGE_INTEGER CreateTime;
970 LARGE_INTEGER AllocationSize;
972 ULONG FileAttributes;
978 ULONGLONG Identifier;
983 // Trace configuration cb
986 typedef struct _AFS_DEBUG_TRACE_CONFIG_CB
993 ULONG TraceBufferLength;
1000 // Object Status Information request
1003 typedef struct _AFS_REDIR_GET_OBJECT_STATUS_CB
1008 USHORT FileNameLength;
1012 } AFSGetStatusInfoCB;
1014 typedef struct _AFS_REDIR_OBJECT_STATUS_CB
1019 AFSFileID TargetFileId;
1021 LARGE_INTEGER Expiration; /* FILETIME */
1023 LARGE_INTEGER DataVersion;
1025 ULONG FileType; /* File, Dir, MountPoint, Symlink */
1029 LARGE_INTEGER CreationTime; /* FILETIME */
1031 LARGE_INTEGER LastAccessTime; /* FILETIME */
1033 LARGE_INTEGER LastWriteTime; /* FILETIME */
1035 LARGE_INTEGER ChangeTime; /* FILETIME */
1037 ULONG FileAttributes; /* NTFS FILE_ATTRIBUTE_xxxx see below */
1039 LARGE_INTEGER EndOfFile;
1041 LARGE_INTEGER AllocationSize;
1050 // Auth Group (Process and Thread) Processing
1052 // afsredir.sys implements a set of generic Authentication Group
1053 // operations that can be executed by processes. The model supports
1054 // one or more authentication groups per process. A process may switch
1055 // the active AuthGroup for any thread to any other AuthGroup the process
1056 // is a member of. However, processes cannot assign itself to an
1057 // AuthGroup that it is not presently a member of. A process can reset
1058 // its AuthGroup to the SID-AuthGroup or can create a new AuthGroup that
1059 // has not previously been used.
1061 // IOCTL_AFS_AUTHGROUP_CREATE_AND_SET
1062 // Creates a new AuthGroup and either activates it for
1063 // the process or the current thread. If set as the
1064 // new process AuthGroup, the prior AuthGroup list is
1067 // IOCTL_AFS_AUTHGROUP_QUERY
1068 // Returns a list of the AuthGroup GUIDS associated
1069 // with the current process, the current process GUID,
1070 // and the current thread GUID.
1072 // IOCTL_AFS_AUTHGROUP_SET
1073 // Permits the current AuthGroup for the process or
1074 // thread to be set to the specified GUID. The GUID
1075 // must be in the list of current values for the process.
1077 // IOCTL_AFS_AUTHGROUP_RESET
1078 // Resets the current AuthGroup for the process or
1079 // thread to the SID-AuthGroup
1081 // IOCTL_AFS_AUTHGROUP_SID_CREATE
1082 // Given a SID as input, assigns a new AuthGroup GUID.
1083 // (May only be executed by LOCAL_SYSTEM or the active SID)
1085 // IOCTL_AFS_AUTHGROUP_SID_QUERY
1086 // Given a SID as input, returns the associated AuthGroup GUID.
1088 // IOCTL_AFS_AUTHGROUP_LOGON_CREATE
1089 // Given a logon Session as input, assigns a new AuthGroup GUID.
1090 // (May only be executed by LOCAL_SYSTEM.)
1092 // New processes inherit only the active AuthGroup at the time of process
1093 // creation. Either that of the active thread (if set) or the process.
1094 // All of the other AuthGroups associated with a parent process are
1099 // Auth Group processing flags
1102 #define AFS_PAG_FLAGS_SET_AS_ACTIVE 0x00000001 // If set, the newly created authgroup is set to the active group
1103 #define AFS_PAG_FLAGS_THREAD_AUTH_GROUP 0x00000002 // If set, the request is targeted for the thread not the process
1105 typedef struct _AFS_AUTH_GROUP_REQUEST
1108 USHORT SIDLength; // If zero the SID of the caller is used
1110 ULONG SessionId; // If -1 the session id of the caller is used
1114 GUID AuthGroup; // The auth group for certain requests
1116 WCHAR SIDString[ 1];
1118 } AFSAuthGroupRequestCB;
1121 // Reparse tag AFS Specific information buffer
1124 #define OPENAFS_SUBTAG_MOUNTPOINT 1
1125 #define OPENAFS_SUBTAG_SYMLINK 2
1126 #define OPENAFS_SUBTAG_UNC 3
1128 #define OPENAFS_MOUNTPOINT_TYPE_NORMAL L'#'
1129 #define OPENAFS_MOUNTPOINT_TYPE_RW L'%'
1131 typedef struct _AFS_REPARSE_TAG_INFORMATION
1141 USHORT MountPointCellLength;
1142 USHORT MountPointVolumeLength;
1148 BOOLEAN RelativeLink;
1149 USHORT SymLinkTargetLength;
1155 USHORT UNCTargetLength;
1160 } AFSReparseTagInfo;
1162 #endif /* _AFS_USER_STRUCT_H */