Windows: Move Authenticated field to CommResultCB
[openafs.git] / src / WINNT / afsrdr / common / AFSUserStructs.h
1 /*
2  * Copyright (c) 2008-2011 Kernel Drivers, LLC.
3  * Copyright (c) 2009-2011 Your File System, Inc.
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
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
13  *   notice,
14  *   this list of conditions and the following disclaimer in the
15  *   documentation
16  *   and/or other materials provided with the distribution.
17  * - Neither the name of Kernel Drivers, LLC nor the names of its
18  *   contributors may be
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.
22  *
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.
34  */
35
36 #ifndef _AFS_USER_STRUCT_H
37 #define _AFS_USER_STRUCT_H
38
39 typedef struct _AFS_FILE_ID
40 {
41
42     ULONG    Hash;
43
44     ULONG    Cell;
45
46     ULONG    Volume;
47
48     ULONG    Vnode;
49
50     ULONG    Unique;
51
52 } AFSFileID;
53
54 //
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.
57 //
58
59 typedef struct _AFS_COMM_REQUEST_BLOCK
60 {
61
62     AFSFileID       FileId;          /* Initialize unused elements to 0 */
63
64     ULONG           RequestType;
65
66     ULONG           RequestIndex;    /* Must return to caller */
67
68     ULONG           RequestFlags;    /* AFS_REQUEST_FLAG_xxxx */
69
70     ULONG           NameLength;      /* Length of the name in bytes */
71
72     ULONG           DataOffset;      /* This offset is from the end of the structure, including the name */
73
74     ULONG           DataLength;
75
76     GUID            AuthGroup;       /* Length: sizeof(GUID) */
77
78     ULONG           ResultBufferLength;    /* Do not exceed this length in response */
79
80     LONG            QueueCount;      /* Current outstanding requests in the queue */
81
82     WCHAR           Name[ 1];
83
84 } AFSCommRequest;
85
86
87 //
88 // This is the result block passed back to the redirector after a request has been handled
89 //
90
91 typedef struct _AFS_COMM_RESULT_BLOCK
92 {
93
94     ULONG           RequestIndex;        /* Must match the AFSCommRequest value */
95
96     ULONG           ResultStatus;        /* NTSTATUS_xxx */
97
98     ULONG           ResultBufferLength;  /* Not to exceed AFSCommRequest ResultBufferLength */
99
100     ULONG           Authenticated;       /* Tokens or No? */
101
102     char            ResultData[ 1];
103
104 } AFSCommResult;
105
106 //
107 // Control block passed to IOCTL_AFS_INITIALIZE_REDIRECTOR_DEVICE
108 //
109
110 #define AFS_REDIR_INIT_FLAG_HIDE_DOT_FILES          0x00000001
111 #define AFS_REDIR_INIT_NO_PAGING_FILE               0x00000002
112 #define AFS_REDIR_INIT_FLAG_DISABLE_SHORTNAMES      0x00000004
113
114 typedef struct _AFS_REDIR_INIT_INFO_CB
115 {
116
117     ULONG       Flags;
118
119     ULONG       MaximumChunkLength;     // Maximum RPC length issued so we should limit
120                                         // requests for data to this length
121
122     AFSFileID   GlobalFileId;           // AFS FID of the Global root.afs volume
123
124     LARGE_INTEGER  ExtentCount;         // Number of extents in the current data cache
125
126     ULONG       CacheBlockSize;         // Size, in bytes, of the current cache block
127
128     ULONG       MaxPathLinkCount;       // Number of symlinks / mountpoints that may
129                                         // be cross during the evaluation of any path
130
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
135
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
139
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
144
145     ULONG       DumpFileLocationLength; // Length, in bytes, of the DumpFileLocation path
146
147     ULONG       CacheFileNameLength;    // size, in bytes, of the cache file name
148
149     WCHAR       CacheFileName[ 1];      // Fully qualified cache file name in the form
150                                         // C:\OPenAFSDir\CacheFile.dat
151
152 } AFSRedirectorInitInfo;
153
154 //
155 // Directory query CB
156 //
157
158 typedef struct _AFS_DIR_QUERY_CB
159 {
160
161     ULONG_PTR        EnumHandle;  // If this is 0 then it is a new query,
162                                   // otherwise it is the FileIndex of the last
163                                   // entry processed.
164
165 } AFSDirQueryCB;
166
167 //
168 // Directory enumeration control block
169 // Entries are aligned on a QuadWord boundary
170 //
171
172 typedef struct _AFS_DIR_ENUM_ENTRY
173 {
174
175     AFSFileID       FileId;
176
177     ULONG           FileIndex;          /* Incremented  */
178
179     LARGE_INTEGER   Expiration;         /* FILETIME */
180
181     LARGE_INTEGER   DataVersion;
182
183     ULONG           FileType;           /* File, Dir, MountPoint, Symlink */
184
185     LARGE_INTEGER   CreationTime;       /* FILETIME */
186
187     LARGE_INTEGER   LastAccessTime;     /* FILETIME */
188
189     LARGE_INTEGER   LastWriteTime;      /* FILETIME */
190
191     LARGE_INTEGER   ChangeTime;         /* FILETIME */
192
193     LARGE_INTEGER   EndOfFile;
194
195     LARGE_INTEGER   AllocationSize;
196
197     ULONG           FileAttributes;     /* NTFS FILE_ATTRIBUTE_xxxx see below */
198
199     ULONG           FileNameLength;
200
201     ULONG           EaSize;
202
203     ULONG           Links;
204
205     ULONG           FileNameOffset;     /* From beginning of this structure */
206
207     ULONG           TargetNameOffset;   /* From beginning of this structure */
208
209     ULONG           TargetNameLength;
210
211     AFSFileID       TargetFileId;       /* Target fid for mp's and symlinks */
212
213     CCHAR           ShortNameLength;
214
215     WCHAR           ShortName[12];
216
217     ULONG           NTStatus;           /* Error code during enumeration */
218
219     /* Long Filename and Target (Symlink and MountPoint only) to follow without NULs */
220
221 } AFSDirEnumEntry;
222
223
224 typedef struct _AFS_DIR_ENUM_RESP
225 {
226
227     ULONG_PTR       EnumHandle;
228
229     LARGE_INTEGER   SnapshotDataVersion; /* DV at time Name/FID list was generated */
230
231     LARGE_INTEGER   CurrentDataVersion;   /* DV at time this header was constructed */
232
233     AFSDirEnumEntry Entry[ 1];     /* Each entry is Quad aligned */
234
235 } AFSDirEnumResp;
236
237 //
238 // Volume information CB passed in the create request
239 //
240
241 typedef struct _AFS_VOLUME_INFORMATION
242 {
243
244     LARGE_INTEGER   TotalAllocationUnits;       /* Volume Max Blocks (Partition or Quota) */
245
246     LARGE_INTEGER   AvailableAllocationUnits;   /* Volume Blocks Avail (Partition or Quota) */
247
248     LARGE_INTEGER   VolumeCreationTime;         /* AFS Last Update - Not Creation */
249
250     ULONG           Characteristics;            /* FILE_READ_ONLY_DEVICE (if readonly)
251                                                  * FILE_REMOTE_DEVICE (always)
252                                                  */
253
254     ULONG           FileSystemAttributes;       /* FILE_CASE_PRESERVED_NAMES (always)
255                                                    FILE_UNICODE_ON_DISK      (always) */
256
257     ULONG           SectorsPerAllocationUnit;   /* = 1 */
258
259     ULONG           BytesPerSector;             /* = 1024 */
260
261     ULONG           CellID;                     /* AFS Cell ID */
262
263     ULONG           VolumeID;                   /* AFS Volume ID */
264
265     ULONG           VolumeLabelLength;
266
267     WCHAR           VolumeLabel[128];           /* Volume */
268
269     ULONG           CellLength;
270
271     WCHAR           Cell[128];                  /* Cell */
272
273 } AFSVolumeInfoCB;
274
275
276 //
277 // Volume size information CB passed used to satisfy
278 // FileFsFullSizeInformation and FileFsSizeInformation
279 //
280
281 typedef struct _AFS_VOLUME_SIZE_INFORMATION
282 {
283
284     LARGE_INTEGER   TotalAllocationUnits;       /* Max Blocks (Quota or Partition) */
285
286     LARGE_INTEGER   AvailableAllocationUnits;   /* Blocks Avail (Quota or Partition) */
287
288     ULONG           SectorsPerAllocationUnit;   /* = 1 */
289
290     ULONG           BytesPerSector;             /* = 1024 */
291
292 } AFSVolumeSizeInfoCB;
293
294 //
295 // File create CB
296 //
297
298 typedef struct _AFS_FILE_CREATE_CB
299 {
300
301     AFSFileID       ParentId;
302
303     LARGE_INTEGER   AllocationSize;
304
305     ULONG           FileAttributes;
306
307     ULONG           EaSize;
308
309     char            EaBuffer[ 1];
310
311 } AFSFileCreateCB;
312
313 typedef struct _AFS_FILE_CREATE_RESULT_CB
314 {
315
316     LARGE_INTEGER   ParentDataVersion;
317
318     AFSDirEnumEntry DirEnum;
319
320 } AFSFileCreateResultCB;
321
322 //
323 // File open CB
324 //
325
326 typedef struct _AFS_FILE_OPEN_CB
327 {
328
329     AFSFileID       ParentId;
330
331     ULONG           DesiredAccess;
332
333     ULONG           ShareAccess;
334
335     ULONGLONG       ProcessId;
336
337     ULONGLONG       Identifier;
338
339 } AFSFileOpenCB;
340
341 typedef struct _AFS_FILE_OPEN_RESULT_CB
342 {
343
344     ULONG           GrantedAccess;
345
346     ULONG           FileAccess;
347
348 } AFSFileOpenResultCB;
349
350 typedef struct _AFS_FILE_ACCESS_RELEASE_CB
351 {
352
353     ULONG           FileAccess;
354
355     ULONGLONG       ProcessId;
356
357     ULONGLONG       Identifier;
358
359 } AFSFileAccessReleaseCB;
360
361 //
362 // IO Interace control blocks for extent processing when performing
363 // queries via the AFS_REQUEST_TYPE_REQUEST_FILE_EXTENTS or synchronous
364 // results from the service
365 //
366
367 typedef struct _AFS_FILE_EXTENT_CB
368 {
369
370     ULONG           Flags;
371
372     ULONG           Length;
373
374     LARGE_INTEGER   FileOffset;
375
376     LARGE_INTEGER   CacheOffset;
377
378     UCHAR           MD5[16];
379
380     ULONG           DirtyOffset;
381
382     ULONG           DirtyLength;
383
384 } AFSFileExtentCB;
385
386 typedef struct _AFS_REQUEST_EXTENTS_CB
387 {
388
389     ULONG           Flags;
390
391     LARGE_INTEGER   ByteOffset;
392
393     ULONG           Length;
394
395 } AFSRequestExtentsCB;
396
397 //
398 // Extent processing when the file system calls the service to
399 // release extents through the AFS_REQUEST_TYPE_RELEASE_FILE_EXTENTS interface
400 //
401
402 typedef struct _AFS_RELEASE_EXTENTS_CB
403 {
404
405     ULONG           Flags;
406
407     ULONG           ExtentCount;
408
409     LARGE_INTEGER   LastAccessTime;
410
411     LARGE_INTEGER   LastWriteTime;
412
413     LARGE_INTEGER   ChangeTime;
414
415     LARGE_INTEGER   CreateTime;
416
417     LARGE_INTEGER   AllocationSize;
418
419     AFSFileExtentCB FileExtents[ 1];
420
421 } AFSReleaseExtentsCB;
422
423 //
424 // This is the control structure used when the service passes the extent
425 // information via the IOCTL_AFS_SET_FILE_EXTENTS interface
426 //
427
428 typedef struct _AFS_SET_FILE_EXTENTS_CB
429 {
430
431     AFSFileID       FileId;
432
433     ULONG           ExtentCount;
434
435     ULONG           ResultStatus;
436
437     AFSFileExtentCB FileExtents[ 1];
438
439 } AFSSetFileExtentsCB;
440
441 //
442 // This is the control structure used when the service passes the extent
443 // information via the IOCTL_AFS_RELEASE_FILE_EXTENTS interface
444 //
445
446 #define AFS_RELEASE_EXTENTS_FLAGS_RELEASE_ALL       0x00000001
447
448 typedef struct _AFS_RELEASE_FILE_EXTENTS_CB
449 {
450
451     ULONG           Flags;
452
453     AFSFileID       FileId;
454
455     ULONG           ExtentCount;
456
457     LARGE_INTEGER   HeldExtentCount;
458
459     AFSFileExtentCB FileExtents[ 1];
460
461 } AFSReleaseFileExtentsCB;
462
463 //
464 // These are the control structures that the filesystem returns from a
465 // IOCTL_AFS_RELEASE_FILE_EXTENTS
466 //
467
468 typedef struct _AFS_RELEASE_FILE_EXTENTS_RESULT_FILE_CB
469 {
470     AFSFileID       FileId;
471
472     ULONG           Flags;
473
474     GUID            AuthGroup; /* Length: sizeof(GUID) */
475
476     ULONG           ExtentCount;
477
478     LARGE_INTEGER   LastAccessTime;
479
480     LARGE_INTEGER   LastWriteTime;
481
482     LARGE_INTEGER   ChangeTime;
483
484     LARGE_INTEGER   CreateTime;
485
486     LARGE_INTEGER   AllocationSize;
487
488     AFSFileExtentCB FileExtents[ 1];
489
490 } AFSReleaseFileExtentsResultFileCB;
491
492 typedef struct _AFS_RELEASE_FILE_EXTENTS_RESULT_CB
493 {
494     ULONG           SerialNumber;
495
496     ULONG           Flags;
497
498     ULONG           FileCount;
499
500     AFSReleaseFileExtentsResultFileCB Files[ 1];
501
502 } AFSReleaseFileExtentsResultCB;
503
504
505 typedef struct _AFS_EXTENT_FAILURE_CB
506 {
507
508     AFSFileID       FileId;
509
510     ULONG           FailureStatus;
511
512     GUID            AuthGroup;      // Length: sizeof(GUID) */
513
514 } AFSExtentFailureCB;
515
516 //
517 // File update CB
518 //
519
520 typedef struct _AFS_FILE_UPDATE_CB
521 {
522
523     AFSFileID       ParentId;
524
525     LARGE_INTEGER   LastAccessTime;
526
527     LARGE_INTEGER   LastWriteTime;
528
529     LARGE_INTEGER   ChangeTime;
530
531     LARGE_INTEGER   CreateTime;
532
533     LARGE_INTEGER   AllocationSize;
534
535     ULONG           FileAttributes;
536
537     ULONG           EaSize;
538
539     char            EaBuffer[ 1];
540
541 } AFSFileUpdateCB;
542
543 //
544 // File update CB result
545 //
546
547 typedef struct _AFS_FILE_UPDATE_RESULT_CB
548 {
549
550     LARGE_INTEGER   ParentDataVersion;
551
552     AFSDirEnumEntry DirEnum;
553
554 } AFSFileUpdateResultCB;
555
556 //
557 // File delete CB
558 //
559
560 typedef struct _AFS_FILE_DELETE_CB
561 {
562
563     AFSFileID       ParentId;        /* Must be directory */
564
565     ULONGLONG       ProcessId;
566
567                                      /* File Name and FileID in Common Request Block */
568
569 } AFSFileDeleteCB;
570
571 typedef struct _AFS_FILE_DELETE_RESULT_CB
572 {
573
574     LARGE_INTEGER   ParentDataVersion;
575
576 } AFSFileDeleteResultCB;
577
578 //
579 // File rename CB
580 //
581
582 typedef struct _AFS_FILE_RENAME_CB
583 {
584
585     AFSFileID       SourceParentId;        /* Must be directory */
586
587     AFSFileID       TargetParentId;        /* Must be directory */
588
589                                            /* Source Name and FileID in Common Request Block */
590
591     USHORT          TargetNameLength;
592
593     WCHAR           TargetName[ 1];
594
595 } AFSFileRenameCB;
596
597 typedef struct _AFS_FILE_RENAME_RESULT_CB
598 {
599
600     LARGE_INTEGER   SourceParentDataVersion;
601
602     LARGE_INTEGER   TargetParentDataVersion;
603
604     AFSDirEnumEntry DirEnum;
605
606 } AFSFileRenameResultCB;
607
608
609 //
610 // File Hard Link CB
611 //
612
613 typedef struct _AFS_FILE_HARDLINK_CB
614 {
615
616     AFSFileID       SourceParentId;        /* Must be directory */
617
618     AFSFileID       TargetParentId;        /* Must be directory */
619
620     BOOLEAN         bReplaceIfExists;
621
622                                            /* Source Name and FileID in Common Request Block */
623
624     USHORT          TargetNameLength;
625
626     WCHAR           TargetName[ 1];
627
628 } AFSFileHardLinkCB;
629
630 typedef struct _AFS_FILE_HARDLINK_RESULT_CB
631 {
632
633     LARGE_INTEGER   SourceParentDataVersion;
634
635     LARGE_INTEGER   TargetParentDataVersion;
636
637     AFSDirEnumEntry DirEnum;
638
639 } AFSFileHardLinkResultCB;
640
641
642 //
643 // Control structures for AFS_REQUEST_TYPE_EVAL_TARGET_BY_ID
644 // and AFS_REQUEST_TYPE_EVAL_TARGET_BY_NAME
645 //
646 // The response to these requests is a AFSDirEnumEntry
647 //
648
649 typedef struct _AFS_FILE_EVAL_TARGET_CB
650 {
651
652     AFSFileID       ParentId;
653
654 } AFSEvalTargetCB;
655
656
657 typedef struct _AFS_FILE_EVAL_RESULT_CB
658 {
659
660     LARGE_INTEGER   ParentDataVersion;
661
662     AFSDirEnumEntry DirEnum;
663
664 } AFSFileEvalResultCB;
665
666
667 //
668 // Control structure for read and write requests through the PIOCtl interface
669 //
670 // CommRequest FileId field contains the active directory
671
672 typedef struct _AFS_PIOCTL_IO_CB
673 {
674     ULONG       RequestId;
675
676     AFSFileID   RootId;
677
678     ULONG       BufferLength;
679
680     void        *MappedBuffer;
681
682 } AFSPIOCtlIORequestCB;
683
684 //
685 // The returned information for the IO Request
686 //
687
688 typedef struct _AFS_PIOCTL_IO_RESULT_CB
689 {
690
691     ULONG       BytesProcessed;
692
693 } AFSPIOCtlIOResultCB;
694
695
696 //
697 // Control structure for open and close requests through the PIOCtl interface
698 //
699 // CommRequest FileId field contains the active directory
700 //
701 // There is no return structure.
702 //
703 typedef struct _AFS_PIOCTL_OPEN_CLOSE_CB
704 {
705
706     ULONG       RequestId;
707
708     AFSFileID   RootId;
709
710 } AFSPIOCtlOpenCloseRequestCB;
711
712 //
713 // Cache invalidation control block
714 //
715
716 typedef struct _AFS_INVALIDATE_CACHE_CB
717 {
718
719     AFSFileID   FileID;
720
721     ULONG       FileType;
722
723     BOOLEAN     WholeVolume;
724
725     ULONG       Reason;
726
727 } AFSInvalidateCacheCB;
728
729 //
730 // Network Status Control Block
731 //
732
733 typedef struct _AFS_NETWORK_STATUS_CB
734 {
735
736     BOOLEAN     Online;
737
738 } AFSNetworkStatusCB;
739
740 //
741 // Volume Status Control Block
742 //
743
744 typedef struct _AFS_VOLUME_STATUS_CB
745 {
746
747     AFSFileID   FileID;         // only cell and volume fields are set
748
749     BOOLEAN     Online;
750
751 } AFSVolumeStatusCB;
752
753
754 typedef struct _AFS_SYSNAME
755 {
756
757     ULONG       Length;         /* bytes */
758
759     WCHAR       String[AFS_MAX_SYSNAME_LENGTH];
760
761 } AFSSysName;
762
763 //
764 // SysName Notification Control Block
765 //   Sent as the buffer with IOCTL_AFS_SYSNAME_NOTIFICATION
766 //   There is no response
767 //
768
769 typedef struct _AFS_SYSNAME_NOTIFICATION_CB
770 {
771
772     ULONG       Architecture;
773
774     ULONG       NumberOfNames;
775
776     AFSSysName  SysNames[1];
777
778 } AFSSysNameNotificationCB;
779
780
781 //
782 // File System Status Query Control Block
783 //   Received as a response to IOCTL_AFS_STATUS_REQUEST
784 //
785 typedef struct _AFS_DRIVER_STATUS_RESPONSE_CB
786 {
787
788     ULONG       Status;         // bit flags - see below
789
790 } AFSDriverStatusRespCB;
791
792 // Bit flags
793 #define AFS_DRIVER_STATUS_READY         0
794 #define AFS_DRIVER_STATUS_NOT_READY     1
795 #define AFS_DRIVER_STATUS_NO_SERVICE    2
796
797 //
798 // Byte Range Lock Request
799 //
800 typedef struct _AFS_BYTE_RANGE_LOCK_REQUEST
801 {
802     ULONG               LockType;
803
804     LARGE_INTEGER       Offset;
805
806     LARGE_INTEGER       Length;
807
808 } AFSByteRangeLockRequest;
809
810 #define AFS_BYTE_RANGE_LOCK_TYPE_SHARED 0
811 #define AFS_BYTE_RANGE_LOCK_TYPE_EXCL   1
812
813
814 //
815 // Byte Range Lock Request Control Block
816 //
817 // Set ProcessId and FileId in the Comm Request Block
818 //
819 typedef struct _AFS_BYTE_RANGE_LOCK_REQUEST_CB
820 {
821
822     ULONG                       Count;
823
824     ULONGLONG                   ProcessId;
825
826     AFSByteRangeLockRequest     Request[1];
827
828 } AFSByteRangeLockRequestCB;
829
830 //
831 // Byte Range Lock Result
832 //
833 typedef struct _AFS_BYTE_RANGE_LOCK_RESULT
834 {
835
836     ULONG               LockType;
837
838     LARGE_INTEGER       Offset;
839
840     LARGE_INTEGER       Length;
841
842     ULONG               Status;
843
844 } AFSByteRangeLockResult;
845
846 //
847 // Byte Range Lock Results Control Block
848 //
849
850 typedef struct _AFS_BYTE_RANGE_LOCK_RESULT_CB
851 {
852
853     AFSFileID                   FileId;
854
855     ULONG                       Count;
856
857     AFSByteRangeLockResult      Result[1];
858
859 } AFSByteRangeLockResultCB;
860
861 //
862 // Set Byte Range Lock Results Control Block
863 //
864
865 typedef struct _AFS_SET_BYTE_RANGE_LOCK_RESULT_CB
866 {
867
868     ULONG                       SerialNumber;
869
870     AFSFileID                   FileId;
871
872     ULONG                       Count;
873
874     AFSByteRangeLockResult      Result[1];
875
876 } AFSSetByteRangeLockResultCB;
877
878
879 //
880 // Byte Range Unlock Request Control Block
881 //
882
883 typedef struct _AFS_BYTE_RANGE_UNLOCK_CB
884 {
885
886     ULONG                       Count;
887
888     ULONGLONG                   ProcessId;
889
890     AFSByteRangeLockRequest     Request[1];
891
892 } AFSByteRangeUnlockRequestCB;
893
894
895 //
896 // Byte Range Unlock Request Control Block
897 //
898
899 typedef struct _AFS_BYTE_RANGE_UNLOCK_RESULT_CB
900 {
901
902     ULONG                       Count;
903
904     AFSByteRangeLockResult      Result[1];
905
906 } AFSByteRangeUnlockResultCB;
907
908
909 //
910 // Control structure for read and write requests through the PIPE interface
911 //
912 // CommRequest FileId field contains the active directory
913
914 typedef struct _AFS_PIPE_IO_CB
915 {
916     ULONG       RequestId;
917
918     AFSFileID   RootId;
919
920     ULONG       BufferLength;
921
922 } AFSPipeIORequestCB;   // For read requests the buffer is mapped in the request cb block.
923                         // For write requests, the buffer immediately follows this structure
924
925 //
926 // The returned information for the Pipe IO Request. Note that this is
927 // only returned in the write request. Read request info is returned in
928 // the request cb
929 //
930
931 typedef struct _AFS_PIPE_IO_RESULT_CB
932 {
933
934     ULONG       BytesProcessed;
935
936 } AFSPipeIOResultCB;
937
938 //
939 // Control structure for set and query info requests through the PIPE interface
940 //
941
942 typedef struct _AFS_PIPE_INFO_CB
943 {
944
945     ULONG       RequestId;
946
947     AFSFileID   RootId;
948
949     ULONG       InformationClass;
950
951     ULONG       BufferLength;
952
953 } AFSPipeInfoRequestCB;   // For query info requests the buffer is mapped in the request cb block.
954                           // For set info requests, the buffer immediately follows this structure
955
956 //
957 // Control structure for open and close requests through the Pipe interface
958 //
959 // CommRequest FileId field contains the active directory
960 //
961 // There is no return structure.
962 //
963 typedef struct _AFS_PIPE_OPEN_CLOSE_CB
964 {
965
966     ULONG       RequestId;
967
968     AFSFileID   RootId;
969
970 } AFSPipeOpenCloseRequestCB;
971
972
973 //
974 // Hold Fid Request Control Block
975 //
976
977 typedef struct _AFS_HOLD_FID_REQUEST_CB
978 {
979
980     ULONG                       Count;
981
982     AFSFileID                   FileID[ 1];
983
984 } AFSHoldFidRequestCB;
985
986
987 typedef struct _AFS_FID_RESULT
988 {
989
990     AFSFileID                   FileID;
991
992     ULONG                       Status;
993
994 } AFSFidResult;
995
996 typedef struct _AFS_HOLD_FID_RESULT_CB
997 {
998
999     ULONG                       Count;
1000
1001     AFSFidResult                Result[ 1];
1002
1003 } AFSHoldFidResultCB;
1004
1005
1006 //
1007 // Release Fid Request Control Block
1008 //
1009
1010 typedef struct _AFS_RELEASE_FID_REQUEST_CB
1011 {
1012
1013     ULONG                       Count;
1014
1015     AFSFileID                   FileID[ 1];
1016
1017 } AFSReleaseFidRequestCB;
1018
1019 typedef struct _AFS_RELEASE_FID_RESULT_CB
1020 {
1021
1022     ULONG                       Count;
1023
1024     AFSFidResult                Result[ 1];
1025
1026 } AFSReleaseFidResultCB;
1027
1028
1029 //
1030 // File cleanup CB
1031 //
1032
1033 typedef struct _AFS_FILE_CLEANUP_CB
1034 {
1035
1036     AFSFileID       ParentId;
1037
1038     LARGE_INTEGER   LastAccessTime;
1039
1040     LARGE_INTEGER   LastWriteTime;
1041
1042     LARGE_INTEGER   ChangeTime;
1043
1044     LARGE_INTEGER   CreateTime;
1045
1046     LARGE_INTEGER   AllocationSize;
1047
1048     ULONG           FileAttributes;
1049
1050     ULONGLONG       ProcessId;
1051
1052     ULONG           FileAccess;
1053
1054     ULONGLONG       Identifier;
1055
1056 } AFSFileCleanupCB;
1057
1058 typedef struct _AFS_FILE_CLEANUP_RESULT_CB
1059 {
1060
1061     LARGE_INTEGER   ParentDataVersion;
1062
1063 } AFSFileCleanupResultCB;
1064
1065
1066 //
1067 // Trace configuration cb
1068 //
1069
1070 typedef struct _AFS_DEBUG_TRACE_CONFIG_CB
1071 {
1072
1073     ULONG       TraceLevel;
1074
1075     ULONG       Subsystem;
1076
1077     ULONG       TraceBufferLength;
1078
1079     ULONG       DebugFlags;
1080
1081 } AFSTraceConfigCB;
1082
1083 //
1084 // Object Status Information request
1085 //
1086
1087 typedef struct _AFS_REDIR_GET_OBJECT_STATUS_CB
1088 {
1089
1090     AFSFileID       FileID;
1091
1092     USHORT          FileNameLength;
1093
1094     WCHAR           FileName[ 1];
1095
1096 } AFSGetStatusInfoCB;
1097
1098 typedef struct _AFS_REDIR_OBJECT_STATUS_CB
1099 {
1100
1101     AFSFileID               FileId;
1102
1103     AFSFileID               TargetFileId;
1104
1105     LARGE_INTEGER           Expiration;         /* FILETIME */
1106
1107     LARGE_INTEGER           DataVersion;
1108
1109     ULONG                   FileType;           /* File, Dir, MountPoint, Symlink */
1110
1111     ULONG                   ObjectFlags;
1112
1113     LARGE_INTEGER           CreationTime;       /* FILETIME */
1114
1115     LARGE_INTEGER           LastAccessTime;     /* FILETIME */
1116
1117     LARGE_INTEGER           LastWriteTime;      /* FILETIME */
1118
1119     LARGE_INTEGER           ChangeTime;         /* FILETIME */
1120
1121     ULONG                   FileAttributes;     /* NTFS FILE_ATTRIBUTE_xxxx see below */
1122
1123     LARGE_INTEGER           EndOfFile;
1124
1125     LARGE_INTEGER           AllocationSize;
1126
1127     ULONG                   EaSize;
1128
1129     ULONG                   Links;
1130
1131 } AFSStatusInfoCB;
1132
1133 //
1134 // Auth Group (Process and Thread) Processing
1135 //
1136 // afsredir.sys implements a set of generic Authentication Group
1137 // operations that can be executed by processes.  The model supports
1138 // one or more authentication groups per process.  A process may switch
1139 // the active AuthGroup for any thread to any other AuthGroup the process
1140 // is a member of.  However, processes cannot assign itself to an
1141 // AuthGroup that it is not presently a member of.  A process can reset
1142 // its AuthGroup to the SID-AuthGroup or can create a new AuthGroup that
1143 // has not previously been used.
1144 //
1145 //  IOCTL_AFS_AUTHGROUP_CREATE_AND_SET
1146 //      Creates a new AuthGroup and either activates it for
1147 //      the process or the current thread.  If set as the
1148 //      new process AuthGroup, the prior AuthGroup list is
1149 //      cleared.
1150 //
1151 //  IOCTL_AFS_AUTHGROUP_QUERY
1152 //      Returns a list of the AuthGroup GUIDS associated
1153 //      with the current process, the current process GUID,
1154 //      and the current thread GUID.
1155 //
1156 //  IOCTL_AFS_AUTHGROUP_SET
1157 //      Permits the current AuthGroup for the process or
1158 //      thread to be set to the specified GUID.  The GUID
1159 //      must be in the list of current values for the process.
1160 //
1161 //  IOCTL_AFS_AUTHGROUP_RESET
1162 //      Resets the current AuthGroup for the process or
1163 //      thread to the SID-AuthGroup
1164 //
1165 //  IOCTL_AFS_AUTHGROUP_SID_CREATE
1166 //      Given a SID as input, assigns a new AuthGroup GUID.
1167 //      (May only be executed by LOCAL_SYSTEM or the active SID)
1168 //
1169 //  IOCTL_AFS_AUTHGROUP_SID_QUERY
1170 //      Given a SID as input, returns the associated AuthGroup GUID.
1171 //
1172 //  IOCTL_AFS_AUTHGROUP_LOGON_CREATE
1173 //      Given a logon Session as input, assigns a new AuthGroup GUID.
1174 //      (May only be executed by LOCAL_SYSTEM.)
1175 //
1176 // New processes inherit only the active AuthGroup at the time of process
1177 // creation.  Either that of the active thread (if set) or the process.
1178 // All of the other AuthGroups associated with a parent process are
1179 // off-limits.
1180 //
1181
1182 //
1183 // Auth Group processing flags
1184 //
1185
1186 #define AFS_PAG_FLAGS_SET_AS_ACTIVE         0x00000001 // If set, the newly created authgroup is set to the active group
1187 #define AFS_PAG_FLAGS_THREAD_AUTH_GROUP     0x00000002 // If set, the request is targeted for the thread not the process
1188
1189 typedef struct _AFS_AUTH_GROUP_REQUEST
1190 {
1191
1192     USHORT              SIDLength; // If zero the SID of the caller is used
1193
1194     ULONG               SessionId; // If -1 the session id of the caller is used
1195
1196     ULONG               Flags;
1197
1198     GUID                AuthGroup; // The auth group for certain requests
1199
1200     WCHAR               SIDString[ 1];
1201
1202 } AFSAuthGroupRequestCB;
1203
1204 //
1205 // Reparse tag AFS Specific information buffer
1206 //
1207
1208 #define OPENAFS_SUBTAG_MOUNTPOINT 1
1209 #define OPENAFS_SUBTAG_SYMLINK    2
1210 #define OPENAFS_SUBTAG_UNC        3
1211
1212 #define OPENAFS_MOUNTPOINT_TYPE_NORMAL   L'#'
1213 #define OPENAFS_MOUNTPOINT_TYPE_RW       L'%'
1214
1215 typedef struct _AFS_REPARSE_TAG_INFORMATION
1216 {
1217
1218     ULONG SubTag;
1219
1220     union
1221     {
1222         struct
1223         {
1224             ULONG  Type;
1225             USHORT MountPointCellLength;
1226             USHORT MountPointVolumeLength;
1227             WCHAR  Buffer[1];
1228         } AFSMountPoint;
1229
1230         struct
1231         {
1232             BOOLEAN RelativeLink;
1233             USHORT  SymLinkTargetLength;
1234             WCHAR   Buffer[1];
1235         } AFSSymLink;
1236
1237         struct
1238         {
1239             USHORT UNCTargetLength;
1240             WCHAR  Buffer[1];
1241         } UNCReferral;
1242     };
1243
1244 } AFSReparseTagInfo;
1245
1246 #endif /* _AFS_USER_STRUCT_H */
1247