2 * Copyright (c) 2008, 2009, 2010, 2011 Kernel Drivers, LLC.
3 * Copyright (c) 2009, 2010, 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 names of Kernel Drivers, LLC and Your File System, Inc.
18 * nor the names of their contributors may be used to endorse or promote
19 * products derived from this software without specific prior written
20 * permission from Kernel Drivers, LLC and Your File System, Inc.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
24 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
25 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
26 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
27 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
28 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
29 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
30 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 #ifndef _AFS_DEFINES_H
36 #define _AFS_DEFINES_H
42 // Conditional compiled code
45 //#define AFS_FLUSH_PAGES_SYNCHRONOUSLY 1 // Flush pages as we mark them dirty
53 //#define AFS_VALIDATE_EXTENTS 0
65 #ifndef FsRtlSetupAdvancedHeader
67 #define FSRTL_FLAG_ADVANCED_HEADER (0x40)
68 #define FSRTL_FLAG2_SUPPORTS_FILTER_CONTEXTS (0x02)
70 #define FsRtlSetupAdvancedHeader( _advhdr, _fmutx ) \
72 SetFlag( (_advhdr)->Flags, FSRTL_FLAG_ADVANCED_HEADER ); \
73 SetFlag( (_advhdr)->Flags2, FSRTL_FLAG2_SUPPORTS_FILTER_CONTEXTS ); \
74 InitializeListHead( &(_advhdr)->FilterContexts ); \
75 if ((_fmutx) != NULL) { \
76 (_advhdr)->FastMutex = (_fmutx); \
84 (*PAFSRtlSetSaclSecurityDescriptor)( PSECURITY_DESCRIPTOR SecurityDescriptor,
87 BOOLEAN SaclDefaulted);
91 (*PAFSRtlSetGroupSecurityDescriptor)( IN PSECURITY_DESCRIPTOR SecurityDescriptor,
92 IN PSID Group OPTIONAL,
93 IN BOOLEAN GroupDefaulted);
96 // Worker thread count
99 #define AFS_WORKER_COUNT 16
100 #define AFS_IO_WORKER_COUNT 8
103 // Worker thread states
106 #define AFS_WORKER_INITIALIZED 0x0001
107 #define AFS_WORKER_PROCESS_REQUESTS 0x0002
110 // Worker Thread codes
113 #define AFS_WORK_UNUSED_1 0x0001
114 #define AFS_WORK_FLUSH_FCB 0x0002
115 #define AFS_WORK_UNUSED_3 0x0003
116 #define AFS_WORK_UNUSED_4 0x0004
117 #define AFS_WORK_UNUSED_5 0x0005
118 #define AFS_WORK_ENUMERATE_GLOBAL_ROOT 0x0006
119 #define AFS_WORK_INVALIDATE_OBJECT 0x0007
120 #define AFS_WORK_START_IOS 0x0008
123 // Worker request flags
126 #define AFS_SYNCHRONOUS_REQUEST 0x00000001
132 #define AFS_FCB_FLAG_FILE_MODIFIED 0x00000001
133 #define AFS_FCB_FILE_CLOSED 0x00000002
134 #define AFS_FCB_FLAG_UPDATE_WRITE_TIME 0x00000004
135 #define AFS_FCB_FLAG_UPDATE_CHANGE_TIME 0x00000008
136 #define AFS_FCB_FLAG_UPDATE_ACCESS_TIME 0x00000010
137 #define AFS_FCB_FLAG_UPDATE_CREATE_TIME 0x00000020
138 #define AFS_FCB_FLAG_UPDATE_LAST_WRITE_TIME 0x00000040
139 #define AFS_FCB_FLAG_PURGE_ON_CLOSE 0x00000080
142 // Object information flags
145 #define AFS_OBJECT_FLAGS_OBJECT_INVALID 0x00000001
146 #define AFS_OBJECT_FLAGS_VERIFY 0x00000002
147 #define AFS_OBJECT_FLAGS_NOT_EVALUATED 0x00000004
148 #define AFS_OBJECT_FLAGS_DIRECTORY_ENUMERATED 0x00000008
149 #define AFS_OBJECT_FLAGS_DELETED 0x00000010
150 #define AFS_OBJECT_INSERTED_HASH_TREE 0x00000020
151 #define AFS_OBJECT_INSERTED_VOLUME_LIST 0x00000040
152 #define AFS_OBJECT_HELD_IN_SERVICE 0x00000080
153 #define AFS_OBJECT_ROOT_VOLUME 0x00000100
154 #define AFS_OBJECT_FLAGS_VERIFY_DATA 0x00000200
155 #define AFS_OBJECT_FLAGS_PARENT_FID 0x00000400
158 // Object information reference count reasons
161 #define AFS_OBJECT_REFERENCE_DIRENTRY 0
162 #define AFS_OBJECT_REFERENCE_CHILD 1
163 #define AFS_OBJECT_REFERENCE_INVALIDATION 2
164 #define AFS_OBJECT_REFERENCE_GLOBAL 3
165 #define AFS_OBJECT_REFERENCE_EXTENTS 4
166 #define AFS_OBJECT_REFERENCE_WORKER 5
167 #define AFS_OBJECT_REFERENCE_STATUS 6
168 #define AFS_OBJECT_REFERENCE_FIND 7
169 #define AFS_OBJECT_REFERENCE_MAX 8
172 // Define one second in terms of 100 nS units
175 #define AFS_ONE_SECOND 10000000
176 #define AFS_ONE_MILLISECOND 10000
177 #define AFS_ONE_MICROSECOND 10
180 // Fcb lifetime in seconds
183 #define AFS_OBJECT_LIFETIME 20 * AFS_ONE_SECOND
185 #define AFS_EXTENT_REQUEST_TIME 10 * AFS_ONE_SECOND
188 // How big to make the runs
190 #define AFS_MAX_STACK_IO_RUNS 5
193 #define FlagOn(_F,_SF) ((_F) & (_SF))
196 #ifndef BooleanFlagOn
197 #define BooleanFlagOn(F,SF) ((BOOLEAN)(((F) & (SF)) != 0))
201 #define SetFlag(_F,_SF) ((_F) |= (_SF))
205 #define ClearFlag(_F,_SF) ((_F) &= ~(_SF))
208 #define QuadAlign(Ptr) ( \
209 ((((ULONG)(Ptr)) + 7) & 0xfffffff8) \
212 #define CRC32_POLYNOMIAL 0xEDB88320L;
214 #define AFS_SERVER_FLUSH_DELAY (5LL * AFS_ONE_SECOND)
215 #define AFS_SERVER_PURGE_DELAY (300LL * AFS_ONE_SECOND)
217 // PURGE_SLEEP is the number of PURGE_DELAYS we wait before we will unilaterally
218 // give back extents.
220 // If the Service asks us, we will start at PURGE_SLEEP of delays and then work back
222 #define AFS_SERVER_PURGE_SLEEP 6
224 #define AFS_DIR_ENUM_BUFFER_LEN (16 * 1024)
227 // IS_BYTE_OFFSET_WRITE_TO_EOF
228 // liOffset - should be from Irp.StackLocation.Parameters.Write.ByteOffset
229 // this macro checks to see if the Offset Large_Integer points to the
230 // special constant value which denotes to start the write at EndOfFile
232 #define IS_BYTE_OFFSET_WRITE_TO_EOF(liOffset) \
233 (((liOffset).LowPart == FILE_WRITE_TO_END_OF_FILE) \
234 && ((liOffset).HighPart == 0xFFFFFFFF))
237 // Ccb Directory enum flags
240 #define CCB_FLAG_DIR_OF_DIRS_ONLY 0x00000001
241 #define CCB_FLAG_FULL_DIRECTORY_QUERY 0x00000002
242 #define CCB_FLAG_MASK_CONTAINS_WILD_CARDS 0x00000004
243 #define CCB_FLAG_FREE_FULL_PATHNAME 0x00000008
244 #define CCB_FLAG_RETURN_RELATIVE_ENTRIES 0x00000010
245 #define CCB_FLAG_DIRECTORY_QUERY_MAPPED 0x00000020
246 #define CCB_FLAG_MASK_PIOCTL_QUERY 0x00000040
247 #define CCB_FLAG_MASK_OPENED_REPARSE_POINT 0x00000080
248 #define CCB_FLAG_INSERTED_CCB_LIST 0x00000100
254 #define AFS_DIR_RELEASE_NAME_BUFFER 0x00000001
256 #define AFS_DIR_ENTRY_CASE_INSENSTIVE_LIST_HEAD 0x00000004
257 #define AFS_DIR_ENTRY_NOT_IN_PARENT_TREE 0x00000008
258 #define AFS_DIR_ENTRY_INSERTED_ENUM_LIST 0x00000010
259 #define AFS_DIR_ENTRY_FAKE 0x00000020
260 #define AFS_DIR_RELEASE_TARGET_NAME_BUFFER 0x00000040
261 #define AFS_DIR_ENTRY_VALID 0x00000080
262 #define AFS_DIR_ENTRY_PENDING_DELETE 0x00000100
263 #define AFS_DIR_ENTRY_DELETED 0x00000200
264 #define AFS_DIR_ENTRY_PIPE_SERVICE 0x00000400
265 #define AFS_DIR_ENTRY_IPC 0x00000800
266 #define AFS_DIR_ENTRY_INSERTED_SHORT_NAME 0x00001000
269 // Network provider errors
272 #define WN_SUCCESS 0L
273 #define WN_ALREADY_CONNECTED 85L
274 #define WN_OUT_OF_MEMORY 8L
275 #define WN_NOT_CONNECTED 2250L
276 #define WN_BAD_NETNAME 67L
278 #define RESOURCE_CONNECTED 0x00000001
279 #define RESOURCE_GLOBALNET 0x00000002
280 #define RESOURCE_REMEMBERED 0x00000003
281 #define RESOURCE_RECENT 0x00000004
282 #define RESOURCE_CONTEXT 0x00000005
284 #define RESOURCETYPE_ANY 0x00000000
285 #define RESOURCETYPE_DISK 0x00000001
286 #define RESOURCETYPE_PRINT 0x00000002
287 #define RESOURCETYPE_RESERVED 0x00000008
288 #define RESOURCETYPE_UNKNOWN 0xFFFFFFFF
290 #define RESOURCEUSAGE_CONNECTABLE 0x00000001
291 #define RESOURCEUSAGE_CONTAINER 0x00000002
292 #define RESOURCEUSAGE_NOLOCALDEVICE 0x00000004
293 #define RESOURCEUSAGE_SIBLING 0x00000008
294 #define RESOURCEUSAGE_ATTACHED 0x00000010
295 #define RESOURCEUSAGE_ALL (RESOURCEUSAGE_CONNECTABLE | RESOURCEUSAGE_CONTAINER | RESOURCEUSAGE_ATTACHED)
296 #define RESOURCEUSAGE_RESERVED 0x80000000
298 #define RESOURCEDISPLAYTYPE_GENERIC 0x00000000
299 #define RESOURCEDISPLAYTYPE_DOMAIN 0x00000001
300 #define RESOURCEDISPLAYTYPE_SERVER 0x00000002
301 #define RESOURCEDISPLAYTYPE_SHARE 0x00000003
302 #define RESOURCEDISPLAYTYPE_FILE 0x00000004
303 #define RESOURCEDISPLAYTYPE_GROUP 0x00000005
304 #define RESOURCEDISPLAYTYPE_NETWORK 0x00000006
305 #define RESOURCEDISPLAYTYPE_ROOT 0x00000007
306 #define RESOURCEDISPLAYTYPE_SHAREADMIN 0x00000008
307 #define RESOURCEDISPLAYTYPE_DIRECTORY 0x00000009
308 #define RESOURCEDISPLAYTYPE_TREE 0x0000000A
309 #define RESOURCEDISPLAYTYPE_NDSCONTAINER 0x0000000B
312 // Method for determining the different control device open requests
315 #define AFS_CONTROL_INSTANCE 0x00000001
316 #define AFS_REDIRECTOR_INSTANCE 0x00000002
322 #define AFS_EXTENT_DIRTY 0x00000001
325 // Extent skip list sizes
327 #define AFS_NUM_EXTENT_LISTS 3
330 // Extents skip lists
332 // We use constant sizes.
334 #define AFS_EXTENT_SIZE (4*1024)
335 #define AFS_EXTENTS_LIST 0
337 // A max of 64 extents in ther first skip list
338 #define AFS_EXTENT_SKIP1_BITS 6
341 // Then 128 bits in the second skip list
342 #define AFS_EXTENT_SKIP2_BITS 7
345 // This means that the top list skips in steps of 2^25 (=12+6+7) which
346 // is 32 Mb. It is to be expected that files which are massively
347 // larger that this will not be fully mapped.
349 #define AFS_EXTENT_SKIP1_SIZE (AFS_EXTENT_SIZE << AFS_EXTENT_SKIP1_BITS)
350 #define AFS_EXTENT_SKIP2_SIZE (AFS_EXTENT_SKIP1_SIZE << AFS_EXTENT_SKIP2_BITS)
352 #define AFS_EXTENTS_MASKS { (AFS_EXTENT_SIZE-1), \
353 (AFS_EXTENT_SKIP1_SIZE-1), \
354 (AFS_EXTENT_SKIP2_SIZE-1) }
357 // Maximum count to release at a time
360 #define AFS_MAXIMUM_EXTENT_RELEASE_COUNT 100
362 #define AFS_DIRTY_CHUNK_THRESHOLD 64
364 // {41966169-3FD7-4392-AFE4-E6A9D0A92C72} - generated using guidgen.exe
365 DEFINE_GUID (GUID_SD_AFS_REDIRECTOR_CONTROL_OBJECT,
366 0x41966169, 0x3fd7, 0x4392, 0xaf, 0xe4, 0xe6, 0xa9, 0xd0, 0xa9, 0x2c, 0x72);
372 #define AFS_DBG_LOG_LENGTH 256
378 #define AFS_DBG_LOG_WRAPPED 0x00000001
384 #define AFS_CONNECTION_FLAG_GLOBAL_SHARE 0x00000001
390 #define AFS_PROCESS_FLAG_IS_64BIT 0x00000001
393 // Maximum number of special share names
396 #define AFS_SPECIAL_SHARE_NAME_COUNT_MAX 10
402 #define AFS_NAME_ARRAY_FLAG_ROOT_ELEMENT 0x00000001
403 #define AFS_NAME_ARRAY_FLAG_REDIRECTION_ELEMENT 0x00000002
406 // Maximum recursion depth
409 #define AFS_MAX_RECURSION_COUNT 20
412 // LocateNameEntry flags
415 #define AFS_LOCATE_FLAGS_SUBSTITUTE_NAME 0x00000001
416 #define AFS_LOCATE_FLAGS_NO_MP_TARGET_EVAL 0x00000002
417 #define AFS_LOCATE_FLAGS_NO_SL_TARGET_EVAL 0x00000004
418 #define AFS_LOCATE_FLAGS_NO_DFS_LINK_EVAL 0x00000008
424 #define AFS_PARSE_FLAG_FREE_FILE_BUFFER 0x00000001
425 #define AFS_PARSE_FLAG_ROOT_ACCESS 0x00000002
428 // Reparse tag information
432 // Tag allocated to OpenAFS for DFS by Microsoft
433 // GUID: EF21A155-5C92-4470-AB3B-370403D96369
436 #ifndef IO_REPARSE_TAG_OPENAFS_DFS
437 #define IO_REPARSE_TAG_OPENAFS_DFS 0x00000037L
440 #ifndef IO_REPARSE_TAG_SURROGATE
441 #define IO_REPARSE_TAG_SURROGATE 0x20000000L
444 // {EF21A155-5C92-4470-AB3B-370403D96369}
445 DEFINE_GUID (GUID_AFS_REPARSE_GUID,
446 0xEF21A155, 0x5C92, 0x4470, 0xAB, 0x3B, 0x37, 0x04, 0x03, 0xD9, 0x63, 0x69);
449 // Enumeration constants
452 #define AFS_DIR_ENTRY_INITIAL_DIR_INDEX (ULONG)-3
453 #define AFS_DIR_ENTRY_INITIAL_ROOT_INDEX (ULONG)-1
455 #define AFS_DIR_ENTRY_PIOCTL_INDEX (ULONG)-3
456 #define AFS_DIR_ENTRY_DOT_INDEX (ULONG)-2
457 #define AFS_DIR_ENTRY_DOT_DOT_INDEX (ULONG)-1
460 // Library state flags
463 #define AFS_REDIR_LIB_FLAGS_NONPERSISTENT_CACHE 0x00000001
465 #endif /* _AFS_DEFINES_H */