5d0bdc92507b12f014d2b36f8c5eee733b53655f
[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  * Alloc declarations.
129  */
130 #if !defined(AFS_OBSD44_ENV) && !defined(AFS_NBSD_ENV)
131 #define afs_osi_Alloc_NoSleep afs_osi_Alloc
132 #endif
133
134 /*
135  * Default vnode related macros
136  *
137  * Darwin, all of the BSDs, and Linux have their own
138  */
139 #if !defined(AFS_DARWIN_ENV) && !defined(AFS_XBSD_ENV) && !defined(AFS_LINUX20_ENV)
140 # define        vType(vc)           (vc)->v.v_type
141 # define        vSetType(vc,type)   (vc)->v.v_type = (type)
142 # define        vSetVfsp(vc,vfsp)   (vc)->v.v_vfsp = (vfsp)
143 extern struct vnodeops *afs_ops;
144 # define        IsAfsVnode(v)       ((v)->v_op == afs_ops)
145 # define        SetAfsVnode(v)      (v)->v_op = afs_ops
146 #endif
147
148 struct vcache;
149 extern int osi_TryEvictVCache(struct vcache *, int *);
150 extern struct vcache *osi_NewVnode(void);
151 extern void osi_PrePopulateVCache(struct vcache *);
152 extern void osi_PostPopulateVCache(struct vcache *);
153 extern void osi_AttachVnode(struct vcache *, int seq);
154
155 /*
156  * In IRIX 6.5 we cannot have DEBUG turned on since certain
157  * system-defined structures are a different size with DEBUG on, the
158  * kernel is compiled without DEBUG on, and the resulting differences
159  * would break our ability to interact with the rest of the kernel.
160  *
161  * Is DEBUG only for turning the ASSERT() macro?  If so, we should
162  * be able to eliminate DEBUG entirely.
163  */
164 #if !defined(AFS_SGI65_ENV)
165 #ifndef DEBUG
166 #define DEBUG   1               /* Default is to enable debugging/logging */
167 #endif
168 #endif
169
170 /*
171  * Time related macros
172  */
173 #define osi_GetuTime(x) osi_GetTime(x)
174
175 /* osi_timeval_t exists because SGI 6.x has two sizes of timeval. */
176 /** In 64 bit Solaris the timeval structure has members that are 64 bit
177   * In the GetTime() interface we expect pointers to afs_int32. So the need to
178   * define osi_timeval_t to have 32 bit members. To make this less ambiguous
179   * we now use 32 bit quantities consistently all over the code.
180   * In 64 bit HP-UX the timeval structure has a 64 bit member.
181   */
182
183 #if defined(AFS_HPUX_ENV) || defined(AFS_LINUX_64BIT_KERNEL) || (defined(AFS_SGI61_ENV) && defined(KERNEL) && defined(_K64U64))
184 typedef struct {
185     afs_int32 tv_sec;
186     afs_int32 tv_usec;
187 } osi_timeval_t;
188 #elif defined(AFS_SUN57_ENV)
189 typedef struct timeval32 osi_timeval_t;
190 #else
191 typedef struct timeval osi_timeval_t;
192 #endif /* AFS_SGI61_ENV */
193
194 #ifndef UKERNEL
195 #define osi_getpid()            getpid()
196 #endif
197
198 /*
199  * osi_ThreadUnique() should yield a value that can be found in ps
200  * output in order to draw correspondences between ICL traces and what
201  * is going on in the system.  So if ps cannot show thread IDs it is
202  * likely to be the process ID instead.
203  */
204 #ifdef AFS_FBSD_ENV
205 /* should use curthread, but 'ps' can't display it */
206 #define osi_ThreadUnique()      (curproc->p_pid)
207 #elif defined(AFS_LINUX_ENV)
208 #define osi_ThreadUnique()      (current->pid)
209 #elif defined(UKERNEL)
210 #define osi_ThreadUnique()      osi_getpid()
211 #else
212 #define osi_ThreadUnique()      getpid()
213 #endif
214
215
216
217 #ifdef AFS_GLOBAL_SUNLOCK
218 #define AFS_ASSERT_GLOCK() \
219     do { if (!ISAFS_GLOCK()) osi_Panic("afs global lock not held at %s:%d\n", __FILE__, __LINE__); } while (0)
220 #endif /* AFS_GLOBAL_SUNLOCK */
221
222 #ifdef RX_ENABLE_LOCKS
223 #define RX_AFS_GLOCK()          AFS_GLOCK()
224 #define RX_AFS_GUNLOCK()        AFS_GUNLOCK()
225 #else
226 #define RX_AFS_GLOCK()
227 #define RX_AFS_GUNLOCK()
228 #endif
229
230
231
232 #ifndef KERNEL
233 #define AFS_GLOCK()
234 #define AFS_GUNLOCK()
235 #define ISAFS_GLOCK() 1
236 #define AFS_ASSERT_GLOCK()
237 #endif
238
239 /* On an MP that uses multithreading, splnet is not sufficient to provide
240  * mutual exclusion because the other processors will not see it.  On some
241  * early multiprocessors (SunOS413 & SGI5.2) splnet actually obtains a global
242  * mutex, which this works in the UP expected way, it means that the whole MP
243  * can only take one interrupt at a time; a serious performance penalty. */
244
245 #if ((defined(AFS_GLOBAL_SUNLOCK) || defined(RX_ENABLE_LOCKS)) && !defined(AFS_HPUX_ENV)) || !defined(KERNEL)
246 #define SPLVAR
247 #define NETPRI
248 #define USERPRI
249 #endif
250
251 /*
252  * vnode/vcache ref count manipulation
253  */
254 #if defined(UKERNEL)
255 #define AFS_RELE(vp) do { VN_RELE(vp); } while (0)
256 #else /* defined(UKERNEL) */
257 #define AFS_RELE(vp) do { AFS_GUNLOCK(); VN_RELE(vp); AFS_GLOCK(); } while (0)
258 #endif /* defined(UKERNEL) */
259
260 /*
261  * For some reason we do bare refcount manipulation in some places, for some
262  * platforms.  The assumption is apparently that either we wouldn't call
263  * afs_inactive anyway (because we know the ref count is high), or that it's
264  * OK not to call it (because we don't expect CUnlinked or CDirty).
265  * (Also, of course, the vnode is assumed to be one of ours.  Can't use this
266  * macro for V-file vnodes.)
267  */
268 /* osi_vnhold is defined in PLATFORM/osi_machdep.h */
269 #define AFS_FAST_HOLD(vp) osi_vnhold((vp), 0)
270
271 #ifdef AFS_AIX_ENV
272 #define AFS_FAST_RELE(vp) VREFCOUNT_DEC(vp)
273 #else
274 #define AFS_FAST_RELE(vp) AFS_RELE(AFSTOV(vp))
275 #endif
276
277 /*
278  * MP safe versions of routines to copy memory between user space
279  * and kernel space. Call these to avoid taking page faults while
280  * holding the global lock.
281  */
282 #if defined(CAST_USER_ADDR_T) && !defined(UKERNEL) && !defined(AFS_DARWIN100_ENV)
283 #define __U(X) CAST_USER_ADDR_T((X))
284 #else
285 #define __U(X) (X)
286 #endif
287 #ifdef AFS_GLOBAL_SUNLOCK
288
289 #define AFS_COPYIN(SRC,DST,LEN,CODE)                            \
290         do {                                                    \
291             int haveGlock = ISAFS_GLOCK();                      \
292             if (haveGlock)                                      \
293                 AFS_GUNLOCK();                                  \
294             CODE = copyin(__U((SRC)),(DST),(LEN));      \
295             if (haveGlock)                                      \
296                 AFS_GLOCK();                                    \
297         } while(0)
298
299 #define AFS_COPYINSTR(SRC,DST,LEN,CNT,CODE)                     \
300         do {                                                    \
301             int haveGlock = ISAFS_GLOCK();                      \
302             if (haveGlock)                                      \
303                 AFS_GUNLOCK();                                  \
304             CODE = copyinstr(__U((SRC)),(DST),(LEN),(CNT));             \
305             if (haveGlock)                                      \
306                 AFS_GLOCK();                                    \
307         } while(0)
308
309 #define AFS_COPYOUT(SRC,DST,LEN,CODE)                           \
310         do {                                                    \
311             int haveGlock = ISAFS_GLOCK();                      \
312             if (haveGlock)                                      \
313                 AFS_GUNLOCK();                                  \
314             CODE = copyout((SRC),__U((DST)),(LEN));                     \
315             if (haveGlock)                                      \
316                 AFS_GLOCK();                                    \
317         } while(0)
318
319 #if defined(AFS_DARWIN80_ENV)
320 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
321         do {                                                    \
322             int haveGlock = ISAFS_GLOCK();                      \
323             if (haveGlock)                                      \
324                 AFS_GUNLOCK();                                  \
325             uio_setrw((UIO),(RW));                              \
326             CODE = uiomove((SRC),(LEN),(UIO));                  \
327             if (haveGlock)                                      \
328                 AFS_GLOCK();                                    \
329         } while(0)
330 #else
331 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
332 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
333         do {                                                    \
334             int haveGlock = ISAFS_GLOCK();                      \
335             if (haveGlock)                                      \
336                 AFS_GUNLOCK();                                  \
337             (UIO)->uio_rw = (RW);                               \
338             CODE = uiomove((SRC),(LEN),(UIO));                  \
339             if (haveGlock)                                      \
340                 AFS_GLOCK();                                    \
341         } while(0)
342 #else
343 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
344         do {                                                    \
345             int haveGlock = ISAFS_GLOCK();                      \
346             if (haveGlock)                                      \
347                 AFS_GUNLOCK();                                  \
348             CODE = uiomove((SRC),(LEN),(RW),(UIO));             \
349             if (haveGlock)                                      \
350                 AFS_GLOCK();                                    \
351         } while(0)
352 #endif
353 #endif /* AFS_DARWIN80_ENV */
354
355 #else /* AFS_GLOBAL_SUNLOCK */
356
357 #define AFS_COPYIN(SRC,DST,LEN,CODE)                            \
358         do {                                                    \
359             CODE = copyin(__U((SRC)),(DST),(LEN));                      \
360         } while(0)
361
362 #define AFS_COPYINSTR(SRC,DST,LEN,CNT,CODE)                     \
363         do {                                                    \
364             CODE = copyinstr(__U((SRC)),(DST),(LEN),(CNT));             \
365         } while(0)
366
367 #define AFS_COPYOUT(SRC,DST,LEN,CODE)                           \
368         do {                                                    \
369             CODE = copyout((SRC),__U((DST)),(LEN));                     \
370         } while(0)
371
372 #if defined(AFS_DARWIN80_ENV)
373 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
374         do {                                                    \
375             uio_setrw((UIO),(RW));                              \
376             CODE = uiomove((SRC),(LEN),(UIO));                  \
377         } while(0)
378 #elif defined(AFS_DARWIN_ENV) || (defined(AFS_XBSD_ENV) && !defined(AFS_NBSD40_ENV))
379 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
380         do {                                                    \
381             (UIO)->uio_rw = (RW);                               \
382             CODE = uiomove((SRC),(LEN),(UIO));                  \
383         } while(0)
384 #else
385 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
386         do {                                                    \
387             CODE = uiomove((SRC),(LEN),(RW),(UIO));             \
388         } while(0)
389 #endif
390
391 #endif /* AFS_GLOBAL_SUNLOCK */
392
393 #ifdef AFS_DARWIN80_ENV
394 #define AFS_UIO_OFFSET(uio) uio_offset(uio)
395 #define AFS_UIO_RESID(uio) (int)uio_resid(uio)
396 #define AFS_UIO_SETOFFSET(uio, off) uio_setoffset(uio, off)
397 #define AFS_UIO_SETRESID(uio, val) uio_setresid(uio, val)
398 #else
399 #define AFS_UIO_OFFSET(uio) (uio)->uio_offset
400 #define AFS_UIO_RESID(uio) (uio)->uio_resid
401 #define AFS_UIO_SETOFFSET(uio, off) (uio)->uio_offset = off
402 #define AFS_UIO_SETRESID(uio, val) (uio)->uio_resid = val
403 #endif
404
405
406 /*
407  * encapsulation of kernel data structure accesses
408  */
409 #ifndef UKERNEL
410 #define setuerror(erval)        u.u_error = (erval)
411 #define getuerror()             u.u_error
412 #endif
413
414 /* Macros for vcache/vnode and vfs arguments to vnode and vfs ops.
415  * These are required for IRIX 6.4 and later, which pass behavior pointers.
416  * Note that the _CONVERT routines get the ";" here so that argument lists
417  * can have arguments after the OSI_x_CONVERT macro is called.
418  */
419 #define OSI_VN_ARG(V) V
420 #define OSI_VN_DECL(V) struct vnode *V
421 #define OSI_VN_CONVERT(V)
422 #define OSI_VC_ARG(V) V
423 #define OSI_VC_DECL(V) struct vcache *V
424 #define OSI_VC_CONVERT(V)
425 #define OSI_VFS_ARG(V) V
426 #define OSI_VFS_DECL(V) struct vfs *V
427 #define OSI_VFS_CONVERT(V)
428
429
430 /*
431 ** Macro for Solaris 2.6 returns 1 if file is larger than 2GB; else returns 0
432 */
433 #define AfsLargeFileUio(uio)       0
434 #define AfsLargeFileSize(pos, off) 0
435
436 /* Now include system specific OSI header file. It will redefine macros
437  * defined here as required by the OS.
438  */
439 #include "osi_machdep.h"
440
441 /* Declare any structures which use these macros after the OSI implementation
442  * has had the opportunity to redefine them.
443  */
444 extern afs_ucred_t afs_osi_cred, *afs_osi_credp;
445
446 #ifndef osi_curcred
447 #define osi_curcred() (u.u_cred)
448 #endif
449
450 #endif /* _AFS_OSI_ */