8107ea7a821cbce24c3673f1d783ed04edc6da46
[openafs.git] / src / WINNT / afsrdr / kernel / lib / Include / AFSDefines.h
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011 Kernel Drivers, LLC.
3  * Copyright (c) 2009, 2010, 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 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.
21  *
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.
33  */
34
35 #ifndef _AFS_DEFINES_H
36 #define _AFS_DEFINES_H
37 //
38 // File: AFSDefines.h
39 //
40
41 //
42 // Conditional compiled code
43 //
44
45 //#define AFS_FLUSH_PAGES_SYNCHRONOUSLY       1       // Flush pages as we mark them dirty
46
47 //
48 // Debug information
49 //
50
51 #if DBG
52
53 //#define AFS_VALIDATE_EXTENTS            0
54
55 #define GEN_MD5 0
56
57 #else
58
59 #endif
60
61 //
62 // For 2K support
63 //
64
65 #ifndef FsRtlSetupAdvancedHeader
66
67 #define FSRTL_FLAG_ADVANCED_HEADER              (0x40)
68 #define FSRTL_FLAG2_SUPPORTS_FILTER_CONTEXTS    (0x02)
69
70 #define FsRtlSetupAdvancedHeader( _advhdr, _fmutx )                         \
71 {                                                                           \
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);                                    \
77     }                                                                       \
78 }
79
80 #endif
81
82 typedef
83 NTSTATUS
84 (*PAFSRtlSetSaclSecurityDescriptor)( PSECURITY_DESCRIPTOR SecurityDescriptor,
85                                      BOOLEAN SaclPresent,
86                                      PACL Sacl,
87                                      BOOLEAN SaclDefaulted);
88
89 //
90 // Worker thread count
91 //
92
93 #define AFS_WORKER_COUNT        5
94 #define AFS_IO_WORKER_COUNT     5
95
96 //
97 // Worker thread states
98 //
99
100 #define AFS_WORKER_INITIALIZED                  0x0001
101 #define AFS_WORKER_PROCESS_REQUESTS             0x0002
102
103 //
104 // Worker Thread codes
105 //
106
107 #define AFS_WORK_UNUSED_1                       0x0001
108 #define AFS_WORK_FLUSH_FCB                      0x0002
109 #define AFS_WORK_ASYNCH_READ                    0x0003
110 #define AFS_WORK_ASYNCH_WRITE                   0x0004
111 #define AFS_WORK_UNUSED_5                       0x0005
112 #define AFS_WORK_ENUMERATE_GLOBAL_ROOT          0x0006
113 #define AFS_WORK_UNUSED_7                       0x0007
114 #define AFS_WORK_START_IOS                      0x0008
115
116 //
117 // Worker request flags
118 //
119
120 #define AFS_SYNCHRONOUS_REQUEST                 0x00000001
121
122 //
123 // Fcb flags
124 //
125
126 #define AFS_FCB_FLAG_FILE_MODIFIED                           0x00000001
127 #define AFS_FCB_FILE_CLOSED                                  0x00000002
128 #define AFS_FCB_FLAG_UPDATE_WRITE_TIME                       0x00000004
129 #define AFS_FCB_FLAG_UPDATE_CHANGE_TIME                      0x00000008
130 #define AFS_FCB_FLAG_UPDATE_ACCESS_TIME                      0x00000010
131 #define AFS_FCB_FLAG_UPDATE_CREATE_TIME                      0x00000020
132 #define AFS_FCB_FLAG_UPDATE_LAST_WRITE_TIME                  0x00000040
133
134 //
135 // Object information flags
136 //
137
138 #define AFS_OBJECT_FLAGS_OBJECT_INVALID                 0x00000001
139 #define AFS_OBJECT_FLAGS_VERIFY                         0x00000002
140 #define AFS_OBJECT_FLAGS_NOT_EVALUATED                  0x00000004
141 #define AFS_OBJECT_FLAGS_DIRECTORY_ENUMERATED           0x00000008
142 #define AFS_OBJECT_FLAGS_DELETED                        0x00000010
143 #define AFS_OBJECT_INSERTED_HASH_TREE                   0x00000020
144 #define AFS_OBJECT_INSERTED_VOLUME_LIST                 0x00000040
145 #define AFS_OBJECT_HELD_IN_SERVICE                      0x00000080
146 #define AFS_OBJECT_ROOT_VOLUME                          0x00000100
147 #define AFS_OBJECT_FLAGS_VERIFY_DATA                    0x00000200
148
149 //
150 // Fcb lifetime in seconds
151 //
152
153 #define AFS_OBJECT_LIFETIME             300000000
154
155 #define AFS_EXTENT_REQUEST_TIME         100000000
156
157 //
158 // How big to make the runs
159 //
160 #define AFS_MAX_STACK_IO_RUNS              5
161
162 #ifndef FlagOn
163 #define FlagOn(_F,_SF)        ((_F) & (_SF))
164 #endif
165
166 #ifndef BooleanFlagOn
167 #define BooleanFlagOn(F,SF)   ((BOOLEAN)(((F) & (SF)) != 0))
168 #endif
169
170 #ifndef SetFlag
171 #define SetFlag(_F,_SF)       ((_F) |= (_SF))
172 #endif
173
174 #ifndef ClearFlag
175 #define ClearFlag(_F,_SF)     ((_F) &= ~(_SF))
176 #endif
177
178 #define QuadAlign(Ptr) (                \
179     ((((ULONG)(Ptr)) + 7) & 0xfffffff8) \
180     )
181
182 #define CRC32_POLYNOMIAL     0xEDB88320L;
183
184 //
185 // Define one second in terms of 100 nS units
186 //
187
188 #define AFS_ONE_SECOND          10000000
189
190 #define AFS_SERVER_FLUSH_DELAY  30
191 #define AFS_SERVER_PURGE_DELAY  60
192 //
193 // PURGE_SLEEP is the number of PURGE_DELAYS we wait before we will unilaterally
194 // give back extents.
195 //
196 // If the Service asks us, we will start at PURGE_SLEEP of delays and then work back
197 //
198 #define AFS_SERVER_PURGE_SLEEP  6
199
200 //
201 // Read ahead granularity
202 //
203
204 #define READ_AHEAD_GRANULARITY      0x10000     // 64KB
205
206 #define AFS_DIR_ENUM_BUFFER_LEN   (16 * 1024)
207
208 //
209 // IS_BYTE_OFFSET_WRITE_TO_EOF
210 // liOffset - should be from Irp.StackLocation.Parameters.Write.ByteOffset
211 // this macro checks to see if the Offset Large_Integer points to the
212 // special constant value which denotes to start the write at EndOfFile
213 //
214 #define IS_BYTE_OFFSET_WRITE_TO_EOF(liOffset) \
215     (((liOffset).LowPart == FILE_WRITE_TO_END_OF_FILE) \
216       && ((liOffset).HighPart == 0xFFFFFFFF))
217
218 //
219 // Ccb Directory enum flags
220 //
221
222 #define CCB_FLAG_DIR_OF_DIRS_ONLY           0x00000001
223 #define CCB_FLAG_FULL_DIRECTORY_QUERY       0x00000002
224 #define CCB_FLAG_MASK_CONTAINS_WILD_CARDS   0x00000004
225 #define CCB_FLAG_FREE_FULL_PATHNAME         0x00000008
226 #define CCB_FLAG_RETURN_RELATIVE_ENTRIES    0x00000010
227 #define CCB_FLAGS_DIRECTORY_QUERY_MAPPED    0x00000020
228 #define CCB_FLAG_MASK_PIOCTL_QUERY          0x00000040
229
230 //
231 // DirEntry flags
232 //
233
234 #define AFS_DIR_RELEASE_NAME_BUFFER             0x00000001
235
236 #define AFS_DIR_ENTRY_CASE_INSENSTIVE_LIST_HEAD 0x00000004
237 #define AFS_DIR_ENTRY_NOT_IN_PARENT_TREE        0x00000008
238 #define AFS_DIR_ENTRY_INSERTED_ENUM_LIST        0x00000010
239 #define AFS_DIR_ENTRY_FAKE                      0x00000020
240 #define AFS_DIR_RELEASE_TARGET_NAME_BUFFER      0x00000040
241 #define AFS_DIR_ENTRY_VALID                     0x00000080
242 #define AFS_DIR_ENTRY_PENDING_DELETE            0x00000100
243 #define AFS_DIR_ENTRY_DELETED                   0x00000200
244 #define AFS_DIR_ENTRY_SERVER_SERVICE            0x00000400
245 #define AFS_DIR_ENTRY_WORKSTATION_SERVICE       0x00000800
246 #define AFS_DIR_ENTRY_IPC                       0x00001000
247 #define AFS_DIR_ENTRY_INSERTED_SHORT_NAME       0x00002000
248
249 //
250 // Network provider errors
251 //
252
253 #define WN_SUCCESS                              0L
254 #define WN_ALREADY_CONNECTED                    85L
255 #define WN_OUT_OF_MEMORY                        8L
256 #define WN_NOT_CONNECTED                        2250L
257 #define WN_BAD_NETNAME                          67L
258
259 #define RESOURCE_CONNECTED      0x00000001
260 #define RESOURCE_GLOBALNET      0x00000002
261 #define RESOURCE_REMEMBERED     0x00000003
262 #define RESOURCE_RECENT         0x00000004
263 #define RESOURCE_CONTEXT        0x00000005
264
265 #define RESOURCETYPE_ANY        0x00000000
266 #define RESOURCETYPE_DISK       0x00000001
267 #define RESOURCETYPE_PRINT      0x00000002
268 #define RESOURCETYPE_RESERVED   0x00000008
269 #define RESOURCETYPE_UNKNOWN    0xFFFFFFFF
270
271 #define RESOURCEUSAGE_CONNECTABLE   0x00000001
272 #define RESOURCEUSAGE_CONTAINER     0x00000002
273 #define RESOURCEUSAGE_NOLOCALDEVICE 0x00000004
274 #define RESOURCEUSAGE_SIBLING       0x00000008
275 #define RESOURCEUSAGE_ATTACHED      0x00000010
276 #define RESOURCEUSAGE_ALL           (RESOURCEUSAGE_CONNECTABLE | RESOURCEUSAGE_CONTAINER | RESOURCEUSAGE_ATTACHED)
277 #define RESOURCEUSAGE_RESERVED      0x80000000
278
279 #define RESOURCEDISPLAYTYPE_GENERIC        0x00000000
280 #define RESOURCEDISPLAYTYPE_DOMAIN         0x00000001
281 #define RESOURCEDISPLAYTYPE_SERVER         0x00000002
282 #define RESOURCEDISPLAYTYPE_SHARE          0x00000003
283 #define RESOURCEDISPLAYTYPE_FILE           0x00000004
284 #define RESOURCEDISPLAYTYPE_GROUP          0x00000005
285 #define RESOURCEDISPLAYTYPE_NETWORK        0x00000006
286 #define RESOURCEDISPLAYTYPE_ROOT           0x00000007
287 #define RESOURCEDISPLAYTYPE_SHAREADMIN     0x00000008
288 #define RESOURCEDISPLAYTYPE_DIRECTORY      0x00000009
289 #define RESOURCEDISPLAYTYPE_TREE           0x0000000A
290 #define RESOURCEDISPLAYTYPE_NDSCONTAINER   0x0000000B
291
292 //
293 // Method for determining the different control device open requests
294 //
295
296 #define AFS_CONTROL_INSTANCE            0x00000001
297 #define AFS_REDIRECTOR_INSTANCE         0x00000002
298
299 //
300 // Extent flags
301 //
302
303 #define AFS_EXTENT_DIRTY                0x00000001
304
305 //
306 // Extent skip list sizes
307 //
308 #define AFS_NUM_EXTENT_LISTS    3
309
310 //
311 // Extents skip lists
312 //
313 // We use constant sizes.
314 //
315 #define AFS_EXTENT_SIZE         (4*1024)
316 #define AFS_EXTENTS_LIST        0
317 //
318 // A max of 64 extents in ther first skip list
319 #define AFS_EXTENT_SKIP1_BITS   6
320
321 //
322 // Then 128 bits in the second skip list
323 #define AFS_EXTENT_SKIP2_BITS   7
324
325 //
326 // This means that the top list skips in steps of 2^25 (=12+6+7) which
327 // is 32 Mb.  It is to be expected that files which are massively
328 // larger that this will not be fully mapped.
329 //
330 #define AFS_EXTENT_SKIP1_SIZE (AFS_EXTENT_SIZE << AFS_EXTENT_SKIP1_BITS)
331 #define AFS_EXTENT_SKIP2_SIZE (AFS_EXTENT_SKIP1_SIZE << AFS_EXTENT_SKIP2_BITS)
332
333 #define AFS_EXTENTS_MASKS { (AFS_EXTENT_SIZE-1),       \
334                             (AFS_EXTENT_SKIP1_SIZE-1), \
335                             (AFS_EXTENT_SKIP2_SIZE-1) }
336
337 //
338 // Maximum count to release at a time
339 //
340
341 #define AFS_MAXIMUM_EXTENT_RELEASE_COUNT        100
342
343 // {41966169-3FD7-4392-AFE4-E6A9D0A92C72}  - generated using guidgen.exe
344 DEFINE_GUID (GUID_SD_AFS_REDIRECTOR_CONTROL_OBJECT,
345         0x41966169, 0x3fd7, 0x4392, 0xaf, 0xe4, 0xe6, 0xa9, 0xd0, 0xa9, 0x2c, 0x72);
346
347 //
348 // Debug log length
349 //
350
351 #define AFS_DBG_LOG_LENGTH              256
352
353 //
354 // Debug log flags
355 //
356
357 #define AFS_DBG_LOG_WRAPPED             0x00000001
358
359 //
360 // Connection flags
361 //
362
363 #define AFS_CONNECTION_FLAG_GLOBAL_SHARE        0x00000001
364
365 //
366 // Process CB flags
367 //
368
369 #define AFS_PROCESS_FLAG_IS_64BIT           0x00000001
370
371 //
372 // Maximum number of special share names
373 //
374
375 #define AFS_SPECIAL_SHARE_NAME_COUNT_MAX    10
376
377 //
378 // Device flags
379 //
380
381 #define AFS_DEVICE_FLAG_HIDE_DOT_NAMES          0x00000001
382 #define AFS_DEVICE_FLAG_REDIRECTOR_SHUTDOWN     0x00000002
383
384 //
385 // Name Array flags
386 //
387
388 #define AFS_NAME_ARRAY_FLAG_ROOT_ELEMENT        0x00000001
389 #define AFS_NAME_ARRAY_FLAG_REDIRECTION_ELEMENT 0x00000002
390
391 //
392 // Maximum recursion depth
393 //
394
395 #define AFS_MAX_RECURSION_COUNT                 20
396
397 //
398 // LocateNameEntry flags
399 //
400
401 #define AFS_LOCATE_FLAGS_SUBSTITUTE_NAME        0x00000001
402 #define AFS_LOCATE_FLAGS_NO_MP_TARGET_EVAL      0x00000002
403 #define AFS_LOCATE_FLAGS_NO_SL_TARGET_EVAL      0x00000004
404 #define AFS_LOCATE_FLAGS_NO_DFS_LINK_EVAL       0x00000008
405
406 //
407 // Parse flags
408 //
409
410 #define AFS_PARSE_FLAG_FREE_FILE_BUFFER         0x00000001
411 #define AFS_PARSE_FLAG_ROOT_ACCESS              0x00000002
412
413 //
414 // Reparse tag information
415 //
416
417 //
418 //  Tag allocated to OpenAFS for DFS by Microsoft
419 //  GUID: EF21A155-5C92-4470-AB3B-370403D96369
420 //
421
422 #ifndef IO_REPARSE_TAG_OPENAFS_DFS
423 #define IO_REPARSE_TAG_OPENAFS_DFS              0x00000037L
424 #endif
425
426 //  {EF21A155-5C92-4470-AB3B-370403D96369}
427 DEFINE_GUID (GUID_AFS_REPARSE_GUID,
428         0xEF21A155, 0x5C92, 0x4470, 0xAB, 0x3B, 0x37, 0x04, 0x03, 0xD9, 0x63, 0x69);
429
430 //
431 // Enumeration constants
432 //
433
434 #define AFS_DIR_ENTRY_INITIAL_DIR_INDEX   (ULONG)-3
435 #define AFS_DIR_ENTRY_INITIAL_ROOT_INDEX  (ULONG)-1
436
437 #define AFS_DIR_ENTRY_PIOCTL_INDEX        (ULONG)-3
438 #define AFS_DIR_ENTRY_DOT_INDEX           (ULONG)-2
439 #define AFS_DIR_ENTRY_DOT_DOT_INDEX       (ULONG)-1
440
441 //
442 // Library state flags
443 //
444
445 #define AFS_REDIR_LIB_FLAGS_NONPERSISTENT_CACHE     0x00000001
446
447 #endif /* _AFS_DEFINES_H */