diff options
Diffstat (limited to 'usr/src/man')
| -rw-r--r-- | usr/src/man/man1m/Makefile | 1 | ||||
| -rw-r--r-- | usr/src/man/man1m/arp.1m | 9 | ||||
| -rw-r--r-- | usr/src/man/man1m/in.ndpd.1m | 17 | ||||
| -rw-r--r-- | usr/src/man/man1m/ndp.1m | 215 | ||||
| -rw-r--r-- | usr/src/man/man1m/netstat.1m | 2 | ||||
| -rw-r--r-- | usr/src/man/man7p/Makefile | 4 | ||||
| -rw-r--r-- | usr/src/man/man7p/arp.7p | 57 | ||||
| -rw-r--r-- | usr/src/man/man7p/if_tcp.7p | 6 | ||||
| -rw-r--r-- | usr/src/man/man7p/ndp.7p | 345 | ||||
| -rw-r--r-- | usr/src/man/man7p/route.7p | 8 |
10 files changed, 594 insertions, 70 deletions
diff --git a/usr/src/man/man1m/Makefile b/usr/src/man/man1m/Makefile index 8dbf7331b1..c5f7db2cbc 100644 --- a/usr/src/man/man1m/Makefile +++ b/usr/src/man/man1m/Makefile @@ -335,6 +335,7 @@ _MANFILES= 6to4relay.1m \ ncheck.1m \ ncheck_ufs.1m \ ndd.1m \ + ndp.1m \ ndmpadm.1m \ ndmpd.1m \ ndmpstat.1m \ diff --git a/usr/src/man/man1m/arp.1m b/usr/src/man/man1m/arp.1m index 11fa0164f0..ca4e20bdc1 100644 --- a/usr/src/man/man1m/arp.1m +++ b/usr/src/man/man1m/arp.1m @@ -4,7 +4,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH ARP 1M "Jan 5, 2009" +.TH ARP 1M "Sep 02, 2015" .SH NAME arp \- address resolution display and control .SH SYNOPSIS @@ -35,7 +35,6 @@ arp \- address resolution display and control .fi .SH DESCRIPTION -.sp .LP The \fBarp\fR program displays and modifies the Internet-to-MAC address translation tables used by the address resolution protocol (see \fBarp\fR(7P)). @@ -48,9 +47,8 @@ dot notation. .LP Options that modify the ARP translation tables (\fB-d\fR, \fB-f\fR, and \fB-s\fR) can be used only when the invoked command is granted the -\fBsys_net_config\fR privilege. See \fBprivileges\fR(5). +\fBPRIV_SYS_NET_CONFIG\fR privilege. See \fBprivileges\fR(5). .SH OPTIONS -.sp .ne 2 .na \fB\fB-a\fR\fR @@ -244,7 +242,6 @@ kernel and thus cannot be changed. .RE .SH SEE ALSO -.sp .LP -\fBifconfig\fR(1M), \fBnetstat\fR(1M), \fBattributes\fR(5), +\fBifconfig\fR(1M), \fBnetstat\fR(1M), \fBndp\fR(1M), \fBattributes\fR(5), \fBprivileges\fR(5), \fBarp\fR(7P) diff --git a/usr/src/man/man1m/in.ndpd.1m b/usr/src/man/man1m/in.ndpd.1m index 5693425a89..2ce2643405 100644 --- a/usr/src/man/man1m/in.ndpd.1m +++ b/usr/src/man/man1m/in.ndpd.1m @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH IN.NDPD 1M "Jan 10, 2007" +.TH IN.NDPD 1M "Sep 02, 2015" .SH NAME in.ndpd \- daemon for IPv6 autoconfiguration .SH SYNOPSIS @@ -13,7 +13,6 @@ in.ndpd \- daemon for IPv6 autoconfiguration .fi .SH DESCRIPTION -.sp .LP \fBin.ndpd\fR provides both the host and router autoconfiguration components of Neighbor Discovery for IPv6 and Stateless and Stateful Address @@ -151,7 +150,6 @@ can only be used for communication with nodes on the same link. .LP For information on how to enable IPv6 address autoconfiguration, see \fI\fR .SH OPTIONS -.sp .LP Supported options and equivalent SMF service properties are listed below. SMF service properties are set using a command of the form: @@ -223,7 +221,6 @@ controlling terminal. As such, this option cannot be run under the SMF. .RE .SH FILES -.sp .ne 2 .na \fB\fB/etc/inet/ndpd.conf\fR\fR @@ -235,14 +232,10 @@ the hosts. .RE .SH SEE ALSO -.sp .LP -\fBdhcpagent\fR(1M), \fBifconfig\fR(1M), \fBrouteadm\fR(1M), \fBsvcadm\fR(1M), -\fBndpd.conf\fR(4), \fBattributes\fR(5), \fBicmp6\fR(7P),\fBip6\fR(7P), -\fBattributes\fR(5), \fBsmf\fR(5) -.sp -.LP -\fI\fR +\fBdhcpagent\fR(1M), \fBifconfig\fR(1M), \fBndp\fR(1M), \fBrouteadm\fR(1M), +\fBsvcadm\fR(1M), \fBndpd.conf\fR(4), \fBattributes\fR(5), \fBsmf\fR(5), +\fBicmp6\fR(7P), \fBip6\fR(7P), \fBndp\fR(7P) .sp .LP Narten, T., Nordmark, E., Simpson, W.\fIRFC 2461, Neighbor Discovery for IP @@ -256,12 +249,10 @@ Autoconfiguration\fR. The Internet Society. December 1998. Narten, T., and Draves, R. RFC 3041, Privacy Extensions for Stateless Address Autoconfiguration in IPv6. The Internet Society. January 2001. .SH DIAGNOSTICS -.sp .LP Receipt of a \fBSIGHUP\fR signal will make \fBin.ndpd\fR restart and reread \fB/etc/inet/ndpd.conf\fR. .SH NOTES -.sp .LP The \fBin.ndpd\fR daemon service is managed by the service management facility, \fBsmf\fR(5), under the service identifier: diff --git a/usr/src/man/man1m/ndp.1m b/usr/src/man/man1m/ndp.1m new file mode 100644 index 0000000000..6301181f5f --- /dev/null +++ b/usr/src/man/man1m/ndp.1m @@ -0,0 +1,215 @@ +.\" +.\" This file and its contents are supplied under the terms of the +.\" Common Development and Distribution License ("CDDL"), version 1.0. +.\" You may only use this file in accordance with the terms of version +.\" 1.0 of the CDDL. +.\" +.\" A full copy of the text of the CDDL should have accompanied this +.\" source. A copy of the CDDL is also available via the Internet at +.\" http://www.illumos.org/license/CDDL. +.\" +.\" +.\" Copyright (c) 2015, Joyent, Inc. All rights reserved. +.\" +.Dd Sep 02, 2015 +.Dt NDP 1M +.Os +.Sh NAME +.Nm ndp +.Nd manipulate IPv6 Neighbor Discovery Protocol mappings +.Sh SYNOPSIS +.Nm +.Op Fl n +.Fl a +.Nm +.Op Fl n +.Fl A Ar period +.Nm +.Op Fl n +.Op Fl i Ar iface +.Ar hostname +.Nm +.Op Fl n +.Op Fl i Ar iface +.Fl d Ar hostname +.Nm +.Op Fl n +.Op Fl i Ar iface +.Fl f Ar filename +.Nm +.Op Fl n +.Op Fl i Ar iface +.Fl s Ar hostname lladdr +.Op Cm temp +.Op Cm any +.Op Cm router +.Sh DESCRIPTION +The +.Nm +command displays and modifies the IPv6-to-MAC address translation +tables used by the Neighbor Discovery Protocol +.Po see Xr ndp 7P Pc . +.Pp +Given just a hostname, +.Nm +will display the current entry. Note that when getting, setting or deleting, +if a hostname refers to multiple IPv6 addresses, the operation will apply to +all of them. +.Pp +The NDP translation tables can be modified with +.Fl d , +.Fl s , +or +.Fl f . +These flags can only be used when +.Nm +is given the +.Sy PRIV_SYS_NET_CONFIG +privilege. See +.Xr privileges 5 +for further information. +.Pp +Note that NDP entries for IPMP (IP Network Multipathing) data and +test addresses are managed by the kernel and therefore cannot be +modified or deleted. +.Sh OPTIONS +.Bl -tag -width 6m +.It Fl a +Display all NDP entries. Entries can be one of several types: +.Bl -tag -offset indent -width 7n +.It Sy dynamic +This is a normal NDP mapping and will eventually expire. This is the most +common type of mapping for non-local addresses that will be displayed. +.It Sy local +The IPv6 address is local to the machine. +.It Sy other +The mapping is a multicast or broadcast address, or the system is acting +as proxy for the address. +.It Sy static +The mapping is static and will not be removed from the machine over time. +.El +.Pp +Entries also exist in one of the following states: +.Bl -tag -offset indent -width 12m +.It Sy INCOMPLETE +Address resolution is in progress +.It Sy REACHABLE +This address has recently been reachable +.It Sy STALE +This address may be unreachable +.It Sy DELAY +Waiting to send out reachability probes +.It Sy PROBE +Sending out probes for the address +.It Sy UNREACHABLE +The address is unreachable, and will be deleted +.It Sy UNKNOWN +The state of the entry is unknown +.El +.Pp +Using the +.Fl a +flag is equivalent to: +.sp +.Dl # netstat -p -f inet6 +.sp +If +.Fl n +is passed to +.Nm , +then it will be passed along to +.Nm netstat . +.It Fl A +Display all NDP entries every +.Ar period +seconds. +.It Fl d +Delete NDP mappings for the host called +.Ar hostname . +.It Fl f +Read in the lines from +.Ar filename +and use each one to set a mapping. The syntax of each line is the +same as the arguments to +.Fl s . +Lines beginning with `#' will be ignored. +.It Fl i +By default, +.Nm +will use the routing table to determine the appropriate interface to place the +mapping on. This flag allows forcing a specific interface +.Ar iface . +This argument will be ignored when using the +.Fl a +or +.Fl A +flags. +.It Fl n +Disable the default translation of numeric IP addresses to host names when +printing. +.It Fl s +Add or update an NDP mapping, and set the desired properties for the entry. The +list of flags should be the full set of flags desired on the entry, i.e., not +listing a flag will remove it if it already exists. The following flags can be +used: +.Bl -tag -offset indent -width Ds +.It Cm temp +The entry should be temporary and eventually expire like a normal NDP +entry. By default, all entries created with the +.Nm +command are static, and will not be deleted. To make a static entry temporary, +it should be deleted and recreated with the +.Cm temp +flag. +.It Cm any +The address should be treated like an anycast address. This will prevent the +system from sending Neighbor Advertisements with the Override flag. +.It Cm router +The address should be treated like a router address. This cause the system to +send Neighbor Advertisements with the Router flag. +.El +.El +.Sh EXAMPLES +.Ss Example 1: Setting a mapping +To create a temporary mapping for an address: +.Bd -literal -offset indent +# ndp -s fd00::1 90:b8:d0:4b:c7:3b temp +.Ed +.Ss Example 2: Getting a mapping +An entry can be fetched via its IP address: +.Bd -literal -offset indent +# ndp fd00::1 +fd00::1 (fd00::1) at 90:b8:d0:4b:c7:3b temp +.Ed +.sp +Or via a name that resolves to that address: +.Bd -literal -offset indent +# echo fd00::1 epicac >> /etc/hosts +# echo fd00::2 epicac >> /etc/hosts +# ndp epicac +fd00::1 (epicac) at 90:b8:d0:4b:c7:3b temp +fd00::2 (epicac) -- no entry +.Ed +.Ss Example 3: Deleting a mapping +An entry can be removed with the +.Fl d +flag: +.Bd -literal -offset indent +# ndp -d fd00::1 +.Ed +.sp +Attempting to remove it again will print an error message: +.Bd -literal -offset indent +# ndp -d fd00::1 +ndp: No entry for fd00::1 +.Ed +.Sh STABILITY +The command line options for this command are stable, but the output format +and diagnostic messages are not. +.Sh SEE ALSO +.Xr arp 1M , +.Xr ifconfig 1M , +.Xr netstat 1M , +.Xr attributes 5 , +.Xr privileges 5 , +.Xr ndp 7P diff --git a/usr/src/man/man1m/netstat.1m b/usr/src/man/man1m/netstat.1m index f9d02d18e0..b1f6d0e22f 100644 --- a/usr/src/man/man1m/netstat.1m +++ b/usr/src/man/man1m/netstat.1m @@ -1028,7 +1028,7 @@ future lease. .SH SEE ALSO .LP \fBarp\fR(1M), \fBdhcpinfo\fR(1), \fBdhcpagent\fR(1M), \fBifconfig\fR(1M), -\fBiostat\fR(1M), \fBkstat\fR(1M), \fBmibiisa\fR(1M), \fBsavecore\fR(1M), +\fBiostat\fR(1M), \fBkstat\fR(1M), \fBmibiisa\fR(1M), \fBndp\fR(1M), \fBsavecore\fR(1M), \fBvmstat\fR(1M), \fBhosts\fR(4), \fBinet_type\fR(4), \fBnetworks\fR(4), \fBprotocols\fR(4), \fBservices\fR(4), \fBattributes\fR(5), \fBdhcp\fR(5), \fBkstat\fR(7D), \fBinet\fR(7P), \fBinet6\fR(7P) diff --git a/usr/src/man/man7p/Makefile b/usr/src/man/man7p/Makefile index bbcf5ecf1d..13cb58770d 100644 --- a/usr/src/man/man7p/Makefile +++ b/usr/src/man/man7p/Makefile @@ -30,6 +30,7 @@ MANFILES= arp.7p \ ipsec.7p \ ipsecah.7p \ ipsecesp.7p \ + ndp.7p \ pf_key.7p \ rarp.7p \ route.7p \ @@ -45,6 +46,7 @@ MANLINKS= AH.7p \ ESP.7p \ ICMP.7p \ IP.7p \ + NDP.7p \ RARP.7p \ SCTP.7p \ TCP.7p \ @@ -63,6 +65,8 @@ AH.7p := LINKSRC = ipsecah.7p ESP.7p := LINKSRC = ipsecesp.7p +NDP.7p := LINKSRC = ndp.7p + RARP.7p := LINKSRC = rarp.7p SCTP.7p := LINKSRC = sctp.7p diff --git a/usr/src/man/man7p/arp.7p b/usr/src/man/man7p/arp.7p index 5489ce3aca..d7055fcb0a 100644 --- a/usr/src/man/man7p/arp.7p +++ b/usr/src/man/man7p/arp.7p @@ -4,40 +4,25 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH ARP 7P "Feb 5, 2009" +.TH ARP 7P "Sep 02, 2015" .SH NAME arp, ARP \- Address Resolution Protocol .SH SYNOPSIS .LP .nf \fB#include <sys/fcntl.h>\fR -.fi - -.LP -.nf \fB#include <sys/socket.h>\fR -.fi - -.LP -.nf \fB#include <net/if_arp.h>\fR -.fi - -.LP -.nf \fB#include <netinet/in.h>\fR .fi - .LP .nf -\fBs = socket(AF_INET, SOCK_DGRAM, 0);\fR +\fBs = socket(PF_INET, SOCK_DGRAM, 0);\fR .fi - .LP .nf \fBd = open ("/dev/arp", \fIoflag\fR);\fR .fi - .SH DESCRIPTION .LP ARP is a protocol used to map dynamically between Internet Protocol (IP) and @@ -64,8 +49,8 @@ interface. .LP To facilitate communications with systems that do not use ARP, ioctl() requests are provided to enter and delete entries in the IP-to-link -address tables. Ioctls that change the table contents require sys_net_config -privilege. See \fBprivileges\fR(5). +address tables. Ioctls that change the table contents require the +\fBPRIV_SYS_NET_CONFIG\fR privilege. See \fBprivileges\fR(5). .sp .in +2 .nf @@ -109,10 +94,8 @@ Each \fBioctl()\fR request takes the same structure as an argument. entry, and \fBSIOCD[X]ARP\fR deletes an \fBARP\fR entry. These \fBioctl()\fR requests may be applied to any Internet family socket descriptor\fIs\fR, or to a descriptor for the \fBARP\fR device. Note that \fBSIOCS[X]ARP\fR and -\fBSIOCD[X]ARP\fR require a privileged user, while \fBSIOCG[X]ARP\fR -.sp -.LP -does not. +\fBSIOCD[X]ARP\fR require the user to have the \fBPRIV_SYS_NET_CONFIG\fR +privilege, while \fBSIOCG[X]ARP\fR does not. .sp .LP The \fBarpreq\fR structure contains @@ -155,8 +138,8 @@ struct xarpreq { .sp .LP The address family for the [x]arp_pa sockaddr must be \fBAF_INET\fR. The -\fBATF_COM\fR flag bits ([x]arp_flags) cannot be altered. -\fBATF_USETRAILERS\fR is not implemented on Solaris and is retained for +\fBATF_COM\fR flag bits ([x]arp_flags) cannot be altered. \fBATF_USETRAILERS\fR +is not implemented by the operating system and is retained for compatibility only. \fBATF_PERM\fR makes the entry permanent (disables aging) if the \fBioctl()\fR request succeeds. \fBATF_PUBL\fR specifies that the system should respond to ARP requests for the indicated protocol address coming from @@ -206,11 +189,11 @@ interface). On return from the kernel on a \fBSIOCGXARP\fR ioctl, the kernel fills in the name of the interface (excluding terminating NULL) and its hardware address, one after another, in the \fBsdl_data/LLADDR\fR area; if the two are larger -than can be held in the 244 byte \fBsdl_data[\fR] area, an \fBENOSPC\fR error +than can be held in the 244 byte \fBsdl_data[\fR] area, an \fBEINVAL\fR error is returned. Assuming it fits, the kernel will also set \fBsdl_alen\fR with the -length of hardware address, \fBsdl_nlen\fR with the length of name of the +length of the hardware address, \fBsdl_nlen\fR with the length of the name of the interface (excluding terminating NULL), \fBsdl_type\fR with an IFT_* value to -indicate the type of the media, \fBsdl_slen\fR with 0, sdl_family with +indicate the type of the media, \fBsdl_slen\fR with 0, \fBsdl_family\fR with \fBAF_LINK\fR and \fBsdl_index\fR (which if not 0) with system given index for the interface. The information returned is very similar to that returned via routing sockets on an \fBRTM_IFINFO\fR message. @@ -239,7 +222,7 @@ corresponding IPMP IP interface. .TP .ie t \(bu .el o -roxy ARP mappings for an IPMP group are automatically managed by the kernel. +Proxy ARP mappings for an IPMP group are automatically managed by the kernel. Specifically, if the hardware address in a \fBSIOCSARP\fR or \fBSIOCSXARP\fR request matches the hardware address of an IP interface in an IPMP group and the IP address is not local to the system, the kernel regards this as a IPMP @@ -247,18 +230,6 @@ Proxy ARP entry. This IPMP Proxy ARP entry will have its hardware address automatically adjusted in order to keep the IP address reachable (provided the IPMP group has not entirely failed). .RE -.br -.in +2 -\(em -.in -2 -.br -.in +2 -\(em -.in -2 -.br -.in +2 -\(emP -.in -2 .sp .LP \fBARP\fR performs duplicate address detection for local addresses. When a @@ -285,7 +256,7 @@ passing it the value \fBNHF_ARP\fR. Through this interface, two packet events are supported: .sp .LP -Physical in - ARP packets received via a network inter face +Physical in - ARP packets received via a network interface .sp .LP Physical out - ARP packets to be sent out via a network interface @@ -321,7 +292,7 @@ Identifier indicating the outbound interface for packets received with the .ad .sp .6 .RS 4n -Pointer to the start of the ARP header (not the ethernet header). +Pointer to the start of the ARP header (not the Ethernet header). .RE .sp diff --git a/usr/src/man/man7p/if_tcp.7p b/usr/src/man/man7p/if_tcp.7p index 6f811bd12c..acba34c8ae 100644 --- a/usr/src/man/man7p/if_tcp.7p +++ b/usr/src/man/man7p/if_tcp.7p @@ -4,7 +4,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH IF_TCP 7P "Sep 14, 2009" +.TH IF_TCP 7P "Sep 02, 2015" .SH NAME if_tcp, if \- general properties of Internet Protocol network interfaces .SH DESCRIPTION @@ -60,7 +60,7 @@ struct lifreq { int lifru_metric; uint_t lifru_mtu; int lif_muxid[2]; /* mux id's for arp & ip */ - struct lif_nd_req lifru_nd_req; + struct lif_nd_req lifru_nd_req; /* SIOCLIF*ND */ struct lif_ifinfo_req lifru_ifinfo_req; zoneid_t lifru_zone; /* SIOC[GS]LIFZONE */ } lifr_lifru; @@ -869,4 +869,4 @@ specified by \fBlifr_ppa\fR plumbed. .LP \fBifconfig\fR(1M), \fBin.routed\fR(1M), \fBioctl\fR(2), \fBsockaddr\fR(3SOCKET), \fBstreamio\fR(7I), \fBarp\fR(7P), \fBdlpi\fR(7P), -\fBip\fR(7P), \fBip6\fR(7P) +\fBip\fR(7P), \fBip6\fR(7P), \fBndp\fR(7P) diff --git a/usr/src/man/man7p/ndp.7p b/usr/src/man/man7p/ndp.7p new file mode 100644 index 0000000000..ef57b1b3d6 --- /dev/null +++ b/usr/src/man/man7p/ndp.7p @@ -0,0 +1,345 @@ +.\" +.\" This file and its contents are supplied under the terms of the +.\" Common Development and Distribution License ("CDDL"), version 1.0. +.\" You may only use this file in accordance with the terms of version +.\" 1.0 of the CDDL. +.\" +.\" A full copy of the text of the CDDL should have accompanied this +.\" source. A copy of the CDDL is also available via the Internet at +.\" http://www.illumos.org/license/CDDL. +.\" +.\" +.\" Copyright (c) 2015, Joyent, Inc. All rights reserved. +.\" +.Dd Sep 02, 2015 +.Dt NDP 7P +.Os +.Sh NAME +.Nm ndp , +.Nm NDP +.Nd Neighbor Discovery Protocol +.Sh SYNOPSIS +.In sys/socket.h +.In sys/sockio.h +.In netinet/in.h +.In net/if.h +.Bd -literal +s = socket(PF_INET6, SOCK_DGRAM, 0); + +struct lifreq lifr; +ioctl(s, SIOCLIFGETND, &lifr); +ioctl(s, SIOCLIFSETND, &lifr); +ioctl(s, SIOCLIFDELND, &lifr); +.Ed +.Sh DESCRIPTION +The Neighbor Discovery Protocol (NDP) is a protocol used to distribute and request +information about neighboring IPv6 systems on the local network, much like +.Xr ARP 7P +for IPv4. NDP is also responsible for spreading information about the network +gateway and how hosts should configure themselves +.Pq see Xr in.ndpd 1M for more on how this happens . +.Sh APPLICATION PROGRAMMING INTERFACE +The operating system provides several ioctls to help manipulate the mappings +obtained through NDP. They are +.Sy SIOCLIFGETND , +.Sy SIOCLIFSETND , +and +.Sy SIOCLIFDELND , +for getting, setting, and deleting respectively. Each of these ioctls takes a +.Vt struct lifreq +.Pq see Xr if 7P for details , +where the +.Fa lifr_lifru +field is of type +.Vt struct lif_nd_req : +.Bd -literal -offset 2m +typedef struct lif_nd_req { + struct sockaddr_storage lnr_addr; + uint8_t lnr_state_create; + uint8_t lnr_state_same_lla; + uint8_t lnr_state_diff_lla; + int lnr_hdw_len; + int lnr_flags; + int lnr_pad0; + char lnr_hdw_addr[ND_MAX_HDW_LEN]; +} lif_nd_req_t; +.Ed +.Pp +The +.Fa lnr_addr +field should be filled in with an IPv6 address +.Pq see Xr sockaddr_in6 3SOCKET , +and the +.Fa lnr_hdw_addr +is the link-layer address of length +.Fa lnr_hdw_len . +.Pp +State flags for +.Fa lnr_state_create , +.Fa lnr_state_same_lla , +and +.Fa lnr_state_diff_lla +can be set to one of the following values: +.Bl -tag -offset indent -width 16m +.It Sy ND_UNCHANGED +For ioctls that don't modify state +.It Sy ND_INCOMPLETE +Address resolution is currently in progress +.It Sy ND_REACHABLE +The link-layer address has recently been reachable +.It Sy ND_STALE +The link-layer address may be unreachable, and the system shouldn't do anything +.It Sy ND_DELAY +This entry hasn't yet started sending Neighbor Solicitations +.It Sy ND_PROBE +The operating system is currently sending out Neighbor Solicitations for the address +.It Sy ND_UNREACHABLE +The link-layer address is unreachable, and this entry is going to be deleted. +.El +.sp +When creating a new entry, the only valid values for +.Fa lnr_state_create +are +.Sy ND_REACHABLE +and +.Sy ND_STALE . +Any other value will return +.Sy EINVAL . +The +.Fa lnr_state_same_lla +and +.Fa lnr_state_diff_lla +fields are reserved for future use and can be safely set to +.Sy ND_UNCHANGED +and +.Sy ND_STALE +respectively. +.Pp +Flags that can be placed in +.Fa lnr_flags +are: +.Bl -tag -offset indent -width 16m +.It Sy NDF_ISROUTER_ON +Mark this entry as being a router. This will cause Neighbor Advertisements for +this address to be sent with the R-bit (Router). +.It Sy NDF_ISROUTER_OFF +If this entry was flagged as being a router, remove the flag. +.It Sy NDF_ANYCAST_ON +Mark this entry as being for an anycast address. This prevents sending Neighbor +Advertisements with the O-bit (Override). +.It Sy NDF_ANYCAST_OFF +If this entry was flagged as an anycast address, remove the flag. +.It Sy NDF_STATIC +Prevent this entry from being deleted by the system. +.El +.sp +When using +.Sy SIOCLIFGETND , +these flags represent the current state of the corresponding Neighbor Cache +Entry. When using +.Sy SIOCLIFSETND , +these flags represent what changes should be applied to the underlying entry. +.Pp +The only fields that need to be set for the +.Sy SIOCLIFGETND +or +.Sy SIOCLIFDELND +ioctls are +.Fa lifr_name +and +.Fa lnr_addr . +All other fields should be zeroed out. After successfully getting an entry, the +other fields will be filled in. When using +.Sy SIOCLIFSETND , +all fields should be set to an appropriate value, as described above, with the +exception of +.Fa lnr_pad0 , +which is unused and only exists for padding purposes. +.Pp +After performing the ioctl, the following errors may be returned through the +global +.Sy errno +variable: +.Bl -tag -offset indent -width 16m +.It Sy EAFNOSUPPORT +A non-IPv6 socket was used to perform the ioctl. +.It Sy EINVAL +The request contents were bad. This could be because conflicting flags were +used, the specified interface wasn't logical unit zero, or another reason. +.It Sy ENOMEM +The system ran out of memory for internal data structures. +.It Sy ENXIO +The specified interface does not exist. +.It Sy EPERM +The caller does not have permission to modify the Neighbor Cache Entries +associated with this interface. They may be lacking the +.Sy PRIV_SYS_NET_CONFIG +privilege +.Po see Xr privileges 5 Pc , +or the interface is managed by IPMP (IP Network Multipathing). +.It Sy ESRCH +There is no entry matching the specified address. +.El +.Sh EXAMPLES +The following examples demonstrate how to get and set NDP mappings using the +provided ioctls. They can be compiled by using a C compiler and linking against +the sockets library. +.Ss Example 1: Getting a mapping +.Bd -literal -offset indent +$ gcc -Wall -lsocket -o get get.c +$ cat get.c +/* + * Example of getting a mapping for a node name. + */ +#include <strings.h> +#include <stdio.h> +#include <stdlib.h> +#include <sys/socket.h> +#include <sys/sockio.h> +#include <unistd.h> +#include <netdb.h> +#include <net/if.h> + +int get(char *host) { + struct lifreq lifr; + struct addrinfo hints, *serverinfo, *p; + int err, s; + + bzero(&hints, sizeof (struct addrinfo)); + hints.ai_family = PF_INET6; + hints.ai_protocol = IPPROTO_IPV6; + + if ((err = getaddrinfo(host, NULL, &hints, &serverinfo)) != 0) { + (void) fprintf(stderr, "Unable to lookup %s: %s\\n", host, + gai_strerror(err)); + return (1); + } + + s = socket(AF_INET6, SOCK_DGRAM, 0); + if (s < 0) { + perror("Failed to open IPv6 socket"); + return (1); + } + + for (p = serverinfo; p != NULL; p = p->ai_next) { + /* Zero out structure */ + bzero(&lifr, sizeof (struct lifreq)); + (void) strlcpy(lifr.lifr_name, "net0", + sizeof (lifr.lifr_name)); + (void) memcpy(&lifr.lifr_nd.lnr_addr, p->ai_addr, + sizeof (struct sockaddr_storage)); + + /* Get mapping */ + if (ioctl(s, SIOCLIFGETND, &lifr) < 0) { + perror("Unable to get NDP mapping"); + continue; + } + + /* + * lifr.lifr_nd.lnr_hdw_addr now contains the MAC address, + * and can be used as desired. + */ + } + + /* + * Clean up linked list. + */ + freeaddrinfo(serverinfo); + return (0); +} + +int main(int argc, char *argv[]) { + if (argc < 2) + exit(1); + return (get(argv[1])); +} +.Ed +.sp +Deleting a mapping would work similarly, except that instead of using +.Sy SIOCLIFGETND , +you would instead use the +.Sy SIOCLIFDELND +ioctl. +.Ss Example 2: Adding a mapping +.Bd -literal -offset indent +$ gcc -Wall -lsocket -o set set.c +$ cat set.c +/* + * Example of setting a mapping to an all-zero Ethernet address. + */ +#include <strings.h> +#include <stdio.h> +#include <stdlib.h> +#include <sys/socket.h> +#include <sys/sockio.h> +#include <unistd.h> +#include <netdb.h> +#include <net/if.h> + +int set(char *host) { + struct lifreq lifr; + struct addrinfo hints, *serverinfo, *p; + int err, s; + + bzero(&hints, sizeof (struct addrinfo)); + hints.ai_family = PF_INET6; + hints.ai_protocol = IPPROTO_IPV6; + + if ((err = getaddrinfo(host, NULL, &hints, &serverinfo)) != 0) { + (void) fprintf(stderr, "Unable to lookup %s: %s\\n", host, + gai_strerror(err)); + return (1); + } + + s = socket(AF_INET6, SOCK_DGRAM, 0); + if (s < 0) { + perror("Failed to open IPv6 socket"); + return (1); + } + + for (p = serverinfo; p != NULL; p = p->ai_next) { + /* Zero out structure */ + bzero(&lifr, sizeof (struct lifreq)); + (void) strlcpy(lifr.lifr_name, "net0", + sizeof (lifr.lifr_name)); + (void) memcpy(&lifr.lifr_nd.lnr_addr, p->ai_addr, + sizeof (struct sockaddr_storage)); + + lifr.lifr_nd.lnr_state_create = ND_REACHABLE; + lifr.lifr_nd.lnr_flags = NDF_STATIC; + + /* Get mapping */ + if (ioctl(s, SIOCLIFSETND, &lifr) < 0) { + perror("Unable to set NDP mapping"); + continue; + } + } + + /* + * Clean up linked list. + */ + freeaddrinfo(serverinfo); + return (0); +} + +int main(int argc, char *argv[]) { + if (argc < 2) + exit(1); + return (set(argv[1])); +} +.Ed +.Sh SEE ALSO +.Xr in.ndpd 1M , +.Xr ndp 1M , +.Xr ifconfig 1M , +.Xr sockaddr_in6 3SOCKET , +.Xr privileges 5 +.Rs +.%A Narten, T. +.%A Nordmark, E. +.%A Simpson, W. +.%A Soliman, H. +.%R Neighbor Discovery for IP version 6 +.%T RFC 4861 +.%D September 2007 +.Re diff --git a/usr/src/man/man7p/route.7p b/usr/src/man/man7p/route.7p index ba193fef11..bbd74fd740 100644 --- a/usr/src/man/man7p/route.7p +++ b/usr/src/man/man7p/route.7p @@ -7,7 +7,7 @@ .\" 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. .\" Portions Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved. -.TH ROUTE 7P "Feb 5, 2009" +.TH ROUTE 7P "Sep 02, 2015" .SH NAME route \- kernel packet forwarding database .SH SYNOPSIS @@ -252,8 +252,8 @@ struct rt_msghdr { int rtm_use; /* from rtentry */ uint_t rtm_inits; /* which values we are initializing */ -struct rt_metrics rtm_rmx; /* metrics themselves */ - }; + struct rt_metrics rtm_rmx; /* metrics themselves */ +}; .fi .in -2 @@ -274,7 +274,7 @@ struct rt_metrics { uint32_t rmx_rtt; /* estimated round trip time */ uint32_t rmx_rttvar; /* estimated rtt variance */ uint32_t rmx_pksent; /* packets sent using this route */ - }; +}; /* Flags include the values */ |