share/man/man7d/ipnet.7d

   1 '\" te
   2 .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved
   3 .\" 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.
   4 .\"  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
   5 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH IPNET 7D "Apr 8, 2009"
   7 .SH NAME
   8 ipnet, lo0 \- ipnet device driver
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/dev/ipnet/*, /dev/lo0\fR
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBipnet\fR device driver creates, removes and manages nodes in the
  19 \fB/dev/ipnet/\fR namespace.
  20 .sp
  21 .LP
  22 A node is created in \fB/dev/ipnet\fR for every IP interface on the system,
  23 including interfaces that exist only in software and for which there is no
  24 hardware device. The \fBipnet\fR device also provides access to all IP traffic
  25 to and from the system. To provide access to packets that are internally
  26 looped-back in IP, the \fBipnet\fR driver creates a \fB/dev/lo0\fR DLPI device.
  27 .SH APPLICATION PROGRAMMING INTERFACE
  28 .SS "ipnet and DLPI"
  29 .sp
  30 .LP
  31 Device nodes created in \fB/dev/ipnet\fR are DLPI style-1 devices. All
  32 \fBM_PROTO\fR and \fBM_PCPROTO\fR-type messages are interpreted as DLPI
  33 primitives. Because the device is read-only and packets can only be observed by
  34 opening them, the following subset of DLPI primitives is supported:
  35 .sp
  36 .in +2
  37 .nf
  38 DL_INFO_REQ
  39 DL_BIND_REQ
  40 DL_UNBIND_REQ
  41 DL_PROMISCON_REQ
  42 DL_PROMISCOFF_REQ
  43 DLIOCRAW
  44 .fi
  45 .in -2
  46
  47 .sp
  48 .LP
  49 The values returned by the driver in the \fBDL_INFO_ACK\fR primitive in
  50 response to the \fBDL_INFO_REQ\fR are:
  51 .RS +4
  52 .TP
  53 .ie t \(bu
  54 .el o
  55 Maximum \fBSDU\fR is \fBINT_MAX\fR
  56 .RE
  57 .RS +4
  58 .TP
  59 .ie t \(bu
  60 .el o
  61 Minimum \fBSDU\fR is \fB0\fR.
  62 .RE
  63 .RS +4
  64 .TP
  65 .ie t \(bu
  66 .el o
  67 \fBDLSAP\fR address length is \fB2.\fR
  68 .RE
  69 .RS +4
  70 .TP
  71 .ie t \(bu
  72 .el o
  73 \fBMAC\fR type is \fBDL_IPNET\fR.
  74 .RE
  75 .RS +4
  76 .TP
  77 .ie t \(bu
  78 .el o
  79 \fBSAP\fR length value is \fB2\fR.
  80 .RE
  81 .RS +4
  82 .TP
  83 .ie t \(bu
  84 .el o
  85 Service mode is \fBDL_CLDLS\fR.
  86 .RE
  87 .RS +4
  88 .TP
  89 .ie t \(bu
  90 .el o
  91 No optional quality of service (QOS) support is provided. Accordingly, the QOS
  92 fields are 0.
  93 .RE
  94 .RS +4
  95 .TP
  96 .ie t \(bu
  97 .el o
  98 Provider style is \fBDL_STYLE1\fR.
  99 .RE
 100 .RS +4
 101 .TP
 102 .ie t \(bu
 103 .el o
 104 Version is \fBDL_VERSION_2\fR.
 105 .RE
 106 .sp
 107 .LP
 108 The \fB/dev/ipnet/*\fR and \fB/dev/lo0\fR devices only accept \fBDL_BIND_REQ\fR
 109 requests for SAPs 4 (IPv4 packets), 6 (IPv6 packets), or 0 (all IP packets).
 110 \fBDL_BIND_REQ\fR requests for other SAP values result in a \fBDL_ERROR_ACK\fR
 111 of \fBDL_BADSAP\fR.
 112 .SS "ipnet primitives"
 113 .sp
 114 .LP
 115 For \fB/dev/ipnet/*\fR devices, the \fBDL_PROMISCON_REQ\fR and
 116 \fBDL_PROMISCOFF_REQ\fR primitives with the \fBDL_PROMISC_PHYS\fR flag set in
 117 the \fBdl_level\fR field enables/disables the reception of all packets. When
 118 disabled, only packets with addresses matching any of the configured addresses
 119 on the IP interface are received. When used with the \fBDL_PROMISC_MULTI\fR
 120 flag set, reception of all multicast group addresses can be enabled/disabled.
 121 \fBDL_PROMISC_PHYS\fR and \fBDL_PROMISC_MULTI\fR have no effect for
 122 \fB/dev/lo0\fR. When the \fBDL_PROMISC_SAP\fR flag is set, reception of all
 123 IPv4/IPv6 can be enabled/disabled.
 124 .sp
 125 .LP
 126 The \fBDLIOCRAW\fR ioctl is supported but has no effect on the data returned
 127 from the device.
 128 .sp
 129 .LP
 130 The \fBDL_IOC_IPNET_INFO\fR ioctl enables/disables the inclusion of a
 131 \fBdl_ipnetinfo_t\fR structure that is prepended to the IP header when
 132 receiving packet data. When enabled, a non-zero integer is returned reflecting
 133 the current \fBDL_IOC_IPNET_INFO\fR version. The \fBdl_ipnetinfo_t\fR data
 134 structure is defined in \fB<sys/dlpi.h>\fR and includes the following fields:
 135 .sp
 136 .in +2
 137 .nf
 138 uint8_t  dli_version;  /* DL_IPNETINFO_* version */
 139 uint8_t  dli_ipver;    /* packet IP header version */
 140 uint16_t dli_len;      /* length of dl_ipnetinfo_t */
 141 uint64_t dli_srczone;  /* packet source zone ID (if any) */
 142 uint64_t dli_dstzone;  /* packet dest zone ID (if any) */
 143 .fi
 144 .in -2
 145
 146 .sp
 147 .LP
 148 The current \fBdli_version\fR is 1. To robustly support future
 149 \fBdl_ipnetinfo_t\fR versions, consumers should check that \fBdli_version\fR is
 150 a value they recognize, and must use the \fBdli_len\fR field to advance past
 151 the \fBdl_ipnetinfo_t\fR header.
 152 .SH FILES
 153 .sp
 154 .ne 2
 155 .na
 156 \fB\fB/dev/ipnet/*, /dev/lo0\fR\fR
 157 .ad
 158 .RS 26n
 159 Special character devices.
 160 .RE
 161
 162 .sp
 163 .ne 2
 164 .na
 165 \fB\fB/kernel/drv/ipnet.conf\fR\fR
 166 .ad
 167 .RS 26n
 168 Configuration file.
 169 .RE
 170
 171 .SH ATTRIBUTES
 172 .sp
 173 .LP
 174 See \fBattributes\fR(5) for descriptions of the following attributes:
 175 .sp
 176
 177 .sp
 178 .TS
 179 box;
 180 l l
 181 l l .
 182 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 183 Architecture    SPARC, x86
 184 Interface Stability     Committed
 185 .TE
 186
 187 .SH SEE ALSO
 188 .sp
 189 .LP
 190 \fBattributes\fR(5), \fBdlpi\fR(7P)