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