share/man/man4/tap.4

   1 .\" $FreeBSD$
   2 .\" Based on PR#2411
   3 .\"
   4 .Dd November 29, 2017
   5 .Dt TAP 4
   6 .Os
   7 .Sh NAME
   8 .Nm tap
   9 .Nd Ethernet tunnel software network interface
  10 .Sh SYNOPSIS
  11 .Cd device tap
  12 .Sh DESCRIPTION
  13 The
  14 .Nm
  15 interface is a software loopback mechanism that can be loosely
  16 described as the network interface analog of the
  17 .Xr pty 4 ,
  18 that is,
  19 .Nm
  20 does for network interfaces what the
  21 .Nm pty
  22 driver does for terminals.
  23 .Pp
  24 The
  25 .Nm
  26 driver, like the
  27 .Nm pty
  28 driver, provides two interfaces: an interface like the usual facility
  29 it is simulating
  30 (an Ethernet network interface in the case of
  31 .Nm ,
  32 or a terminal for
  33 .Nm pty ) ,
  34 and a character-special device
  35 .Dq control
  36 interface.
  37 .Pp
  38 The network interfaces are named
  39 .Dq Li tap0 ,
  40 .Dq Li tap1 ,
  41 etc., one for each control device that has been opened.
  42 These Ethernet network interfaces persist until
  43 .Pa if_tap.ko
  44 module is unloaded, or until removed with "ifconfig destroy" (see below).
  45 .Pp
  46 .Nm
  47 devices are created using interface cloning.
  48 This is done using the
  49 .Dq ifconfig tap Ns Sy N No create
  50 command.
  51 This is the preferred method of creating
  52 .Nm
  53 devices.
  54 The same method allows removal of interfaces.
  55 For this, use the
  56 .Dq ifconfig tap Ns Sy N No destroy
  57 command.
  58 .Pp
  59 If the
  60 .Xr sysctl 8
  61 variable
  62 .Va net.link.tap.devfs_cloning
  63 is non-zero, the
  64 .Nm
  65 interface
  66 permits opens on the special control device
  67 .Pa /dev/tap .
  68 When this device is opened,
  69 .Nm
  70 will return a handle for the lowest unused
  71 .Nm
  72 device (use
  73 .Xr devname 3
  74 to determine which).
  75 .Pp
  76 .Bf Em
  77 Disabling the legacy devfs cloning functionality may break existing
  78 applications which use
  79 .Nm ,
  80 such as
  81 .Tn VMware
  82 and
  83 .Xr ssh 1 .
  84 It therefore defaults to being enabled until further notice.
  85 .Ef
  86 .Pp
  87 Control devices (once successfully opened) persist until
  88 .Pa if_tap.ko
  89 is unloaded or the interface is destroyed.
  90 .Pp
  91 Each interface supports the usual Ethernet network interface
  92 .Xr ioctl 2 Ns s ,
  93 such as
  94 .Dv SIOCSIFADDR
  95 and
  96 .Dv SIOCSIFNETMASK ,
  97 and thus can be used with
  98 .Xr ifconfig 8
  99 like any other Ethernet interface.
 100 When the system chooses to transmit
 101 an Ethernet frame on the network interface, the frame can be read from
 102 the control device
 103 (it appears as
 104 .Dq input
 105 there);
 106 writing an Ethernet frame to the control device generates an input frame on
 107 the network interface, as if the
 108 (non-existent)
 109 hardware had just received it.
 110 .Pp
 111 The Ethernet tunnel device, normally
 112 .Pa /dev/tap Ns Sy N ,
 113 is exclusive-open
 114 (it cannot be opened if it is already open)
 115 and is restricted to the super-user, unless the
 116 .Xr sysctl 8
 117 variable
 118 .Va net.link.tap.user_open
 119 is non-zero.
 120 If the
 121 .Xr sysctl 8
 122 variable
 123 .Va net.link.tap.up_on_open
 124 is non-zero, the tunnel device will be marked
 125 .Dq up
 126 when the control device is opened.
 127 A
 128 .Fn read
 129 call will return an error
 130 .Pq Er EHOSTDOWN
 131 if the interface is not
 132 .Dq ready .
 133 Once the interface is ready,
 134 .Fn read
 135 will return an Ethernet frame if one is available; if not, it will
 136 either block until one is or return
 137 .Er EWOULDBLOCK ,
 138 depending on whether non-blocking I/O has been enabled.
 139 If the frame
 140 is longer than is allowed for in the buffer passed to
 141 .Fn read ,
 142 the extra data will be silently dropped.
 143 .Pp
 144 A
 145 .Xr write 2
 146 call passes an Ethernet frame in to be
 147 .Dq received
 148 on the pseudo-interface.
 149 Each
 150 .Fn write
 151 call supplies exactly one frame; the frame length is taken from the
 152 amount of data provided to
 153 .Fn write .
 154 Writes will not block; if the frame cannot be accepted
 155 for a transient reason
 156 (e.g., no buffer space available),
 157 it is silently dropped; if the reason is not transient
 158 (e.g., frame too large),
 159 an error is returned.
 160 The following
 161 .Xr ioctl 2
 162 calls are supported
 163 (defined in
 164 .In net/if_tap.h ) :
 165 .Bl -tag -width VMIO_SIOCSETMACADDR
 166 .It Dv TAPSIFINFO
 167 Set network interface information (line speed and MTU).
 168 The type must be the same as returned by
 169 .Dv TAPGIFINFO
 170 or set to
 171 .Dv IFT_ETHER
 172 else the
 173 .Xr ioctl 2
 174 call will fail.
 175 The argument should be a pointer to a
 176 .Va struct tapinfo .
 177 .It Dv TAPGIFINFO
 178 Retrieve network interface information (line speed, MTU and type).
 179 The argument should be a pointer to a
 180 .Va struct tapinfo .
 181 .It Dv TAPSDEBUG
 182 The argument should be a pointer to an
 183 .Va int ;
 184 this sets the internal debugging variable to that value.
 185 What, if
 186 anything, this variable controls is not documented here; see the source
 187 code.
 188 .It Dv TAPGDEBUG
 189 The argument should be a pointer to an
 190 .Va int ;
 191 this stores the internal debugging variable's value into it.
 192 .It Dv TAPGIFNAME
 193 Retrieve network interface name.
 194 The argument should be a pointer to a
 195 .Va struct ifreq .
 196 The interface name will be returned in the
 197 .Va ifr_name
 198 field.
 199 .It Dv FIONBIO
 200 Turn non-blocking I/O for reads off or on, according as the argument
 201 .Va int Ns 's
 202 value is or is not zero
 203 (Writes are always nonblocking).
 204 .It Dv FIOASYNC
 205 Turn asynchronous I/O for reads
 206 (i.e., generation of
 207 .Dv SIGIO
 208 when data is available to be read)
 209 off or on, according as the argument
 210 .Va int Ns 's
 211 value is or is not zero.
 212 .It Dv FIONREAD
 213 If any frames are queued to be read, store the size of the first one into the argument
 214 .Va int ;
 215 otherwise, store zero.
 216 .It Dv TIOCSPGRP
 217 Set the process group to receive
 218 .Dv SIGIO
 219 signals, when asynchronous I/O is enabled, to the argument
 220 .Va int
 221 value.
 222 .It Dv TIOCGPGRP
 223 Retrieve the process group value for
 224 .Dv SIGIO
 225 signals into the argument
 226 .Va int
 227 value.
 228 .It Dv SIOCGIFADDR
 229 Retrieve the Media Access Control
 230 .Pq Dv MAC
 231 address of the
 232 .Dq remote
 233 side.
 234 This command is used by the VMware port and expected to be executed on
 235 descriptor, associated with control device
 236 (usually
 237 .Pa /dev/vmnet Ns Sy N
 238 or
 239 .Pa /dev/tap Ns Sy N ) .
 240 The
 241 .Va buffer ,
 242 which is passed as the argument, is expected to have enough space to store
 243 the
 244 .Dv MAC
 245 address.
 246 At the open time both
 247 .Dq local
 248 and
 249 .Dq remote
 250 .Dv MAC
 251 addresses are the same, so this command could be used to retrieve the
 252 .Dq local
 253 .Dv MAC
 254 address.
 255 .It Dv SIOCSIFADDR
 256 Set the Media Access Control
 257 .Pq Dv MAC
 258 address of the
 259 .Dq remote
 260 side.
 261 This command is used by VMware port and expected to be executed on
 262 a descriptor, associated with control device
 263 (usually
 264 .Pa /dev/vmnet Ns Sy N ) .
 265 .El
 266 .Pp
 267 The control device also supports
 268 .Xr select 2
 269 for read; selecting for write is pointless, and always succeeds, since
 270 writes are always non-blocking.
 271 .Pp
 272 On the last close of the data device, the interface is
 273 brought down
 274 (as if with
 275 .Dq ifconfig tap Ns Sy N No down )
 276 unless the device is a
 277 .Em VMnet
 278 device.
 279 All queued frames are thrown away.
 280 If the interface is up when the data
 281 device is not open, output frames are thrown away rather than
 282 letting them pile up.
 283 .Pp
 284 The
 285 .Nm
 286 device can also be used with the VMware port as a replacement
 287 for the old
 288 .Em VMnet
 289 device driver.
 290 The driver uses the minor number
 291 to select between
 292 .Nm
 293 and
 294 .Nm vmnet
 295 devices.
 296 .Em VMnet
 297 minor numbers begin at
 298 .Va 0x800000
 299 +
 300 .Va N ;
 301 where
 302 .Va N
 303 is a
 304 .Em VMnet
 305 unit number.
 306 In this case the control device is expected to be
 307 .Pa /dev/vmnet Ns Sy N ,
 308 and the network interface will be
 309 .Sy vmnet Ns Ar N .
 310 Additionally,
 311 .Em VMnet
 312 devices do not
 313 .Xr ifconfig 8
 314 themselves down when the
 315 control device is closed.
 316 Everything else is the same.
 317 .Pp
 318 In addition to the above mentioned
 319 .Xr ioctl 2
 320 calls, there is an additional one for the VMware port.
 321 .Bl -tag -width VMIO_SIOCSETMACADDR
 322 .It Dv VMIO_SIOCSIFFLAGS
 323 VMware
 324 .Dv SIOCSIFFLAGS .
 325 .El
 326 .Sh SEE ALSO
 327 .Xr inet 4 ,
 328 .Xr intro 4