d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Import the netdump client code.

Browse Source 
This is a component of a system which lets the kernel dump core to
a remote host after a panic, rather than to a local storage device.
The server component is available in the ports tree. netdump is
particularly useful on diskless systems.

The netdump(4) man page contains some details describing the protocol.
Support for configuring netdump will be added to dumpon(8) in a future
commit. To use netdump, the kernel must have been compiled with the
NETDUMP option.

The initial revision of netdump was written by Darrell Anderson and
was integrated into Sandvine's OS, from which this version was derived.

Reviewed by:	bdrewery, cem (earlier versions), julian, sbruno
MFC after:	1 month
X-MFC note:	use a spare field in struct ifnet
Sponsored by:	Dell EMC Isilon
Differential Revision:	https://reviews.freebsd.org/D15253
This commit is contained in:
Mark Johnston 2018-05-06 00:38:29 +00:00
parent bd92e6b6f5
commit e505460228
11 changed files with 1575 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
etc/mtree/BSD.include.dist
View File

@ -290,6 +290,8 @@
netinet
cc
..
netdump
..
..
netinet6
..

1
include/Makefile
View File

@ -56,6 +56,7 @@ LSUBDIRS= cam/ata cam/mmc cam/nvme cam/scsi \
net/altq \
netgraph/atm netgraph/netflow \
netinet/cc \
netinet/netdump \
security/audit \
security/mac_biba security/mac_bsdextended security/mac_lomac \
security/mac_mls security/mac_partition \

1
share/man/man4/Makefile
View File

@ -319,6 +319,7 @@ MAN= aac.4 \
ncv.4 \
${_ndis.4} \
net80211.4 \
netdump.4 \
netfpga10g_nf10bmac.4 \
netgraph.4 \
netintro.4 \

127
share/man/man4/netdump.4 Normal file
View File

@ -0,0 +1,127 @@
.\"-
.\" Copyright (c) 2018 Mark Johnston <markj@FreeBSD.org>
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd May 4, 2018
.Dt NETDUMP 4
.Os
.Sh NAME
.Nm netdump
.Nd protocol for transmitting kernel dumps to a remote server
.Sh SYNOPSIS
To compile netdump client support into the kernel, place the following line in
your kernel configuration file:
.Bd -ragged -offset indent
.Cd "options NETDUMP"
.Ed
.Pp
Debug output can be enabled by adding the following line:
.Bd -ragged -offset indent
.Cd "options NETDUMP_DEBUG"
.Ed
.Sh DESCRIPTION
netdump is a UDP-based protocol for transmitting kernel dumps to a remote host.
A netdump client is a panicking kernel, and a netdump server is a host
running the
.Nm
daemon, available in ports as
.Pa ports/ftp/netdumpd .
.Nm
clients are configured using the
.Xr dumpon 8
utility.
.Pp
.Nm
client messages consist of a fixed-size header followed by a variable-sized
payload.
The header contains the message type, a sequence number, the offset of
the payload data in the kernel dump, and the length of the payload data
(not including the header).
The message types are
.Dv HERALD , FINISHED , KDH , VMCORE ,
and
.Dv EKCD_KEY .
.Nm
server messages have a fixed size and contain only the sequence number of
the client message.
These messages indicate that the server has successfully processed the
client message with the corresponding sequence number.
All client messages are acknowledged this way.
Server messages are always sent to port 20024 of the client.
.Pp
To initiate a
.Nm ,
the client sends a
.Dv HERALD
message to the server at port 20023.
The client may include a relative path in its payload, in which case the
.Nm
server should attempt to save the dump at that path relative to its configured
dump directory.
The server will acknowledge the
.Dv HERALD
using a random source port, and the client must send all subsequent messages
to that port.
.Pp
The
.Dv KDH , VMCORE ,
and
.Dv EKCD_KEY
message payloads contain the kernel dump header, dump contents, and
dump encryption key respectively.
The offset in the message header should be treated as a seek offset
in the corresponding file.
There are no ordering requirements for these messages.
.Pp
A
.Nm
is completed by sending the
.Dv FINISHED
message to the server.
.Pp
The following network drivers support netdump:
.Xr alc 4 ,
.Xr bge 4 ,
.Xr bxe 4 ,
.Xr cxgb 4 ,
.Xr em 4 ,
.Xr igb 4 ,
.Xr ix 4 ,
.Xr mlx4en 4 ,
.Xr re 4 ,
.Xr vtnet 4 .
.Sh SEE ALSO
.Xr decryptcore 8 ,
.Xr dumpon 8 ,
.Xr savecore 8
.Sh HISTORY
.Nm
client support first appeared in
.Fx 12.0 .
.Sh BUGS
Only IPv4 is supported.
.Pp
.Nm
may only be used after the kernel has panicked.

4
sys/conf/NOTES
View File

@ -1025,6 +1025,10 @@ options TCP_SIGNATURE #include support for RFC 2385
# a smooth scheduling of the traffic.
options DUMMYNET
# The NETDUMP option enables netdump(4) client support in the kernel.
# This allows a panicking kernel to transmit a kernel dump to a remote host.
options NETDUMP
#####################################################################
# FILESYSTEM OPTIONS

1
sys/conf/files
View File

@ -4372,6 +4372,7 @@ netinet/libalias/alias_mod.c optional libalias | netgraph_nat
netinet/libalias/alias_proxy.c optional libalias inet | netgraph_nat inet
netinet/libalias/alias_util.c optional libalias inet | netgraph_nat inet
netinet/libalias/alias_sctp.c optional libalias inet | netgraph_nat inet
netinet/netdump/netdump_client.c optional inet netdump
netinet6/dest6.c optional inet6
netinet6/frag6.c optional inet6
netinet6/icmp6.c optional inet6

