afsifs-20050615
[openafs.git] / src / WINNT / afsrdr / kif.h
1 /* copyright (c) 2005
2  * the regents of the university of michigan
3  * all rights reserved
4  * 
5  * permission is granted to use, copy, create derivative works and
6  * redistribute this software and such derivative works for any purpose,
7  * so long as the name of the university of michigan is not used in
8  * any advertising or publicity pertaining to the use or distribution
9  * of this software without specific, written prior authorization.  if
10  * the above copyright notice or any other identification of the
11  * university of michigan is included in any copy of any portion of
12  * this software, then the disclaimer below must also be included.
13  * 
14  * this software is provided as is, without representation from the
15  * university of michigan as to its fitness for any purpose, and without
16  * warranty by the university of michigan of any kind, either express 
17  * or implied, including without limitation the implied warranties of
18  * merchantability and fitness for a particular purpose.  the regents
19  * of the university of michigan shall not be liable for any damages,   
20  * including special, indirect, incidental, or consequential damages, 
21  * with respect to any claim arising out or in connection with the use
22  * of the software, even if it has been or is hereafter advised of the
23  * possibility of such damages.
24  */
25
26 /* versioning history
27  * 
28  * 03-jun 2005 (eric williams) entered into versioning
29  */
30
31 /* error codes */
32 #define IFSL_SUCCESS_BASE                       0x00000000
33 #define IFSL_FAIL_BASE                          0x80000000
34
35 #define IFSL_SUCCESS                            (IFSL_SUCCESS_BASE + 0)
36 #define IFSL_DOES_NOT_EXIST                     (IFSL_FAIL_BASE + 1)
37 #define IFSL_NOT_IMPLEMENTED            (IFSL_FAIL_BASE + 2)
38 #define IFSL_END_OF_ENUM                        (IFSL_SUCCESS_BASE + 3)
39 #define IFSL_CANNOT_MAKE                        (IFSL_FAIL_BASE + 4)
40 #define IFSL_END_OF_FILE                        (IFSL_SUCCESS_BASE + 5)
41 #define IFSL_NO_ACCESS                          (IFSL_FAIL_BASE + 6)
42 #define IFSL_BUFFER_TOO_SMALL           (IFSL_FAIL_BASE + 7)
43 #define IFSL_SHARING_VIOLATION          (IFSL_FAIL_BASE + 8)
44 #define IFSL_BAD_INPUT                          (IFSL_FAIL_BASE + 9)
45 #define IFSL_GENERIC_FAILURE            (IFSL_FAIL_BASE + 10)
46 #define IFSL_OPEN_CREATED                       (IFSL_SUCCESS_BASE + 11)
47 #define IFSL_OPEN_EXISTS                        (IFSL_FAIL_BASE + 12)
48 #define IFSL_OPEN_OPENED                        (IFSL_SUCCESS_BASE + 13)
49 #define IFSL_OPEN_OVERWRITTEN           (IFSL_SUCCESS_BASE + 14)
50 #define IFSL_OPEN_SUPERSCEDED           (IFSL_SUCCESS_BASE + 15)
51 #define IFSL_BADFILENAME                        (IFSL_FAIL_BASE + 16)
52 #define IFSL_READONLY                           (IFSL_FAIL_BASE + 17)
53 #define IFSL_IS_A_DIR                           (IFSL_FAIL_BASE + 18)
54 #define IFSL_PATH_DOES_NOT_EXIST        (IFSL_FAIL_BASE + 19)
55 #define IFSL_IS_A_FILE                          (IFSL_FAIL_BASE + 20)
56 #define IFSL_NO_FILE                            (IFSL_FAIL_BASE + 21)
57 #define IFSL_NOT_EMPTY                          (IFSL_FAIL_BASE + 22)
58 #define IFSL_RPC_TIMEOUT                        (IFSL_FAIL_BASE + 23)
59 #define IFSL_OVERQUOTA                          (IFSL_FAIL_BASE + 24)
60 #define IFSL_UNSPEC                                     (IFSL_FAIL_BASE + 25)
61
62
63 /* ioctl codes */
64 #define IOCTL_AFSRDR_IOCTL              CTL_CODE(IOCTL_DISK_BASE, 0x007, METHOD_OUT_DIRECT, FILE_ANY_ACCESS)
65 #define IOCTL_AFSRDR_DOWNCALL   CTL_CODE(IOCTL_DISK_BASE, 0x008, METHOD_OUT_DIRECT, FILE_ANY_ACCESS)
66 #define IOCTL_AFSRDR_GET_PATH   CTL_CODE(IOCTL_DISK_BASE, 0x009, METHOD_OUT_DIRECT, FILE_ANY_ACCESS)
67
68
69 /* upcalls */
70 uc_namei(WCHAR *name, ULONG *fid);
71 uc_check_access(ULONG fid, ULONG access, ULONG *granted);
72 uc_create(WCHAR *str, ULONG attribs, LARGE_INTEGER alloc, ULONG access, ULONG *granted, ULONG *fid);
73 uc_stat(ULONG fid, ULONG *attribs, LARGE_INTEGER *size, LARGE_INTEGER *creation, LARGE_INTEGER *access, LARGE_INTEGER *change, LARGE_INTEGER *written);
74 uc_setinfo(ULONG fid, ULONG attribs, LARGE_INTEGER creation, LARGE_INTEGER access, LARGE_INTEGER change, LARGE_INTEGER written);
75 uc_trunc(ULONG fid, LARGE_INTEGER size);
76 uc_read(ULONG fid, LARGE_INTEGER offset, ULONG length, ULONG *read, char *data);
77 uc_write(ULONG fid, LARGE_INTEGER offset, ULONG length, ULONG *written, char *data);
78 /*#ifdef RPC_KERN
79 uc_read_mdl(ULONG fid, LARGE_INTEGER offset, ULONG length, ULONG *read, MDL *data);
80 uc_write_mdl(ULONG fid, LARGE_INTEGER offset, ULONG length, ULONG *written, MDL *mdl);
81 #endif*/
82 uc_readdir(ULONG fid, LARGE_INTEGER cookie_in, WCHAR *filter, ULONG *count, char *data, ULONG *len);
83 uc_close(ULONG fid);
84 uc_unlink(WCHAR *name);
85 uc_ioctl_write(ULONG length, char *data, ULONG *key);
86 uc_ioctl_read(ULONG key, ULONG *length, char *data);
87 uc_rename(ULONG fid, WCHAR *curr, WCHAR *new_dir, WCHAR *new_name, ULONG *new_fid);
88
89 /* downcalls */
90 dc_break_callback(ULONG fid);