share/man/man4/netdump.4

   1 .\"-
   2 .\" Copyright (c) 2018 Mark Johnston <markj@FreeBSD.org>
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd June 8, 2018
  28 .Dt NETDUMP 4
  29 .Os
  30 .Sh NAME
  31 .Nm netdump
  32 .Nd protocol for transmitting kernel dumps to a remote server
  33 .Sh SYNOPSIS
  34 To compile netdump client support into the kernel, place the following line in
  35 your kernel configuration file:
  36 .Bd -ragged -offset indent
  37 .Cd "options NETDUMP"
  38 .Ed
  39 .Sh DESCRIPTION
  40 netdump is a UDP-based protocol for transmitting kernel dumps to a remote host.
  41 A netdump client is a panicking kernel, and a netdump server is a host
  42 running the
  43 .Nm
  44 daemon, available in ports as
  45 .Pa ports/ftp/netdumpd .
  46 .Nm
  47 clients are configured using the
  48 .Xr dumpon 8
  49 utility.
  50 .Pp
  51 .Nm
  52 client messages consist of a fixed-size header followed by a variable-sized
  53 payload.
  54 The header contains the message type, a sequence number, the offset of
  55 the payload data in the kernel dump, and the length of the payload data
  56 (not including the header).
  57 The message types are
  58 .Dv HERALD , FINISHED , KDH , VMCORE ,
  59 and
  60 .Dv EKCD_KEY .
  61 .Nm
  62 server messages have a fixed size and contain only the sequence number of
  63 the client message.
  64 These messages indicate that the server has successfully processed the
  65 client message with the corresponding sequence number.
  66 All client messages are acknowledged this way.
  67 Server messages are always sent to port 20024 of the client.
  68 .Pp
  69 To initiate a
  70 .Nm ,
  71 the client sends a
  72 .Dv HERALD
  73 message to the server at port 20023.
  74 The client may include a relative path in its payload, in which case the
  75 .Nm
  76 server should attempt to save the dump at that path relative to its configured
  77 dump directory.
  78 The server will acknowledge the
  79 .Dv HERALD
  80 using a random source port, and the client must send all subsequent messages
  81 to that port.
  82 .Pp
  83 The
  84 .Dv KDH , VMCORE ,
  85 and
  86 .Dv EKCD_KEY
  87 message payloads contain the kernel dump header, dump contents, and
  88 dump encryption key respectively.
  89 The offset in the message header should be treated as a seek offset
  90 in the corresponding file.
  91 There are no ordering requirements for these messages.
  92 .Pp
  93 A
  94 .Nm
  95 is completed by sending the
  96 .Dv FINISHED
  97 message to the server.
  98 .Pp
  99 The following network drivers support netdump:
 100 .Xr alc 4 ,
 101 .Xr bge 4 ,
 102 .Xr bnxt 4 ,
 103 .Xr bxe 4 ,
 104 .Xr cxgb 4 ,
 105 .Xr em 4 ,
 106 .Xr igb 4 ,
 107 .Xr ix 4 ,
 108 .Xr re 4 ,
 109 .Xr vtnet 4 .
 110 .Sh SYSCTL VARIABLES
 111 The following variables are available as both
 112 .Xr sysctl 8
 113 variables and
 114 .Xr loader 8
 115 variables:
 116 .Bl -tag -width "indent"
 117 .It Va net.netdump.debug
 118 Control debug message verbosity.
 119 Debug messages are disabled by default, but are useful when troubleshooting
 120 or when developing driver support.
 121 .It Va net.netdump.path
 122 Specify a path relative to the server's dump directory in which to store
 123 the dump.
 124 For example, if the
 125 .Nm
 126 server is configured to store dumps in
 127 .Pa /var/crash ,
 128 a path of
 129 .Dq foo
 130 will cause the server to attempt to store dumps from the client in
 131 .Pa /var/crash/foo .
 132 The server will not automatically create the relative directory.
 133 .El
 134 .Sh SEE ALSO
 135 .Xr decryptcore 8 ,
 136 .Xr dumpon 8 ,
 137 .Xr savecore 8
 138 .Sh HISTORY
 139 .Nm
 140 client support first appeared in
 141 .Fx 12.0 .
 142 .Sh BUGS
 143 Only IPv4 is supported.
 144 .Pp
 145 .Nm
 146 may only be used after the kernel has panicked.