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_ASYNCH_READ 0x0003
116 #define AFS_WORK_ASYNCH_WRITE 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
157 // Define one second in terms of 100 nS units
160 #define AFS_ONE_SECOND 10000000
161 #define AFS_ONE_MILLISECOND 10000
162 #define AFS_ONE_MICROSECOND 10
165 // Fcb lifetime in seconds
168 #define AFS_OBJECT_LIFETIME 600 * AFS_ONE_SECOND
170 #define AFS_EXTENT_REQUEST_TIME 10 * AFS_ONE_SECOND
173 // How big to make the runs
175 #define AFS_MAX_STACK_IO_RUNS 5
178 #define FlagOn(_F,_SF) ((_F) & (_SF))
181 #ifndef BooleanFlagOn
182 #define BooleanFlagOn(F,SF) ((BOOLEAN)(((F) & (SF)) != 0))
186 #define SetFlag(_F,_SF) ((_F) |= (_SF))
190 #define ClearFlag(_F,_SF) ((_F) &= ~(_SF))
193 #define QuadAlign(Ptr) ( \
194 ((((ULONG)(Ptr)) + 7) & 0xfffffff8) \
197 #define CRC32_POLYNOMIAL 0xEDB88320L;
199 #define AFS_SERVER_FLUSH_DELAY (5LL * AFS_ONE_SECOND)
200 #define AFS_SERVER_PURGE_DELAY (300LL * AFS_ONE_SECOND)
202 // PURGE_SLEEP is the number of PURGE_DELAYS we wait before we will unilaterally
203 // give back extents.
205 // If the Service asks us, we will start at PURGE_SLEEP of delays and then work back
207 #define AFS_SERVER_PURGE_SLEEP 6
210 // Read ahead granularity
213 #define READ_AHEAD_GRANULARITY 0x10000 // 64KB
215 #define AFS_DIR_ENUM_BUFFER_LEN (16 * 1024)
218 // IS_BYTE_OFFSET_WRITE_TO_EOF
219 // liOffset - should be from Irp.StackLocation.Parameters.Write.ByteOffset
220 // this macro checks to see if the Offset Large_Integer points to the
221 // special constant value which denotes to start the write at EndOfFile
223 #define IS_BYTE_OFFSET_WRITE_TO_EOF(liOffset) \
224 (((liOffset).LowPart == FILE_WRITE_TO_END_OF_FILE) \
225 && ((liOffset).HighPart == 0xFFFFFFFF))
228 // Ccb Directory enum flags
231 #define CCB_FLAG_DIR_OF_DIRS_ONLY 0x00000001
232 #define CCB_FLAG_FULL_DIRECTORY_QUERY 0x00000002
233 #define CCB_FLAG_MASK_CONTAINS_WILD_CARDS 0x00000004
234 #define CCB_FLAG_FREE_FULL_PATHNAME 0x00000008
235 #define CCB_FLAG_RETURN_RELATIVE_ENTRIES 0x00000010
236 #define CCB_FLAGS_DIRECTORY_QUERY_MAPPED 0x00000020
237 #define CCB_FLAG_MASK_PIOCTL_QUERY 0x00000040
238 #define CCB_FLAG_MASK_OPENED_REPARSE_POINT 0x00000080
239 #define CCB_FLAG_INSERTED_CCB_LIST 0x00000100
245 #define AFS_DIR_RELEASE_NAME_BUFFER 0x00000001
247 #define AFS_DIR_ENTRY_CASE_INSENSTIVE_LIST_HEAD 0x00000004
248 #define AFS_DIR_ENTRY_NOT_IN_PARENT_TREE 0x00000008
249 #define AFS_DIR_ENTRY_INSERTED_ENUM_LIST 0x00000010
250 #define AFS_DIR_ENTRY_FAKE 0x00000020
251 #define AFS_DIR_RELEASE_TARGET_NAME_BUFFER 0x00000040
252 #define AFS_DIR_ENTRY_VALID 0x00000080
253 #define AFS_DIR_ENTRY_PENDING_DELETE 0x00000100
254 #define AFS_DIR_ENTRY_DELETED 0x00000200
255 #define AFS_DIR_ENTRY_SERVER_SERVICE 0x00000400
256 #define AFS_DIR_ENTRY_WORKSTATION_SERVICE 0x00000800
257 #define AFS_DIR_ENTRY_IPC 0x00001000
258 #define AFS_DIR_ENTRY_INSERTED_SHORT_NAME 0x00002000
261 // Network provider errors
264 #define WN_SUCCESS 0L
265 #define WN_ALREADY_CONNECTED 85L
266 #define WN_OUT_OF_MEMORY 8L
267 #define WN_NOT_CONNECTED 2250L
268 #define WN_BAD_NETNAME 67L
270 #define RESOURCE_CONNECTED 0x00000001
271 #define RESOURCE_GLOBALNET 0x00000002
272 #define RESOURCE_REMEMBERED 0x00000003
273 #define RESOURCE_RECENT 0x00000004
274 #define RESOURCE_CONTEXT 0x00000005
276 #define RESOURCETYPE_ANY 0x00000000
277 #define RESOURCETYPE_DISK 0x00000001
278 #define RESOURCETYPE_PRINT 0x00000002
279 #define RESOURCETYPE_RESERVED 0x00000008
280 #define RESOURCETYPE_UNKNOWN 0xFFFFFFFF
282 #define RESOURCEUSAGE_CONNECTABLE 0x00000001
283 #define RESOURCEUSAGE_CONTAINER 0x00000002
284 #define RESOURCEUSAGE_NOLOCALDEVICE 0x00000004
285 #define RESOURCEUSAGE_SIBLING 0x00000008
286 #define RESOURCEUSAGE_ATTACHED 0x00000010
287 #define RESOURCEUSAGE_ALL (RESOURCEUSAGE_CONNECTABLE | RESOURCEUSAGE_CONTAINER | RESOURCEUSAGE_ATTACHED)
288 #define RESOURCEUSAGE_RESERVED 0x80000000
290 #define RESOURCEDISPLAYTYPE_GENERIC 0x00000000
291 #define RESOURCEDISPLAYTYPE_DOMAIN 0x00000001
292 #define RESOURCEDISPLAYTYPE_SERVER 0x00000002
293 #define RESOURCEDISPLAYTYPE_SHARE 0x00000003
294 #define RESOURCEDISPLAYTYPE_FILE 0x00000004
295 #define RESOURCEDISPLAYTYPE_GROUP 0x00000005
296 #define RESOURCEDISPLAYTYPE_NETWORK 0x00000006
297 #define RESOURCEDISPLAYTYPE_ROOT 0x00000007
298 #define RESOURCEDISPLAYTYPE_SHAREADMIN 0x00000008
299 #define RESOURCEDISPLAYTYPE_DIRECTORY 0x00000009
300 #define RESOURCEDISPLAYTYPE_TREE 0x0000000A
301 #define RESOURCEDISPLAYTYPE_NDSCONTAINER 0x0000000B
304 // Method for determining the different control device open requests
307 #define AFS_CONTROL_INSTANCE 0x00000001
308 #define AFS_REDIRECTOR_INSTANCE 0x00000002
314 #define AFS_EXTENT_DIRTY 0x00000001
317 // Extent skip list sizes
319 #define AFS_NUM_EXTENT_LISTS 3
322 // Extents skip lists
324 // We use constant sizes.
326 #define AFS_EXTENT_SIZE (4*1024)
327 #define AFS_EXTENTS_LIST 0
329 // A max of 64 extents in ther first skip list
330 #define AFS_EXTENT_SKIP1_BITS 6
333 // Then 128 bits in the second skip list
334 #define AFS_EXTENT_SKIP2_BITS 7
337 // This means that the top list skips in steps of 2^25 (=12+6+7) which
338 // is 32 Mb. It is to be expected that files which are massively
339 // larger that this will not be fully mapped.
341 #define AFS_EXTENT_SKIP1_SIZE (AFS_EXTENT_SIZE << AFS_EXTENT_SKIP1_BITS)
342 #define AFS_EXTENT_SKIP2_SIZE (AFS_EXTENT_SKIP1_SIZE << AFS_EXTENT_SKIP2_BITS)
344 #define AFS_EXTENTS_MASKS { (AFS_EXTENT_SIZE-1), \
345 (AFS_EXTENT_SKIP1_SIZE-1), \
346 (AFS_EXTENT_SKIP2_SIZE-1) }
349 // Maximum count to release at a time
352 #define AFS_MAXIMUM_EXTENT_RELEASE_COUNT 100
354 // {41966169-3FD7-4392-AFE4-E6A9D0A92C72} - generated using guidgen.exe
355 DEFINE_GUID (GUID_SD_AFS_REDIRECTOR_CONTROL_OBJECT,
356 0x41966169, 0x3fd7, 0x4392, 0xaf, 0xe4, 0xe6, 0xa9, 0xd0, 0xa9, 0x2c, 0x72);
362 #define AFS_DBG_LOG_LENGTH 256
368 #define AFS_DBG_LOG_WRAPPED 0x00000001
374 #define AFS_CONNECTION_FLAG_GLOBAL_SHARE 0x00000001
380 #define AFS_PROCESS_FLAG_IS_64BIT 0x00000001
383 // Maximum number of special share names
386 #define AFS_SPECIAL_SHARE_NAME_COUNT_MAX 10
392 #define AFS_DEVICE_FLAG_HIDE_DOT_NAMES 0x00000001
393 #define AFS_DEVICE_FLAG_REDIRECTOR_SHUTDOWN 0x00000002
399 #define AFS_NAME_ARRAY_FLAG_ROOT_ELEMENT 0x00000001
400 #define AFS_NAME_ARRAY_FLAG_REDIRECTION_ELEMENT 0x00000002
403 // Maximum recursion depth
406 #define AFS_MAX_RECURSION_COUNT 20
409 // LocateNameEntry flags
412 #define AFS_LOCATE_FLAGS_SUBSTITUTE_NAME 0x00000001
413 #define AFS_LOCATE_FLAGS_NO_MP_TARGET_EVAL 0x00000002
414 #define AFS_LOCATE_FLAGS_NO_SL_TARGET_EVAL 0x00000004
415 #define AFS_LOCATE_FLAGS_NO_DFS_LINK_EVAL 0x00000008
421 #define AFS_PARSE_FLAG_FREE_FILE_BUFFER 0x00000001
422 #define AFS_PARSE_FLAG_ROOT_ACCESS 0x00000002
425 // Reparse tag information
429 // Tag allocated to OpenAFS for DFS by Microsoft
430 // GUID: EF21A155-5C92-4470-AB3B-370403D96369
433 #ifndef IO_REPARSE_TAG_OPENAFS_DFS
434 #define IO_REPARSE_TAG_OPENAFS_DFS 0x00000037L
437 // {EF21A155-5C92-4470-AB3B-370403D96369}
438 DEFINE_GUID (GUID_AFS_REPARSE_GUID,
439 0xEF21A155, 0x5C92, 0x4470, 0xAB, 0x3B, 0x37, 0x04, 0x03, 0xD9, 0x63, 0x69);
442 // Enumeration constants
445 #define AFS_DIR_ENTRY_INITIAL_DIR_INDEX (ULONG)-3
446 #define AFS_DIR_ENTRY_INITIAL_ROOT_INDEX (ULONG)-1
448 #define AFS_DIR_ENTRY_PIOCTL_INDEX (ULONG)-3
449 #define AFS_DIR_ENTRY_DOT_INDEX (ULONG)-2
450 #define AFS_DIR_ENTRY_DOT_DOT_INDEX (ULONG)-1
453 // Library state flags
456 #define AFS_REDIR_LIB_FLAGS_NONPERSISTENT_CACHE 0x00000001
458 #endif /* _AFS_DEFINES_H */