NAME

SYNOPSIS

DESCRIPTION

PROTOCOLS

ADDRESSING

struct sockaddr {
	u_int8_t	sa_len;		/* total length */
	sa_family_t	sa_family;	/* address family */
	char		sa_data[14];	/* actually longer */
};

#define AF_LOCAL	1	/* local to host (pipes, portals) */
#define AF_INET		2	/* internetwork: UDP, TCP, etc. */
#define AF_HYLINK	15	/* NSC Hyperchannel */
#define AF_APPLETALK	16	/* AppleTalk */
#define AF_INET6	24	/* IPv6 */
#define AF_NATM		27	/* native ATM access */
#define AF_BLUETOOTH	32	/* Bluetooth */

ROUTING

INTERFACES

struct	ifreq {
#define IFNAMSIZ 16
	char	ifr_name[IFNAMSIZ];	/* if name, e.g. "en0" */
	union {
		struct	sockaddr ifru_addr;
		struct	sockaddr ifru_dstaddr;
		struct	sockaddr ifru_broadaddr;
		short	ifru_flags;
		int	ifru_metric;
		caddr_t	ifru_data;
	} ifr_ifru;
#define ifr_addr	ifr_ifru.ifru_addr	/* address */
#define ifr_dstaddr	ifr_ifru.ifru_dstaddr	/* p-to-p peer */
#define ifr_broadaddr	ifr_ifru.ifru_broadaddr	/* broadcast address */
#define ifr_flags	ifr_ifru.ifru_flags	/* flags */
#define ifr_metric	ifr_ifru.ifru_metric	/* metric */
#define ifr_mtu		ifr_ifru.ifru_metric	/* mtu (overload) */
#define ifr_media	ifr_ifru.ifru_metric	/* media options */
#define ifr_data	ifr_ifru.ifru_data	/* used by interface */
};

SIOCSIFADDR"structifreq *"

Set the interface address for a protocol family. Following the address assignment, the “initialization” routine for the interface is called.

This call has been deprecated and superseded by the SIOCAIFADDR call, described below.

SIOCSIFDSTADDR"structifreq *"

Set the point-to-point address for a protocol family and interface.

This call has been deprecated and superseded by the SIOCAIFADDR call, described below.

SIOCSIFBRDADDR"structifreq *"

Set the broadcast address for a protocol family and interface.

This call has been deprecated and superseded by the SIOCAIFADDR call, described below.

SIOCGIFADDR"structifreq *"

Get the interface address for a protocol family.

SIOCGIFDSTADDR"structifreq *"

Get the point-to-point address for a protocol family and interface.

SIOCGIFBRDADDR"structifreq *"

Get the broadcast address for a protocol family and interface.

SIOCGIFDESCR"structifreq *"

Get the interface description, returned in the ifru_data field.

SIOCSIFDESCR"structifreq *"

Set the interface description to the value of the ifru_data field, limited to the size of IFDESCRSIZE.

SIOCSIFFLAGS"structifreq *"

Set the interface flags. If the interface is marked down, any processes currently routing packets through the interface are notified; some interfaces may be reset so that incoming packets are no longer received. When marked up again, the interface is reinitialized.

SIOCGIFFLAGS"structifreq *"

Get the interface flags.

SIOCSIFMEDIA"structifreq *"

Set the interface media settings. See ifmedia(4) for possible values.

SIOCGIFMEDIA"structifmediareq *"

Get the interface media settings. The ifmediareq structure is as follows:

struct ifmediareq {
	char	 ifm_name[IFNAMSIZ];	/* if name, e.g. "en0" */
	int	 ifm_current;	/* current media options */
	int	 ifm_mask;	/* don't care mask */
	int	 ifm_status;	/* media status */
	int	 ifm_active;	/* active options */
	int	 ifm_count;	/* #entries in ifm_ulist array */
	int	*ifm_ulist;	/* media words */
};

See ifmedia(4) for interpreting this value.

SIOCSIFMETRIC"structifreq *"

Set the interface routing metric. The metric is used only by user-level routers.

SIOCGIFMETRIC"structifreq *"

Get the interface metric.

SIOCAIFADDR"structifaliasreq *"

