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