windows-byte-range-locking-20060108
[openafs.git] / src / WINNT / afsd / cm_vnodeops.h
1 /*
2  * Copyright 2000, International Business Machines Corporation and others.
3  * All Rights Reserved.
4  * 
5  * This software has been released under the terms of the IBM Public
6  * License.  For details, see the LICENSE file in the top-level source
7  * directory or online at http://www.openafs.org/dl/license10.html
8  */
9
10 #ifndef __CM_VNODEOPS_H_ENV__
11 #define __CM_VNODEOPS_H_ENV__ 1
12
13 extern unsigned int cm_mountRootGen;
14
15 extern int cm_enableServerLocks;
16
17 /* parms for attribute setting call */
18 typedef struct cm_attr {
19         int mask;
20         time_t clientModTime;
21         osi_hyper_t length;
22         int unixModeBits;
23         long owner;
24         long group;
25 } cm_attr_t;
26
27 #define CM_ATTRMASK_CLIENTMODTIME       1       /* set if field is valid */
28 #define CM_ATTRMASK_LENGTH              2       /* field is valid */
29 #define CM_ATTRMASK_UNIXMODEBITS        4       /* field is valid */
30 #define CM_ATTRMASK_OWNER               8       /* field is valid */
31 #define CM_ATTRMASK_GROUP               0x10    /* field is valid */
32
33 /* type of rock for lookup's searches */
34 typedef struct cm_lookupSearch {
35         cm_fid_t fid;
36         char *searchNamep;
37         int found;
38         int LCfound, UCfound, NCfound, ExactFound;
39         int caseFold;
40         int hasTilde;
41 } cm_lookupSearch_t;
42
43 #include "cm_dir.h"
44
45 typedef int (*cm_DirFuncp_t)(struct cm_scache *, struct cm_dirEntry *, void *,
46         osi_hyper_t *entryOffsetp);
47
48 /* arrays */
49
50 extern unsigned char cm_foldUpper[];
51
52 /* functions */
53
54 extern int cm_NoneLower(char *s);
55
56 extern int cm_NoneUpper(char *s);
57
58 extern int cm_Is8Dot3(char *namep);
59
60 extern int cm_stricmp(const char *, const char *);
61
62 extern void cm_Gen8Dot3Name(struct cm_dirEntry *dep, char *shortName,
63         char **shortNameEndp);
64
65 extern long cm_ReadMountPoint(cm_scache_t *scp, cm_user_t *userp,
66         cm_req_t *reqp);
67
68 extern long cm_NameI(cm_scache_t *rootSCachep, char *pathp, long flags,
69         cm_user_t *userp, char *tidPathp, cm_req_t *reqp,
70         cm_scache_t **outScpp);
71
72 extern long cm_Lookup(cm_scache_t *dscp, char *namep, long flags,
73         cm_user_t *userp, cm_req_t *reqp, cm_scache_t **outpScpp);
74
75 extern long cm_LookupInternal(cm_scache_t *dscp, char *namep, long flags,
76                               cm_user_t *userp, cm_req_t *reqp, 
77                               cm_scache_t **outpScpp);
78
79 extern void cm_TryBulkStat(cm_scache_t *dscp, osi_hyper_t *offsetp,
80         cm_user_t *userp, cm_req_t *reqp);
81
82 extern long cm_SetAttr(cm_scache_t *scp, cm_attr_t *attrp, cm_user_t *userp,
83         cm_req_t *reqp);
84
85 extern long cm_Create(cm_scache_t *scp, char *namep, long flags,
86         cm_attr_t *attrp, cm_scache_t **scpp, cm_user_t *userp, cm_req_t *reqp);
87
88 extern long cm_FSync(cm_scache_t *scp, cm_user_t *userp, cm_req_t *reqp);
89
90 extern void cm_StatusFromAttr(struct AFSStoreStatus *statusp,
91         struct cm_scache *scp, struct cm_attr *attrp);
92
93 extern long cm_Unlink(cm_scache_t *dscp, char *namep, cm_user_t *userp,
94         cm_req_t *reqp);
95
96 extern long cm_ApplyDir(cm_scache_t *scp, cm_DirFuncp_t funcp, void *parmp,
97         osi_hyper_t *startOffsetp, cm_user_t *userp, cm_req_t *reqp, 
98         cm_scache_t **retscp);
99
100 extern long cm_MakeDir(cm_scache_t *dscp, char *lastNamep, long flags,
101         cm_attr_t *attrp, cm_user_t *userp, cm_req_t *reqp);
102
103 extern long cm_RemoveDir(cm_scache_t *dscp, char *lastNamep, cm_user_t *userp,
104         cm_req_t *reqp);
105
106 extern long cm_Rename(cm_scache_t *oldDscp, char *oldLastNamep,
107         cm_scache_t *newDscp, char *newLastNamep, cm_user_t *userp,
108         cm_req_t *reqp);
109
110 extern long cm_HandleLink(cm_scache_t *linkScp, struct cm_user *userp,
111         cm_req_t *reqp);
112
113 extern long cm_Link(cm_scache_t *dscp, char *namep, cm_scache_t *sscp,
114     long flags, cm_user_t *userp, cm_req_t *reqp);
115
116 extern long cm_SymLink(cm_scache_t *dscp, char *namep, char *contentsp,
117         long flags, cm_attr_t *attrp, cm_user_t *userp, cm_req_t *reqp);
118
119 extern long cm_AssembleLink(cm_scache_t *linkScp, char *pathSuffixp,
120                             cm_scache_t **newRootScpp, cm_space_t **newSpaceBufferp,
121                             cm_user_t *userp, cm_req_t *reqp);
122
123 extern int cm_ExpandSysName(char *inp, char *outp, long outSize,
124                             unsigned int sysNameIndex);
125
126 extern long cm_Open(cm_scache_t *scp, int type, cm_user_t *userp);
127
128 extern long cm_CheckOpen(cm_scache_t *scp, int openMode, int trunc,
129         cm_user_t *userp, cm_req_t *reqp);
130
131 /*
132  * Combinations of file opening access bits for AFS.
133  * We don't insist on write rights to open the file with FILE_WRITE_ATTRIBUTES,
134  * because we want to enable the owner to set/clear the READONLY flag.
135  * The RPC will fail if you can't modify the attributes, anyway.
136  */
137 #define AFS_ACCESS_READ (FILE_GENERIC_READ & ~SYNCHRONIZE)
138 #define AFS_ACCESS_WRITE ((FILE_GENERIC_WRITE & ~(READ_CONTROL | SYNCHRONIZE)) \
139                                 & ~FILE_WRITE_ATTRIBUTES)
140
141 extern long cm_CheckNTOpen(cm_scache_t *scp, unsigned int desiredAccess,
142         unsigned int createDisp, cm_user_t *userp, cm_req_t *reqp);
143
144 extern long cm_CheckNTDelete(cm_scache_t *dscp, cm_scache_t *scp,
145         cm_user_t *userp, cm_req_t *reqp);
146
147 extern long cm_EvaluateSymLink(cm_scache_t *dscp, cm_scache_t *linkScp,
148         cm_scache_t **outScpp, cm_user_t *userp, cm_req_t *reqp);
149
150 extern long cm_Lock(cm_scache_t *scp, unsigned char sLockType,
151         LARGE_INTEGER LOffset, LARGE_INTEGER LLength, cm_key_t key,
152         int allowWait, cm_user_t *userp, cm_req_t *reqp,
153         cm_file_lock_t **lockpp);
154
155 #define CM_UNLOCK_BY_FID        0x0001
156
157 extern long cm_UnlockByKey(cm_scache_t * scp,
158         cm_key_t key,
159         int flags,
160         cm_user_t * userp,
161         cm_req_t * reqp);
162
163 extern long cm_Unlock(cm_scache_t *scp, unsigned char sLockType,
164         LARGE_INTEGER LOffset, LARGE_INTEGER LLength, cm_key_t key,
165         cm_user_t *userp, cm_req_t *reqp);
166
167 extern long cm_LockCheckRead(cm_scache_t *scp, 
168         LARGE_INTEGER LOffset, 
169         LARGE_INTEGER LLength, 
170         cm_key_t key);
171
172 extern long cm_LockCheckWrite(cm_scache_t *scp,
173         LARGE_INTEGER LOffset,
174         LARGE_INTEGER LLength,
175         cm_key_t key);
176
177 extern void cm_CheckLocks(void);
178
179 extern void cm_ReleaseAllLocks(void);
180
181 extern long cm_RetryLock(cm_file_lock_t *oldFileLock, int client_is_dead);
182
183 #define CM_SESSION_SMB      0xffff
184 #define CM_SESSION_IFS      0xfffe
185 #define CM_SESSION_CMINT    0xfffd
186 #define CM_SESSION_RESERVED 0xfff0
187
188 extern cm_key_t cm_GenerateKey(unsigned int session, unsigned long process_id, unsigned int file_id);
189
190 #define MAX_SYMLINK_COUNT 16
191 #endif /*  __CM_VNODEOPS_H_ENV__ */