pull-prototypes-to-head-20020821
[openafs.git] / src / afs / afs_osi.c
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 #include <afsconfig.h>
11 #include "../afs/param.h"
12
13 RCSID("$Header$");
14
15 #include "../afs/sysincludes.h" /* Standard vendor system headers */
16 #include "../afs/afsincludes.h" /* Afs-based standard headers */
17 #include "../afs/afs_stats.h"   /* afs statistics */
18 #ifdef AFS_AIX_ENV
19 #include <sys/adspace.h>        /* for vm_att(), vm_det() */
20 #endif
21
22 static char memZero;                    /* address of 0 bytes for kmem_alloc */
23
24 struct osimem {
25     struct osimem *next;
26 };
27
28 /* osi_Init -- do once per kernel installation initialization.
29  *     -- On Solaris this is called from modload initialization.
30  *     -- On AIX called from afs_config.
31  *     -- On HP called from afsc_link.
32  *     -- On SGI called from afs_init. */
33
34 #ifdef AFS_SGI53_ENV
35 lock_t afs_event_lock;
36 #endif
37
38 #ifdef AFS_SGI64_ENV
39 flid_t osi_flid;
40 #endif
41
42 void osi_Init(void)
43 {
44     static int once = 0;
45     if (once++ > 0)                     /* just in case */
46         return;
47 #if     defined(AFS_HPUX_ENV)
48     osi_InitGlock();
49 #else   /* AFS_HPUX_ENV */
50 #if defined(AFS_GLOBAL_SUNLOCK)
51 #if defined(AFS_SGI62_ENV)
52     mutex_init(&afs_global_lock, MUTEX_DEFAULT, "afs_global_lock");
53 #elif defined(AFS_OSF_ENV)
54     usimple_lock_init(&afs_global_lock);
55     afs_global_owner = (thread_t)0;
56 #elif defined(AFS_DARWIN_ENV) || defined(AFS_FBSD_ENV)
57     lockinit(&afs_global_lock, PLOCK, "afs global lock", 0, 0);
58     afs_global_owner = 0;
59 #elif defined(AFS_AIX41_ENV)
60     lock_alloc((void*)&afs_global_lock, LOCK_ALLOC_PIN, 1, 1);
61     simple_lock_init((void *)&afs_global_lock);
62 #else
63 #ifndef AFS_LINUX22_ENV
64      /* Linux initialization in osi directory. Should move the others. */
65     mutex_init(&afs_global_lock, "afs_global_lock", MUTEX_DEFAULT, NULL);
66 #endif
67 #endif
68     /* afs_rxglobal_lock is initialized in rx_Init. */
69 #endif
70 #endif  /* AFS_HPUX_ENV */
71
72         if ( !afs_osicred_initialized )
73         {
74                 memset((char *)&afs_osi_cred, 0, sizeof(struct AFS_UCRED));
75                 crhold(&afs_osi_cred);      /* don't let it evaporate */
76                 afs_osicred_initialized = 1;
77         }
78 #ifdef AFS_SGI64_ENV
79      osi_flid.fl_pid = osi_flid.fl_sysid = 0;
80 #endif
81 }
82
83 int osi_Active(register struct vcache *avc)
84 {
85     AFS_STATCNT(osi_Active);
86 #if defined(AFS_SUN_ENV) || defined(AFS_AIX_ENV) || defined(AFS_OSF_ENV) || defined(AFS_SUN5_ENV) || (AFS_LINUX20_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_FBSD_ENV)
87     if ((avc->opens > 0) || (avc->states & CMAPPED))    return 1;   /* XXX: Warning, verify this XXX  */
88 #else
89 #if     defined(AFS_MACH_ENV)
90     if (avc->opens > 0 || ((avc->v.v_flag & VTEXT) && !inode_uncache_try(avc))) return 1;
91 #else
92 #if defined(AFS_SGI_ENV)
93     if ((avc->opens > 0) || AFS_VN_MAPPED(AFSTOV(avc)))
94         return 1;
95 #else
96     if (avc->opens > 0 || (AFSTOV(avc)->v_flag & VTEXT)) return(1);
97 #endif
98 #endif /* AFS_MACH_ENV */
99 #endif
100     return 0;
101 }
102
103 /* this call, unlike osi_FlushText, is supposed to discard caches that may
104    contain invalid information if a file is written remotely, but that may
105    contain valid information that needs to be written back if the file is
106    being written locally.  It doesn't subsume osi_FlushText, since the latter
107    function may be needed to flush caches that are invalidated by local writes.
108
109    avc->pvnLock is already held, avc->lock is guaranteed not to be held (by
110    us, of course).
111 */
112 void osi_FlushPages(register struct vcache *avc, struct AFS_UCRED *credp)
113 {
114     afs_hyper_t origDV;
115     ObtainReadLock(&avc->lock);
116     /* If we've already purged this version, or if we're the ones
117        writing this version, don't flush it (could lose the
118        data we're writing). */
119     if ((hcmp((avc->m.DataVersion), (avc->mapDV)) <= 0) || 
120         ((avc->execsOrWriters > 0) && afs_DirtyPages(avc))) {
121         ReleaseReadLock(&avc->lock);
122         return;
123     }
124     ReleaseReadLock(&avc->lock);
125     ObtainWriteLock(&avc->lock,10);
126     /* Check again */
127     if ((hcmp((avc->m.DataVersion), (avc->mapDV)) <= 0) || 
128         ((avc->execsOrWriters > 0) && afs_DirtyPages(avc))) {
129         ReleaseWriteLock(&avc->lock);
130         return;
131     }
132     if (hiszero(avc->mapDV)) {
133         hset(avc->mapDV, avc->m.DataVersion);
134         ReleaseWriteLock(&avc->lock);
135         return;
136     }
137
138     AFS_STATCNT(osi_FlushPages);
139     hset(origDV, avc->m.DataVersion);
140     afs_Trace3(afs_iclSetp, CM_TRACE_FLUSHPAGES, ICL_TYPE_POINTER, avc,
141                    ICL_TYPE_INT32, origDV.low, ICL_TYPE_INT32, avc->m.Length);
142
143     ReleaseWriteLock(&avc->lock);
144     AFS_GUNLOCK();
145     osi_VM_FlushPages(avc, credp);
146     AFS_GLOCK();
147     ObtainWriteLock(&avc->lock,88);
148
149     /* do this last, and to original version, since stores may occur
150        while executing above PUTPAGE call */
151     hset(avc->mapDV, origDV);
152     ReleaseWriteLock(&avc->lock);
153 }
154
155 afs_lock_t afs_ftf;             /* flush text lock */
156
157 #ifdef  AFS_TEXT_ENV
158
159 /* This call is supposed to flush all caches that might be invalidated
160  * by either a local write operation or a write operation done on
161  * another client.  This call may be called repeatedly on the same
162  * version of a file, even while a file is being written, so it
163  * shouldn't do anything that would discard newly written data before
164  * it is written to the file system. */
165
166 void osi_FlushText_really(register struct vcache *vp)
167 {
168     afs_hyper_t fdv;    /* version before which we'll flush */
169
170     AFS_STATCNT(osi_FlushText);
171     /* see if we've already flushed this data version */
172     if (hcmp(vp->m.DataVersion, vp->flushDV) <= 0) return;
173
174 #ifdef AFS_DEC_ENV 
175     {
176       void afs_gfs_FlushText();
177       afs_gfs_FlushText(vp);
178       return;
179     }
180 #else
181
182     MObtainWriteLock(&afs_ftf,317);
183     hset(fdv, vp->m.DataVersion);
184
185     /* why this disgusting code below?  
186      *    xuntext, called by xrele, doesn't notice when it is called 
187      * with a freed text object.  Sun continually calls xrele or xuntext
188      * without any locking, as long as VTEXT is set on the
189      * corresponding vnode.  
190      *    But, if the text object is locked when you check the VTEXT
191      * flag, several processes can wait in xuntext, waiting for the
192      * text lock; when the second one finally enters xuntext's
193      * critical region, the text object is already free, but the check
194      * was already done by xuntext's caller.
195      *    Even worse, it turns out that xalloc locks the text object
196      * before reading or stating a file via the vnode layer.  Thus, we
197      * could end up in getdcache, being asked to bring in a new
198      * version of a file, but the corresponding text object could be
199      * locked.  We can't flush the text object without causing
200      * deadlock, so now we just don't try to lock the text object
201      * unless it is guaranteed to work.  And we try to flush the text
202      * when we need to a bit more often at the vnode layer.  Sun
203      * really blew the vm-cache flushing interface.
204      */
205
206 #if defined (AFS_HPUX_ENV)
207     if (vp->v.v_flag & VTEXT) {
208         xrele(vp);  
209
210         if (vp->v.v_flag & VTEXT) {     /* still has a text object? */
211             MReleaseWriteLock(&afs_ftf);
212             return;
213         }
214     }
215 #endif
216
217     /* next do the stuff that need not check for deadlock problems */
218     mpurge(vp);
219
220     /* finally, record that we've done it */
221     hset(vp->flushDV, fdv);
222     MReleaseWriteLock(&afs_ftf);
223
224 #endif /* AFS_DEC_ENV */
225 }
226
227 #ifdef AFS_DEC_ENV
228 /* I don't really like using xinval() here, because it kills processes
229  * a bit aggressively.  Previous incarnations of this functionality
230  * used to use xrele() instead of xinval, and didn't invoke
231  * cacheinval().  But they would panic.  So it might be worth looking
232  * into some middle ground...
233  */
234 static void afs_gfs_FlushText(register struct vcache *vp)
235 {
236     afs_hyper_t fdv;    /* version before which we'll flush */
237     register struct text *xp;
238     struct gnode * gp;
239
240     MObtainWriteLock(&afs_ftf,318);
241     hset(fdv, vp->m.DataVersion);
242     gp = afs_vntogn(vp);
243
244     if (!gp) {
245       /* this happens frequently after cores are created. */
246       MReleaseWriteLock(&afs_ftf);
247       return;
248     }
249
250     if (gp->g_flag & GTEXT) {
251         if (gp->g_textp) {
252           xp = (struct text *) gp->g_textp ;
253           /* if text object is locked, give up */
254           if (xp && (xp->x_flag & XLOCK)) {
255             MReleaseWriteLock(&afs_ftf);
256             return;
257           }
258         }
259         else xp = NULL;
260
261         if (gp->g_flag & GTEXT) {/* still has a text object? */
262           xinval(gp);
263           }
264     }
265
266     /* next do the stuff that need not check for deadlock problems */
267     /*    maybe xinval(gp); here instead of above */
268     binval(NODEV, gp);
269     cacheinval(gp);
270     /* finally, record that we've done it */
271     hset(vp->flushDV, fdv);
272
273     MReleaseWriteLock(&afs_ftf);
274 }
275 #endif /* AFS_DEC_ENV */
276
277 #endif /* AFS_TEXT_ENV */
278
279 /* mask signals in afsds */
280 void afs_osi_MaskSignals(void)
281 {
282 #ifdef AFS_LINUX22_ENV
283     osi_linux_mask();
284 #endif
285 }
286     
287 /* unmask signals in rxk listener */
288 void afs_osi_UnmaskRxkSignals(void)
289 {
290 #ifdef AFS_LINUX22_ENV
291     osi_linux_unmask();
292 #endif
293 }
294     
295 /* register rxk listener proc info */
296 void afs_osi_RxkRegister(void)
297 {
298 #ifdef AFS_LINUX22_ENV
299     osi_linux_rxkreg();
300 #endif
301 }
302
303 /* procedure for making our processes as invisible as we can */
304 void afs_osi_Invisible(void)
305 {
306 #ifdef AFS_LINUX22_ENV
307     afs_osi_MaskSignals();
308 #endif 
309 #ifdef AFS_DEC_ENV
310     u.u_procp->p_type |= SSYS;
311 #endif 
312 #if AFS_SUN5_ENV
313     curproc->p_flag |= SSYS;
314 #endif
315 #if AFS_HPUX101_ENV
316     set_system_proc(u.u_procp);
317 #endif
318 #if defined(AFS_DARWIN_ENV)
319     /* maybe call init_process instead? */
320     current_proc()->p_flag |= P_SYSTEM;
321 #endif
322 #if defined(AFS_FBSD_ENV)
323     curproc->p_flag |= P_SYSTEM;
324 #endif
325 #if defined(AFS_SGI_ENV)
326     vrelvm();
327 #endif /* AFS_SGI_ENV */
328
329     AFS_STATCNT(osi_Invisible);
330 }
331
332
333 #ifndef AFS_LINUX20_ENV /* Linux version in osi_misc.c */
334 /* set the real time */
335 int afs_osi_SetTime(register osi_timeval_t *atv)
336 {
337 #ifdef  AFS_AIX32_ENV
338     struct timestruc_t t;
339
340     t.tv_sec  = atv->tv_sec;
341     t.tv_nsec = atv->tv_usec * 1000;
342     ksettimer(&t);              /*  Was -> settimer(TIMEOFDAY, &t); */
343 #else
344 #ifdef AFS_SUN55_ENV
345     stime(atv->tv_sec);
346 #else
347 #ifdef  AFS_SUN5_ENV
348     /*
349      * To get more than second resolution we can use adjtime. The problem
350      * is that the usecs from the server are wrong (by now) so it isn't
351      * worth complicating the following code.
352      */
353     struct stimea {
354         time_t time;
355     } sta;
356
357     sta.time = atv->tv_sec;
358
359     stime(&sta, NULL);
360 #else
361 #if defined(AFS_SGI_ENV)
362     struct stimea {
363         sysarg_t time;
364     } sta;
365
366     AFS_GUNLOCK();
367     sta.time = atv->tv_sec;
368     stime(&sta);
369     AFS_GLOCK();
370 #else
371 #if defined(AFS_FBSD_ENV)
372     /* does not impliment security features of kern_time.c:settime() */
373     struct timespec ts;
374     struct timeval tv,delta;
375     int s;
376     AFS_GUNLOCK();
377     s=splclock();
378     microtime(&tv);
379     delta=*atv;
380     timevalsub(&delta, &tv);
381     ts.tv_sec=atv->tv_sec;
382     ts.tv_nsec=atv->tv_usec * 1000;
383     set_timecounter(&ts);
384     (void) splsoftclock();
385     lease_updatetime(delta.tv_sec);
386     splx(s);
387     resettodr();
388     AFS_GLOCK();
389 #else
390 #if defined(AFS_DARWIN_ENV)
391     AFS_GUNLOCK();
392     setthetime(atv);
393     AFS_GLOCK();
394 #else
395     /* stolen from kern_time.c */
396 #ifndef AFS_AUX_ENV
397     boottime.tv_sec += atv->tv_sec - time.tv_sec;
398 #endif
399 #ifdef AFS_HPUX_ENV
400     {
401     register ulong_t s;
402     struct timeval t;
403     t.tv_sec = atv->tv_sec;
404     t.tv_usec = atv->tv_usec;
405     s = spl7(); time = t; (void) splx(s);
406     resettodr(atv);
407     }
408 #else
409     {
410     register int s;
411     s = splclock(); time = *atv; (void) splx(s);
412     }
413     resettodr();
414 #endif
415 #ifdef  AFS_AUX_ENV
416     logtchg(atv->tv_sec);
417 #endif
418 #endif  /* AFS_DARWIN_ENV */
419 #endif  /* AFS_FBSD_ENV */
420 #endif  /* AFS_SGI_ENV */
421 #endif /* AFS_SUN55_ENV */
422 #endif /* AFS_SUN5_ENV */
423 #endif /* AFS_AIX32_ENV */
424     AFS_STATCNT(osi_SetTime);
425     return 0;
426 }
427 #endif /* AFS_LINUX20_ENV */
428
429
430 void *afs_osi_Alloc(size_t x)
431 {
432     register struct osimem *tm = NULL;
433     register int size;
434
435     AFS_STATCNT(osi_Alloc);
436     /* 0-length allocs may return NULL ptr from AFS_KALLOC, so we special-case
437        things so that NULL returned iff an error occurred */
438     if (x == 0) return &memZero;
439
440     AFS_STATS(afs_stats_cmperf.OutStandingAllocs++);
441     AFS_STATS(afs_stats_cmperf.OutStandingMemUsage += x);
442 #ifdef AFS_LINUX20_ENV
443     return osi_linux_alloc(x, 1);
444 #else
445     size = x;
446     tm = (struct osimem *) AFS_KALLOC(size);
447 #ifdef  AFS_SUN_ENV
448     if (!tm)
449         osi_Panic("osi_Alloc: Couldn't allocate %d bytes; out of memory!\n",
450                   size);
451 #endif
452     return (char *) tm;
453 #endif
454 }
455
456 #if     defined(AFS_SUN_ENV) || defined(AFS_SGI_ENV)
457
458 void *afs_osi_Alloc_NoSleep(size_t x)
459 {
460     register struct osimem *tm;
461     register int size;
462
463     AFS_STATCNT(osi_Alloc);
464     /* 0-length allocs may return NULL ptr from AFS_KALLOC, so we special-case
465        things so that NULL returned iff an error occurred */
466     if (x == 0) return &memZero;
467
468     size = x;
469     AFS_STATS(afs_stats_cmperf.OutStandingAllocs++);
470     AFS_STATS(afs_stats_cmperf.OutStandingMemUsage += x);
471     tm = (struct osimem *) AFS_KALLOC_NOSLEEP(size);
472     return (char *) tm;
473 }
474
475 #endif  /* SUN || SGI */
476
477 void afs_osi_Free(void *x, size_t asize)
478 {
479     register struct osimem *tm, **lm, *um;
480
481     AFS_STATCNT(osi_Free);
482     if (x == &memZero) return;  /* check for putting memZero back */
483
484     AFS_STATS(afs_stats_cmperf.OutStandingAllocs--);
485     AFS_STATS(afs_stats_cmperf.OutStandingMemUsage -= asize);
486 #ifdef AFS_LINUX20_ENV
487     osi_linux_free(x);
488 #else
489     AFS_KFREE((struct osimem *)x, asize);
490 #endif
491 }
492
493
494 /* ? is it moderately likely that there are dirty VM pages associated with 
495  * this vnode?
496  *
497  *  Prereqs:  avc must be write-locked
498  *
499  *  System Dependencies:  - *must* support each type of system for which 
500  *                          memory mapped files are supported, even if all 
501  *                          it does is return TRUE;
502  *
503  * NB:  this routine should err on the side of caution for ProcessFS to work
504  *      correctly (or at least, not to introduce worse bugs than already exist)
505  */
506 #ifdef  notdef
507 int osi_VMDirty_p(struct vcache *avc)
508 {
509     int dirtyPages;
510
511     if (avc->execsOrWriters <= 0)
512         return 0;         /* can't be many dirty pages here, I guess */
513     
514 #if defined (AFS_AIX32_ENV) 
515 #ifdef  notdef
516     /* because of the level of hardware involvment with VM and all the
517      * warnings about "This routine must be called at VMM interrupt
518      * level", I thought it would be safest to disable interrupts while
519      * looking at the software page fault table.  */
520
521     /* convert vm handle into index into array:  I think that stoinio is 
522      * always zero...  Look into this XXX  */
523 #define VMHASH(handle) ( \
524                         ( ((handle) & ~vmker.stoinio)  \
525                          ^ ((((handle) & ~vmker.stoinio) & vmker.stoimask) << vmker.stoihash) \
526                          ) & 0x000fffff) 
527
528     if (avc->vmh) {
529         unsigned int pagef, pri, index, next;
530
531         index = VMHASH(avc->vmh);
532         if (scb_valid(index)) {  /* could almost be an ASSERT */
533
534             pri = disable_ints();
535             for (pagef = scb_sidlist(index); pagef >= 0; pagef = next) {
536                 next = pft_sidfwd(pagef);
537                 if (pft_modbit(pagef)) {  /* has page frame been modified? */
538                     enable_ints(pri);
539                     return 1;
540                 }
541             }
542             enable_ints(pri);
543         }
544     }
545 #undef VMHASH
546 #endif
547 #endif /* AFS_AIX32_ENV */
548
549 #if defined (AFS_SUN_ENV)
550     if (avc->states & CMAPPED) {
551         struct page * pg;
552         for (pg = avc->v.v_s.v_Pages ; pg ; pg = pg->p_vpnext) {
553             if (pg->p_mod) {
554                 return 1;
555             }
556         }
557     }
558 #endif
559 return 0;
560 }
561 #endif /* notdef */
562
563
564 /*
565  * Solaris osi_ReleaseVM should not drop and re-obtain the vcache entry lock.
566  * This leads to bad races when osi_ReleaseVM() is called from
567  * afs_InvalidateAllSegments().
568
569  * We can do this because Solaris osi_VM_Truncate() doesn't care whether the
570  * vcache entry lock is held or not.
571  *
572  * For other platforms, in some cases osi_VM_Truncate() doesn't care, but
573  * there may be cases where it does care.  If so, it would be good to fix
574  * them so they don't care.  Until then, we assume the worst.
575  *
576  * Locking:  the vcache entry lock is held.  It is dropped and re-obtained.
577  */
578 void osi_ReleaseVM(struct vcache *avc, struct AFS_UCRED *acred)
579 {
580 #ifdef  AFS_SUN5_ENV
581     AFS_GUNLOCK();
582     osi_VM_Truncate(avc, 0, acred);
583     AFS_GLOCK();
584 #else
585     ReleaseWriteLock(&avc->lock);
586     AFS_GUNLOCK();
587     osi_VM_Truncate(avc, 0, acred);
588     AFS_GLOCK();
589     ObtainWriteLock(&avc->lock, 80);
590 #endif
591 }
592
593
594 void shutdown_osi(void)
595 {
596     AFS_STATCNT(shutdown_osi);
597     if (afs_cold_shutdown) {
598         LOCK_INIT(&afs_ftf, "afs_ftf"); 
599       }
600 }
601
602 int afs_osi_suser(void *credp) 
603 {
604 #ifdef AFS_SUN5_ENV
605   return afs_suser(credp);
606 #else
607   return afs_suser();
608 #endif
609 }
610
611 #if AFS_GCPAGS
612
613 /* afs_osi_TraverseProcTable() - Walk through the systems process
614  * table, calling afs_GCPAGs_perproc_func() for each process.
615  */
616
617 #if defined(AFS_SUN5_ENV)
618 void afs_osi_TraverseProcTable(void)
619 {
620     struct proc *prp;
621     for (prp = practive; prp != NULL; prp = prp->p_next) {
622         afs_GCPAGs_perproc_func(prp);
623     }
624 }
625 #endif
626
627 #if defined(AFS_HPUX_ENV)
628
629 /*
630  * NOTE: h/proc_private.h gives the process table locking rules
631  * It indicates that access to p_cred must be protected by
632  * mp_mtproc_lock(p);
633  * mp_mtproc_unlock(p);
634  *
635  * The code in sys/pm_prot.c uses pcred_lock() to protect access to
636  * the process creds, and uses mp_mtproc_lock() only for audit-related
637  * changes.  To be safe, we use both.
638  */
639
640 void afs_osi_TraverseProcTable(void)
641 {
642     register proc_t *p;
643     int endchain = 0;
644
645     MP_SPINLOCK(activeproc_lock);
646     MP_SPINLOCK(sched_lock);
647     pcred_lock();
648
649     /*
650      * Instead of iterating through all of proc[], traverse only
651      * the list of active processes.  As an example of this,
652      * see foreach_process() in sys/vm_sched.c.
653      *
654      * We hold the locks for the entire scan in order to get a
655      * consistent view of the current set of creds.
656      */
657
658     for(p = proc; endchain == 0; p = &proc[p->p_fandx]) {
659         if (p->p_fandx == 0) {
660             endchain = 1;
661         }
662
663         if (system_proc(p))
664             continue;
665
666         mp_mtproc_lock(p);
667         afs_GCPAGs_perproc_func(p);
668         mp_mtproc_unlock(p);
669     }
670
671     pcred_unlock();
672     MP_SPINUNLOCK(sched_lock);
673     MP_SPINUNLOCK(activeproc_lock);
674 }
675 #endif
676
677 #if defined(AFS_SGI_ENV)
678
679 #ifdef AFS_SGI65_ENV
680 /* TODO: Fix this later. */
681 static int SGI_ProcScanFunc(void *p, void *arg, int mode)
682 {
683     return 0;
684 }
685 #else   /* AFS_SGI65_ENV */
686 static int SGI_ProcScanFunc(proc_t *p, void *arg, int mode) 
687 {
688     afs_int32 (*perproc_func)(struct proc *) = arg;
689     int code=0;
690     /* we pass in the function pointer for arg,
691      * mode ==0 for startup call, ==1 for each valid proc, 
692      * and ==2 for terminate call.
693      */
694     if(mode == 1) {
695         code = perproc_func(p);
696     }
697     return code;
698 }
699 #endif  /* AFS_SGI65_ENV */
700
701 void afs_osi_TraverseProcTable(void)
702 {
703     procscan(SGI_ProcScanFunc, afs_GCPAGs_perproc_func);
704 }
705 #endif  /* AFS_SGI_ENV */
706
707 #if defined(AFS_AIX_ENV)
708 void afs_osi_TraverseProcTable(void)
709 {
710     struct proc *p;
711     int i;
712
713     /*
714      * For binary compatibility, on AIX we need to be careful to use the
715      * proper size of a struct proc, even if it is different from what
716      * we were compiled with.
717      */
718     if (!afs_gcpags_procsize)
719         return;
720
721     simple_lock(&proc_tbl_lock);
722     for (p = (struct proc *)v.vb_proc, i = 0;
723          p < max_proc;
724          p = (struct proc *)((char *)p + afs_gcpags_procsize), i++) {
725
726         if (p->p_stat == SNONE)
727             continue;
728         if (p->p_stat == SIDL)
729             continue;
730         if (p->p_stat == SEXIT)
731             continue;
732
733         /* sanity check */
734
735         if (PROCMASK(p->p_pid) != i) {
736             afs_gcpags = AFS_GCPAGS_EPIDCHECK;
737             break;
738         }
739
740         /* sanity check */
741
742         if ((p->p_nice < P_NICE_MIN) || (P_NICE_MAX < p->p_nice)) {
743             afs_gcpags = AFS_GCPAGS_ENICECHECK;
744             break;
745         }
746
747         afs_GCPAGs_perproc_func(p);
748     }
749     simple_unlock(&proc_tbl_lock);
750 }
751 #endif
752
753 #if defined(AFS_OSF_ENV)
754 void afs_osi_TraverseProcTable(void)
755 {
756     struct pid_entry *pe;
757 #ifdef AFS_DUX50_ENV
758 #define pidNPID (pidtab + npid)
759 #define PID_LOCK()
760 #define PID_UNLOCK()
761 #endif
762     PID_LOCK();
763     for (pe = pidtab; pe < pidNPID; ++pe) {
764        if (pe->pe_proc != PROC_NULL)
765           afs_GCPAGs_perproc_func(pe->pe_proc);
766     }
767     PID_UNLOCK();
768 }
769 #endif
770
771 #if defined(AFS_DARWIN_ENV) || defined(AFS_FBSD_ENV)
772 void afs_osi_TraverseProcTable(void)
773 {   
774     struct proc *p;
775     LIST_FOREACH(p, &allproc, p_list) {
776         if (p->p_stat == SIDL)
777             continue;
778         if (p->p_stat == SZOMB)
779             continue;
780         if (p->p_flag & P_SYSTEM)
781             continue;
782           afs_GCPAGs_perproc_func(p);
783     }
784 }   
785 #endif
786
787 #if defined(AFS_LINUX22_ENV)
788 void afs_osi_TraverseProcTable()
789 {   
790     struct task_struct *p;
791
792     read_lock(&tasklist_lock);
793     for_each_task(p) if (p->pid) {
794         if (p->state & TASK_ZOMBIE)
795             continue;
796         afs_GCPAGs_perproc_func(p);
797     }
798     read_unlock(&tasklist_lock);
799 }   
800 #endif
801
802 /* return a pointer (sometimes a static copy ) to the cred for a
803  * given AFS_PROC.
804  * subsequent calls may overwrite the previously returned value.
805  */
806
807 #if defined(AFS_SGI65_ENV)
808 const struct AFS_UCRED *afs_osi_proc2cred(AFS_PROC *p)
809 {
810     return NULL;
811 }
812 #elif defined(AFS_HPUX_ENV)
813 const struct AFS_UCRED *afs_osi_proc2cred(AFS_PROC *p)
814 {
815     if (!p)
816         return;
817
818     /*
819      * Cannot use afs_warnuser() here, as the code path
820      * eventually wants to grab sched_lock, which is
821      * already held here
822      */
823
824     return p_cred(p);
825 }
826 #elif defined(AFS_AIX_ENV)
827
828 /* GLOBAL DECLARATIONS */
829
830 /*
831  * LOCKS: the caller must do
832  *  simple_lock(&proc_tbl_lock);
833  *  simple_unlock(&proc_tbl_lock);
834  * around calls to this function.
835  */
836
837 const struct AFS_UCRED *afs_osi_proc2cred(AFS_PROC *pproc)
838 {
839     struct AFS_UCRED *pcred = 0;
840
841     /*
842      * pointer to process user structure valid in *our*
843      * address space
844      *
845      * The user structure for a process is stored in the user
846      * address space (as distinct from the kernel address
847      * space), and so to refer to the user structure of a
848      * different process we must employ special measures.
849      *
850      * I followed the example used in the AIX getproc() system
851      * call in bos/kernel/proc/getproc.c
852      */
853     struct user *xmem_userp;
854
855     struct xmem dp;             /* ptr to xmem descriptor */
856     int xm;                     /* xmem result */
857
858     if (!pproc) {
859         return pcred;
860     }
861
862     /*
863      * The process private segment in which the user
864      * area is located may disappear. We need to increment
865      * its use count. Therefore we
866      *    - get the proc_tbl_lock to hold the segment.
867      *    - get the p_lock to lockout vm_cleardata.
868      *    - vm_att to load the segment register (no check)
869      *    - xmattach to bump its use count.
870      *    - release the p_lock.
871      *    - release the proc_tbl_lock.
872      *    - do whatever we need.
873      *    - xmdetach to decrement the use count.
874      *    - vm_det to free the segment register (no check)
875      */
876
877     xmem_userp = NULL;
878     xm = XMEM_FAIL;
879     /* simple_lock(&proc_tbl_lock); */
880     if (pproc->p_adspace != NULLSEGVAL) {
881
882         simple_lock(&pproc->p_lock);
883
884         if (pproc->p_threadcount &&
885             pproc->p_threadlist) {
886
887             /*
888              * arbitrarily pick the first thread in pproc
889              */
890             struct thread *pproc_thread =
891                 pproc->p_threadlist;
892
893             /*
894              * location of 'struct user' in pproc's
895              * address space
896              */
897             struct user *pproc_userp =
898                 pproc_thread->t_userp;
899
900             /*
901              * create a pointer valid in my own address space
902              */
903
904             xmem_userp =
905                 (struct user *)vm_att(pproc->p_adspace,
906                                       pproc_userp);
907
908             dp.aspace_id = XMEM_INVAL;
909             xm = xmattach(xmem_userp,
910                           sizeof(*xmem_userp),
911                           &dp, SYS_ADSPACE);
912         }
913
914         simple_unlock(&pproc->p_lock);
915     }
916     /* simple_unlock(&proc_tbl_lock); */
917     if (xm == XMEM_SUCC) {
918
919         static struct AFS_UCRED cred;
920
921         /*
922          * What locking should we use to protect access to the user
923          * area?  If needed also change the code in AIX/osi_groups.c.
924          */
925
926         /* copy cred to local address space */
927         cred = *xmem_userp->U_cred;
928         pcred = &cred;
929
930         xmdetach(&dp);
931     }
932     if (xmem_userp) {
933         vm_det((void *)xmem_userp);
934     }
935
936     return pcred;
937 }
938
939 #elif defined(AFS_OSF_ENV)
940 const struct AFS_UCRED *afs_osi_proc2cred(AFS_PROC *pr)
941 {
942     struct AFS_UCRED *rv=NULL;
943
944     if(pr == NULL) {
945        return NULL;
946     }
947
948     if((pr->p_stat == SSLEEP) ||
949        (pr->p_stat == SRUN) ||
950        (pr->p_stat == SSTOP)) 
951        rv = pr->p_rcred;
952
953     return rv;
954 }
955 #elif defined(AFS_DARWIN_ENV) || defined(AFS_FBSD_ENV)
956 const struct AFS_UCRED *afs_osi_proc2cred(AFS_PROC *pr)
957 {   
958     struct AFS_UCRED *rv=NULL;
959     static struct AFS_UCRED cr;
960
961     if(pr == NULL) {
962        return NULL;
963     }
964    
965     if((pr->p_stat == SSLEEP) ||
966        (pr->p_stat == SRUN) ||
967        (pr->p_stat == SSTOP)) {
968        pcred_readlock(pr);
969        cr.cr_ref=1;
970        cr.cr_uid=pr->p_cred->pc_ucred->cr_uid;
971        cr.cr_ngroups=pr->p_cred->pc_ucred->cr_ngroups;
972        memcpy(cr.cr_groups, pr->p_cred->pc_ucred->cr_groups, NGROUPS *
973              sizeof(gid_t));
974        pcred_unlock(pr);
975        rv = &cr;
976     }
977     
978     return rv;
979 }  
980 #elif defined(AFS_LINUX22_ENV)
981 const struct AFS_UCRED *afs_osi_proc2cred(AFS_PROC *pr)
982 {   
983     struct AFS_UCRED *rv=NULL;
984     static struct AFS_UCRED cr;
985
986     if(pr == NULL) {
987        return NULL;
988     }
989    
990     if ((pr->state == TASK_RUNNING) ||
991         (pr->state == TASK_INTERRUPTIBLE) ||
992         (pr->state == TASK_UNINTERRUPTIBLE) ||
993         (pr->state == TASK_STOPPED)) {
994         cr.cr_ref=1;
995         cr.cr_uid=pr->uid;
996         cr.cr_ngroups=pr->ngroups;
997         memcpy(cr.cr_groups, pr->groups, NGROUPS * sizeof(gid_t));
998         rv = &cr;
999     }
1000     
1001     return rv;
1002 }  
1003 #else
1004 const struct AFS_UCRED *afs_osi_proc2cred(AFS_PROC *pr)
1005 {
1006     struct AFS_UCRED *rv=NULL;
1007
1008     if(pr == NULL) {
1009        return NULL;
1010     }
1011     rv = pr->p_cred;          
1012
1013     return rv;
1014 }
1015 #endif
1016
1017 #endif  /* AFS_GCPAGS */