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