windows-scp-recycle-init-20070208
[openafs.git] / src / afs / afs_osi.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 _AFS_OSI_
11 #define _AFS_OSI_
12
13 #include "h/types.h"
14 #include "h/param.h"
15
16 #ifdef AFS_FBSD50_ENV
17 #include <sys/condvar.h>
18 #endif
19
20 #ifdef AFS_LINUX20_ENV
21 #ifndef _LINUX_CODA_FS_I
22 #define _LINUX_CODA_FS_I
23 #define _CODA_HEADER_
24 struct coda_inode_info {
25 };
26 #endif
27 #ifndef _LINUX_XFS_FS_I
28 #define _LINUX_XFS_FS_I
29 struct xfs_inode_info {
30 };
31 #endif
32 #include "h/fs.h"
33 #include "h/mm.h"
34 #endif
35
36
37 /* this is just a dummy type decl, we're really using struct sockets here */
38 struct osi_socket {
39     int junk;
40 };
41
42 struct osi_stat {
43     afs_int32 size;             /* file size in bytes */
44     afs_int32 mtime;            /* modification date */
45     afs_int32 atime;            /* access time */
46 };
47
48 struct osi_file {
49     afs_int32 size;             /* file size in bytes XXX Must be first field XXX */
50 #ifdef AFS_LINUX26_ENV
51     struct file *filp;          /* May need this if we really open the file. */
52 #else
53 #ifdef AFS_LINUX22_ENV
54     struct dentry dentry;       /* merely to hold the pointer to the inode. */
55     struct file file;           /* May need this if we really open the file. */
56 #else
57     struct vnode *vnode;
58 #endif
59 #endif
60 #if     defined(AFS_HPUX102_ENV)
61     k_off_t offset;
62 #else
63 #if defined(AFS_AIX51_ENV) && defined(AFS_64BIT_KERNEL)
64     afs_offs_t offset;
65 #else
66     afs_int32 offset;
67 #endif
68 #endif
69     int (*proc) (struct osi_file * afile, afs_int32 code);      /* proc, which, if not null, is called on writes */
70     char *rock;                 /* rock passed to proc */
71     ino_t inum;                 /* guarantee validity of hint */
72 #if defined(UKERNEL)
73     int fd;                     /* file descriptor for user space files */
74 #endif                          /* defined(UKERNEL) */
75 };
76
77 struct osi_dev {
78 #if defined(AFS_XBSD_ENV)
79     struct mount *mp;
80     struct vnode *held_vnode;
81 #elif defined(AFS_AIX42_ENV)
82     dev_t dev;
83 #else
84     afs_int32 dev;
85 #endif
86 };
87
88 struct afs_osi_WaitHandle {
89 #ifdef AFS_FBSD50_ENV
90     struct cv wh_condvar;
91     int wh_inited;              /* XXX */
92 #else
93     caddr_t proc;               /* process waiting */
94 #endif
95 };
96
97 #define osi_SetFileProc(x,p)    ((x)->proc=(p))
98 #define osi_SetFileRock(x,r)    ((x)->rock=(r))
99 #define osi_GetFileProc(x)      ((x)->proc)
100 #define osi_GetFileRock(x)      ((x)->rock)
101
102 #ifdef  AFS_TEXT_ENV
103 #define osi_FlushText(vp) if (hcmp((vp)->m.DataVersion, (vp)->flushDV) > 0) \
104                             osi_FlushText_really(vp)
105 #else
106 #define osi_FlushText(vp)
107 #endif
108
109
110 #define AFSOP_STOP_RXEVENT   214        /* stop rx event deamon */
111 #define AFSOP_STOP_COMPLETE  215        /* afs has been shutdown */
112 #define AFSOP_STOP_RXK_LISTENER   217   /* stop rx listener daemon */
113
114
115 #define osi_NPACKETS    20      /* number of cluster pkts to alloc */
116
117 /*
118  * Alloc declarations.
119  */
120 #define afs_osi_Alloc_NoSleep afs_osi_Alloc
121
122 /*
123  * Vnode related macros
124  */
125 #if defined(AFS_DARWIN80_ENV)
126 #define vType(vc)               vnode_vtype(AFSTOV(vc))
127 #define vSetVfsp(vc, vfsp)      
128 #define vSetType(vc, type)      (vc)->m.Type = (type)
129 extern int afs_vfs_typenum;
130 #define SetAfsVnode(vn)         /* nothing; done in getnewvnode() */
131 #define IsAfsVnode(v) (vfs_typenum(vnode_mount((v))) == afs_vfs_typenum)
132 #else
133 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV) || defined(AFS_LINUX22_ENV)
134 #define vSetVfsp(vc, vfsp)      AFSTOV(vc)->v_mount = (vfsp)
135 #define vSetType(vc, type)      AFSTOV(vc)->v_type = (type)
136 #define vType(vc)               AFSTOV(vc)->v_type
137 #else
138 #define vType(vc)           (vc)->v.v_type
139 #define vSetType(vc,type)   (vc)->v.v_type = (type)
140 #define vSetVfsp(vc,vfsp)   (vc)->v.v_vfsp = (vfsp)
141 #endif
142 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
143 extern int (**afs_vnodeop_p) ();
144 #define IsAfsVnode(v)      ((v)->v_op == afs_vnodeop_p)
145 #define SetAfsVnode(v)     /* nothing; done in getnewvnode() */
146 #else
147 extern struct vnodeops *afs_ops;
148 #define IsAfsVnode(v)       ((v)->v_op == afs_ops)
149 #define SetAfsVnode(v)      (v)->v_op = afs_ops
150 #endif
151 #endif
152
153 #ifdef AFS_SGI65_ENV
154 #define gop_lookupname(fnamep,segflg,followlink,compvpp) \
155              lookupname((fnamep),(segflg),(followlink),NULL,(compvpp),\
156                         NULL)
157 #else
158 #define gop_lookupname(fnamep,segflg,followlink,compvpp) \
159              lookupname((fnamep),(segflg),(followlink),NULL,(compvpp))
160 #endif
161
162 /*
163  * In IRIX 6.5 we cannot have DEBUG turned on since certain
164  * system-defined structures are a different size with DEBUG on, the
165  * kernel is compiled without DEBUG on, and the resulting differences
166  * would break our ability to interact with the rest of the kernel.
167  *
168  * Is DEBUG only for turning the ASSERT() macro?  If so, we should
169  * be able to eliminate DEBUG entirely.
170  */
171 #if !defined(AFS_SGI65_ENV)
172 #ifndef DEBUG
173 #define DEBUG   1               /* Default is to enable debugging/logging */
174 #endif
175 #endif
176
177 /* 
178  * Time related macros
179  */
180 #define osi_GetuTime(x) osi_GetTime(x)
181
182 /* osi_timeval_t exists because SGI 6.x has two sizes of timeval. */
183 /** In 64 bit Solaris the timeval structure has members that are 64 bit
184   * In the GetTime() interface we expect pointers to afs_int32. So the need to
185   * define osi_timeval_t to have 32 bit members. To make this less ambiguous
186   * we now use 32 bit quantities consistently all over the code.
187   * In 64 bit HP-UX the timeval structure has a 64 bit member.
188   */
189
190 #if defined(AFS_HPUX_ENV) || defined(AFS_LINUX_64BIT_KERNEL) || (defined(AFS_SGI61_ENV) && defined(KERNEL) && defined(_K64U64))
191 typedef struct {
192     afs_int32 tv_sec;
193     afs_int32 tv_usec;
194 } osi_timeval_t;
195 #elif defined(AFS_SUN57_ENV)
196 typedef struct timeval32 osi_timeval_t;
197 #else
198 typedef struct timeval osi_timeval_t;
199 #endif /* AFS_SGI61_ENV */
200
201 #define osi_getpid()            getpid()
202
203 #define osi_getpid()            getpid()
204
205 /*
206  * osi_ThreadUnique() should yield a value that can be found in ps
207  * output in order to draw correspondences between ICL traces and what
208  * is going on in the system.  So if ps cannot show thread IDs it is
209  * likely to be the process ID instead.
210  */
211 #ifdef AFS_FBSD50_ENV
212 /* should use curthread, but 'ps' can't display it */
213 #define osi_ThreadUnique()      curproc
214 #else
215 #define osi_ThreadUnique()      getpid()
216 #endif
217
218
219
220 #ifdef AFS_GLOBAL_SUNLOCK
221 #define AFS_ASSERT_GLOCK() \
222     do { if (!ISAFS_GLOCK()) osi_Panic("afs global lock not held at %s:%d\n", __FILE__, __LINE__); } while (0)
223 #endif /* AFS_GLOBAL_SUNLOCK */
224
225 #ifdef RX_ENABLE_LOCKS
226 #define RX_AFS_GLOCK()          AFS_GLOCK()
227 #define RX_AFS_GUNLOCK()        AFS_GUNLOCK()
228 #else
229 #define RX_AFS_GLOCK()
230 #define RX_AFS_GUNLOCK()
231 #endif
232
233
234
235 #ifndef KERNEL
236 #define AFS_GLOCK()
237 #define AFS_GUNLOCK()
238 #define ISAFS_GLOCK() 1
239 #define AFS_ASSERT_GLOCK()
240 #endif
241
242 /* On an MP that uses multithreading, splnet is not sufficient to provide
243  * mutual exclusion because the other processors will not see it.  On some
244  * early multiprocessors (SunOS413 & SGI5.2) splnet actually obtains a global
245  * mutex, which this works in the UP expected way, it means that the whole MP
246  * can only take one interrupt at a time; a serious performance penalty. */
247
248 #if ((defined(AFS_GLOBAL_SUNLOCK) || defined(RX_ENABLE_LOCKS)) && !defined(AFS_HPUX_ENV)) || !defined(KERNEL)
249 #define SPLVAR
250 #define NETPRI
251 #define USERPRI
252 #endif
253
254 /*
255  * vnode/vcache ref count manipulation
256  */
257 #if defined(UKERNEL)
258 #define AFS_RELE(vp) do { VN_RELE(vp); } while (0)
259 #else /* defined(UKERNEL) */
260 #define AFS_RELE(vp) do { AFS_GUNLOCK(); VN_RELE(vp); AFS_GLOCK(); } while (0)
261 #endif /* defined(UKERNEL) */
262
263 /*
264  * For some reason we do bare refcount manipulation in some places, for some
265  * platforms.  The assumption is apparently that either we wouldn't call
266  * afs_inactive anyway (because we know the ref count is high), or that it's
267  * OK not to call it (because we don't expect CUnlinked or CDirty).
268  * (Also, of course, the vnode is assumed to be one of ours.  Can't use this
269  * macro for V-file vnodes.)
270  */
271 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
272 /* Bare refcount manipulation would probably work on this platform, but just
273    calling VREF does not */
274 #define AFS_FAST_HOLD(vp) osi_vnhold((vp),0)
275 #else
276 #define AFS_FAST_HOLD(vp) VN_HOLD(AFSTOV(vp))
277 #endif
278 #define AFS_FAST_RELE(vp) AFS_RELE(AFSTOV(vp))
279
280 /*
281  * MP safe versions of routines to copy memory between user space
282  * and kernel space. Call these to avoid taking page faults while
283  * holding the global lock.
284  */
285 #ifdef CAST_USER_ADDR_T
286 #define __U(X) CAST_USER_ADDR_T((X))
287 #else
288 #define __U(X) (X)
289 #endif
290 #ifdef AFS_GLOBAL_SUNLOCK
291
292 #define AFS_COPYIN(SRC,DST,LEN,CODE)                            \
293         do {                                                    \
294             int haveGlock = ISAFS_GLOCK();                      \
295             if (haveGlock)                                      \
296                 AFS_GUNLOCK();                                  \
297             CODE = copyin(__U((SRC)),(DST),(LEN));                      \
298             if (haveGlock)                                      \
299                 AFS_GLOCK();                                    \
300         } while(0)
301
302 #define AFS_COPYINSTR(SRC,DST,LEN,CNT,CODE)                     \
303         do {                                                    \
304             int haveGlock = ISAFS_GLOCK();                      \
305             if (haveGlock)                                      \
306                 AFS_GUNLOCK();                                  \
307             CODE = copyinstr(__U((SRC)),(DST),(LEN),(CNT));             \
308             if (haveGlock)                                      \
309                 AFS_GLOCK();                                    \
310         } while(0)
311
312 #define AFS_COPYOUT(SRC,DST,LEN,CODE)                           \
313         do {                                                    \
314             int haveGlock = ISAFS_GLOCK();                      \
315             if (haveGlock)                                      \
316                 AFS_GUNLOCK();                                  \
317             CODE = copyout((SRC),__U((DST)),(LEN));                     \
318             if (haveGlock)                                      \
319                 AFS_GLOCK();                                    \
320         } while(0)
321
322 #if defined(AFS_DARWIN80_ENV)
323 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
324         do {                                                    \
325             int haveGlock = ISAFS_GLOCK();                      \
326             if (haveGlock)                                      \
327                 AFS_GUNLOCK();                                  \
328             uio_setrw((UIO),(RW));                              \
329             CODE = uiomove((SRC),(LEN),(UIO));                  \
330             if (haveGlock)                                      \
331                 AFS_GLOCK();                                    \
332         } while(0)
333 #else
334 #if defined(AFS_OSF_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
335 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
336         do {                                                    \
337             int haveGlock = ISAFS_GLOCK();                      \
338             if (haveGlock)                                      \
339                 AFS_GUNLOCK();                                  \
340             (UIO)->uio_rw = (RW);                               \
341             CODE = uiomove((SRC),(LEN),(UIO));                  \
342             if (haveGlock)                                      \
343                 AFS_GLOCK();                                    \
344         } while(0)
345 #else
346 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
347         do {                                                    \
348             int haveGlock = ISAFS_GLOCK();                      \
349             if (haveGlock)                                      \
350                 AFS_GUNLOCK();                                  \
351             CODE = uiomove((SRC),(LEN),(RW),(UIO));             \
352             if (haveGlock)                                      \
353                 AFS_GLOCK();                                    \
354         } while(0)
355 #endif
356 #endif /* AFS_DARWIN80_ENV */
357
358 #else /* AFS_GLOBAL_SUNLOCK */
359
360 #define AFS_COPYIN(SRC,DST,LEN,CODE)                            \
361         do {                                                    \
362             CODE = copyin(__U((SRC)),(DST),(LEN));                      \
363         } while(0)
364
365 #define AFS_COPYINSTR(SRC,DST,LEN,CNT,CODE)                     \
366         do {                                                    \
367             CODE = copyinstr(__U((SRC)),(DST),(LEN),(CNT));             \
368         } while(0)
369
370 #define AFS_COPYOUT(SRC,DST,LEN,CODE)                           \
371         do {                                                    \
372             CODE = copyout((SRC),__U((DST)),(LEN));                     \
373         } while(0)
374
375 #if defined(AFS_DARWIN80_ENV)
376 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
377         do {                                                    \
378             uio_setrw((UIO),(RW));                              \
379             CODE = uiomove((SRC),(LEN),(UIO));                  \
380         } while(0)
381 #else /* AFS_OSF_ENV || AFS_FBSD_ENV */
382 #if defined(AFS_OSF_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
383 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
384         do {                                                    \
385             (UIO)->uio_rw = (RW);                               \
386             CODE = uiomove((SRC),(LEN),(UIO));                  \
387         } while(0)
388 #else /* AFS_OSF_ENV || AFS_FBSD_ENV */
389 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
390         do {                                                    \
391             CODE = uiomove((SRC),(LEN),(RW),(UIO));             \
392         } while(0)
393 #endif /* AFS_OSF_ENV || AFS_FBSD_ENV */
394 #endif /* AFS_DARWIN80_ENV */
395
396 #endif /* AFS_GLOBAL_SUNLOCK */
397
398 #ifdef AFS_DARWIN80_ENV
399 #define AFS_UIO_OFFSET(uio) uio_offset(uio)
400 #define AFS_UIO_RESID(uio) (int)uio_resid(uio)
401 #define AFS_UIO_SETOFFSET(uio, off) uio_setoffset(uio, off)
402 #define AFS_UIO_SETRESID(uio, val) uio_setresid(uio, val)
403 #else
404 #define AFS_UIO_OFFSET(uio) (uio)->uio_offset
405 #define AFS_UIO_RESID(uio) (uio)->uio_resid
406 #define AFS_UIO_SETOFFSET(uio, off) (uio)->uio_offset = off
407 #define AFS_UIO_SETRESID(uio, val) (uio)->uio_resid = val
408 #endif
409
410
411 /*
412  * encapsulation of kernel data structure accesses
413  */
414 #define setuerror(erval)        u.u_error = (erval)
415 #define getuerror()             u.u_error
416
417 /* Macros for vcache/vnode and vfs arguments to vnode and vfs ops.
418  * These are required for IRIX 6.4 and later, which pass behavior pointers.
419  * Note that the _CONVERT routines get the ";" here so that argument lists
420  * can have arguments after the OSI_x_CONVERT macro is called.
421  */
422 #define OSI_VN_ARG(V) V
423 #define OSI_VN_DECL(V) struct vnode *V
424 #define OSI_VN_CONVERT(V)
425 #define OSI_VC_ARG(V) V
426 #define OSI_VC_DECL(V) struct vcache *V
427 #define OSI_VC_CONVERT(V)
428 #define OSI_VFS_ARG(V) V
429 #define OSI_VFS_DECL(V) struct vfs *V
430 #define OSI_VFS_CONVERT(V)
431
432
433 /*
434 ** Macro for Solaris 2.6 returns 1 if file is larger than 2GB; else returns 0 
435 */
436 #define AfsLargeFileUio(uio)       0
437 #define AfsLargeFileSize(pos, off) 0
438
439 /* Now include system specific OSI header file. It will redefine macros
440  * defined here as required by the OS.
441  */
442 #include "osi_machdep.h"
443
444 /* Declare any structures which use these macros after the OSI implementation
445  * has had the opportunity to redefine them.
446  */
447 extern struct AFS_UCRED afs_osi_cred, *afs_osi_credp;
448
449 #ifndef osi_curcred
450 #define osi_curcred() (u.u_cred)
451 #endif
452
453 #endif /* _AFS_OSI_ */