freebsd-skq/share/man/man4
cem 45bf92cd20 Implement NetGDB(4)
NetGDB(4) is a component of a system using a panic-time network stack to
remotely debug crashed FreeBSD kernels over the network, instead of
traditional serial interfaces.

There are three pieces in the complete NetGDB system.

First, a dedicated proxy server must be running to accept connections from
both NetGDB and gdb(1), and pass bidirectional traffic between the two
protocols.

Second, the NetGDB client is activated much like ordinary 'gdb' and
similarly to 'netdump' in ddb(4) after a panic.  Like other debugnet(4)
clients (netdump(4)), the network interface on the route to the proxy server
must be online and support debugnet(4).

Finally, the remote (k)gdb(1) uses 'target remote <proxy>:<port>' (like any
other TCP remote) to connect to the proxy server.

The NetGDB v1 protocol speaks the literal GDB remote serial protocol, and
uses a 1:1 relationship between GDB packets and sequences of debugnet
packets (fragmented by MTU).  There is no encryption utilized to keep
debugging sessions private, so this is only appropriate for local
segments or trusted networks.

Submitted by:	John Reimer <john.reimer AT emc.com> (earlier version)
Discussed some with:	emaste, markj
Relnotes:	sure
Differential Revision:	https://reviews.freebsd.org/D21568
2019-10-17 21:33:01 +00:00
..
man4.aarch64 pkgbase: move man pages from runtime-manual to runtime 2019-07-19 15:12:20 +00:00
man4.arm pkgbase: move man pages from runtime-manual to runtime 2019-07-19 15:12:20 +00:00
man4.i386 pkgbase: move man pages from runtime-manual to runtime 2019-07-19 15:12:20 +00:00
man4.powerpc pkgbase: move man pages from runtime-manual to runtime 2019-07-19 15:12:20 +00:00
man4.sparc64 pkgbase: move man pages from runtime-manual to runtime 2019-07-19 15:12:20 +00:00
aac.4
aacraid.4
acpi_asus_wmi.4
acpi_asus.4
acpi_dock.4
acpi_fujitsu.4
acpi_hp.4
acpi_ibm.4
acpi_panasonic.4
acpi_rapidstart.4
acpi_sony.4
acpi_thermal.4
acpi_toshiba.4
acpi_video.4
acpi_wmi.4 Add embedded Managed Object Format blob access to acpi_wmi(4). 2019-09-06 10:12:05 +00:00
acpi.4
ada.4
adm6996fc.4
ads111x.4 Fix the name of the devicetree bindings document file cited in the manpage. 2019-09-02 18:32:08 +00:00
ae.4 Remove the notice that ae(4) will be removed in FreeBSD 13. 2019-05-17 18:16:55 +00:00
aesni.4
age.4
agp.4
ahc.4
ahci.4 Document RST support in nvme(4) and ahci(4). 2019-08-21 22:18:07 +00:00
ahd.4
aibs.4
aio.4
alc.4
ale.4
alpm.4
altera_atse.4
altera_avgen.4
altera_jtag_uart.4
altera_sdcard.4
altq.4 document how to apply altq to vlan interfaces w/ pf. 2019-10-09 21:48:00 +00:00
amdpm.4
amdsbwd.4
amdsmb.4
amdsmn.4
amdtemp.4
amr.4
an.4
aout.4
apic.4
arcmsr.4
asmc.4
at45d.4
ata.4
ath_ahb.4
ath_hal.4
ath_pci.4
ath.4
atkbd.4
atkbdc.4
atp.4
atrtc.4
attimer.4
audit.4 Update the audit(4) man page to talk about dtaudit(4), and also add a 2019-04-28 16:28:36 +00:00
auditpipe.4 Update the audit(4) man page to talk about dtaudit(4), and also add a 2019-04-28 16:28:36 +00:00
aue.4
axe.4
axge.4
bce.4
bcma.4
bfe.4
bge.4
bhnd_chipc.4
bhnd_pmu.4
bhnd.4
bhndb_pci.4
bhndb.4
bhyve.4
bktr.4
blackhole.4
bnxt.4
bpf.4
bridge.4 Correct grammos and typos. 2019-10-05 09:59:00 +00:00
bt.4
bwi.4
bwn.4
bxe.4
bytgpio.4
capsicum.4
cardbus.4
carp.4
cas.4
cc_cdg.4
cc_chd.4
cc_cubic.4
cc_dctcp.4 * Improve input validation of sysctl parameters for DCTPC. 2019-07-29 08:50:35 +00:00
cc_hd.4
cc_htcp.4
cc_newreno.4 Reference the RFC instead of the internet draft. 2019-08-06 11:26:30 +00:00
cc_vegas.4
ccd.4
ccr.4 Add 'device cxgbe' explicitly in the synopsis. 2019-06-03 15:41:54 +00:00
cd.4
cdce.4 Add cdceem(4) driver, for virtual ethernet devices compliant 2019-08-07 18:14:45 +00:00
cdceem.4 Add cdceem(4) driver, for virtual ethernet devices compliant 2019-08-07 18:14:45 +00:00
cfi.4
cfiscsi.4 Update the spelling of my name 2019-04-22 17:52:46 +00:00
cfumass.4
ch.4
chromebook_platform.4
chvgpio.4
ciss.4
cloudabi.4
cmx.4
coretemp.4
cpuctl.4
cpufreq.4
crypto.4
ctl.4
cue.4 Don't use .Xr for things that have no man page. 2019-07-24 07:07:46 +00:00
cxgb.4
cxgbe.4
cxgbev.4
cy.4
cyapa.4
da.4
dc.4
dcons_crom.4
dcons.4
ddb.4 Implement NetGDB(4) 2019-10-17 21:33:01 +00:00
devctl.4
disc.4
divert.4
dpms.4
ds1307.4
ds3231.4
dtrace_audit.4 Add a man page for the DTrace Audit Provider, since we are now growing a set 2019-04-28 13:07:38 +00:00
dtrace_io.4
dtrace_ip.4
dtrace_lockstat.4 Add lockmgr(9) probes to the lockstat DTrace provider. 2019-08-21 23:43:58 +00:00
dtrace_proc.4
dtrace_sched.4
dtrace_sctp.4
dtrace_tcp.4
dtrace_udp.4
dtrace_udplite.4
dummynet.4
e6060sw.4
edsc.4
efidev.4
ehci.4
em.4
ena.4 Fix ENA manual issues 2019-05-30 13:50:45 +00:00
enc.4
epair.4
esp.4
est.4
et.4
etherswitch.4
eventtimers.4
exca.4
fd.4
fdc.4
fdt_pinctrl.4
fdt.4 fdt: further consolidate DTB building and revise manpage 2019-04-17 03:29:16 +00:00
fdtbus.4
ffclock.4
filemon.4 symlinkat(2) is not covered. 2019-06-16 05:12:17 +00:00
firewire.4
full.4
fwe.4
fwip.4
fwohci.4
fxp.4
gbde.4
gdb.4
gem.4
geom_linux_lvm.4
geom_map.4
geom_uzip.4 geom_uzip(4), mkuzip(8): Add Zstd image mode 2019-08-13 23:32:56 +00:00
geom.4 Remove deprecated GEOM classes 2019-08-13 20:06:55 +00:00
gif.4
gpio.4 gpiobus: provide a new hint, pin_list 2019-06-27 15:46:06 +00:00
gpioiic.4
gpioled.4 gpioled: fix the manual page update in r348154 2019-05-23 11:35:00 +00:00
gre.4 Add GRE-in-UDP encapsulation support as defined in RFC8086. 2019-04-24 09:05:45 +00:00
h_ertt.4
hifn.4
hme.4
hpet.4
hpt27xx.4
hptiop.4
hptmv.4
hptnr.4
hptrr.4
hv_kvp.4
hv_netvsc.4
hv_storvsc.4
hv_utils.4
hv_vmbus.4
hv_vss.4
hwpmc.4
iavf.4
ichsmb.4
ichwd.4
icmp6.4
icmp.4
ida.4
if_ipsec.4
if_ntb.4
iflib.4 iflib: Better control over queue core assignment 2019-04-25 21:24:56 +00:00
ifmib.4
ig4.4
igmp.4
iic.4
iicbb.4
iicbus.4
iicsmb.4
iir.4
imcsmb.4
inet6.4
inet.4
intpm.4
intro.4
io.4
ioat.4
ip6.4
ip.4
ipfirewall.4
ipheth.4 Add cdceem(4) driver, for virtual ethernet devices compliant 2019-08-07 18:14:45 +00:00
ipmi.4
ips.4
ipsec.4
ipw.4
ipwfw.4
isci.4
iscsi_initiator.4
iscsi.4
iser.4
isl.4
ismt.4
isp.4
ispfw.4
itwd.4 itwd(4): driver for watchdog function in ITE Super I/O chips 2019-10-16 14:57:38 +00:00
iwi.4
iwifw.4
iwm.4
iwmfw.4
iwn.4
iwnfw.4
ixgbe.4 Mention iflib(4). 2019-07-17 01:56:40 +00:00
ixl.4 Mention iflib(4). 2019-07-17 01:56:40 +00:00
jedec_dimm.4
jme.4
kbdmux.4
keyboard.4
kld.4
ksyms.4
ksz8995ma.4
ktr.4
kue.4 Don't use .Xr for things that have no man page. 2019-07-24 07:07:46 +00:00
lagg.4
le.4
led.4
lge.4
linux.4
liquidio.4
lm75.4
lo.4
lp.4
lpbb.4
lpt.4
mac_biba.4
mac_bsdextended.4
mac_ifoff.4
mac_lomac.4
mac_mls.4
mac_none.4
mac_ntpd.4
mac_partition.4
mac_portacl.4
mac_seeotheruids.4
mac_stub.4
mac_test.4
mac.4
Makefile Implement NetGDB(4) 2019-10-17 21:33:01 +00:00
Makefile.depend
malo.4
md.4
mdio.4
me.4
mem.4
meteor.4
mfi.4
miibus.4
mk48txx.4
mld.4
mlx4en.4
mlx4ib.4
mlx5en.4 Initial version of Mellanox in-kernel firmware upgrade support. 2019-05-08 10:49:05 +00:00
mlx5ib.4
mlx5io.4 Move EEPROM information query from a sysctl in mlx5en(4) to an ioctl 2019-10-02 10:14:55 +00:00
mlx.4
mly.4
mmc.4
mmcsd.4
mn.4
mod_cc.4 Reference the RFC instead of the internet draft. 2019-08-06 11:26:30 +00:00
mos.4
mouse.4
mpr.4 Document max_chains bump to 16384 at r330049. 2019-06-01 16:04:20 +00:00
mps.4 Document max_chains bump to 16384 at r330049. 2019-06-01 16:04:20 +00:00
mpt.4
mrsas.4
msk.4
mtio.4
muge.4
multicast.4
mvs.4
mwl.4
mwlfw.4
mx25l.4
mxge.4 There is no need to explicitly add zlib, we already have it in 2019-08-04 04:51:32 +00:00
my.4
nda.4
ndis.4
net80211.4
netdump.4 Add ddb(4) 'netdump' command to netdump a core without preconfiguration 2019-10-17 19:49:20 +00:00
netfpga10g_nf10bmac.4
netgdb.4 Implement NetGDB(4) 2019-10-17 21:33:01 +00:00
netgraph.4
netintro.4
netmap.4 netmap.4: Fix a typo as FreeBSD Linux is not a thing 2019-06-15 12:09:22 +00:00
nfe.4
nfsmb.4
ng_async.4
ng_atmllc.4
ng_bluetooth.4
ng_bpf.4
ng_bridge.4 - Remove the compile time limit for number of links a ng_bridge node 2019-10-03 02:32:55 +00:00
ng_bt3c.4
ng_btsocket.4
ng_car.4
ng_ccatm.4
ng_checksum.4
ng_cisco.4
ng_deflate.4
ng_device.4
ng_echo.4
ng_eiface.4 Fix some spelling errors in ng_eiface(4). 2019-05-14 15:41:34 +00:00
ng_etf.4
ng_ether_echo.4
ng_ether.4
ng_frame_relay.4
ng_gif_demux.4
ng_gif.4
ng_h4.4
ng_hci.4
ng_hole.4
ng_hub.4
ng_iface.4
ng_ip_input.4
ng_ipfw.4
ng_ksocket.4
ng_l2cap.4
ng_l2tp.4
ng_lmi.4
ng_mppc.4
ng_nat.4
ng_netflow.4
ng_one2many.4
ng_patch.4
ng_ppp.4
ng_pppoe.4
ng_pptpgre.4
ng_pred1.4
ng_rfc1490.4
ng_socket.4
ng_source.4
ng_split.4
ng_sppp.4
ng_sscfu.4
ng_sscop.4
ng_tag.4
ng_tcpmss.4
ng_tee.4
ng_tty.4
ng_ubt.4
ng_UI.4
ng_uni.4
ng_vjc.4
ng_vlan.4
ngatmbase.4
nge.4
nmdm.4
ntb_hw_amd.4 Man page for AMD Non-Transparent Bridge (ntb_hw_amd) driver. 2019-08-29 13:46:54 +00:00
ntb_hw_intel.4
ntb_hw_plx.4
ntb_transport.4 Man page for AMD Non-Transparent Bridge (ntb_hw_amd) driver. 2019-08-29 13:46:54 +00:00
ntb.4 Man page for AMD Non-Transparent Bridge (ntb_hw_amd) driver. 2019-08-29 13:46:54 +00:00
null.4 Earliest reference to /dev/null I can find is in v4 sh(1) and nulldev in 2019-08-30 21:49:00 +00:00
numa.4
nvd.4 nvd.4: Reference nda(4) 2019-05-19 06:01:11 +00:00
nvdimm.4 nvdimm(4): Add description of NVDIMM Namespace support 2019-09-05 20:51:41 +00:00
nvme.4 Document RST support in nvme(4) and ahci(4). 2019-08-21 22:18:07 +00:00
nvram2env.4
nvram.4
oce.4
ocs_fc.4
ohci.4
orm.4
otus.4
otusfw.4
ow_temp.4
ow.4
owc.4 fix up r349406, add missing .El 2019-06-26 07:08:51 +00:00
padlock.4
pass.4
pccard.4
pccbb.4
pcf.4
pci.4 pci(4): Use plural configuration registers 2019-07-02 17:48:27 +00:00
pcib.4
pcic.4
pcm.4
pf.4
pflog.4 Add a bugs section to pflog man page 2019-04-18 11:06:45 +00:00
pfsync.4
pim.4
pms.4
polling.4
ppbus.4
ppc.4
ppi.4
procdesc.4
proto.4
psm.4 psm(4): respect tap_disabled configuration with enabled Extended support 2019-04-20 21:04:56 +00:00
pst.4
pt.4
ptnet.4
pts.4
pty.4
puc.4
pwmc.4 Add a pwmc(4) manpage. 2019-06-18 04:32:19 +00:00
qlnxe.4
qlxgb.4
qlxgbe.4
qlxge.4
ral.4
random.4 sys: Remove DEV_RANDOM device option 2019-06-21 00:16:30 +00:00
rc.4
rccgpio.4
rctl.4
re.4
rgephy.4 Don't use .Xr for things that have no man page. 2019-07-24 07:07:46 +00:00
rights.4
rl.4
rndtest.4
route.4
rp.4
rsu.4
rsufw.4
rtwn_pci.4
rtwn_usb.4 Add support for TP-Link Archer T2U Nano. 2019-09-01 06:40:58 +00:00
rtwn.4
rtwnfw.4
rue.4
rum.4
run.4
runfw.4
sa.4
safe.4
sbp_targ.4
sbp.4
scc.4
sched_4bsd.4
sched_ule.4
screen.4
scsi.4
sctp.4
sdhci.4
sem.4
send.4
ses.4
sfxge.4
sge.4
siba.4
siftr.4 In r343587 a simple port filter as sysctl tunable was added to siftr. 2019-10-07 20:35:04 +00:00
siis.4
simplebus.4
sio.4
sis.4
sk.4
smartpqi.4
smb.4
smbus.4
smp.4
smsc.4
snd_ad1816.4
snd_als4000.4
snd_atiixp.4
snd_cmi.4
snd_cs4281.4
snd_csa.4
snd_ds1.4 Add deprecation notice to snd_ds1(4). 2019-08-13 01:24:43 +00:00
snd_emu10k1.4
snd_emu10kx.4
snd_envy24.4
snd_envy24ht.4
snd_es137x.4
snd_ess.4
snd_fm801.4
snd_gusc.4
snd_hda.4 I add the ability to accept the default pin widget configuration to help 2019-07-17 04:13:46 +00:00
snd_hdspe.4
snd_ich.4
snd_maestro3.4
snd_maestro.4 Add deprecation notice to snd_maestro(4). 2019-08-13 01:25:07 +00:00
snd_mss.4
snd_neomagic.4
snd_sbc.4
snd_solo.4
snd_spicds.4
snd_t4dwave.4
snd_uaudio.4
snd_via82c686.4
snd_via8233.4
snd_vibes.4
snp.4
spigen.4
spkr.4
splash.4
sppp.4
ste.4
stf.4
stge.4
superio.4 fix a typo in superio.4 2019-10-11 11:31:45 +00:00
sym.4
syncache.4
syncer.4
syscons.4
sysmouse.4
tap.4 tun/tap: merge and rename to tuntap 2019-05-08 02:32:11 +00:00
targ.4
tcp.4 Add kernel-side support for in-kernel TLS. 2019-08-27 00:01:56 +00:00
tdfx.4
terasic_mtl.4
termios.4 Remove some more leftover rlogin man page xrefs 2019-08-13 15:41:36 +00:00
textdump.4
ti.4
timecounters.4
tpm.4
trm.4
tty.4 Remove some more leftover rlogin man page xrefs 2019-08-13 15:41:36 +00:00
tun.4 tun/tap: merge and rename to tuntap 2019-05-08 02:32:11 +00:00
twa.4
twe.4
tws.4
u3g.4
uark.4
uart.4
uath.4
ubsa.4
ubsec.4
ubser.4
ubtbcmfw.4
uchcom.4
ucom.4
ucycom.4
udav.4
udbp.4
udl.4
udp.4
udplite.4
uep.4
ufm.4
ufoma.4
uftdi.4
ugen.4
ugold.4
uhci.4
uhid.4
uhso.4
uipaq.4
ukbd.4
uled.4
ulpt.4
umass.4
umcs.4
umct.4
umodem.4
umoscom.4
ums.4
unix.4 Complete LOCAL_PEERCRED support. Cache pid of the remote process in the 2019-05-30 14:24:26 +00:00
upgt.4
uplcom.4
ural.4
ure.4
urio.4
urndis.4 Add cdceem(4) driver, for virtual ethernet devices compliant 2019-08-07 18:14:45 +00:00
urtw.4
usb_quirk.4
usb_template.4 Add cdceem(4) driver, for virtual ethernet devices compliant 2019-08-07 18:14:45 +00:00
usb.4
usfs.4
uslcom.4
uvisor.4
uvscom.4
vale.4
vga.4
vge.4
viapm.4
viawd.4
virtio_balloon.4
virtio_blk.4
virtio_console.4
virtio_random.4
virtio_scsi.4
virtio.4 virtio.4: Add missing devices and Xr 2019-05-27 00:51:27 +00:00
vkbd.4
vlan.4
vmci.4
vmd.4 This driver attaches to the Intel VMD drive and connects a new PCI domain 2019-10-10 03:12:17 +00:00
vmm.4
vmx.4 Mention iflib(4). 2019-07-17 01:56:40 +00:00
vpo.4
vr.4
vt.4
vte.4
vtnet.4
vxlan.4
watchdog.4
wbwd.4 wbwd: move to superio(4) bus 2019-10-16 14:46:04 +00:00
wi.4
witness.4
wlan_acl.4
wlan_amrr.4
wlan_ccmp.4
wlan_tkip.4
wlan_wep.4
wlan_xauth.4
wlan.4
wmt.4
wpi.4
wsp.4
xdma.4
xen.4
xhci.4
xl.4
xnb.4
xpt.4
zero.4
zyd.4