| textdump.4 (209031) | textdump.4 (242424) |
|---|---|
| 1.\" 2.\" Copyright (c) 2007 Robert N. M. Watson 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright --- 11 unchanged lines hidden (view full) --- 20.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 21.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 22.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 23.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 26.\" DAMAGE. 27.\" | 1.\" 2.\" Copyright (c) 2007 Robert N. M. Watson 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright --- 11 unchanged lines hidden (view full) --- 20.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 21.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 22.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 23.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 26.\" DAMAGE. 27.\" |
| 28.\" $FreeBSD: head/share/man/man4/textdump.4 209031 2010-06-11 06:03:47Z uqs $ | 28.\" $FreeBSD: head/share/man/man4/textdump.4 242424 2012-11-01 04:07:08Z alfred $ |
| 29.\" 30.Dd December 24, 2008 31.Dt TEXTDUMP 4 32.Os 33.Sh NAME 34.Nm textdump 35.Nd textdump kernel dumping facility 36.Sh SYNOPSIS 37.Cd options KDB 38.Cd options DDB | 29.\" 30.Dd December 24, 2008 31.Dt TEXTDUMP 4 32.Os 33.Sh NAME 34.Nm textdump 35.Nd textdump kernel dumping facility 36.Sh SYNOPSIS 37.Cd options KDB 38.Cd options DDB |
| 39 40.Cd options TEXTDUMP_VERBOSE 41.Cd options TEXTDUMP_PREFERRED |
|
| 39.Sh DESCRIPTION 40The 41.Nm 42facility allows the capture of kernel debugging information to disk in a 43human-readable rather than the machine-readable form normally used with 44kernel memory dumps and minidumps. 45This representation, while less complete in that it does not capture full 46kernel state, can provide debugging information in a more compact, portable, --- 63 unchanged lines hidden (view full) --- 110dump will be regular memory dumps; however, by using the 111.Ic textdump set 112command in 113.Xr ddb 4 , 114or by setting the 115.Dv debug.ddb.textdump.pending 116sysctl to 1 using 117.Xr sysctl 8 , | 42.Sh DESCRIPTION 43The 44.Nm 45facility allows the capture of kernel debugging information to disk in a 46human-readable rather than the machine-readable form normally used with 47kernel memory dumps and minidumps. 48This representation, while less complete in that it does not capture full 49kernel state, can provide debugging information in a more compact, portable, --- 63 unchanged lines hidden (view full) --- 113dump will be regular memory dumps; however, by using the 114.Ic textdump set 115command in 116.Xr ddb 4 , 117or by setting the 118.Dv debug.ddb.textdump.pending 119sysctl to 1 using 120.Xr sysctl 8 , |
| 118it is possible to request that the next dump be a textdump. | 121it is possible to request that the next dump be a textdump. One can 122also directly trigger a textdump in 123.Xr ddb 4 124by running the command 125.Ic textdump dump . |
| 119.Pp 120If at the 121.Xr ddb 4 122command line, the commands 123.Ic textdump set , 124.Ic textdump status , 125and 126.Ic textdump unset 127may be used to set, query, and clear the textdump pending flag. | 126.Pp 127If at the 128.Xr ddb 4 129command line, the commands 130.Ic textdump set , 131.Ic textdump status , 132and 133.Ic textdump unset 134may be used to set, query, and clear the textdump pending flag. |
| 135The command 136.Ic textdump dump 137can be used to immediately trigger a textdump. |
|
| 128.Pp 129As with regular kernel dumps, a dump partition must be automatically or 130manually configured using 131.Xr dumpon 8 . | 138.Pp 139As with regular kernel dumps, a dump partition must be automatically or 140manually configured using 141.Xr dumpon 8 . |
| 142.Pp 143Additional kernel 144.Xr config 8 145options: 146.Bl -tag -width TEXTDUMP_PREFERRED 147.It Cd TEXTDUMP_PREFERRED 148sets textdumps to be the default manner of doing dumps. This means there 149will be no need to 150.Xr sysctl 8 151or use the 152.Cr textdump set 153.Xr ddb 8 154commands. 155.It Cd TEXTDUMP_VERBOSE 156will have the textdump facility be more verbose about each file it is emitting 157as well as other diagnostics useful to debug the textdump facility itself. 158.El |
|
| 132.Sh EXAMPLES 133In the following example, the script 134.Dv kdb.enter.panic 135will run when the kernel debugger is entered as a result of a panic, enable 136output capture, dump several useful pieces of debugging information, and then 137invoke panic in order to force a kernel dump to be written out followed by a 138reboot: 139.Bd -literal -offset indent --- 33 unchanged lines hidden --- | 159.Sh EXAMPLES 160In the following example, the script 161.Dv kdb.enter.panic 162will run when the kernel debugger is entered as a result of a panic, enable 163output capture, dump several useful pieces of debugging information, and then 164invoke panic in order to force a kernel dump to be written out followed by a 165reboot: 166.Bd -literal -offset indent --- 33 unchanged lines hidden --- |