diff options
Diffstat (limited to 'share/man')
-rw-r--r-- | share/man/man4/Makefile | 1 | ||||
-rw-r--r-- | share/man/man4/ddb.4 | 64 | ||||
-rw-r--r-- | share/man/man4/muge.4 | 4 | ||||
-rw-r--r-- | share/man/man4/netdump.4 | 4 | ||||
-rw-r--r-- | share/man/man4/netmap.4 | 137 | ||||
-rw-r--r-- | share/man/man4/nvme.4 | 5 | ||||
-rw-r--r-- | share/man/man4/pfsync.4 | 9 | ||||
-rw-r--r-- | share/man/man4/sfxge.4 | 6 | ||||
-rw-r--r-- | share/man/man4/textdump.4 | 18 | ||||
-rw-r--r-- | share/man/man4/vmci.4 | 4 | ||||
-rw-r--r-- | share/man/man4/vxlan.4 | 6 | ||||
-rw-r--r-- | share/man/man5/ext2fs.5 | 7 | ||||
-rw-r--r-- | share/man/man5/src.conf.5 | 20 | ||||
-rw-r--r-- | share/man/man7/build.7 | 4 | ||||
-rw-r--r-- | share/man/man7/development.7 | 43 | ||||
-rw-r--r-- | share/man/man7/hier.7 | 10 |
16 files changed, 215 insertions, 127 deletions
diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index 7849a31763a9..5a21af24f1ae 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -323,6 +323,7 @@ MAN= aac.4 \ ng_btsocket.4 \ ng_car.4 \ ng_ccatm.4 \ + ng_checksum.4 \ ng_cisco.4 \ ng_deflate.4 \ ng_device.4 \ diff --git a/share/man/man4/ddb.4 b/share/man/man4/ddb.4 index 42135af13d04..972e77416fba 100644 --- a/share/man/man4/ddb.4 +++ b/share/man/man4/ddb.4 @@ -60,7 +60,7 @@ .\" .\" $FreeBSD$ .\" -.Dd November 10, 2018 +.Dd November 30, 2018 .Dt DDB 4 .Os .Sh NAME @@ -108,8 +108,8 @@ If linked into the running kernel, it can be invoked locally with the .Ql debug .Xr keymap 5 -action, or by setting setting the -.Dv debug.kdb.enter +action, usually mapped to Ctrl+Alt+Esc, or by setting the +.Va debug.kdb.enter sysctl to 1. The debugger is also invoked on kernel .Xr panic 9 @@ -1207,17 +1207,17 @@ Userspace processes may inspect and manage capture state using .Xr sysctl 8 : .Pp -.Dv debug.ddb.capture.bufsize +.Va debug.ddb.capture.bufsize may be used to query or set the current capture buffer size. .Pp -.Dv debug.ddb.capture.maxbufsize +.Va debug.ddb.capture.maxbufsize may be used to query the compile-time limit on the capture buffer size. .Pp -.Dv debug.ddb.capture.bytes +.Va debug.ddb.capture.bytes may be used to query the number of bytes of output currently in the capture buffer. .Pp -.Dv debug.ddb.capture.data +.Va debug.ddb.capture.data returns the contents of the buffer as a string to an appropriately privileged process. .Pp @@ -1419,58 +1419,58 @@ Certain scripts are run automatically, if defined, for specific events. The follow scripts are run when various events occur: .Bl -tag -width kdb.enter.powerfail -.It Dv kdb.enter.acpi +.It Va kdb.enter.acpi The kernel debugger was entered as a result of an .Xr acpi 4 event. -.It Dv kdb.enter.bootflags +.It Va kdb.enter.bootflags The kernel debugger was entered at boot as a result of the debugger boot flag being set. -.It Dv kdb.enter.break +.It Va kdb.enter.break The kernel debugger was entered as a result of a serial or console break. -.It Dv kdb.enter.cam +.It Va kdb.enter.cam The kernel debugger was entered as a result of a .Xr CAM 4 event. -.It Dv kdb.enter.mac +.It Va kdb.enter.mac The kernel debugger was entered as a result of an assertion failure in the .Xr mac_test 4 module of the TrustedBSD MAC Framework. -.It Dv kdb.enter.ndis +.It Va kdb.enter.ndis The kernel debugger was entered as a result of an .Xr ndis 4 breakpoint event. -.It Dv kdb.enter.netgraph +.It Va kdb.enter.netgraph The kernel debugger was entered as a result of a .Xr netgraph 4 event. -.It Dv kdb.enter.panic +.It Va kdb.enter.panic .Xr panic 9 was called. -.It Dv kdb.enter.powerfail +.It Va kdb.enter.powerfail The kernel debugger was entered as a result of a powerfail NMI on the sparc64 platform. -.It Dv kdb.enter.powerpc +.It Va kdb.enter.powerpc The kernel debugger was entered as a result of an unimplemented interrupt type on the powerpc platform. -.It Dv kdb.enter.sysctl +.It Va kdb.enter.sysctl The kernel debugger was entered as a result of the -.Dv debug.kdb.enter +.Va debug.kdb.enter sysctl being set. -.It Dv kdb.enter.trapsig +.It Va kdb.enter.trapsig The kernel debugger was entered as a result of a trapsig event on the sparc64 platform. -.It Dv kdb.enter.unionfs +.It Va kdb.enter.unionfs The kernel debugger was entered as a result of an assertion failure in the union file system. -.It Dv kdb.enter.unknown +.It Va kdb.enter.unknown The kernel debugger was entered, but no reason has been set. -.It Dv kdb.enter.vfslock +.It Va kdb.enter.vfslock The kernel debugger was entered as a result of a VFS lock violation. -.It Dv kdb.enter.watchdog +.It Va kdb.enter.watchdog The kernel debugger was entered as a result of a watchdog firing. -.It Dv kdb.enter.witness +.It Va kdb.enter.witness The kernel debugger was entered as a result of a .Xr witness 4 violation. @@ -1480,14 +1480,14 @@ In the event that none of these scripts is found, .Nm will attempt to execute a default script: .Bl -tag -width kdb.enter.powerfail -.It Dv kdb.enter.default +.It Va kdb.enter.default The kernel debugger was entered, but a script exactly matching the reason for entering was not defined. This can be used as a catch-all to handle cases not specifically of interest; for example, -.Dv kdb.enter.witness +.Va kdb.enter.witness might be defined to have special handling, and -.Dv kdb.enter.default +.Va kdb.enter.default might be defined to simply panic and reboot. .El .Sh HINTS @@ -1507,7 +1507,7 @@ debugging. Modern server systems typically use IPMI to generate signals to enter the debugger. The -.Dv devel/ipmitool +.Va devel/ipmitool port can be used to send the .Cd chassis power diag command which delivers an NMI to the processor. @@ -1537,16 +1537,16 @@ and then releasing both. The break to enter the debugger behavior may be enabled at run-time by setting the .Xr sysctl 8 -.Dv debug.kdb.break_to_debugger +.Va debug.kdb.break_to_debugger to 1. The alternate sequence to enter the debugger behavior may be enabled at run-time by setting the .Xr sysctl 8 -.Dv debug.kdb.alt_break_to_debugger +.Va debug.kdb.alt_break_to_debugger to 1. The debugger may be entered by setting the .Xr sysctl 8 -.Dv debug.kdb.enter +.Va debug.kdb.enter to 1. .Sh FILES Header files mentioned in this manual page can be found below diff --git a/share/man/man4/muge.4 b/share/man/man4/muge.4 index 8c6f6859e297..3bb8810d81b0 100644 --- a/share/man/man4/muge.4 +++ b/share/man/man4/muge.4 @@ -35,10 +35,6 @@ To load the driver as a module at boot time, place the following line in .Bd -literal -offset indent if_muge_load="YES" .Ed -.Pp -.\" Alternatively, to compile this driver into the kernel, place the -.\" following lines in your kernel configuration file: -.Ed .Sh DESCRIPTION The .Nm diff --git a/share/man/man4/netdump.4 b/share/man/man4/netdump.4 index 4c47dbce72ce..4424dcd5ead6 100644 --- a/share/man/man4/netdump.4 +++ b/share/man/man4/netdump.4 @@ -24,7 +24,7 @@ .\" .\" $FreeBSD$ .\" -.Dd October 29, 2018 +.Dd December 5, 2018 .Dt NETDUMP 4 .Os .Sh NAME @@ -105,6 +105,8 @@ The following network drivers support netdump: .Xr em 4 , .Xr igb 4 , .Xr ix 4 , +.Xr ixl 4 , +.Xr mlx4en 4 , .Xr re 4 , .Xr vtnet 4 . .Sh SYSCTL VARIABLES diff --git a/share/man/man4/netmap.4 b/share/man/man4/netmap.4 index c282001dce3a..3ee7ccf13892 100644 --- a/share/man/man4/netmap.4 +++ b/share/man/man4/netmap.4 @@ -27,17 +27,12 @@ .\" .\" $FreeBSD$ .\" -.Dd October 28, 2018 +.Dd November 20, 2018 .Dt NETMAP 4 .Os .Sh NAME .Nm netmap .Nd a framework for fast packet I/O -.Nm VALE -.Nd a fast VirtuAl Local Ethernet using the netmap API -.Pp -.Nm netmap pipes -.Nd a shared memory packet transport channel .Sh SYNOPSIS .Cd device netmap .Sh DESCRIPTION @@ -79,7 +74,7 @@ with much less than one core on 10 Gbit/s NICs; 35-40 Mpps on 40 Gbit/s NICs (limited by the hardware); about 20 Mpps per core for VALE ports; and over 100 Mpps for -.Nm netmap pipes. +.Nm netmap pipes . NICs without native .Nm support can still use the API in emulated mode, @@ -108,9 +103,9 @@ synchronization and blocking I/O through a file descriptor and standard OS mechanisms such as .Xr select 2 , .Xr poll 2 , -.Xr epoll 2 , +.Xr kqueue 2 and -.Xr kqueue 2 . +.Xr epoll 7 . All types of .Nm netmap ports and the @@ -218,12 +213,6 @@ Non-blocking I/O is done with special and .Xr poll 2 on the file descriptor permit blocking I/O. -.Xr epoll 2 -and -.Xr kqueue 2 -are not supported on -.Nm -file descriptors. .Pp While a NIC is in .Nm @@ -244,7 +233,7 @@ which is the ultimate reference for the API. The main structures and fields are indicated below: .Bl -tag -width XXX -.It Dv struct netmap_if (one per interface) +.It Dv struct netmap_if (one per interface ) .Bd -literal struct netmap_if { ... @@ -267,14 +256,30 @@ NICs also have an extra tx/rx ring pair connected to the host stack. .Em NIOCREGIF can also request additional unbound buffers in the same memory space, to be used as temporary storage for packets. +The number of extra +buffers is specified in the +.Va arg.nr_arg3 +field. +On success, the kernel writes back to +.Va arg.nr_arg3 +the number of extra buffers actually allocated (they may be less +than the amount requested if the memory space ran out of buffers). .Pa ni_bufs_head -contains the index of the first of these free rings, +contains the index of the first of these extra buffers, which are connected in a list (the first uint32_t of each buffer being the index of the next buffer in the list). A .Dv 0 indicates the end of the list. -.It Dv struct netmap_ring (one per ring) +The application is free to modify +this list and use the buffers (i.e., binding them to the slots of a +netmap ring). +When closing the netmap file descriptor, +the kernel frees the buffers contained in the list pointed by +.Pa ni_bufs_head +, irrespectively of the buffers originally provided by the kernel on +.Em NIOCREGIF . +.It Dv struct netmap_ring (one per ring ) .Bd -literal struct netmap_ring { ... @@ -296,7 +301,7 @@ Implements transmit and receive rings, with read/write pointers, metadata and an array of .Em slots describing the buffers. -.It Dv struct netmap_slot (one per buffer) +.It Dv struct netmap_slot (one per buffer ) .Bd -literal struct netmap_slot { uint32_t buf_idx; /* buffer index */ @@ -371,7 +376,6 @@ during the execution of a netmap-related system call. The only exception are slots (and buffers) in the range .Va tail\ . . . head-1 , that are explicitly assigned to the kernel. -.Pp .Ss TRANSMIT RINGS On transmit rings, after a .Nm @@ -498,10 +502,9 @@ can be delayed indefinitely. This flag helps detect when packets have been sent and a file descriptor can be closed. .It NS_FORWARD -When a ring is in 'transparent' mode (see -.Sx TRANSPARENT MODE ) , -packets marked with this flag are forwarded to the other endpoint -at the next system call, thus restoring (in a selective way) +When a ring is in 'transparent' mode, +packets marked with this flag by the user application are forwarded to the +other endpoint at the next system call, thus restoring (in a selective way) the connection between a NIC and the host stack. .It NS_NO_LEARN tells the forwarding code that the source MAC address for this @@ -669,7 +672,7 @@ and does not need to be sequential. On return the pipe will only have a single ring pair with index 0, irrespective of the value of -.Va i. +.Va i . .El .Pp By default, a @@ -681,11 +684,14 @@ no write events are specified. The feature can be disabled by or-ing .Va NETMAP_NO_TX_POLL to the value written to -.Va nr_ringid. +.Va nr_ringid . When this feature is used, packets are transmitted only on .Va ioctl(NIOCTXSYNC) -or select()/poll() are called with a write event (POLLOUT/wfdset) or a full ring. +or +.Va select() / +.Va poll() +are called with a write event (POLLOUT/wfdset) or a full ring. .Pp When registering a virtual interface that is dynamically created to a .Xr vale 4 @@ -698,7 +704,7 @@ number of slots available for transmission. tells the hardware of consumed packets, and asks for newly available packets. .El -.Sh SELECT, POLL, EPOLL, KQUEUE. +.Sh SELECT, POLL, EPOLL, KQUEUE .Xr select 2 and .Xr poll 2 @@ -712,7 +718,7 @@ respectively when write (POLLOUT) and read (POLLIN) events are requested. Both block if no slots are available in the ring .Va ( ring->cur == ring->tail ) . Depending on the platform, -.Xr epoll 2 +.Xr epoll 7 and .Xr kqueue 2 are supported too. @@ -731,7 +737,10 @@ Passing the .Dv NETMAP_DO_RX_POLL flag to .Em NIOCREGIF updates receive rings even without read events. -Note that on epoll and kqueue, +Note that on +.Xr epoll 7 +and +.Xr kqueue 2 , .Dv NETMAP_NO_TX_POLL and .Dv NETMAP_DO_RX_POLL @@ -759,9 +768,9 @@ before .Pp The following functions are available: .Bl -tag -width XXXXX -.It Va struct nm_desc * nm_open(const char *ifname, const struct nmreq *req, uint64_t flags, const struct nm_desc *arg) +.It Va struct nm_desc * nm_open(const char *ifname, const struct nmreq *req, uint64_t flags, const struct nm_desc *arg ) similar to -.Xr pcap_open 3pcap , +.Xr pcap_open_live 3 , binds a file descriptor to a port. .Bl -tag -width XX .It Va ifname @@ -782,44 +791,50 @@ can be set to a combination of the following flags: .Va NETMAP_NO_TX_POLL , .Va NETMAP_DO_RX_POLL (copied into nr_ringid); -.Va NM_OPEN_NO_MMAP (if arg points to the same memory region, +.Va NM_OPEN_NO_MMAP +(if arg points to the same memory region, avoids the mmap and uses the values from it); -.Va NM_OPEN_IFNAME (ignores ifname and uses the values in arg); +.Va NM_OPEN_IFNAME +(ignores ifname and uses the values in arg); .Va NM_OPEN_ARG1 , .Va NM_OPEN_ARG2 , -.Va NM_OPEN_ARG3 (uses the fields from arg); -.Va NM_OPEN_RING_CFG (uses the ring number and sizes from arg). +.Va NM_OPEN_ARG3 +(uses the fields from arg); +.Va NM_OPEN_RING_CFG +(uses the ring number and sizes from arg). .El -.It Va int nm_close(struct nm_desc *d) +.It Va int nm_close(struct nm_desc *d ) closes the file descriptor, unmaps memory, frees resources. -.It Va int nm_inject(struct nm_desc *d, const void *buf, size_t size) -similar to pcap_inject(), pushes a packet to a ring, returns the size +.It Va int nm_inject(struct nm_desc *d, const void *buf, size_t size ) +similar to +.Va pcap_inject() , +pushes a packet to a ring, returns the size of the packet is successful, or 0 on error; -.It Va int nm_dispatch(struct nm_desc *d, int cnt, nm_cb_t cb, u_char *arg) -similar to pcap_dispatch(), applies a callback to incoming packets -.It Va u_char * nm_nextpkt(struct nm_desc *d, struct nm_pkthdr *hdr) -similar to pcap_next(), fetches the next packet +.It Va int nm_dispatch(struct nm_desc *d, int cnt, nm_cb_t cb, u_char *arg ) +similar to +.Va pcap_dispatch() , +applies a callback to incoming packets +.It Va u_char * nm_nextpkt(struct nm_desc *d, struct nm_pkthdr *hdr ) +similar to +.Va pcap_next() , +fetches the next packet .El .Sh SUPPORTED DEVICES .Nm natively supports the following devices: .Pp -On FreeBSD: +On +.Fx : .Xr cxgbe 4 , .Xr em 4 , -.Xr igb 4 , +.Xr iflib 4 +(providing igb, em and lem), .Xr ixgbe 4 , .Xr ixl 4 , -.Xr lem 4 , -.Xr re 4 . -.Pp -On Linux -.Xr e1000 4 , -.Xr e1000e 4 , -.Xr i40e 4 , -.Xr igb 4 , -.Xr ixgbe 4 , -.Xr r8169 4 . +.Xr re 4 , +.Xr vtnet 4 . +.Pp +On Linux e1000, e1000e, i40e, igb, ixgbe, ixgbevf, r8169, virtio_net, vmxnet3. .Pp NICs without native support can still be used in .Nm @@ -848,10 +863,11 @@ globally controls how netmap mode is implemented. .Sh SYSCTL VARIABLES AND MODULE PARAMETERS Some aspect of the operation of .Nm -are controlled through sysctl variables on FreeBSD +are controlled through sysctl variables on +.Fx .Em ( dev.netmap.* ) and module parameters on Linux -.Em ( /sys/module/netmap_lin/parameters/* ) : +.Em ( /sys/module/netmap/parameters/* ) : .Bl -tag -width indent .It Va dev.netmap.admode: 0 Controls the use of native or emulated adapter mode. @@ -861,6 +877,8 @@ Controls the use of native or emulated adapter mode. 1 forces native mode and fails if not available; .Pp 2 forces emulated hence never fails. +.It Va dev.netmap.generic_rings: 1 +Number of rings used for emulated netmap mode .It Va dev.netmap.generic_ringsize: 1024 Ring size used for emulated netmap mode .It Va dev.netmap.generic_mit: 100000 @@ -902,13 +920,15 @@ Batch size used when moving packets across a switch. Values above 64 generally guarantee good performance. +.It Va dev.netmap.ptnet_vnet_hdr: 1 +Allow ptnet devices to use virtio-net headers .El .Sh SYSTEM CALLS .Nm uses .Xr select 2 , .Xr poll 2 , -.Xr epoll 2 +.Xr epoll 7 and .Xr kqueue 2 to wake up processes when significant events occur, and @@ -1077,6 +1097,7 @@ with the network card or the host. .Xr vale-ctl 4 , .Xr bridge 8 , .Xr lb 8 , +.Xr nmreplay 8 , .Xr pkt-gen 8 .Pp .Pa http://info.iet.unipi.it/~luigi/netmap/ diff --git a/share/man/man4/nvme.4 b/share/man/man4/nvme.4 index 45025cfc32fe..e1b67e5ba5e4 100644 --- a/share/man/man4/nvme.4 +++ b/share/man/man4/nvme.4 @@ -33,7 +33,7 @@ .\" .\" $FreeBSD$ .\" -.Dd January 7, 2016 +.Dd December 7, 2018 .Dt NVME 4 .Os .Sh NAME @@ -70,6 +70,8 @@ Per-CPU IO queue pairs .It API for registering NVMe namespace consumers such as .Xr nvd 4 +or +.Xr nda 4 .It API for submitting NVM commands to namespaces .It @@ -163,6 +165,7 @@ with a completion entry that was posted by the controller. and completion queues to the console. .El .Sh SEE ALSO +.Xr nda 4 , .Xr nvd 4 , .Xr pci 4 , .Xr nvmecontrol 8 , diff --git a/share/man/man4/pfsync.4 b/share/man/man4/pfsync.4 index b12b3c8cdbe0..5b3159ff8292 100644 --- a/share/man/man4/pfsync.4 +++ b/share/man/man4/pfsync.4 @@ -26,7 +26,7 @@ .\" .\" $FreeBSD$ .\" -.Dd August 18, 2017 +.Dd December 6, 2018 .Dt PFSYNC 4 .Os .Sh NAME @@ -130,6 +130,13 @@ See .Xr carp 4 for more information. Default value is 240. +.It Va net.pfsync.pfsync_buckets +The number of +.Nm +buckets. +This affects the performance and memory tradeoff. +Defaults to twice the number of CPUs. +Change only if benchmarks show this helps on your workload. .El .Sh EXAMPLES .Nm diff --git a/share/man/man4/sfxge.4 b/share/man/man4/sfxge.4 index 589129792ceb..0c6ac4f8db22 100644 --- a/share/man/man4/sfxge.4 +++ b/share/man/man4/sfxge.4 @@ -52,7 +52,7 @@ sfxge_load="YES" The .Nm driver provides support for 10Gb Ethernet adapters based on -Solarflare SFC9000 family controllers. +Solarflare SFC9000 and XtremeScale X2 family controllers. The driver supports jumbo frames, transmit/receive checksum offload, TCP Segmentation Offload (TSO), Large Receive Offload (LRO), VLAN checksum offload, VLAN TSO, @@ -163,8 +163,8 @@ Period in milliseconds to refresh interface statistics from hardware. The accepted range is 0 to 65535, the default is 1000 (1 second). Use zero value to disable periodic statistics update. Supported on SFN8xxx series adapters with firmware v6.2.1.1033 and later and -SFN5xxx and SFN6xxx series adapters. -SFN7xxx series adapters and SFN8xxx series with earlier firmware use a +SFN5xxx, SFN6xxx and XtremeScale X2xxx series adapters. +SFN7xxx series adapters and sfN8xxx series with earlier firmware use a fixed 1000 milliseconds statistics update period. The period may also be changed after the driver is loaded using the sysctl .Va dev.sfxge.%d.stats_update_period_ms . diff --git a/share/man/man4/textdump.4 b/share/man/man4/textdump.4 index f3aa5bd05f72..c3c1dcad300a 100644 --- a/share/man/man4/textdump.4 +++ b/share/man/man4/textdump.4 @@ -27,7 +27,7 @@ .\" .\" $FreeBSD$ .\" -.Dd December 24, 2008 +.Dd November 30, 2018 .Dt TEXTDUMP 4 .Os .Sh NAME @@ -73,30 +73,30 @@ Captured .Xr ddb 4 output, if the capture facility has been used. May be disabled by clearing the -.Dv debug.ddb.textdump.do_ddb +.Va debug.ddb.textdump.do_ddb sysctl. .It Pa config.txt Kernel configuration, if .Cd options INCLUDE_CONFIG_FILE has been compiled into the kernel. May be disabled by clearing the -.Dv debug.ddb.textdump.do_config +.Va debug.ddb.textdump.do_config sysctl. .It Pa msgbuf.txt Kernel message buffer, including recent console output if the capture facility has been used. May be disabled by clearing the -.Dv debug.ddb.textdump.do_msgbuf +.Va debug.ddb.textdump.do_msgbuf sysctl. .It Pa panic.txt Kernel panic string, if the kernel panicked before the dump was generated. May be disabled by clearing the -.Dv debug.ddb.textdump.do_panic +.Va debug.ddb.textdump.do_panic sysctl. .It Pa version.txt Kernel version string. My be disabled by clearing the -.Dv debug.ddb.textdump.do_version +.Va debug.ddb.textdump.do_version sysctl. .El .Pp @@ -115,7 +115,7 @@ dump will be regular memory dumps; however, by using the command in .Xr ddb 4 , or by setting the -.Dv debug.ddb.textdump.pending +.Va debug.ddb.textdump.pending sysctl to 1 using .Xr sysctl 8 , it is possible to request that the next dump be a textdump. @@ -155,7 +155,7 @@ as well as other diagnostics useful to debug the textdump facility itself. .El .Sh EXAMPLES In the following example, the script -.Dv kdb.enter.panic +.Va kdb.enter.panic will run when the kernel debugger is entered as a result of a panic, enable output capture, dump several useful pieces of debugging information, and then invoke panic in order to force a kernel dump to be written out followed by a @@ -166,7 +166,7 @@ script kdb.enter.panic=textdump set; capture on; show allpcpu; bt; .Ed .Pp In the following example, the script -.Dv kdb.enter.witness +.Va kdb.enter.witness will run when the kernel debugger is entered as a result of a witness violation, printing lock-related information for the user: .Bd -literal -offset indent diff --git a/share/man/man4/vmci.4 b/share/man/man4/vmci.4 index 241aa5075962..afff97b7001c 100644 --- a/share/man/man4/vmci.4 +++ b/share/man/man4/vmci.4 @@ -54,8 +54,8 @@ In addition to this, the VMCI kernel API provides support for receiving events related to the state of the VMCI communication channels, and the virtual machine itself. .Sh SEE ALSO -.Xr pci 9 , -.Xr socket 2 +.Xr socket 2 , +.Xr pci 9 .Rs .%T "VMware vSockets Documentation" .%U https://www.vmware.com/support/developer/vmci-sdk/ diff --git a/share/man/man4/vxlan.4 b/share/man/man4/vxlan.4 index 5dac2b0a4e81..24c87998a2fc 100644 --- a/share/man/man4/vxlan.4 +++ b/share/man/man4/vxlan.4 @@ -108,7 +108,7 @@ forwarding table entry. When the .Nm interface is brought up, a -.Xr UDP 4 +.Xr udp 4 .Xr socket 9 is created based on the configuration, such as the local address for unicast mode or @@ -214,7 +214,6 @@ Once created, the .Nm interface can be configured with .Xr ifconfig 8 . -.Ed .Pp The following when placed in the file .Pa /etc/rc.conf @@ -224,6 +223,7 @@ to be created, and will configure the interface in unicast mode. .Bd -literal -offset indent cloned_interfaces="vxlan0" create_args_vxlan0="vxlanid 108 vxlanlocal 192.168.100.1 vxlanremote 192.168.100.2" +.Ed .Sh SEE ALSO .Xr inet 4 , .Xr inet6 4 , @@ -238,7 +238,7 @@ create_args_vxlan0="vxlanid 108 vxlanlocal 192.168.100.1 vxlanremote 192.168.100 .%D August 2014 .%O "RFC 7348" .Re -.Sh AUTHOR +.Sh AUTHORS .An -nosplit The .Nm diff --git a/share/man/man5/ext2fs.5 b/share/man/man5/ext2fs.5 index db792bb0c8c1..758eb0629b7b 100644 --- a/share/man/man5/ext2fs.5 +++ b/share/man/man5/ext2fs.5 @@ -26,7 +26,7 @@ .\" .\" $FreeBSD$ .\" -.Dd January 23, 2016 +.Dd December 4, 2018 .Dt EXT2FS 5 .Os .Sh NAME @@ -52,9 +52,10 @@ kernel to access and .Tn ext4 file systems. -The +Support for Extended Attributes in .Tn ext4 -support is read-only. +is experimental. +Journalling and encryption are currently not supported. .Sh EXAMPLES To mount a .Nm diff --git a/share/man/man5/src.conf.5 b/share/man/man5/src.conf.5 index 31d9fb4e9133..ca775507b338 100644 --- a/share/man/man5/src.conf.5 +++ b/share/man/man5/src.conf.5 @@ -1,6 +1,6 @@ .\" DO NOT EDIT-- this file is @generated by tools/build/options/makeman. .\" $FreeBSD$ -.Dd November 6, 2018 +.Dd November 26, 2018 .Dt SRC.CONF 5 .Os .Sh NAME @@ -149,7 +149,12 @@ Build all binaries with the flag set to indicate that the run-time loader should perform all relocation processing at process startup rather than on demand. .It Va WITHOUT_BINUTILS -Set to not build or install binutils (as, ld, and objdump) as part +Set to not build or install GNU +.Xr as 1 , +.Xr objdump 1 , +and for some CPU architectures +.Xr ld.bfd 1 +as part of the normal system build. The resulting system cannot build programs from source. .Pp @@ -162,7 +167,12 @@ When set, it enforces these options: .Va WITHOUT_GDB .El .It Va WITH_BINUTILS -Set to build and install binutils (as, ld, and objdump) as part +Set to build and install GNU +.Xr as 1 , +.Xr objdump 1 , +and for some CPU architectures +.Xr ld.bfd 1 +as part of the normal system build. .Pp This is a default setting on @@ -224,8 +234,8 @@ and related programs. .It Va WITHOUT_BSD_CPIO Set to not build the BSD licensed version of cpio based on .Xr libarchive 3 . -.It Va WITH_BSD_CRTBEGIN -Enable the BSD licensed +.It Va WITHOUT_BSD_CRTBEGIN +Disable the BSD licensed .Pa crtbegin.o and .Pa crtend.o . diff --git a/share/man/man7/build.7 b/share/man/man7/build.7 index 54811bf7e46a..70abff2a1bba 100644 --- a/share/man/man7/build.7 +++ b/share/man/man7/build.7 @@ -24,7 +24,7 @@ .\" .\" $FreeBSD$ .\" -.Dd November 10, 2018 +.Dd December 3, 2018 .Dt BUILD 7 .Os .Sh NAME @@ -804,7 +804,7 @@ system for the armv6 architecture on an amd64 host: .Bd -literal -offset indent cd /usr/src make TARGET_ARCH=armv6 buildworld buildkernel -make TARGET_ARCH=armv6 DESTDIR=/clients/arm64 installworld installkernel +make TARGET_ARCH=armv6 DESTDIR=/clients/arm installworld installkernel .Ed .Sh SEE ALSO .Xr cc 1 , diff --git a/share/man/man7/development.7 b/share/man/man7/development.7 index 1b871fc0fa0a..989513937b21 100644 --- a/share/man/man7/development.7 +++ b/share/man/man7/development.7 @@ -24,7 +24,7 @@ .\" .\" $FreeBSD$ .\" -.Dd November 16, 2018 +.Dd December 6, 2018 .Dt DEVELOPMENT 7 .Os .Sh NAME @@ -109,7 +109,7 @@ system: .Bd -literal -offset indent svnlite co https://svn.FreeBSD.org/base/head src cd src -make -j8 buildworld buildkernel installkernel +make -sj8 buildworld buildkernel installkernel shutdown -r now .Ed .Pp @@ -119,6 +119,45 @@ cd src make -j8 installworld reboot .Ed +.Pp +Rebuild and reinstall a single piece of userspace, in this +case +.Xr ls 1 : +.Bd -literal -offset indent +cd src/bin/ls +make clean all install +.Ed +.Pp +Quickly rebuild and reinstall the kernel, only recompiling the files +changed since last build; note that this will only work if the full kernel +build has been completed in the past, not on a fresh source tree: +.Bd -literal -offset indent +cd src +make -sj8 kernel KERNFAST=1 +.Ed +.Pp +To rebuild parts of +.Fx +for another CPU architecture, +first prepare your source tree by building the cross-toolchain: +.Bd -literal -offset indent +cd src +make -sj8 toolchain TARGET_ARCH=armv6 +.Ed +.Pp +Afterwards, to build and install a single piece of userspace, use: +.Bd -literal -offset indent +cd src/bin/ls +make buildenv TARGET_ARCH=armv6 +make clean all install DESTDIR=/clients/arm +.Ed +.Pp +Likewise, to quickly rebuild and reinstall the kernel, use: +.Bd -literal -offset indent +cd src +make buildenv TARGET_ARCH=armv6 +make -sj8 kernel KERNFAST=1 DESTDIR=/clients/arm +.Ed .Sh SEE ALSO .Xr svnlite 1 , .Xr witness 4 , diff --git a/share/man/man7/hier.7 b/share/man/man7/hier.7 index 3596077432a0..4681352fb6af 100644 --- a/share/man/man7/hier.7 +++ b/share/man/man7/hier.7 @@ -28,7 +28,7 @@ .\" @(#)hier.7 8.1 (Berkeley) 6/5/93 .\" $FreeBSD$ .\" -.Dd June 18, 2018 +.Dd December 6, 2018 .Dt HIER 7 .Os .Sh NAME @@ -144,10 +144,18 @@ and .Pa /sbin .Pp .Bl -tag -width "defaults/" -compact +.It Pa casper/ +service-specific +.Xr libcasper 3 +Capsicum support libraries .It Pa geom/ class-specific libraries for the .Xr geom 8 utility +.It Pa nvmecontrol/ +vendor-specific libraries to extend the +.Xr nvmecontrol 8 +utility .El .It Pa /libexec/ critical system utilities needed for binaries in |