3
sys/conf/options
View File

@ -313,6 +313,9 @@ NFS_ROOT opt_nfsroot.h
# SMB/CIFS requester
NETSMB opt_netsmb.h
# Enable netdump(4) client support.
NETDUMP opt_global.h
# Options used only in subr_param.c.
HZ opt_param.h
MAXFILES opt_param.h

4
sys/net/if.c
View File

@ -87,6 +87,7 @@
#include <netinet/ip_carp.h>
#ifdef INET
#include <netinet/if_ether.h>
#include <netinet/netdump/netdump.h>
#endif /* INET */
#ifdef INET6
#include <netinet6/in6_var.h>
@ -2769,6 +2770,9 @@ ifhwioctl(u_long cmd, struct ifnet *ifp, caddr_t data, struct thread *td)
if (error == 0) {
getmicrotime(&ifp->if_lastchange);
rt_ifmsg(ifp);
#ifdef INET
NETDUMP_REINIT(ifp);
#endif
}
/*
* If the link MTU changed, do network layer specific procedure.

6
sys/net/if_var.h
View File

@ -70,6 +70,7 @@ struct route; /* if_output */
struct vnet;
struct ifmedia;
struct netmap_adapter;
struct netdump_methods;
#ifdef _KERNEL
#include <sys/mbuf.h> /* ifqueue only? */
@ -368,6 +369,11 @@ struct ifnet {
/* Ethernet PCP */
uint8_t if_pcp;
/*
* Netdump hooks to be called while dumping.
*/
struct netdump_methods *if_netdump_methods;
/*
* Spare fields to be added before branching a stable branch, so
* that structure can be enhanced without changing the kernel

130
sys/netinet/netdump/netdump.h Normal file
View File

@ -0,0 +1,130 @@
/*-
* Copyright (c) 2005-2014 Sandvine Incorporated
* Copyright (c) 2000 Darrell Anderson <anderson@cs.duke.edu>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* $FreeBSD$
*/
#ifndef _NETINET_NETDUMP_H_
#define _NETINET_NETDUMP_H_
#include <sys/types.h>
#include <sys/disk.h>
#include <sys/ioccom.h>
#include <net/if.h>
#include <netinet/in.h>
#define NETDUMP_PORT 20023 /* Server UDP port for heralds. */
#define NETDUMP_ACKPORT 20024 /* Client UDP port for acks. */
#define NETDUMP_HERALD 1 /* Broadcast before starting a dump. */
#define NETDUMP_FINISHED 2 /* Send after finishing a dump. */
#define NETDUMP_VMCORE 3 /* Contains dump data. */
#define NETDUMP_KDH 4 /* Contains kernel dump header. */
#define NETDUMP_EKCD_KEY 5 /* Contains kernel dump key. */
#define NETDUMP_DATASIZE 4096 /* Arbitrary packet size limit. */
struct netdump_msg_hdr {
uint32_t mh_type; /* Netdump message type. */
uint32_t mh_seqno; /* Match acks with msgs. */
uint64_t mh_offset; /* vmcore offset (bytes). */
uint32_t mh_len; /* Attached data (bytes). */
uint32_t mh__pad;
} __packed;
struct netdump_ack {
uint32_t na_seqno; /* Match acks with msgs. */
} __packed;
struct netdump_conf {
struct diocskerneldump_arg ndc_kda;
char ndc_iface[IFNAMSIZ];
struct in_addr ndc_server;
struct in_addr ndc_client;
struct in_addr ndc_gateway;
};
#define _PATH_NETDUMP "/dev/netdump"
#define NETDUMPGCONF _IOR('n', 1, struct netdump_conf)
#define NETDUMPSCONF _IOW('n', 2, struct netdump_conf)
#ifdef _KERNEL
#ifdef NETDUMP
#define NETDUMP_MAX_IN_FLIGHT 64
enum netdump_ev {
NETDUMP_START,
NETDUMP_END,
};
struct ifnet;
struct mbuf;
void netdump_reinit(struct ifnet *);
typedef void netdump_init_t(struct ifnet *, int *nrxr, int *ncl, int *clsize);
typedef void netdump_event_t(struct ifnet *, enum netdump_ev);
typedef int netdump_transmit_t(struct ifnet *, struct mbuf *);
typedef int netdump_poll_t(struct ifnet *, int);
struct netdump_methods {
netdump_init_t *nd_init;
netdump_event_t *nd_event;
netdump_transmit_t *nd_transmit;
netdump_poll_t *nd_poll;
};
#define NETDUMP_DEFINE(driver) \
static netdump_init_t driver##_netdump_init; \
static netdump_event_t driver##_netdump_event; \
static netdump_transmit_t driver##_netdump_transmit; \
static netdump_poll_t driver##_netdump_poll; \
\
static struct netdump_methods driver##_netdump_methods = { \
.nd_init = driver##_netdump_init, \
.nd_event = driver##_netdump_event, \
.nd_transmit = driver##_netdump_transmit, \
.nd_poll = driver##_netdump_poll, \
}
#define NETDUMP_REINIT(ifp) netdump_reinit(ifp)
#define NETDUMP_SET(ifp, driver) \
(ifp)->if_netdump_methods = &driver##_netdump_methods
#else /* !NETDUMP */
#define NETDUMP_DEFINE(driver)
#define NETDUMP_REINIT(ifp)
#define NETDUMP_SET(ifp, driver)
#endif /* NETDUMP */
#endif /* _KERNEL */
#endif /* _NETINET_NETDUMP_H_ */

1296
sys/netinet/netdump/netdump_client.c Normal file
View File

File diff suppressed because it is too large Load Diff