An interface may have more than one address associated with it in some protocols. This request provides a means to add additional addresses (or modify characteristics of the primary address if the default address for the address family is specified).

Rather than making separate calls to set destination or broadcast addresses, or network masks (now an integral feature of multiple protocols), a separate structure, ifaliasreq, is used to specify all three facets simultaneously (see below). One would use a slightly tailored version of this structure specific to each family (replacing each sockaddr by one of the family-specific type). One should always set the length of a sockaddr, as described in ioctl(2).

The ifaliasreq structure is as follows:

struct ifaliasreq {
	char	ifra_name[IFNAMSIZ];	/* if name, e.g. "en0" */
	struct	sockaddr ifra_addr;
	struct	sockaddr ifra_dstaddr;
#define ifra_broadaddr ifra_dstaddr
	struct	sockaddr ifra_mask;
};

SIOCDIFADDR"structifreq *"

This request deletes the specified address from the list associated with an interface. It also uses the ifaliasreq structure to allow for the possibility of protocols allowing multiple masks or destination addresses, and also adopts the convention that specification of the default address means to delete the first address for the interface belonging to the address family in which the original socket was opened.

SIOCGIFCONF"structifconf *"

Get the 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.

Alternately, if the ifc_len passed in is set to 0, SIOCGIFCONF will set ifc_len to the size that ifc_buf needs to be to fit the entire configuration list and will not fill in the other parameters. This is useful for determining the exact size that ifc_buf needs to be in advance. Note, however, that this is an extension that not all operating systems support.

struct ifconf {
	int	ifc_len;	  /* size of associated buffer */
	union {
		caddr_t	ifcu_buf;
		struct	ifreq *ifcu_req;
	} ifc_ifcu;
#define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */
#define ifc_req ifc_ifcu.ifcu_req /* array of structures ret'd */
};

SIOCIFCREATE"structifreq *"

Attempt to create the specified interface.

SIOCIFDESTROY"structifreq *"

Attempt to destroy the specified interface.

SIOCIFGCLONERS"structif_clonereq *"

Get the list of clonable interfaces. This request takes an if_clonereq structure pointer (see below) as a value-result parameter. The ifcr_count field should be set to the number of IFNAMSIZ strings that can fit in the buffer pointed to by ifcr_buffer. On return, ifcr_total will be set to the number of clonable interfaces, and the buffer pointed to by ifcr_buffer will be filled with the names of clonable interfaces aligned on IFNAMSIZ boundaries.

The if_clonereq structure is as follows:

struct if_clonereq {
	int   ifcr_total;  /* total cloners (out) */
	int   ifcr_count;  /* room for this many in user buf */
	char *ifcr_buffer; /* buffer for cloner names */
};

SIOCAIFGROUP"structifgroupreq *"

Associate the interface named by ifgr_name with the interface group named by ifgr_group. The ifgroupreq structure is as follows:

struct ifg_req {
	char			 ifgrq_group[IFNAMSIZ];
};

struct ifgroupreq {
	char	ifgr_name[IFNAMSIZ];
	u_int	ifgr_len;
	union {
		char	ifgru_group[IFNAMSIZ];
		struct	ifg_req *ifgru_groups;
	} ifgr_ifgru;
#define ifgr_group	ifgr_ifgru.ifgru_group
#define ifgr_groups	ifgr_ifgru.ifgru_groups
};

SIOCGIFGROUP"structifgroupreq *"

Retrieve the list of groups for which an interface is a member. The interface is named by ifgr_name. On enter, the amount of memory in which the group names will be written is stored in ifgr_len, and the group names themselves will be written to the memory pointed to by ifgr_groups. On return, the amount of memory actually written is returned in ifgr_len.

Alternately, if the ifgr_len passed in is set to 0, SIOCGIFGROUP will set ifgr_len to the size that ifgr_groups needs to be to fit the entire group list and will not fill in the other parameters. This is useful for determining the exact size that ifgr_groups needs to be in advance.

SIOCDIFGROUP"structifgroupreq *"

Remove the membership of the interface named by ifgr_name from the group ifgr_group.

SEE ALSO

HISTORY