afs: Remove osi_GetuTime
[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_LINUX26_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_LINUX20_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_LINUX26_ENV
64     struct file *filp;          /* May need this if we really open the file. */
65 #else
66 #ifdef AFS_LINUX22_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_LINUX20_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 #if defined(AFS_HPUX_ENV) || defined(AFS_LINUX_64BIT_KERNEL) || (defined(AFS_LINUX26_ENV) && !defined(HAVE_LINUX_TIME_T)) || (defined(AFS_SGI61_ENV) && defined(KERNEL) && defined(_K64U64))
182 typedef struct {
183     afs_int32 tv_sec;
184     afs_int32 tv_usec;
185 } osi_timeval32_t;
186 #elif defined(AFS_SUN5_ENV)
187 typedef struct timeval32 osi_timeval32_t;
188 #else
189 typedef struct timeval osi_timeval32_t;
190 #endif /* AFS_SGI61_ENV */
191
192 #ifndef UKERNEL
193 #define osi_getpid()            getpid()
194 #endif
195
196 /*
197  * osi_ThreadUnique() should yield a value that can be found in ps
198  * output in order to draw correspondences between ICL traces and what
199  * is going on in the system.  So if ps cannot show thread IDs it is
200  * likely to be the process ID instead.
201  */
202 #ifdef AFS_FBSD_ENV
203 /* should use curthread, but 'ps' can't display it */
204 #define osi_ThreadUnique()      (curproc->p_pid)
205 #elif defined(UKERNEL)
206 #define osi_ThreadUnique()      osi_getpid()
207 #else
208 #define osi_ThreadUnique()      getpid()
209 #endif
210
211
212
213 #ifdef AFS_GLOBAL_SUNLOCK
214 #define AFS_ASSERT_GLOCK() \
215     do { if (!ISAFS_GLOCK()) osi_Panic("afs global lock not held at %s:%d\n", __FILE__, __LINE__); } while (0)
216 #endif /* AFS_GLOBAL_SUNLOCK */
217
218 #ifdef RX_ENABLE_LOCKS
219 #define RX_AFS_GLOCK()          AFS_GLOCK()
220 #define RX_AFS_GUNLOCK()        AFS_GUNLOCK()
221 #else
222 #define RX_AFS_GLOCK()
223 #define RX_AFS_GUNLOCK()
224 #endif
225
226
227
228 #ifndef KERNEL
229 #define AFS_GLOCK()
230 #define AFS_GUNLOCK()
231 #define ISAFS_GLOCK() 1
232 #define AFS_ASSERT_GLOCK()
233 #endif
234
235 /* On an MP that uses multithreading, splnet is not sufficient to provide
236  * mutual exclusion because the other processors will not see it.  On some
237  * early multiprocessors (SGI5.2) splnet actually obtains a global
238  * mutex, which this works in the UP expected way, it means that the whole MP
239  * can only take one interrupt at a time; a serious performance penalty. */
240
241 #if ((defined(AFS_GLOBAL_SUNLOCK) || defined(RX_ENABLE_LOCKS)) && !defined(AFS_HPUX_ENV)) || !defined(KERNEL)
242 #define SPLVAR
243 #define NETPRI
244 #define USERPRI
245 #endif
246
247 /*
248  * vnode/vcache ref count manipulation
249  */
250 #if defined(UKERNEL)
251 #define AFS_RELE(vp) do { VN_RELE(vp); } while (0)
252 #else /* defined(UKERNEL) */
253 #define AFS_RELE(vp) do { AFS_GUNLOCK(); VN_RELE(vp); AFS_GLOCK(); } while (0)
254 #endif /* defined(UKERNEL) */
255
256 /*
257  * For some reason we do bare refcount manipulation in some places, for some
258  * platforms.  The assumption is apparently that either we wouldn't call
259  * afs_inactive anyway (because we know the ref count is high), or that it's
260  * OK not to call it (because we don't expect CUnlinked or CDirty).
261  * (Also, of course, the vnode is assumed to be one of ours.  Can't use this
262  * macro for V-file vnodes.)
263  */
264 #ifdef AFS_AIX_ENV
265 #define AFS_FAST_RELE(vp) VREFCOUNT_DEC(vp)
266 #else
267 #define AFS_FAST_RELE(vp) AFS_RELE(AFSTOV(vp))
268 #endif
269
270 /*
271  * MP safe versions of routines to copy memory between user space
272  * and kernel space. Call these to avoid taking page faults while
273  * holding the global lock.
274  */
275 #if defined(CAST_USER_ADDR_T) && !defined(UKERNEL) && !defined(AFS_DARWIN100_ENV)
276 #define __U(X) CAST_USER_ADDR_T((X))
277 #else
278 #define __U(X) (X)
279 #endif
280 #ifdef AFS_GLOBAL_SUNLOCK
281
282 #define AFS_COPYIN(SRC,DST,LEN,CODE)                            \
283         do {                                                    \
284             int haveGlock = ISAFS_GLOCK();                      \
285             if (haveGlock)                                      \
286                 AFS_GUNLOCK();                                  \
287             CODE = copyin(__U((SRC)),(DST),(LEN));      \
288             if (haveGlock)                                      \
289                 AFS_GLOCK();                                    \
290         } while(0)
291
292 #define AFS_COPYINSTR(SRC,DST,LEN,CNT,CODE)                     \
293         do {                                                    \
294             int haveGlock = ISAFS_GLOCK();                      \
295             if (haveGlock)                                      \
296                 AFS_GUNLOCK();                                  \
297             CODE = copyinstr(__U((SRC)),(DST),(LEN),(CNT));             \
298             if (haveGlock)                                      \
299                 AFS_GLOCK();                                    \
300         } while(0)
301
302 #define AFS_COPYOUT(SRC,DST,LEN,CODE)                           \
303         do {                                                    \
304             int haveGlock = ISAFS_GLOCK();                      \
305             if (haveGlock)                                      \
306                 AFS_GUNLOCK();                                  \
307             CODE = copyout((SRC),__U((DST)),(LEN));                     \
308             if (haveGlock)                                      \
309                 AFS_GLOCK();                                    \
310         } while(0)
311
312 #if defined(AFS_DARWIN80_ENV)
313 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
314         do {                                                    \
315             int haveGlock = ISAFS_GLOCK();                      \
316             if (haveGlock)                                      \
317                 AFS_GUNLOCK();                                  \
318             uio_setrw((UIO),(RW));                              \
319             CODE = uiomove((SRC),(LEN),(UIO));                  \
320             if (haveGlock)                                      \
321                 AFS_GLOCK();                                    \
322         } while(0)
323 #else
324 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
325 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
326         do {                                                    \
327             int haveGlock = ISAFS_GLOCK();                      \
328             if (haveGlock)                                      \
329                 AFS_GUNLOCK();                                  \
330             (UIO)->uio_rw = (RW);                               \
331             CODE = uiomove((SRC),(LEN),(UIO));                  \
332             if (haveGlock)                                      \
333                 AFS_GLOCK();                                    \
334         } while(0)
335 #else
336 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
337         do {                                                    \
338             int haveGlock = ISAFS_GLOCK();                      \
339             if (haveGlock)                                      \
340                 AFS_GUNLOCK();                                  \
341             CODE = uiomove((SRC),(LEN),(RW),(UIO));             \
342             if (haveGlock)                                      \
343                 AFS_GLOCK();                                    \
344         } while(0)
345 #endif
346 #endif /* AFS_DARWIN80_ENV */
347
348 #else /* AFS_GLOBAL_SUNLOCK */
349
350 #define AFS_COPYIN(SRC,DST,LEN,CODE)                            \
351         do {                                                    \
352             CODE = copyin(__U((SRC)),(DST),(LEN));                      \
353         } while(0)
354
355 #define AFS_COPYINSTR(SRC,DST,LEN,CNT,CODE)                     \
356         do {                                                    \
357             CODE = copyinstr(__U((SRC)),(DST),(LEN),(CNT));             \
358         } while(0)
359
360 #define AFS_COPYOUT(SRC,DST,LEN,CODE)                           \
361         do {                                                    \
362             CODE = copyout((SRC),__U((DST)),(LEN));                     \
363         } while(0)
364
365 #if defined(AFS_DARWIN80_ENV)
366 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
367         do {                                                    \
368             uio_setrw((UIO),(RW));                              \
369             CODE = uiomove((SRC),(LEN),(UIO));                  \
370         } while(0)
371 #elif defined(AFS_DARWIN_ENV) || (defined(AFS_XBSD_ENV) && !defined(AFS_NBSD40_ENV))
372 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
373         do {                                                    \
374             (UIO)->uio_rw = (RW);                               \
375             CODE = uiomove((SRC),(LEN),(UIO));                  \
376         } while(0)
377 #else
378 #define AFS_UIOMOVE(SRC,LEN,RW,UIO,CODE)                        \
379         do {                                                    \
380             CODE = uiomove((SRC),(LEN),(RW),(UIO));             \
381         } while(0)
382 #endif
383
384 #endif /* AFS_GLOBAL_SUNLOCK */
385
386 #ifdef AFS_DARWIN80_ENV
387 #define AFS_UIO_OFFSET(uio) uio_offset(uio)
388 #define AFS_UIO_RESID(uio) (int)uio_resid(uio)
389 #define AFS_UIO_SETOFFSET(uio, off) uio_setoffset(uio, off)
390 #define AFS_UIO_SETRESID(uio, val) uio_setresid(uio, val)
391 #else
392 #define AFS_UIO_OFFSET(uio) (uio)->uio_offset
393 #define AFS_UIO_RESID(uio) (uio)->uio_resid
394 #define AFS_UIO_SETOFFSET(uio, off) (uio)->uio_offset = off
395 #define AFS_UIO_SETRESID(uio, val) (uio)->uio_resid = val
396 #endif
397
398
399 /*
400  * encapsulation of kernel data structure accesses
401  */
402 #ifndef UKERNEL
403 #define setuerror(erval)        u.u_error = (erval)
404 #define getuerror()             u.u_error
405 #endif
406
407 /* Macros for vcache/vnode and vfs arguments to vnode and vfs ops.
408  * These are required for IRIX 6.4 and later, which pass behavior pointers.
409  * Note that the _CONVERT routines get the ";" here so that argument lists
410  * can have arguments after the OSI_x_CONVERT macro is called.
411  */
412 #define OSI_VN_ARG(V) V
413 #define OSI_VN_DECL(V) struct vnode *V
414 #define OSI_VN_CONVERT(V)
415 #define OSI_VC_ARG(V) V
416 #define OSI_VC_DECL(V) struct vcache *V
417 #define OSI_VC_CONVERT(V)
418 #define OSI_VFS_ARG(V) V
419 #define OSI_VFS_DECL(V) struct vfs *V
420 #define OSI_VFS_CONVERT(V)
421
422
423 /*
424 ** Macro for Solaris 2.6 returns 1 if file is larger than 2GB; else returns 0
425 */
426 #define AfsLargeFileUio(uio)       0
427 #define AfsLargeFileSize(pos, off) 0
428
429 /* Now include system specific OSI header file. It will redefine macros
430  * defined here as required by the OS.
431  */
432 #include "osi_machdep.h"
433
434 /* Declare any structures which use these macros after the OSI implementation
435  * has had the opportunity to redefine them.
436  */
437 extern afs_ucred_t afs_osi_cred, *afs_osi_credp;
438
439 #ifndef osi_curcred
440 #define osi_curcred() (u.u_cred)
441 #endif
442
443 #ifdef AFS_PAG_ONEGROUP_ENV
444 #define AFS_NUMPAGGROUPS 1
445 #else
446 #define AFS_NUMPAGGROUPS 2
447 #endif
448
449 #endif /* _AFS_OSI_ */