2 * Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
29 * File: bsd/kern/kern_shutdown.c
31 * Copyright (C) 1989, NeXT, Inc.
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/kernel.h>
39 #include <sys/proc_internal.h>
41 #include <sys/reboot.h>
43 #include <sys/vnode_internal.h>
44 #include <sys/file_internal.h>
45 #include <sys/clist.h>
46 #include <sys/callout.h>
48 #include <sys/msgbuf.h>
49 #include <sys/ioctl.h>
50 #include <sys/signal.h>
52 #include <kern/task.h>
53 #include <sys/quota.h>
54 #include <vm/vm_kern.h>
55 #include <mach/vm_param.h>
56 #include <sys/filedesc.h>
57 #include <mach/host_priv.h>
58 #include <mach/host_reboot.h>
60 #include <security/audit/audit.h>
62 #include <kern/sched_prim.h> /* for thread_block() */
63 #include <kern/host.h> /* for host_priv_self() */
64 #include <net/if_var.h> /* for if_down_all() */
65 #include <sys/buf_internal.h> /* for count_busy_buffers() */
66 #include <sys/mount_internal.h> /* for vfs_unmountall() */
67 #include <mach/task.h> /* for task_suspend() */
68 #include <sys/sysproto.h> /* abused for sync() */
69 #include <kern/clock.h> /* for delay_for_interval() */
70 #include <libkern/OSAtomic.h>
71 #include <IOKit/IOPlatformExpert.h>
73 #include <sys/kdebug.h>
75 uint32_t system_inshutdown
= 0;
77 /* XXX should be in a header file somewhere, but isn't */
78 extern void (*unmountroot_pre_hook
)(void);
80 unsigned int proc_shutdown_exitcount
= 0;
82 static int sd_openlog(vfs_context_t
);
83 static int sd_closelog(vfs_context_t
);
84 static void sd_log(vfs_context_t
, const char *, ...);
85 static void proc_shutdown(void);
86 static void zprint_panic_info(void);
87 extern void halt_log_enter(const char * what
, const void * pc
, uint64_t time
);
89 #if DEVELOPMENT || DEBUG
90 extern boolean_t
kdp_has_polled_corefile(void);
91 #endif /* DEVELOPMENT || DEBUG */
93 struct sd_filterargs
{
100 int signo
; /* the signal to be posted */
101 int setsdstate
; /* shutdown state to be set */
102 int countproc
; /* count processes on action */
103 int activecount
; /* number of processes on which action was done */
106 static vnode_t sd_logvp
= NULLVP
;
107 static off_t sd_log_offset
= 0;
110 static int sd_filt1(proc_t
, void *);
111 static int sd_filt2(proc_t
, void *);
112 static int sd_callback1(proc_t p
, void * arg
);
113 static int sd_callback2(proc_t p
, void * arg
);
114 static int sd_callback3(proc_t p
, void * arg
);
116 extern boolean_t panic_include_zprint
;
117 extern mach_memory_info_t
*panic_kext_memory_info
;
118 extern vm_size_t panic_kext_memory_size
;
121 zprint_panic_info(void)
123 unsigned int num_sites
;
126 panic_include_zprint
= TRUE
;
127 panic_kext_memory_info
= NULL
;
128 panic_kext_memory_size
= 0;
130 num_sites
= vm_page_diagnose_estimate();
131 panic_kext_memory_size
= num_sites
* sizeof(panic_kext_memory_info
[0]);
133 kr
= kmem_alloc(kernel_map
, (vm_offset_t
*)&panic_kext_memory_info
, round_page(panic_kext_memory_size
), VM_KERN_MEMORY_OSFMK
);
134 if (kr
!= KERN_SUCCESS
) {
135 panic_kext_memory_info
= NULL
;
139 vm_page_diagnose(panic_kext_memory_info
, num_sites
, 0);
143 get_system_inshutdown()
145 return system_inshutdown
;
149 panic_kernel(int howto
, char *message
)
151 if ((howto
& RB_PANIC_ZPRINT
) == RB_PANIC_ZPRINT
) {
154 panic("userspace panic: %s", message
);
158 reboot_kernel(int howto
, char *message
)
160 int hostboot_option
= 0;
163 if ((howto
& (RB_PANIC
| RB_QUICK
)) == (RB_PANIC
| RB_QUICK
)) {
164 panic_kernel(howto
, message
);
167 if (!OSCompareAndSwap(0, 1, &system_inshutdown
)) {
168 if ((howto
& RB_QUICK
) == RB_QUICK
) {
174 * Notify the power management root domain that the system will shut down.
176 IOSystemShutdownNotification(kIOSystemShutdownNotificationStageProcessExit
);
178 if ((howto
& RB_QUICK
) == RB_QUICK
) {
179 printf("Quick reboot...\n");
180 if ((howto
& RB_NOSYNC
) == 0) {
181 sync((proc_t
)NULL
, (void *)NULL
, (int *)NULL
);
183 } else if ((howto
& RB_NOSYNC
) == 0) {
186 printf("syncing disks... ");
189 * Release vnodes held by texts before sync.
192 /* handle live procs (deallocate their root and current directories), suspend initproc */
194 startTime
= mach_absolute_time();
196 halt_log_enter("proc_shutdown", 0, mach_absolute_time() - startTime
);
199 startTime
= mach_absolute_time();
201 halt_log_enter("audit_shutdown", 0, mach_absolute_time() - startTime
);
204 if (unmountroot_pre_hook
!= NULL
) {
205 unmountroot_pre_hook();
208 startTime
= mach_absolute_time();
209 sync((proc_t
)NULL
, (void *)NULL
, (int *)NULL
);
212 startTime
= mach_absolute_time();
213 kdbg_dump_trace_to_file("/var/log/shutdown/shutdown.trace");
214 halt_log_enter("shutdown.trace", 0, mach_absolute_time() - startTime
);
217 IOSystemShutdownNotification(kIOSystemShutdownNotificationStageRootUnmount
);
220 * Unmount filesystems
223 #if DEVELOPMENT || DEBUG
224 if (!(howto
& RB_PANIC
) || !kdp_has_polled_corefile())
225 #endif /* DEVELOPMENT || DEBUG */
227 startTime
= mach_absolute_time();
229 halt_log_enter("vfs_unmountall", 0, mach_absolute_time() - startTime
);
232 /* Wait for the buffer cache to clean remaining dirty buffers */
233 startTime
= mach_absolute_time();
234 for (iter
= 0; iter
< 100; iter
++) {
235 nbusy
= count_busy_buffers();
239 printf("%d ", nbusy
);
240 delay_for_interval( 1 * nbusy
, 1000 * 1000);
243 printf("giving up\n");
247 halt_log_enter("bufferclean", 0, mach_absolute_time() - startTime
);
251 * Can't just use an splnet() here to disable the network
252 * because that will lock out softints which the disk
253 * drivers depend on to finish DMAs.
255 startTime
= mach_absolute_time();
257 halt_log_enter("if_down_all", 0, mach_absolute_time() - startTime
);
258 #endif /* NETWORKING */
262 if (howto
& RB_PANIC
) {
263 panic_kernel(howto
, message
);
266 if (howto
& RB_POWERDOWN
) {
267 hostboot_option
= HOST_REBOOT_HALT
;
269 if (howto
& RB_HALT
) {
270 hostboot_option
= HOST_REBOOT_HALT
;
273 if (howto
& RB_UPSDELAY
) {
274 hostboot_option
= HOST_REBOOT_UPSDELAY
;
277 host_reboot(host_priv_self(), hostboot_option
);
279 * should not be reached
285 sd_openlog(vfs_context_t ctx
)
290 /* Open shutdown log */
291 if ((error
= vnode_open(PROC_SHUTDOWN_LOG
, (O_CREAT
| FWRITE
| O_NOFOLLOW
), 0644, 0, &sd_logvp
, ctx
))) {
292 printf("Failed to open %s: error %d\n", PROC_SHUTDOWN_LOG
, error
);
297 vnode_setsize(sd_logvp
, (off_t
)0, 0, ctx
);
299 /* Write a little header */
301 sd_log(ctx
, "Process shutdown log. Current time is %lu (in seconds).\n\n", tv
.tv_sec
);
307 sd_closelog(vfs_context_t ctx
)
310 if (sd_logvp
!= NULLVP
) {
311 VNOP_FSYNC(sd_logvp
, MNT_WAIT
, ctx
);
312 error
= vnode_close(sd_logvp
, FWRITE
, ctx
);
319 sd_log(vfs_context_t ctx
, const char *fmt
, ...)
321 int resid
, log_error
, len
;
325 /* If the log isn't open yet, open it */
326 if (sd_logvp
== NULLVP
) {
327 if (sd_openlog(ctx
) != 0) {
328 /* Couldn't open, we fail out */
333 va_start(arglist
, fmt
);
334 len
= vsnprintf(logbuf
, sizeof(logbuf
), fmt
, arglist
);
335 log_error
= vn_rdwr(UIO_WRITE
, sd_logvp
, (caddr_t
)logbuf
, len
, sd_log_offset
,
336 UIO_SYSSPACE
, IO_UNIT
| IO_NOAUTH
, vfs_context_ucred(ctx
), &resid
, vfs_context_proc(ctx
));
337 if (log_error
== EIO
|| log_error
== 0) {
338 sd_log_offset
+= (len
- resid
);
345 sd_filt1(proc_t p
, void * args
)
347 proc_t self
= current_proc();
348 struct sd_filterargs
* sf
= (struct sd_filterargs
*)args
;
349 int delayterm
= sf
->delayterm
;
350 int shutdownstate
= sf
->shutdownstate
;
352 if (((p
->p_flag
& P_SYSTEM
) != 0) || (p
->p_ppid
== 0)
353 || (p
== self
) || (p
->p_stat
== SZOMB
)
354 || (p
->p_shutdownstate
!= shutdownstate
)
355 || ((delayterm
== 0) && ((p
->p_lflag
& P_LDELAYTERM
) == P_LDELAYTERM
))
356 || ((p
->p_sigcatch
& sigmask(SIGTERM
)) == 0)) {
365 sd_callback1(proc_t p
, void * args
)
367 struct sd_iterargs
* sd
= (struct sd_iterargs
*)args
;
368 int signo
= sd
->signo
;
369 int setsdstate
= sd
->setsdstate
;
370 int countproc
= sd
->countproc
;
373 p
->p_shutdownstate
= setsdstate
;
374 if (p
->p_stat
!= SZOMB
) {
376 if (countproc
!= 0) {
378 p
->p_listflag
|= P_LIST_EXITCOUNT
;
379 proc_shutdown_exitcount
++;
384 if (countproc
!= 0) {
391 return PROC_RETURNED
;
395 sd_filt2(proc_t p
, void * args
)
397 proc_t self
= current_proc();
398 struct sd_filterargs
* sf
= (struct sd_filterargs
*)args
;
399 int delayterm
= sf
->delayterm
;
400 int shutdownstate
= sf
->shutdownstate
;
402 if (((p
->p_flag
& P_SYSTEM
) != 0) || (p
->p_ppid
== 0)
403 || (p
== self
) || (p
->p_stat
== SZOMB
)
404 || (p
->p_shutdownstate
== shutdownstate
)
405 || ((delayterm
== 0) && ((p
->p_lflag
& P_LDELAYTERM
) == P_LDELAYTERM
))) {
413 sd_callback2(proc_t p
, void * args
)
415 struct sd_iterargs
* sd
= (struct sd_iterargs
*)args
;
416 int signo
= sd
->signo
;
417 int setsdstate
= sd
->setsdstate
;
418 int countproc
= sd
->countproc
;
421 p
->p_shutdownstate
= setsdstate
;
422 if (p
->p_stat
!= SZOMB
) {
424 if (countproc
!= 0) {
426 p
->p_listflag
|= P_LIST_EXITCOUNT
;
427 proc_shutdown_exitcount
++;
431 if (countproc
!= 0) {
438 return PROC_RETURNED
;
442 sd_callback3(proc_t p
, void * args
)
444 struct sd_iterargs
* sd
= (struct sd_iterargs
*)args
;
445 vfs_context_t ctx
= vfs_context_current();
447 int setsdstate
= sd
->setsdstate
;
450 p
->p_shutdownstate
= setsdstate
;
451 if (p
->p_stat
!= SZOMB
) {
453 * NOTE: following code ignores sig_lock and plays
454 * with exit_thread correctly. This is OK unless we
455 * are a multiprocessor, in which case I do not
456 * understand the sig_lock. This needs to be fixed.
459 if (p
->exit_thread
) { /* someone already doing it */
461 /* give him a chance */
462 thread_block(THREAD_CONTINUE_NULL
);
464 p
->exit_thread
= current_thread();
467 sd_log(ctx
, "%s[%d] had to be forced closed with exit1().\n", p
->p_comm
, p
->p_pid
);
470 KERNEL_DEBUG_CONSTANT(BSDDBG_CODE(DBG_BSD_PROC
, BSD_PROC_FRCEXIT
) | DBG_FUNC_NONE
,
471 p
->p_pid
, 0, 1, 0, 0);
473 exit1(p
, 1, (int *)NULL
);
479 return PROC_RETURNED
;
486 * Shutdown down proc system (release references to current and root
487 * dirs for each process).
489 * POSIX modifications:
491 * For POSIX fcntl() file locking call vno_lockrelease() on
492 * the file to release all of its record locks, if any.
498 vfs_context_t ctx
= vfs_context_current();
499 struct proc
*p
, *self
;
501 struct sd_filterargs sfargs
;
502 struct sd_iterargs sdargs
;
507 * Kill as many procs as we can. (Except ourself...)
509 self
= (struct proc
*)current_proc();
512 * Signal the init with SIGTERM so that he does not launch
516 if (p
&& p
!= self
) {
521 printf("Killing all processes ");
525 * send SIGTERM to those procs interested in catching one
527 sfargs
.delayterm
= delayterm
;
528 sfargs
.shutdownstate
= 0;
529 sdargs
.signo
= SIGTERM
;
530 sdargs
.setsdstate
= 1;
531 sdargs
.countproc
= 1;
532 sdargs
.activecount
= 0;
535 /* post a SIGTERM to all that catch SIGTERM and not marked for delay */
536 proc_rebootscan(sd_callback1
, (void *)&sdargs
, sd_filt1
, (void *)&sfargs
);
538 if (sdargs
.activecount
!= 0 && proc_shutdown_exitcount
!= 0) {
540 if (proc_shutdown_exitcount
!= 0) {
542 * now wait for up to 3 seconds to allow those procs catching SIGTERM
544 * as soon as these procs have exited, we'll continue on to the next step
548 error
= msleep(&proc_shutdown_exitcount
, proc_list_mlock
, PWAIT
, "shutdownwait", &ts
);
550 for (p
= allproc
.lh_first
; p
; p
= p
->p_list
.le_next
) {
551 if ((p
->p_listflag
& P_LIST_EXITCOUNT
) == P_LIST_EXITCOUNT
) {
552 p
->p_listflag
&= ~P_LIST_EXITCOUNT
;
555 for (p
= zombproc
.lh_first
; p
; p
= p
->p_list
.le_next
) {
556 if ((p
->p_listflag
& P_LIST_EXITCOUNT
) == P_LIST_EXITCOUNT
) {
557 p
->p_listflag
&= ~P_LIST_EXITCOUNT
;
564 if (error
== ETIMEDOUT
) {
566 * log the names of the unresponsive tasks
571 for (p
= allproc
.lh_first
; p
; p
= p
->p_list
.le_next
) {
572 if (p
->p_shutdownstate
== 1) {
573 printf("%s[%d]: didn't act on SIGTERM\n", p
->p_comm
, p
->p_pid
);
574 sd_log(ctx
, "%s[%d]: didn't act on SIGTERM\n", p
->p_comm
, p
->p_pid
);
582 * send a SIGKILL to all the procs still hanging around
584 sfargs
.delayterm
= delayterm
;
585 sfargs
.shutdownstate
= 2;
586 sdargs
.signo
= SIGKILL
;
587 sdargs
.setsdstate
= 2;
588 sdargs
.countproc
= 1;
589 sdargs
.activecount
= 0;
591 /* post a SIGKILL to all that catch SIGTERM and not marked for delay */
592 proc_rebootscan(sd_callback2
, (void *)&sdargs
, sd_filt2
, (void *)&sfargs
);
596 if (sdargs
.activecount
!= 0 && proc_shutdown_exitcount
!= 0) {
598 if (proc_shutdown_exitcount
!= 0) {
600 * wait for up to 60 seconds to allow these procs to exit normally
602 * History: The delay interval was changed from 100 to 200
603 * for NFS requests in particular.
607 error
= msleep(&proc_shutdown_exitcount
, proc_list_mlock
, PWAIT
, "shutdownwait", &ts
);
609 for (p
= allproc
.lh_first
; p
; p
= p
->p_list
.le_next
) {
610 if ((p
->p_listflag
& P_LIST_EXITCOUNT
) == P_LIST_EXITCOUNT
) {
611 p
->p_listflag
&= ~P_LIST_EXITCOUNT
;
614 for (p
= zombproc
.lh_first
; p
; p
= p
->p_list
.le_next
) {
615 if ((p
->p_listflag
& P_LIST_EXITCOUNT
) == P_LIST_EXITCOUNT
) {
616 p
->p_listflag
&= ~P_LIST_EXITCOUNT
;
624 if (error
== ETIMEDOUT
) {
626 * log the names of the unresponsive tasks
631 for (p
= allproc
.lh_first
; p
; p
= p
->p_list
.le_next
) {
632 if (p
->p_shutdownstate
== 2) {
633 printf("%s[%d]: didn't act on SIGKILL\n", p
->p_comm
, p
->p_pid
);
634 sd_log(ctx
, "%s[%d]: didn't act on SIGKILL\n", p
->p_comm
, p
->p_pid
);
642 * if we still have procs that haven't exited, then brute force 'em
644 sfargs
.delayterm
= delayterm
;
645 sfargs
.shutdownstate
= 3;
647 sdargs
.setsdstate
= 3;
648 sdargs
.countproc
= 0;
649 sdargs
.activecount
= 0;
653 /* post a SIGTERM to all that catch SIGTERM and not marked for delay */
654 proc_rebootscan(sd_callback3
, (void *)&sdargs
, sd_filt2
, (void *)&sfargs
);
657 /* Now start the termination of processes that are marked for delayed termn */
658 if (delayterm
== 0) {
666 * Now that all other processes have been terminated, suspend init
668 task_suspend_internal(initproc
->task
);
670 /* drop the ref on initproc */
672 printf("continuing\n");