tasklist-lock-redux-20060922
[openafs.git] / src / afs / afs_osi_gcpags.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
14     ("$Header$");
15
16 #include "afs/sysincludes.h"    /* Standard vendor system headers */
17 #include "afsincludes.h"        /* Afs-based standard headers */
18 #include "afs/afs_stats.h"      /* afs statistics */
19 #ifdef AFS_AIX_ENV
20 #include <sys/adspace.h>        /* for vm_att(), vm_det() */
21 #endif
22
23 #if AFS_GCPAGS
24
25 /* afs_osi_TraverseProcTable() - Walk through the systems process
26  * table, calling afs_GCPAGs_perproc_func() for each process.
27  */
28
29 #if defined(AFS_SUN5_ENV)
30 void
31 afs_osi_TraverseProcTable(void)
32 {
33     struct proc *prp;
34     for (prp = practive; prp != NULL; prp = prp->p_next) {
35         afs_GCPAGs_perproc_func(prp);
36     }
37 }
38 #endif
39
40 #if defined(AFS_HPUX_ENV)
41
42 /*
43  * NOTE: h/proc_private.h gives the process table locking rules
44  * It indicates that access to p_cred must be protected by
45  * mp_mtproc_lock(p);
46  * mp_mtproc_unlock(p);
47  *
48  * The code in sys/pm_prot.c uses pcred_lock() to protect access to
49  * the process creds, and uses mp_mtproc_lock() only for audit-related
50  * changes.  To be safe, we use both.
51  */
52
53 void
54 afs_osi_TraverseProcTable(void)
55 {
56     register proc_t *p;
57     int endchain = 0;
58
59     MP_SPINLOCK(activeproc_lock);
60     MP_SPINLOCK(sched_lock);
61     pcred_lock();
62
63     /*
64      * Instead of iterating through all of proc[], traverse only
65      * the list of active processes.  As an example of this,
66      * see foreach_process() in sys/vm_sched.c.
67      *
68      * We hold the locks for the entire scan in order to get a
69      * consistent view of the current set of creds.
70      */
71
72     for (p = proc; endchain == 0; p = &proc[p->p_fandx]) {
73         if (p->p_fandx == 0) {
74             endchain = 1;
75         }
76
77         if (system_proc(p))
78             continue;
79
80         mp_mtproc_lock(p);
81         afs_GCPAGs_perproc_func(p);
82         mp_mtproc_unlock(p);
83     }
84
85     pcred_unlock();
86     MP_SPINUNLOCK(sched_lock);
87     MP_SPINUNLOCK(activeproc_lock);
88 }
89 #endif
90
91 #if defined(AFS_SGI_ENV)
92
93 #ifdef AFS_SGI65_ENV
94 /* TODO: Fix this later. */
95 static int
96 SGI_ProcScanFunc(void *p, void *arg, int mode)
97 {
98     return 0;
99 }
100 #else /* AFS_SGI65_ENV */
101 static int
102 SGI_ProcScanFunc(proc_t * p, void *arg, int mode)
103 {
104     afs_int32(*perproc_func) (struct proc *) = arg;
105     int code = 0;
106     /* we pass in the function pointer for arg,
107      * mode ==0 for startup call, ==1 for each valid proc,
108      * and ==2 for terminate call.
109      */
110     if (mode == 1) {
111         code = perproc_func(p);
112     }
113     return code;
114 }
115 #endif /* AFS_SGI65_ENV */
116
117 void
118 afs_osi_TraverseProcTable(void)
119 {
120     procscan(SGI_ProcScanFunc, afs_GCPAGs_perproc_func);
121 }
122 #endif /* AFS_SGI_ENV */
123
124 #if defined(AFS_AIX_ENV)
125 #ifdef AFS_AIX51_ENV
126 #define max_proc v.ve_proc
127 #endif
128 void
129 afs_osi_TraverseProcTable(void)
130 {
131     struct proc *p;
132     int i;
133
134     /*
135      * For binary compatibility, on AIX we need to be careful to use the
136      * proper size of a struct proc, even if it is different from what
137      * we were compiled with.
138      */
139     if (!afs_gcpags_procsize)
140         return;
141
142 #ifndef AFS_AIX51_ENV
143     simple_lock(&proc_tbl_lock);
144 #endif
145     for (p = (struct proc *)v.vb_proc, i = 0; p < max_proc;
146          p = (struct proc *)((char *)p + afs_gcpags_procsize), i++) {
147
148 #ifdef AFS_AIX51_ENV
149         if (p->p_pvprocp->pv_stat == SNONE)
150             continue;
151         if (p->p_pvprocp->pv_stat == SIDL)
152             continue;
153         if (p->p_pvprocp->pv_stat == SEXIT)
154             continue;
155 #else
156         if (p->p_stat == SNONE)
157             continue;
158         if (p->p_stat == SIDL)
159             continue;
160         if (p->p_stat == SEXIT)
161             continue;
162 #endif
163
164         /* sanity check */
165
166         if (PROCMASK(p->p_pid) != i) {
167             afs_gcpags = AFS_GCPAGS_EPIDCHECK;
168             break;
169         }
170
171         /* sanity check */
172
173         if ((p->p_nice < P_NICE_MIN) || (P_NICE_MAX < p->p_nice)) {
174             afs_gcpags = AFS_GCPAGS_ENICECHECK;
175             break;
176         }
177
178         afs_GCPAGs_perproc_func(p);
179     }
180 #ifndef AFS_AIX51_ENV
181     simple_unlock(&proc_tbl_lock);
182 #endif
183 }
184 #endif
185
186 #if defined(AFS_OSF_ENV)
187
188 #ifdef AFS_DUX50_ENV
189 extern struct pid_entry *pidtab;
190 extern int npid; 
191 #endif
192
193 void
194 afs_osi_TraverseProcTable(void)
195 {
196     struct pid_entry *pe;
197 #ifdef AFS_DUX50_ENV
198 #define pidNPID (pidtab + npid)
199 #define PID_LOCK()
200 #define PID_UNLOCK()
201 #endif
202     PID_LOCK();
203     for (pe = pidtab; pe < pidNPID; ++pe) {
204         if (pe->pe_proc != PROC_NULL)
205             afs_GCPAGs_perproc_func(pe->pe_proc);
206     }
207     PID_UNLOCK();
208 }
209 #endif
210
211 #if (defined(AFS_DARWIN_ENV) && !defined(AFS_DARWIN80_ENV)) || defined(AFS_FBSD_ENV)
212 void
213 afs_osi_TraverseProcTable(void)
214 {
215     struct proc *p;
216     LIST_FOREACH(p, &allproc, p_list) {
217         if (p->p_stat == SIDL)
218             continue;
219         if (p->p_stat == SZOMB)
220             continue;
221         if (p->p_flag & P_SYSTEM)
222             continue;
223         afs_GCPAGs_perproc_func(p);
224     }
225 }
226 #endif
227
228 #if defined(AFS_LINUX22_ENV)
229 extern rwlock_t tasklist_lock __attribute__((weak));
230 void
231 afs_osi_TraverseProcTable()
232 {
233     struct task_struct *p;
234     if (&tasklist_lock)
235        read_lock(&tasklist_lock);
236 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,16)
237     else
238         rcu_read_lock();
239 #endif
240
241 #ifdef DEFINED_FOR_EACH_PROCESS
242     for_each_process(p) if (p->pid) {
243 #ifdef STRUCT_TASK_STRUCT_HAS_EXIT_STATE
244         if (p->exit_state)
245             continue;
246 #else
247         if (p->state & TASK_ZOMBIE)
248             continue;
249 #endif
250         afs_GCPAGs_perproc_func(p);
251     }
252 #else
253     for_each_task(p) if (p->pid) {
254 #ifdef STRUCT_TASK_STRUCT_HAS_EXIT_STATE
255         if (p->exit_state)
256             continue;
257 #else
258         if (p->state & TASK_ZOMBIE)
259             continue;
260 #endif
261         afs_GCPAGs_perproc_func(p);
262     }
263 #endif
264     if (&tasklist_lock)
265        read_unlock(&tasklist_lock);
266 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,16)
267     else
268         rcu_read_unlock();
269 #endif
270 }
271 #endif
272
273 /* return a pointer (sometimes a static copy ) to the cred for a
274  * given AFS_PROC.
275  * subsequent calls may overwrite the previously returned value.
276  */
277
278 #if defined(AFS_SGI65_ENV)
279 const struct AFS_UCRED *
280 afs_osi_proc2cred(AFS_PROC * p)
281 {
282     return NULL;
283 }
284 #elif defined(AFS_HPUX_ENV)
285 const struct AFS_UCRED *
286 afs_osi_proc2cred(AFS_PROC * p)
287 {
288     if (!p)
289         return;
290
291     /*
292      * Cannot use afs_warnuser() here, as the code path
293      * eventually wants to grab sched_lock, which is
294      * already held here
295      */
296
297     return p_cred(p);
298 }
299 #elif defined(AFS_AIX_ENV)
300
301 /* GLOBAL DECLARATIONS */
302
303 /*
304  * LOCKS: the caller must do
305  *  simple_lock(&proc_tbl_lock);
306  *  simple_unlock(&proc_tbl_lock);
307  * around calls to this function.
308  */
309
310 const struct AFS_UCRED *
311 afs_osi_proc2cred(AFS_PROC * pproc)
312 {
313     struct AFS_UCRED *pcred = 0;
314
315     /*
316      * pointer to process user structure valid in *our*
317      * address space
318      *
319      * The user structure for a process is stored in the user
320      * address space (as distinct from the kernel address
321      * space), and so to refer to the user structure of a
322      * different process we must employ special measures.
323      *
324      * I followed the example used in the AIX getproc() system
325      * call in bos/kernel/proc/getproc.c
326      */
327     struct user *xmem_userp;
328
329     struct xmem dp;             /* ptr to xmem descriptor */
330     int xm;                     /* xmem result */
331
332     if (!pproc) {
333         return pcred;
334     }
335
336     /*
337      * The process private segment in which the user
338      * area is located may disappear. We need to increment
339      * its use count. Therefore we
340      *    - get the proc_tbl_lock to hold the segment.
341      *    - get the p_lock to lockout vm_cleardata.
342      *    - vm_att to load the segment register (no check)
343      *    - xmattach to bump its use count.
344      *    - release the p_lock.
345      *    - release the proc_tbl_lock.
346      *    - do whatever we need.
347      *    - xmdetach to decrement the use count.
348      *    - vm_det to free the segment register (no check)
349      */
350
351     xmem_userp = NULL;
352     xm = XMEM_FAIL;
353     /* simple_lock(&proc_tbl_lock); */
354 #ifdef __64BIT__
355     if (pproc->p_adspace != vm_handle(NULLSEGID, (int32long64_t) 0)) {
356 #else
357     if (pproc->p_adspace != NULLSEGVAL) {
358 #endif
359
360 #ifdef AFS_AIX51_ENV
361         simple_lock(&pproc->p_pvprocp->pv_lock);
362 #else
363         simple_lock(&pproc->p_lock);
364 #endif
365
366         if (pproc->p_threadcount &&
367 #ifdef AFS_AIX51_ENV
368             pproc->p_pvprocp->pv_threadlist) {
369 #else
370             pproc->p_threadlist) {
371 #endif
372
373             /*
374              * arbitrarily pick the first thread in pproc
375              */
376             struct thread *pproc_thread =
377 #ifdef AFS_AIX51_ENV
378                 pproc->p_pvprocp->pv_threadlist;
379 #else
380                 pproc->p_threadlist;
381 #endif
382
383             /*
384              * location of 'struct user' in pproc's
385              * address space
386              */
387             struct user *pproc_userp = pproc_thread->t_userp;
388
389             /*
390              * create a pointer valid in my own address space
391              */
392
393             xmem_userp = (struct user *)vm_att(pproc->p_adspace, pproc_userp);
394
395             dp.aspace_id = XMEM_INVAL;
396             xm = xmattach(xmem_userp, sizeof(*xmem_userp), &dp, SYS_ADSPACE);
397         }
398
399 #ifdef AFS_AIX51_ENV
400         simple_unlock(&pproc->p_pvprocp->pv_lock);
401 #else
402         simple_unlock(&pproc->p_lock);
403 #endif
404     }
405     /* simple_unlock(&proc_tbl_lock); */
406     if (xm == XMEM_SUCC) {
407
408         static struct AFS_UCRED cred;
409
410         /*
411          * What locking should we use to protect access to the user
412          * area?  If needed also change the code in AIX/osi_groups.c.
413          */
414
415         /* copy cred to local address space */
416         cred = *xmem_userp->U_cred;
417         pcred = &cred;
418
419         xmdetach(&dp);
420     }
421     if (xmem_userp) {
422         vm_det((void *)xmem_userp);
423     }
424
425     return pcred;
426 }
427
428 #elif defined(AFS_OSF_ENV)
429 const struct AFS_UCRED *
430 afs_osi_proc2cred(AFS_PROC * pr)
431 {
432     struct AFS_UCRED *rv = NULL;
433
434     if (pr == NULL) {
435         return NULL;
436     }
437
438     if ((pr->p_stat == SSLEEP) || (pr->p_stat == SRUN)
439         || (pr->p_stat == SSTOP))
440         rv = pr->p_rcred;
441
442     return rv;
443 }
444 #elif defined(AFS_DARWIN80_ENV) 
445 const struct AFS_UCRED *
446 afs_osi_proc2cred(AFS_PROC * pr)
447 {
448     struct AFS_UCRED *rv = NULL;
449     static struct AFS_UCRED cr;
450     struct ucred *pcred;
451
452     if (pr == NULL) {
453         return NULL;
454     }
455     pcred = proc_ucred(pr);
456     cr.cr_ref = 1;
457     cr.cr_uid = pcred->cr_uid;
458     cr.cr_ngroups = pcred->cr_ngroups;
459     memcpy(cr.cr_groups, pcred->cr_groups,
460            NGROUPS * sizeof(gid_t));
461     return &cr;
462 }
463 #elif defined(AFS_DARWIN_ENV) || defined(AFS_FBSD_ENV)
464 const struct AFS_UCRED *
465 afs_osi_proc2cred(AFS_PROC * pr)
466 {
467     struct AFS_UCRED *rv = NULL;
468     static struct AFS_UCRED cr;
469
470     if (pr == NULL) {
471         return NULL;
472     }
473
474     if ((pr->p_stat == SSLEEP) || (pr->p_stat == SRUN)
475         || (pr->p_stat == SSTOP)) {
476         pcred_readlock(pr);
477         cr.cr_ref = 1;
478         cr.cr_uid = pr->p_cred->pc_ucred->cr_uid;
479         cr.cr_ngroups = pr->p_cred->pc_ucred->cr_ngroups;
480         memcpy(cr.cr_groups, pr->p_cred->pc_ucred->cr_groups,
481                NGROUPS * sizeof(gid_t));
482         pcred_unlock(pr);
483         rv = &cr;
484     }
485
486     return rv;
487 }
488 #elif defined(AFS_LINUX22_ENV)
489 const struct AFS_UCRED *
490 afs_osi_proc2cred(AFS_PROC * pr)
491 {
492     struct AFS_UCRED *rv = NULL;
493     static struct AFS_UCRED cr;
494
495     if (pr == NULL) {
496         return NULL;
497     }
498
499     if ((pr->state == TASK_RUNNING) || (pr->state == TASK_INTERRUPTIBLE)
500         || (pr->state == TASK_UNINTERRUPTIBLE)
501         || (pr->state == TASK_STOPPED)) {
502         cr.cr_ref = 1;
503         cr.cr_uid = pr->uid;
504 #if defined(AFS_LINUX26_ENV)
505         get_group_info(pr->group_info);
506         cr.cr_group_info = pr->group_info;
507 #else
508         cr.cr_ngroups = pr->ngroups;
509         memcpy(cr.cr_groups, pr->groups, NGROUPS * sizeof(gid_t));
510 #endif
511         rv = &cr;
512     }
513
514     return rv;
515 }
516 #else
517 const struct AFS_UCRED *
518 afs_osi_proc2cred(AFS_PROC * pr)
519 {
520     struct AFS_UCRED *rv = NULL;
521
522     if (pr == NULL) {
523         return NULL;
524     }
525     rv = pr->p_cred;
526
527     return rv;
528 }
529 #endif
530
531 #endif /* AFS_GCPAGS */