Start consolidating process related code into kern_proc.c. Implement
[dragonfly.git] / sys / kern / kern_exit.c
1 /*
2  * Copyright (c) 1982, 1986, 1989, 1991, 1993
3  *      The Regents of the University of California.  All rights reserved.
4  * (c) UNIX System Laboratories, Inc.
5  * All or some portions of this file are derived from material licensed
6  * to the University of California by American Telephone and Telegraph
7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8  * the permission of UNIX System Laboratories, Inc.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *      This product includes software developed by the University of
21  *      California, Berkeley and its contributors.
22  * 4. Neither the name of the University nor the names of its contributors
23  *    may be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  *
38  *      @(#)kern_exit.c 8.7 (Berkeley) 2/12/94
39  * $FreeBSD: src/sys/kern/kern_exit.c,v 1.92.2.11 2003/01/13 22:51:16 dillon Exp $
40  * $DragonFly: src/sys/kern/kern_exit.c,v 1.56 2006/05/24 17:44:02 dillon Exp $
41  */
42
43 #include "opt_compat.h"
44 #include "opt_ktrace.h"
45
46 #include <sys/param.h>
47 #include <sys/systm.h>
48 #include <sys/sysproto.h>
49 #include <sys/kernel.h>
50 #include <sys/malloc.h>
51 #include <sys/proc.h>
52 #include <sys/ktrace.h>
53 #include <sys/pioctl.h>
54 #include <sys/tty.h>
55 #include <sys/wait.h>
56 #include <sys/vnode.h>
57 #include <sys/resourcevar.h>
58 #include <sys/signalvar.h>
59 #include <sys/ptrace.h>
60 #include <sys/acct.h>           /* for acct_process() function prototype */
61 #include <sys/filedesc.h>
62 #include <sys/shm.h>
63 #include <sys/sem.h>
64 #include <sys/aio.h>
65 #include <sys/jail.h>
66 #include <sys/kern_syscall.h>
67 #include <sys/upcall.h>
68 #include <sys/caps.h>
69
70 #include <vm/vm.h>
71 #include <vm/vm_param.h>
72 #include <sys/lock.h>
73 #include <vm/pmap.h>
74 #include <vm/vm_map.h>
75 #include <vm/vm_zone.h>
76 #include <vm/vm_extern.h>
77 #include <sys/user.h>
78
79 #include <sys/thread2.h>
80
81 static MALLOC_DEFINE(M_ATEXIT, "atexit", "atexit callback");
82 static MALLOC_DEFINE(M_ZOMBIE, "zombie", "zombie proc status");
83
84 /*
85  * callout list for things to do at exit time
86  */
87 struct exitlist {
88         exitlist_fn function;
89         TAILQ_ENTRY(exitlist) next;
90 };
91
92 TAILQ_HEAD(exit_list_head, exitlist);
93 static struct exit_list_head exit_list = TAILQ_HEAD_INITIALIZER(exit_list);
94
95 /*
96  * exit --
97  *      Death of process.
98  *
99  * SYS_EXIT_ARGS(int rval)
100  */
101 void
102 sys_exit(struct sys_exit_args *uap)
103 {
104         exit1(W_EXITCODE(uap->rval, 0));
105         /* NOTREACHED */
106 }
107
108 /*
109  * Exit: deallocate address space and other resources, change proc state
110  * to zombie, and unlink proc from allproc and parent's lists.  Save exit
111  * status and rusage for wait().  Check for child processes and orphan them.
112  */
113 void
114 exit1(int rv)
115 {
116         struct proc *p = curproc;
117         struct lwp *lp;
118         struct proc *q, *nq;
119         struct vmspace *vm;
120         struct vnode *vtmp;
121         struct exitlist *ep;
122
123         if (p->p_pid == 1) {
124                 printf("init died (signal %d, exit %d)\n",
125                     WTERMSIG(rv), WEXITSTATUS(rv));
126                 panic("Going nowhere without my init!");
127         }
128
129         lp = &p->p_lwp;         /* XXX lwp kill other threads */
130
131         sysmsg_rundown(lp, 1);
132         caps_exit(lp->lwp_thread);
133         aio_proc_rundown(p);
134
135         /* are we a task leader? */
136         if(p == p->p_leader) {
137                 struct kill_args killArgs;
138                 killArgs.signum = SIGKILL;
139                 q = p->p_peers;
140                 while(q) {
141                         killArgs.pid = q->p_pid;
142                         /*
143                          * The interface for kill is better
144                          * than the internal signal
145                          */
146                         kill(&killArgs);
147                         nq = q;
148                         q = q->p_peers;
149                 }
150                 while (p->p_peers) 
151                   tsleep((caddr_t)p, 0, "exit1", 0);
152         } 
153
154 #ifdef PGINPROF
155         vmsizmon();
156 #endif
157         STOPEVENT(p, S_EXIT, rv);
158         wakeup(&p->p_stype);    /* Wakeup anyone in procfs' PIOCWAIT */
159
160         /* 
161          * Check if any loadable modules need anything done at process exit.
162          * e.g. SYSV IPC stuff
163          * XXX what if one of these generates an error?
164          */
165         TAILQ_FOREACH(ep, &exit_list, next) 
166                 (*ep->function)(p->p_thread);
167
168         if (p->p_flag & P_PROFIL)
169                 stopprofclock(p);
170         MALLOC(p->p_ru, struct rusage *, sizeof(struct rusage),
171                 M_ZOMBIE, M_WAITOK);
172         /*
173          * If parent is waiting for us to exit or exec,
174          * P_PPWAIT is set; we will wakeup the parent below.
175          */
176         p->p_flag &= ~(P_TRACED | P_PPWAIT);
177         p->p_flag |= P_WEXIT;
178         SIGEMPTYSET(p->p_siglist);
179         if (timevalisset(&p->p_realtimer.it_value))
180                 callout_stop(&p->p_ithandle);
181
182         /*
183          * Reset any sigio structures pointing to us as a result of
184          * F_SETOWN with our pid.
185          */
186         funsetownlst(&p->p_sigiolst);
187
188         /*
189          * Close open files and release open-file table.
190          * This may block!
191          */
192         fdfree(p);
193         p->p_fd = NULL;
194
195         if(p->p_leader->p_peers) {
196                 q = p->p_leader;
197                 while(q->p_peers != p)
198                         q = q->p_peers;
199                 q->p_peers = p->p_peers;
200                 wakeup((caddr_t)p->p_leader);
201         }
202
203         /*
204          * XXX Shutdown SYSV semaphores
205          */
206         semexit(p);
207
208         KKASSERT(p->p_numposixlocks == 0);
209
210         /* The next two chunks should probably be moved to vmspace_exit. */
211         vm = p->p_vmspace;
212
213         /*
214          * Release upcalls associated with this process
215          */
216         if (vm->vm_upcalls)
217                 upc_release(vm, &p->p_lwp);
218
219         /*
220          * Release user portion of address space.
221          * This releases references to vnodes,
222          * which could cause I/O if the file has been unlinked.
223          * Need to do this early enough that we can still sleep.
224          * Can't free the entire vmspace as the kernel stack
225          * may be mapped within that space also.
226          *
227          * Processes sharing the same vmspace may exit in one order, and
228          * get cleaned up by vmspace_exit() in a different order.  The
229          * last exiting process to reach this point releases as much of
230          * the environment as it can, and the last process cleaned up
231          * by vmspace_exit() (which decrements exitingcnt) cleans up the
232          * remainder.
233          */
234         ++vm->vm_exitingcnt;
235         if (--vm->vm_refcnt == 0) {
236                 shmexit(vm);
237                 pmap_remove_pages(vmspace_pmap(vm), VM_MIN_ADDRESS,
238                     VM_MAXUSER_ADDRESS);
239                 (void) vm_map_remove(&vm->vm_map, VM_MIN_ADDRESS,
240                     VM_MAXUSER_ADDRESS);
241         }
242
243         if (SESS_LEADER(p)) {
244                 struct session *sp = p->p_session;
245                 struct vnode *vp;
246
247                 if (sp->s_ttyvp) {
248                         /*
249                          * We are the controlling process.  Signal the 
250                          * foreground process group, drain the controlling
251                          * terminal, and revoke access to the controlling
252                          * terminal.
253                          *
254                          * NOTE: while waiting for the process group to exit
255                          * it is possible that one of the processes in the
256                          * group will revoke the tty, so we have to recheck.
257                          */
258                         if (sp->s_ttyp && (sp->s_ttyp->t_session == sp)) {
259                                 if (sp->s_ttyp->t_pgrp)
260                                         pgsignal(sp->s_ttyp->t_pgrp, SIGHUP, 1);
261                                 (void) ttywait(sp->s_ttyp);
262                                 /*
263                                  * The tty could have been revoked
264                                  * if we blocked.
265                                  */
266                                 if ((vp = sp->s_ttyvp) != NULL) {
267                                         ttyclosesession(sp, 0);
268                                         if (vx_lock(vp) == 0) {
269                                                 VOP_REVOKE(vp, REVOKEALL);
270                                                 vx_unlock(vp);
271                                         }
272                                         vrele(vp);      /* s_ttyvp ref */
273                                 }
274                         }
275                         /*
276                          * Release the tty.  If someone has it open via
277                          * /dev/tty then close it (since they no longer can
278                          * once we've NULL'd it out).
279                          */
280                         if (sp->s_ttyvp)
281                                 ttyclosesession(sp, 1);
282                         /*
283                          * s_ttyp is not zero'd; we use this to indicate
284                          * that the session once had a controlling terminal.
285                          * (for logging and informational purposes)
286                          */
287                 }
288                 sp->s_leader = NULL;
289         }
290         fixjobc(p, p->p_pgrp, 0);
291         (void)acct_process(p);
292 #ifdef KTRACE
293         /*
294          * release trace file
295          */
296         if (p->p_tracenode)
297                 ktrdestroy(&p->p_tracenode);
298         p->p_traceflag = 0;
299 #endif
300         /*
301          * Release reference to text vnode
302          */
303         if ((vtmp = p->p_textvp) != NULL) {
304                 p->p_textvp = NULL;
305                 vrele(vtmp);
306         }
307
308         /*
309          * Move the process to the zombie list.  This will block
310          * until the process p_lock count reaches 0.  The process will
311          * not be reaped until TDF_EXITING is set by cpu_thread_exit(),
312          * which is called from cpu_proc_exit().
313          */
314         proc_move_allproc_zombie(p);
315
316         q = LIST_FIRST(&p->p_children);
317         if (q)          /* only need this if any child is S_ZOMB */
318                 wakeup((caddr_t) initproc);
319         for (; q != 0; q = nq) {
320                 nq = LIST_NEXT(q, p_sibling);
321                 LIST_REMOVE(q, p_sibling);
322                 LIST_INSERT_HEAD(&initproc->p_children, q, p_sibling);
323                 q->p_pptr = initproc;
324                 q->p_sigparent = SIGCHLD;
325                 /*
326                  * Traced processes are killed
327                  * since their existence means someone is screwing up.
328                  */
329                 if (q->p_flag & P_TRACED) {
330                         q->p_flag &= ~P_TRACED;
331                         psignal(q, SIGKILL);
332                 }
333         }
334
335         /*
336          * Save exit status and final rusage info, adding in child rusage
337          * info and self times.
338          */
339         p->p_xstat = rv;
340         *p->p_ru = p->p_stats->p_ru;
341         calcru(p, &p->p_ru->ru_utime, &p->p_ru->ru_stime, NULL);
342         ruadd(p->p_ru, &p->p_stats->p_cru);
343
344         /*
345          * notify interested parties of our demise.
346          */
347         KNOTE(&p->p_klist, NOTE_EXIT);
348
349         /*
350          * Notify parent that we're gone.  If parent has the PS_NOCLDWAIT
351          * flag set, notify process 1 instead (and hope it will handle
352          * this situation).
353          */
354         if (p->p_pptr->p_procsig->ps_flag & PS_NOCLDWAIT) {
355                 struct proc *pp = p->p_pptr;
356                 proc_reparent(p, initproc);
357                 /*
358                  * If this was the last child of our parent, notify
359                  * parent, so in case he was wait(2)ing, he will
360                  * continue.
361                  */
362                 if (LIST_EMPTY(&pp->p_children))
363                         wakeup((caddr_t)pp);
364         }
365
366         if (p->p_sigparent && p->p_pptr != initproc) {
367                 psignal(p->p_pptr, p->p_sigparent);
368         } else {
369                 psignal(p->p_pptr, SIGCHLD);
370         }
371
372         wakeup((caddr_t)p->p_pptr);
373         /*
374          * cpu_exit is responsible for clearing curproc, since
375          * it is heavily integrated with the thread/switching sequence.
376          *
377          * Other substructures are freed from wait().
378          */
379         plimit_free(&p->p_limit);
380
381         /*
382          * Release the current user process designation on the process so
383          * the userland scheduler can work in someone else.
384          */
385         p->p_usched->release_curproc(lp);
386
387         /*
388          * Finally, call machine-dependent code to release the remaining
389          * resources including address space, the kernel stack and pcb.
390          * The address space is released by "vmspace_free(p->p_vmspace)";
391          * This is machine-dependent, as we may have to change stacks
392          * or ensure that the current one isn't reallocated before we
393          * finish.  cpu_exit will end with a call to cpu_switch(), finishing
394          * our execution (pun intended).
395          */
396         cpu_proc_exit();
397 }
398
399 int
400 wait4(struct wait_args *uap)
401 {
402         struct rusage rusage;
403         int error, status;
404
405         error = kern_wait(uap->pid, uap->status ? &status : NULL,
406             uap->options, uap->rusage ? &rusage : NULL, &uap->sysmsg_fds[0]);
407
408         if (error == 0 && uap->status)
409                 error = copyout(&status, uap->status, sizeof(*uap->status));
410         if (error == 0 && uap->rusage)
411                 error = copyout(&rusage, uap->rusage, sizeof(*uap->rusage));
412         return (error);
413 }
414
415 /*
416  * wait1()
417  *
418  * wait_args(int pid, int *status, int options, struct rusage *rusage)
419  */
420 int
421 kern_wait(pid_t pid, int *status, int options, struct rusage *rusage, int *res)
422 {
423         struct thread *td = curthread;
424         struct proc *q = td->td_proc;
425         struct proc *p, *t;
426         int nfound, error;
427
428         if (pid == 0)
429                 pid = -q->p_pgid;
430         if (options &~ (WUNTRACED|WNOHANG|WLINUXCLONE))
431                 return (EINVAL);
432 loop:
433         /*
434          * Hack for backwards compatibility with badly written user code.  
435          * Or perhaps we have to do this anyway, it is unclear. XXX
436          *
437          * The problem is that if a process group is stopped and the parent
438          * is doing a wait*(..., WUNTRACED, ...), it will see the STOP
439          * of the child and then stop itself when it tries to return from the
440          * system call.  When the process group is resumed the parent will
441          * then get the STOP status even though the child has now resumed
442          * (a followup wait*() will get the CONT status).
443          *
444          * Previously the CONT would overwrite the STOP because the tstop
445          * was handled within tsleep(), and the parent would only see
446          * the CONT when both are stopped and continued together.  This litte
447          * two-line hack restores this effect.
448          */
449         while (q->p_flag & P_STOPPED)  
450             tstop(q);
451
452         nfound = 0;
453         LIST_FOREACH(p, &q->p_children, p_sibling) {
454                 if (pid != WAIT_ANY &&
455                     p->p_pid != pid && p->p_pgid != -pid)
456                         continue;
457
458                 /* This special case handles a kthread spawned by linux_clone 
459                  * (see linux_misc.c).  The linux_wait4 and linux_waitpid 
460                  * functions need to be able to distinguish between waiting
461                  * on a process and waiting on a thread.  It is a thread if
462                  * p_sigparent is not SIGCHLD, and the WLINUXCLONE option
463                  * signifies we want to wait for threads and not processes.
464                  */
465                 if ((p->p_sigparent != SIGCHLD) ^ 
466                     ((options & WLINUXCLONE) != 0)) {
467                         continue;
468                 }
469
470                 nfound++;
471                 if (p->p_flag & P_ZOMBIE) {
472                         /*
473                          * Other kernel threads may be in the middle of 
474                          * accessing the proc.  For example, kern/kern_proc.c
475                          * could be blocked writing proc data to a sysctl.
476                          * At the moment, if this occurs, we are not woken
477                          * up and rely on a one-second retry.
478                          */
479                         if (p->p_lock) {
480                                 while (p->p_lock)
481                                         tsleep(p, 0, "reap3", hz);
482                         }
483                         lwkt_wait_free(p->p_thread);
484
485                         /*
486                          * The process's thread may still be in the middle
487                          * of switching away, we can't rip its stack out from
488                          * under it until TDF_EXITING is set and both
489                          * TDF_RUNNING and TDF_PREEMPT_LOCK are clear.
490                          * TDF_PREEMPT_LOCK must be checked because TDF_RUNNING
491                          * will be cleared temporarily if a thread gets
492                          * preempted.
493                          *
494                          * YYY no wakeup occurs so we depend on the timeout.
495                          */
496                         if ((p->p_thread->td_flags & (TDF_RUNNING|TDF_PREEMPT_LOCK|TDF_EXITING)) != TDF_EXITING) {
497                                 tsleep(p->p_thread, 0, "reap2", 1);
498                                 goto loop;
499                         }
500
501                         /* scheduling hook for heuristic */
502                         p->p_usched->heuristic_exiting(td->td_lwp, &p->p_lwp);
503
504                         /* Take care of our return values. */
505                         *res = p->p_pid;
506                         if (status)
507                                 *status = p->p_xstat;
508                         if (rusage)
509                                 *rusage = *p->p_ru;
510                         /*
511                          * If we got the child via a ptrace 'attach',
512                          * we need to give it back to the old parent.
513                          */
514                         if (p->p_oppid && (t = pfind(p->p_oppid))) {
515                                 p->p_oppid = 0;
516                                 proc_reparent(p, t);
517                                 psignal(t, SIGCHLD);
518                                 wakeup((caddr_t)t);
519                                 return (0);
520                         }
521                         p->p_xstat = 0;
522                         ruadd(&q->p_stats->p_cru, p->p_ru);
523                         FREE(p->p_ru, M_ZOMBIE);
524                         p->p_ru = NULL;
525
526                         /*
527                          * Decrement the count of procs running with this uid.
528                          */
529                         chgproccnt(p->p_ucred->cr_ruidinfo, -1, 0);
530
531                         /*
532                          * Free up credentials.
533                          */
534                         crfree(p->p_ucred);
535                         p->p_ucred = NULL;
536
537                         /*
538                          * Remove unused arguments
539                          */
540                         if (p->p_args && --p->p_args->ar_ref == 0)
541                                 FREE(p->p_args, M_PARGS);
542
543                         /*
544                          * Finally finished with old proc entry.
545                          * Unlink it from its process group and free it.
546                          */
547                         leavepgrp(p);
548                         proc_remove_zombie(p);
549
550                         if (--p->p_procsig->ps_refcnt == 0) {
551                                 if (p->p_sigacts != &p->p_addr->u_sigacts)
552                                         FREE(p->p_sigacts, M_SUBPROC);
553                                 FREE(p->p_procsig, M_SUBPROC);
554                                 p->p_procsig = NULL;
555                         }
556
557                         vm_waitproc(p);
558                         zfree(proc_zone, p);
559                         nprocs--;
560                         return (0);
561                 }
562                 if ((p->p_flag & P_STOPPED) && (p->p_flag & P_WAITED) == 0 &&
563                     (p->p_flag & P_TRACED || options & WUNTRACED)) {
564                         p->p_flag |= P_WAITED;
565
566                         *res = p->p_pid;
567                         if (status)
568                                 *status = W_STOPCODE(p->p_xstat);
569                         /* Zero rusage so we get something consistent. */
570                         if (rusage)
571                                 bzero(rusage, sizeof(rusage));
572                         return (0);
573                 }
574         }
575         if (nfound == 0)
576                 return (ECHILD);
577         if (options & WNOHANG) {
578                 *res = 0;
579                 return (0);
580         }
581         error = tsleep((caddr_t)q, PCATCH, "wait", 0);
582         if (error)
583                 return (error);
584         goto loop;
585 }
586
587 /*
588  * make process 'parent' the new parent of process 'child'.
589  */
590 void
591 proc_reparent(struct proc *child, struct proc *parent)
592 {
593
594         if (child->p_pptr == parent)
595                 return;
596
597         LIST_REMOVE(child, p_sibling);
598         LIST_INSERT_HEAD(&parent->p_children, child, p_sibling);
599         child->p_pptr = parent;
600 }
601
602 /*
603  * The next two functions are to handle adding/deleting items on the
604  * exit callout list
605  * 
606  * at_exit():
607  * Take the arguments given and put them onto the exit callout list,
608  * However first make sure that it's not already there.
609  * returns 0 on success.
610  */
611
612 int
613 at_exit(exitlist_fn function)
614 {
615         struct exitlist *ep;
616
617 #ifdef INVARIANTS
618         /* Be noisy if the programmer has lost track of things */
619         if (rm_at_exit(function)) 
620                 printf("WARNING: exit callout entry (%p) already present\n",
621                     function);
622 #endif
623         ep = malloc(sizeof(*ep), M_ATEXIT, M_NOWAIT);
624         if (ep == NULL)
625                 return (ENOMEM);
626         ep->function = function;
627         TAILQ_INSERT_TAIL(&exit_list, ep, next);
628         return (0);
629 }
630
631 /*
632  * Scan the exit callout list for the given item and remove it.
633  * Returns the number of items removed (0 or 1)
634  */
635 int
636 rm_at_exit(exitlist_fn function)
637 {
638         struct exitlist *ep;
639
640         TAILQ_FOREACH(ep, &exit_list, next) {
641                 if (ep->function == function) {
642                         TAILQ_REMOVE(&exit_list, ep, next);
643                         free(ep, M_ATEXIT);
644                         return(1);
645                 }
646         }       
647         return (0);
648 }
649
650 void
651 check_sigacts(void)
652 {
653         struct proc *p = curproc;
654         struct sigacts *pss;
655
656         if (p->p_procsig->ps_refcnt == 1 &&
657             p->p_sigacts != &p->p_addr->u_sigacts) {
658                 pss = p->p_sigacts;
659                 crit_enter();
660                 p->p_addr->u_sigacts = *pss;
661                 p->p_sigacts = &p->p_addr->u_sigacts;
662                 crit_exit();
663                 FREE(pss, M_SUBPROC);
664         }
665 }
666