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