if_tcp(7P)

NAME

if_tcp, if − general properties of Internet Protocol network interfaces

DESCRIPTION

A network interface is a device for sending and receiving packets on a network. It is usually a hardware device, although it can be implemented in software. Network interfaces used by the Internet Protocol (IP) must be STREAMS devices conforming to the Datalink Provider Interface (DLPI). See dlpi(7P).

APPLICATION PROGRAMMING INTERFACE

An interface becomes available to IP when it is opened and the IP module is pushed onto the stream with the I_PUSH ioctl(2) command (see streamio(7I)). This may be initiated by the kernel at boot time or by a user program some time after the system is running. Each interface must be assigned an IP address with the SIOCSIFADDR ioctl() before it can be used. On interfaces where the network-to-link layer address mapping is static, only the network number is taken from the ioctl() request; the remainder is found in a hardware specific manner. On interfaces which provide dynamic network-to-link layer address mapping facilities (for example, 10Mb/s Ethernets using arp(7P)), the entire address specified in the ioctl() is used. A routing table entry for destinations on the network of the interface is installed automatically when an interface’s address is set.

IOCTLS

The following ioctl() calls may be used to manipulate IP network interfaces. Unless specified otherwise, the request takes an ifreq structure as its parameter. This structure has the form:

/∗ Interface request structure used for socket ioctls. All ∗/
/∗ interface ioctls must have parameter definitions which ∗/
/∗ begin with ifr_name. The remainder may be interface specific. ∗/
struct ifreq {
#defineIFNAMSIZ16
charifr_name[IFNAMSIZ];/∗ if name, for example ∗/
/∗ "emd1" ∗/
union {
struct sockaddrifru_addr;
struct sockaddrifru_dstaddr;
charifru_oname[IFNAMSIZ];/∗ other if name ∗/
struct sockaddrifru_broadaddr;
shortifru_flags;
intifru_metric;
charifru_data[1];/∗ interface dependent data ∗/
charifru_enaddr[6];
intif_muxid[2];/∗ mux id’s for arp and ip ∗/
intifru_index;/∗ interface index ∗/
} ifr_ifru;
#defineifr_addrifr_ifru.ifru_addr /∗ address ∗/
#defineifr_dstaddrifr_ifru.ifru_dstaddr/∗ other end of p-to-p
link ∗/
#defineifr_onameifr_ifru.ifru_oname/∗ other if name ∗/
#defineifr_broadaddrifr_ifru.ifru_broadaddr /∗ broadcast address ∗/
#defineifr_flagsifr_ifru.ifru_flags
/∗ flags ∗/
#defineifr_index ifr_ifru.ifru_index/∗ interface index ∗/
#defineifr_metricifr_ifru.ifru_metric/∗ metric ∗/
#defineifr_dataifr_ifru.ifru_data/∗ for use by interface ∗/
#defineifr_enaddrifr_ifru.ifru_enaddr/∗ ethernet address ∗/
};

SIOCSIFADDR Set interface address. Following the address assignment, the “initialization” routine for the interface is called.

SIOCGIFADDR Get interface address.

SIOCSIFDSTADDR Set point to point address for interface.

SIOCGIFDSTADDR
Get point to point address for interface.

SIOCSIFFLAGS Set interface flags field. If the interface is marked down, any processes currently routing packets through the interface are notified.

SIOCGIFFLAGS Get interface flags.

SIOCGIFCONF Get interface configuration list. This request takes an ifconf structure (see below) as a value-result parameter. The ifc_len field should be initially set to the size of the buffer pointed to by ifc_buf. On return it will contain the length, in bytes, of the configuration list.

SIOGIFNUM Get number of interfaces. This request returns an integer which is the number of interface descriptions (struct ifreq) that will be returned by the SIOCGIFCONF ioctl; that is, it gives an indication of how large ifc_len has to be.

SIOCSIFMTU Set the maximum transmission unit (MTU) size for interface. Place the result of this request in ifru_metric field. The MTU has to be smaller than physical MTU limitation (which is reported in the DLPI DL_INFO_ACK message).

SIOCGIFMTU Get the maximum transmission unit size for interface. Place the result of this request in ifru_metric field.

SIOCSIFMETRIC Set the metric associated with the interface. The metric is used by routine daemons such as in.routed(1M).

SIOCGIFMETRIC Get the metric associated with the interface.

SIOCGIFMUXID Get the ip and arp muxid associated with the interface.

SIOCSIFMUXID Set the ip and arp muxid associated with the interface.

SIOCGIFINDEX Get the interface index associated with the interface.

SIOCSIFINDEX Set the interface index associated with the interface.

The ifconf structure has the form:

/∗
∗ Structure used in SIOCGIFCONF request.
∗ Used to retrieve interface configuration
∗ for machine (useful for programs which
∗ must know all networks accessible).
∗/
struct ifconf {
intifc_len;/∗ size of associated buffer ∗/
union {
caddr_tifcu_buf;
struct ifreq∗ifcu_req;
} ifc_ifcu;
#defineifc_bufifc_ifcu.ifcu_buf/∗ buffer address ∗/
#defineifc_reqifc_ifcu.ifcu_req/∗ array of structures returned ∗/
};

ERRORS

EPERM The effective user id of the calling process in not superuser.

ENXIO The ifr_name member of the ifreq structure contains an invalid value.

EBADADDR Wrong address family or malformed address.

EBUSY For SIOCSIFFLAGS, this error is returned when the order of bringing the primary/physical interface (for example, le0) and a secondary/logical interface associated with the same physical interface (for example, le0:1) up or down is violated. The physical interface must be configured up first and cannot be configured down until all the corresponding logical interfaces have been configured down.

EINVAL For SIOCGIFCONF, this error is returned when the size of the buffer pointed to by the ifc_buf member of the ifconf structure is too small.

For SIOCSIFMTU, this error is returned when the requested MTU size is invalid. This error indicates the MTU size is greater than the MTU size supported by the DLPI provider or less than 68.

Museum