ff43371b16cb1ca7d56d1c22ceffcbdb0c8d63b0
[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 #if defined(UKERNEL)
72     int fd;                     /* file descriptor for user space files */
73 #endif                          /* defined(UKERNEL) */
74 };
75
76 struct osi_dev {
77 #if defined(AFS_XBSD_ENV)
78     struct mount *mp;
79     struct vnode *held_vnode;
80 #elif defined(AFS_AIX42_ENV)
81     dev_t dev;
82 #else
83     afs_int32 dev;
84 #endif
85 };
86
87 struct afs_osi_WaitHandle {
88 #ifdef AFS_FBSD50_ENV
89     struct cv wh_condvar;
90     int wh_inited;              /* XXX */
91 #else
92     caddr_t proc;               /* process waiting */
93 #endif
94 };
95
96 #define osi_SetFileProc(x,p)    ((x)->proc=(p))
97 #define osi_SetFileRock(x,r)    ((x)->rock=(r))
98 #define osi_GetFileProc(x)      ((x)->proc)
99 #define osi_GetFileRock(x)      ((x)->rock)
100
101 #ifdef  AFS_TEXT_ENV
102 #define osi_FlushText(vp) if (hcmp((vp)->f.m.DataVersion, (vp)->flushDV) > 0) \
103                             osi_FlushText_really(vp)
104 #else
105 #define osi_FlushText(vp)
106 #endif
107
108
109 #define AFSOP_STOP_RXEVENT   214        /* stop rx event deamon */
110 #define AFSOP_STOP_COMPLETE  215        /* afs has been shutdown */
111 #define AFSOP_STOP_RXK_LISTENER   217   /* stop rx listener daemon */
112
113
114 #define osi_NPACKETS    20      /* number of cluster pkts to alloc */
115
116 /*
117  * Alloc declarations.
118  */
119 #if !defined(AFS_OBSD44_ENV)
120 #define afs_osi_Alloc_NoSleep afs_osi_Alloc
121 #endif
122
123 /*
124  * Default vnode related macros
125  *
126  * Darwin, all of the BSDs, and Linux have their own
127  */
128 #if !defined(AFS_DARWIN_ENV) && !defined(AFS_XBSD_ENV) && !defined(AFS_LINUX20_ENV)
129 # define        vType(vc)           (vc)->v.v_type
130 # define        vSetType(vc,type)   (vc)->v.v_type = (type)
131 # define        vSetVfsp(vc,vfsp)   (vc)->v.v_vfsp = (vfsp)
132 extern struct vnodeops *afs_ops;
133 # define        IsAfsVnode(v)       ((v)->v_op == afs_ops)
134 # define        SetAfsVnode(v)      (v)->v_op = afs_ops
135 #endif
136
137 /*
138  * In IRIX 6.5 we cannot have DEBUG turned on since certain
139  * system-defined structures are a different size with DEBUG on, the
140  * kernel is compiled without DEBUG on, and the resulting differences
141  * would break our ability to interact with the rest of the kernel.
142  *
143  * Is DEBUG only for turning the ASSERT() macro?  If so, we should
144  * be able to eliminate DEBUG entirely.
145  */
146 #if !defined(AFS_SGI65_ENV)
147 #ifndef DEBUG
148 #define DEBUG   1               /* Default is to enable debugging/logging */
149 #endif
150 #endif
151
152 /* 
153  * Time related macros
154  */
155 #define osi_GetuTime(x) osi_GetTime(x)
156
157 /* osi_timeval_t exists because SGI 6.x has two sizes of timeval. */
158 /** In 64 bit Solaris the timeval structure has members that are 64 bit
159   * In the GetTime() interface we expect pointers to afs_int32. So the need to
160   * define osi_timeval_t to have 32 bit members. To make this less ambiguous
161   * we now use 32 bit quantities consistently all over the code.
162   * In 64 bit HP-UX the timeval structure has a 64 bit member.
163   */
164
165 #if defined(AFS_HPUX_ENV) || defined(AFS_LINUX_64BIT_KERNEL) || (defined(AFS_SGI61_ENV) && defined(KERNEL) && defined(_K64U64))
166 typedef struct {
167     afs_int32 tv_sec;
168     afs_int32 tv_usec;
169 } osi_timeval_t;
170 #elif defined(AFS_SUN57_ENV)
171 typedef struct timeval32 osi_timeval_t;
172 #else
173 typedef struct timeval osi_timeval_t;
174 #endif /* AFS_SGI61_ENV */
175
176 #ifndef UKERNEL
177 #define osi_getpid()            getpid()
178 #endif
179
180 /*
181  * osi_ThreadUnique() should yield a value that can be found in ps
182  * output in order to draw correspondences between ICL traces and what
183  * is going on in the system.  So if ps cannot show thread IDs it is
184  * likely to be the process ID instead.
185  */
186 #ifdef AFS_FBSD50_ENV
187 /* should use curthread, but 'ps' can't display it */
188 #define osi_ThreadUnique()      curproc
189 #elif defined(AFS_LINUX_ENV)
190 #define osi_ThreadUnique()      (current->pid)
191 #elif defined(UKERNEL)
192 #define osi_ThreadUnique()      osi_getpid()
193 #else
194 #define osi_ThreadUnique()      getpid()
195 #endif
196
197
198
199 #ifdef AFS_GLOBAL_SUNLOCK
200 # if defined(AFS_AIX_ENV) || defined(AFS_SGI_ENV)
201 #define AFS_ASSERT_GLOCK() \
202     do { if (!ISAFS_GLOCK()) osi_Panic("afs global lock not held at %s:%d%s\n", __FILE__, (void *)__LINE__, ""); } while (0)
203 # else
204 #define AFS_ASSERT_GLOCK() \
205     do { if (!ISAFS_GLOCK()) osi_Panic("afs global lock not held at %s:%d\n", __FILE__, __LINE__); } while (0)
206 # endif /* defined(AFS_AIX_ENV) || defined(AFS_SGI_ENV) */
207 #endif /* AFS_GLOBAL_SUNLOCK */
208
209 #ifdef RX_ENABLE_LOCKS
210 #define RX_AFS_GLOCK()          AFS_GLOCK()
211 #define RX_AFS_GUNLOCK()        AFS_GUNLOCK()
212 #else
213 #define RX_AFS_GLOCK()
214 #define RX_AFS_GUNLOCK()
215 #endif
216
217
218
219 #ifndef KERNEL
220 #define AFS_GLOCK()
221 #define AFS_GUNLOCK()
222 #define ISAFS_GLOCK() 1
223 #define AFS_ASSERT_GLOCK()
224 #endif
225
226 /* On an MP that uses multithreading, splnet is not sufficient to provide
227  * mutual exclusion because the other processors will not see it.  On some
228  * early multiprocessors (SunOS413 & SGI5.2) splnet actually obtains a global
229  * mutex, which this works in the UP expected way, it means that the whole MP
230  * can only take one interrupt at a time; a serious performance penalty. */
231
232 #if ((defined(AFS_GLOBAL_SUNLOCK) || defined(RX_ENABLE_LOCKS)) && !defined(AFS_HPUX_ENV)) || !defined(KERNEL)
233 #define SPLVAR
234 #define NETPRI
235 #define USERPRI
236 #endif
237
238 /*
239  * vnode/vcache ref count manipulation
240  */
241 #if defined(UKERNEL)
242 #define AFS_RELE(vp) do { VN_RELE(vp); } while (0)
243 #else /* defined(UKERNEL) */
244 #define AFS_RELE(vp) do { AFS_GUNLOCK(); VN_RELE(vp); AFS_GLOCK(); } while (0)
245 #endif /* defined(UKERNEL) */
246
247 /*
248  * For some reason we do bare refcount manipulation in some places, for some
249  * platforms.  The assumption is apparently that either we wouldn't call
250  * afs_inactive anyway (because we know the ref count is high), or that it's
251  * OK not to call it (because we don't expect CUnlinked or CDirty).
252  * (Also, of course, the vnode is assumed to be one of ours.  Can't use this
253  * macro for V-file vnodes.)
254  */
255 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
256 /* Bare refcount manipulation would probably work on this platform, but just
257    calling VREF does not */
258 #define AFS_FAST_HOLD(vp) osi_vnhold((vp),0)
259 #else
260 #define AFS_FAST_HOLD(vp) VN_HOLD(AFSTOV(vp))
261 #endif
262 #define AFS_FAST_RELE(vp) AFS_RELE(AFSTOV(vp))
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)
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 #endif /* _AFS_OSI_ */