Advanced Search

Log In | Not a Member?

Contact ADC

Introduction

This header defines an API to interact with network interfaces in the kernel. The network interface KPI may be used to implement network interfaces or to attach protocols to existing interfaces.

Functions

ifaddr_address(ifaddr_t)

ifaddr_address(ifaddr_t, struct sockaddr *, u_int32_t)

ifaddr_address_family

ifaddr_dstaddress

ifaddr_findbestforaddr

ifaddr_ifnet

ifaddr_netmask

ifaddr_reference

ifaddr_release

ifaddr_withaddr

ifaddr_withdstaddr

ifaddr_withnet

ifaddr_withroute

ifmaddr_address

ifmaddr_ifnet

ifmaddr_lladdress

ifmaddr_reference

ifmaddr_release

ifnet_add_multicast

ifnet_addrlen

ifnet_allocate

ifnet_attach

ifnet_attach_protocol

ifnet_baudrate

ifnet_detach

ifnet_detach_protocol

ifnet_event

ifnet_family

ifnet_find_by_name

ifnet_flags

ifnet_free_address_list

ifnet_free_multicast_list

ifnet_get_address_list

ifnet_get_address_list_family

ifnet_get_link_mib_data

ifnet_get_link_mib_data_length

ifnet_get_multicast_list

ifnet_hdrlen

ifnet_index

ifnet_input

ifnet_ioctl

ifnet_lastchange

ifnet_list_free

ifnet_list_get

ifnet_lladdr_copy_bytes

ifnet_llbroadcast_copy_bytes

ifnet_metric

ifnet_mtu

ifnet_name

ifnet_offload

ifnet_output

ifnet_output_raw

ifnet_reference

ifnet_release

ifnet_remove_multicast

ifnet_resolve_multicast

ifnet_set_addrlen

ifnet_set_baudrate

ifnet_set_flags

ifnet_set_flags Sets the interface flags to match new_flags.

ifnet_set_hdrlen

ifnet_set_link_mib_data

ifnet_set_lladdr

ifnet_set_metric

ifnet_set_mtu

ifnet_set_offload

ifnet_set_promiscuous

ifnet_set_stat

ifnet_softc

ifnet_stat

ifnet_stat_increment

ifnet_stat_increment_in

ifnet_stat_increment_out

ifnet_touch_lastchange

ifnet_type

ifnet_unit

sa_family_t ifaddr_address_family(
    ifaddr_t ifaddr);  

Parameters

ifaddr

The interface address.

Return Value

0 on failure, address family on success.

Discussion

Returns the address family of the address.

errno_t ifaddr_address(
    ifaddr_t ifaddr,
    struct sockaddr *out_addr,
    u_int32_t addr_size);  

Parameters

ifaddr

The interface address.

out_addr

The sockaddr storage for the address.

addr_size

The size of the storage for the address.

Return Value

0 upon success

Discussion

Copies the address out of the ifaddr.

sa_family_t ifaddr_address_family(
    ifaddr_t ifaddr);  

Parameters

ifaddr

The interface address.

Return Value

0 on failure, address family on success.

Discussion

Returns the address family of the address.

errno_t ifaddr_dstaddress(
    ifaddr_t ifaddr,
    struct sockaddr *out_dstaddr,
    u_int32_t dstaddr_size);  

Parameters

ifaddr

The interface address.

out_dstaddr

The sockaddr storage for the destination address.

dstaddr_size

The size of the storage for the destination address.

Return Value

0 upon success

Discussion

Copies the destination address out of the ifaddr.

ifaddr_t ifaddr_findbestforaddr(
    const struct sockaddr *addr,
    ifnet_t interface);  

Parameters

addr

The remote address.

interface

The local interface.

Return Value

A reference to the interface address.

Discussion

Finds the best local address assigned to a specific interface to use when communicating with another address. Increments the reference count on the ifaddr before returning to the caller. Caller is responsible for calling ifaddr_release.

ifnet_t ifaddr_ifnet(
    ifaddr_t ifaddr);  

Parameters

ifaddr

The interface address.

Return Value

A reference to the interface the address is attached to.

Discussion

Returns the interface the address is attached to. The reference is only valid until the ifaddr is released. If you need to hold a reference to the ifnet for longer than you hold a reference to the ifaddr, increment the reference using ifnet_reference.

errno_t ifaddr_netmask(
    ifaddr_t ifaddr,
    struct sockaddr *out_netmask,
    u_int32_t netmask_size);  

Parameters

ifaddr

The interface address.

out_netmask

The sockaddr storage for the netmask.

netmask_size

The size of the storage for the netmask.

Return Value

0 upon success

Discussion

Copies the netmask out of the ifaddr.

errno_t ifaddr_reference(
    ifaddr_t ifaddr);  

Parameters

ifaddr

The interface address.

Return Value

0 upon success

Discussion

Increment the reference count of an address tied to an interface.

errno_t ifaddr_release(
    ifaddr_t ifaddr);  

Parameters

ifaddr

The interface address.

Return Value

0 upon success

Discussion

Decrements the reference count of and possibly frees an address tied to an interface.

ifaddr_t ifaddr_withaddr(
    const struct sockaddr*address);  

Parameters

address

The address to search for.

Return Value

A reference to the interface address.

Discussion

Returns an interface address with the address specified. Increments the reference count on the ifaddr before returning to the caller. Caller is responsible for calling ifaddr_release.

ifaddr_t ifaddr_withdstaddr(
    const struct sockaddr*destination);  

Parameters

destination

The destination to search for.

Return Value

A reference to the interface address.

Discussion

Returns an interface address for the interface address that matches the destination when the netmask is applied. Increments the reference count on the ifaddr before returning to the caller. Caller is responsible for calling ifaddr_release.

ifaddr_t ifaddr_withnet(
    const struct sockaddr*net);  

Parameters

net

The network to search for.

Return Value

A reference to the interface address.

Discussion

Returns an interface address for the interface with the network described by net. Increments the reference count on the ifaddr before returning to the caller. Caller is responsible for calling ifaddr_release.

ifaddr_t ifaddr_withroute(
    int flags,
    const struct sockaddr*destination, 
    const struct sockaddr*gateway);  

Parameters

flags

Routing flags. See net/route.h, RTF_GATEWAY etc.

destination

The destination to search for.

gateway

A gateway to search for.

Return Value

A reference to the interface address.

Discussion

Returns an interface address given a destination and gateway. Increments the reference count on the ifaddr before returning to the caller. Caller is responsible for calling ifaddr_release.

errno_t ifmaddr_address(
    ifmultiaddr_t ifmaddr,
    struct sockaddr *out_multicast,
    u_int32_t addr_size);  

Parameters

out_multicast

Storage for a sockaddr.

addr_size

Size of the storage.

Return Value

0 on success.

Discussion

Copies the multicast address to out_multicast.

ifnet_t ifmaddr_ifnet(
    ifmultiaddr_t ifmaddr);  

Parameters

ifmaddr

The interface multicast address.

Return Value

A reference to the interface.

Discussion

Returns the interface this multicast address is attached to. The interface reference count is not bumped by this function. The interface is only valid as long as you don't release the refernece to the multiast address. If you need to maintain your pointer to the ifnet, call ifnet_reference followed by ifnet_release when you're finished.

errno_t ifmaddr_lladdress(
    ifmultiaddr_t ifmaddr,
    struct sockaddr *out_link_layer_multicast, 
    u_int32_t addr_size);  

Parameters

out_link_layer_multicast

Storage for a sockaddr.

addr_size

Size of the storage.

Return Value

0 on success.

Discussion

Copies the link layer multicast address to out_link_layer_multicast.

errno_t ifmaddr_reference(
    ifmultiaddr_t ifmaddr);  

Parameters

ifmaddr

The interface multicast address.

Return Value

0 on success. Only error will be EINVAL if ifmaddr is not valid.

Discussion

Increment the reference count of an interface multicast address.

errno_t ifmaddr_release(
    ifmultiaddr_t ifmaddr);  

Parameters

ifmaddr

The interface multicast address.

Return Value

0 on success. Only error will be EINVAL if ifmaddr is not valid.

Discussion

Decrement the reference count of an interface multicast address. If the reference count reaches zero, the ifmultiaddr will be removed from the interface and the ifmultiaddr will be freed.

errno_t ifnet_add_multicast(
    ifnet_t interface,
    const struct sockaddr *maddr, 
    ifmultiaddr_t *multicast);  

Parameters

interface

The interface.

maddr

The multicast address to join. Either a physical address or logical address to be translated to a physical address.

multicast

The resulting ifmultiaddr_t multicast address.

Return Value

0 on success otherwise the errno error.

Discussion

Joins a multicast and returns an ifmultiaddr_t with the reference count incremented for you. You are responsible for decrementing the reference count after calling ifnet_remove_multicast and making sure you no longer have any references to the multicast.

u_int8_t ifnet_addrlen(
    ifnet_t interface);  

Parameters

interface

The interface.

Return Value

The address length.

errno_t ifnet_allocate(
    const struct ifnet_init_params *init,
    ifnet_t *interface);  

Parameters

init

The initial values for the interface. These values can not be changed after the interface has been allocated.

interface

The interface allocated upon success.

Return Value

May return ENOMEM if there is insufficient memory or EEXIST if an interface with the same uniqueid and family has already been allocated and is in use.

Discussion

Allocate an ifnet_t with an initial refcount of 1. Many parts of the stack do not properly refcount the ifnet_t. In order to avoid freeing the ifnet_t while some parts of the stack may contain a reference to it, the ifnet_ts are only recycled, never freed. A unique id is used to try and recycle the same ifnet_t when allocating an interface. For example, for an ethernet interface, the hardware address of the ethernet card is usually used for the uniqueid. If a PC Card is removed and inserted again, if the ethernet address of the PC card is used, the same ifnet_t will be used for the card the second time it is inserted. In the future, when the ifnet_t is correctly refcounted by all of the stack, the interfaces may be freed and the unique ids ignored.

errno_t ifnet_attach(
    ifnet_t interface,
    const struct sockaddr_dl *ll_addr);  

Parameters

interface

The interface to attach.

ll_addr

The link layer address of the interface. This is used to fill out the first ifaddr in the list of addresses for the interface. This parameter is not required for interfaces such as PPP that have no link-layer address.

Return Value

Will return an error if there is anything wrong with the interface.

Discussion

Attaches an interface to the global interface list. The interface must be setup properly before calling attach. The stack will take a reference on the interface and hold it until ifnet_detach is called.

This function is intended to be called by the driver. A kext must not call this function on an interface the kext does not own.

errno_t ifnet_attach_protocol(
    ifnet_t interface,
    protocol_family_t protocol_family, 
    const struct ifnet_attach_proto_param *proto_details);  

Parameters

interface

The interface.

protocol_family

The protocol family being attached (PF_INET/PF_APPLETALK/etc...).

proto_details

Details of the protocol being attached.

Return Value

0 on success otherwise the errno error.

Discussion

Attaches a protocol to an interface.

u_int64_t ifnet_baudrate(
    ifnet_t interface);  

Parameters

interface

The interface.

Return Value

The baudrate.

errno_t ifnet_detach(
    ifnet_t interface);  

Parameters

interface

The interface to detach.

Return Value

0 on success, otherwise errno error.

Discussion

Detaches the interface.

Call this to indicate this interface is no longer valid (i.e. PC Card was removed). This function will begin the process of removing knowledge of this interface from the stack.

The function will return before the interface is detached. The functions you supplied in to the interface may continue to be called. When the detach has been completed, your detached function will be called. Your kext must not unload until the detached function has been called. The interface will be properly freed when the reference count reaches zero.

An interface may not be attached again. You must call ifnet_allocate to create a new interface to attach.

This function is intended to be called by the driver. A kext must not call this function on an interface the kext does not own.

errno_t ifnet_detach_protocol(
    ifnet_t interface,
    protocol_family_t protocol_family);  

Parameters

interface

The interface.

protocol_family

The protocol family of the protocol to detach.

Return Value

0 on success otherwise the errno error.

Discussion

Detaches a protocol from an interface.

errno_t ifnet_event(
    ifnet_t interface,
    struct kern_event_msg*event_ptr);  

Parameters

interface

The interface.

event_ptr

Pointer to an kern_event structure describing the event.

Return Value

0 on success otherwise the errno error.

Discussion

Calls the interface's event function.

ifnet_family_t ifnet_family(
    ifnet_t interface);  

Parameters

interface

Interface to retrieve the unit number from.

Return Value

Unit number.

Discussion

Returns the family of the interface.

errno_t ifnet_find_by_name(
    const char *ifname,
    ifnet_t *interface);  

Parameters

name

The name of the interface, including any unit number (i.e. "en0").

interface

A pointer to an interface reference. This will be filled in if a matching interface is found.

Return Value

0 on success otherwise the errno error.

Discussion

Find an interface by the name including the unit number. Caller must call ifnet_release on any non-null interface return value.

u_int16_t ifnet_flags(
    ifnet_t interface);  

Parameters

interface

Interface to retrieve the flags from.

Return Value

Flags. These flags are defined in net/if.h

Discussion

Returns the interface flags that are set.

void ifnet_free_address_list(
    ifaddr_t *addresses);  

Parameters

addresses

An array of ifaddr_ts.

Discussion

Free a list of addresses returned from ifnet_get_address_list. Decrements the refcounts and frees the memory used for the array of references.

void ifnet_free_multicast_list(
    ifmultiaddr_t *multicasts);  

Parameters

multicasts

An array of references to the multicast addresses.

Return Value

0 on success otherwise the errno error.

Discussion

Frees a list of multicasts returned by ifnet_get_multicast_list. Decrements the refcount on each multicast address and frees the array.

errno_t ifnet_get_address_list(
    ifnet_t interface,
    ifaddr_t **addresses);  

Parameters

interface

The interface.

addresses

A pointer to a NULL terminated array of ifaddr_ts.

Return Value

0 on success otherwise the errno error.

Discussion

Get a list of addresses on the interface. Passing NULL for the interface will return a list of all addresses. The addresses will have their reference count bumped so they will not go away. Calling ifnet_free_address_list will decrement the refcount and free the array. If you wish to hold on to a reference to an ifaddr_t, be sure to bump the reference count before calling ifnet_free_address_list.

Old versions of this function erroneously returned EINVAL when passed NULL for the interface. Passing NULL will not work on some versions of MacOS X 10.4.

errno_t ifnet_get_address_list_family(
    ifnet_t interface,
    ifaddr_t **addresses,
    sa_family_t family);  

Parameters

interface

The interface.

addresses

A pointer to a NULL terminated array of ifaddr_ts.

Return Value

0 on success otherwise the errno error.

Discussion

Get a list of addresses on the interface. Passing NULL for the interface will return a list of all addresses. The addresses will have their reference count bumped so they will not go away. Calling ifnet_free_address_list will decrement the refcount and free the array. If you wish to hold on to a reference to an ifaddr_t, be sure to bump the reference count before calling ifnet_free_address_list. Unlike ifnet_get_address_list, this function lets the caller specify the address family to get a list of only a specific address type. Old versions of this function erroneously returned EINVAL when passed NULL for the interface. Passing NULL will not work on some versions of MacOS X 10.4.

errno_t ifnet_get_link_mib_data(
    ifnet_t interface,
    void *mibData,
    u_int32_t *mibLen);  

Parameters

interface

The interface.

mibData

A pointer to space for the mibData to be copied in to.

mibLen

When calling, this should be the size of the buffer passed in mibData. Upon return, this will be the size of data copied in to mibData.

Return Value

Returns an error if the buffer size is too small or there is no data.

Discussion

Copies the link MIB data in to mibData, up to mibLen bytes. Returns error if the buffer is too small to hold all of the MIB data.

u_int32_t ifnet_get_link_mib_data_length(
    ifnet_t interface);  

Parameters

interface

The interface.

Return Value

Returns the number of bytes of mib data associated with the interface.

Discussion

Retrieve the size of the mib data.

errno_t ifnet_get_multicast_list(
    ifnet_t interface,
    ifmultiaddr_t **addresses);  

Parameters

interface

The interface.

multicasts

A pointer to a NULL terminated array of references to the multicast addresses.

Return Value

0 on success otherwise the errno error.

Discussion

Retrieves a list of multicast address the interface is set to receive. This function allocates and returns an array of references to the various multicast addresses. The multicasts have their reference counts bumped on your behalf. Calling ifnet_free_multicast_list will decrement the reference counts and free the array.

u_int8_t ifnet_hdrlen(
    ifnet_t interface);  

Parameters

interface

The interface.

Return Value

The header length.

u_int32_t ifnet_index(
    ifnet_t interface);  

Parameters

interface

Interface to retrieve the index of.

Return Value

Index.

Discussion

Returns the index of the interface. This index value will match the index you would find in a sockaddr_dl or using if_nametoindex or if_indextoname in user space. The value of the interface index is undefined for an interface that is not currently attached.

errno_t ifnet_input(
    ifnet_t interface,
    mbuf_t first_packet, 
    const struct ifnet_stat_increment_param *stats);  

Parameters

interface

The interface.

first_packet

The first packet in a chain of packets.

stats

Counts to be integrated in to the stats. The interface statistics will be incremented by the amounts specified in stats. This parameter may be NULL.

Return Value

0 on success otherwise the errno error.

Discussion

Inputs packets from the interface. The interface's demux will be called to determine the protocol. Once the protocol is determined, the interface filters and protocol filters will be called. From there, the packet will be passed to the registered protocol. If there is an error, the mbuf chain will be freed.

errno_t ifnet_ioctl(
    ifnet_t interface,
    protocol_family_t protocol, 
    u_int32_t ioctl_code,
    void *ioctl_arg);  

Parameters

interface

The interface.

protocol

The protocol family of the protocol to send the ioctl to (may be zero). Some ioctls apply to a protocol while other ioctls apply to just an interface.

ioctl_code

The ioctl to perform.

ioctl_arg

Any parameters to the ioctl.

Return Value

0 on success otherwise the errno error.

Discussion

Calls the interface's ioctl function with the parameters passed.

All undefined ioctls are reserved for future use by Apple. If you need to communicate with your kext using an ioctl, please use SIOCSIFKPI and SIOCGIFKPI.

errno_t ifnet_lastchange(
    ifnet_t interface,
    struct timeval *last_change);  

Parameters

interface

The interface.

last_change

A timeval struct to copy the last time changed in to.

void ifnet_list_free(
    ifnet_t *interfaces);  

Parameters

interfaces

An array of interface references from ifnet_list_get.

Discussion

Free a list of interfaces returned by ifnet_list_get. Decrements the reference count on each interface and frees the array of references. If you keep a reference to an interface, be sure to increment the reference count before calling ifnet_list_free.

errno_t ifnet_list_get(
    ifnet_family_t family,
    ifnet_t **interfaces,
    u_int32_t *count);  

Parameters

family

The interface family (i.e. IFNET_FAMILY_ETHERNET). To find interfaces of all families, use IFNET_FAMILY_ANY.

interfaces

A pointer to an array of interface references.

count

A pointer that will be filled in with the number of matching interfaces in the array.

Return Value

0 on success otherwise the errno error.

Discussion

Get a list of attached interfaces. List will be set to point to an array allocated by ifnet_list_get. The interfaces are refcounted and the counts will be incremented before the function returns. The list of interfaces must be freed using ifnet_list_free.

errno_t ifnet_lladdr_copy_bytes(
    ifnet_t interface,
    void*lladdr,
    size_t length);  

Parameters

interface

The interface to copy the link-layer address from.

lladdr

The buffer to copy the link-layer address in to.

length

The length of the buffer. This value must match the length of the link-layer address.

Discussion

Copies the bytes of the link-layer address in to the specified buffer.

errno_t ifnet_llbroadcast_copy_bytes(
    ifnet_t interface,
    void*addr, 
    size_t bufferlen,
    size_t*addr_len);  

Parameters

interface

The interface.

addr

A buffer to copy the broadcast address in to.

bufferlen

The length of the buffer at addr.

addr_len

On return, the length of the broadcast address.

lladdr_len

The length, in bytes, of the link layer address.

Discussion

Retrieves the link-layer broadcast address for this interface.

u_int32_t ifnet_metric(
    ifnet_t interface);  

Parameters

interface

The interface.

Return Value

The metric.

u_int32_t ifnet_mtu(
    ifnet_t interface);  

Parameters

interface

The interface.

Return Value

The MTU.

const char* ifnet_name(
    ifnet_t interface);  

Parameters

interface

Interface to retrieve the name from.

Return Value

Pointer to the name.

Discussion

Returns a pointer to the name of the interface.

ifnet_offload_t ifnet_offload(
    ifnet_t interface);  

Parameters

interface

Interface to retrieve the offload from.

Return Value

Abilities flags, see ifnet_offload_t.

Discussion

Returns flags indicating which operations can be offloaded to the interface.

errno_t ifnet_output(
    ifnet_t interface,
    protocol_family_t protocol_family,
    mbuf_t packet, 
    void*route,
    const struct sockaddr *dest);  

Parameters

interface

The interface.

protocol_family

The family of the protocol generating this packet (i.e. AF_INET).

packet

The packet to be transmitted.

route

A pointer to a routing structure for this packet. The preoutput function determines whether this value may be NULL or not.

dest

The destination address of protocol_family type. This will be passed to the preoutput function. If the preoutput function does not require this value, you may pass NULL.

Return Value

0 on success otherwise the errno error.

Discussion

Handles an outbound packet on the interface by calling any filters, a protocol preoutput function, the interface framer function, and finally the interface's output function. The protocol_family will be used to apply protocol filters and determine which preoutput function to call. The route and dest parameters will be passed to the preoutput function defined for the attachment of the specified protocol to the specified interface. ifnet_output will always free the mbuf chain.

errno_t ifnet_output_raw(
    ifnet_t interface,
    protocol_family_t protocol_family,
    mbuf_t packet);  

Parameters

interface

The interface.

protocol_family

The family of the protocol generating this packet (i.e. AF_INET).

packet

The fully formed packet to be transmitted.

Return Value

0 on success otherwise the errno error.

Discussion

Handles and outbond raw packet on the interface by calling any filters followed by the interface's output function. protocol_family may be zero. If the packet is from a specific protocol the protocol_family will be used to apply protocol filters. All interface filters will be applied to the outgoing packet. Processing, such as calling the protocol preoutput and interface framer functions will be bypassed. The packet will pass through the filters and be sent on the interface as is. ifnet_output_raw will always free the packet chain.

errno_t ifnet_reference(
    ifnet_t interface);  

Parameters

interface

The interface to increment the reference count of.

Return Value

May return EINVAL if the interface is not valid.

Discussion

Increment the reference count of the ifnet to assure that it will not go away. The interface must already have at least one reference.

errno_t ifnet_release(
    ifnet_t interface);  

Parameters

interface

The interface to decrement the reference count of and possibly free.

Return Value

May return EINVAL if the interface is not valid.

Discussion

Release a reference of the ifnet, this may trigger a free if the reference count reaches 0.

errno_t ifnet_remove_multicast(
    ifmultiaddr_t multicast);  

Parameters

multicast

The multicast to be removed.

Return Value

0 on success otherwise the errno error.

Discussion

Causes the interface to leave the multicast group. The stack keeps track of how many times ifnet_add_multicast has been called for a given multicast address. The multicast will only be removed when the number of times ifnet_remove_multicast has been called matches the number of times ifnet_add_multicast has been called.

The memory for the multicast address is not actually freed until the separate reference count has reached zero. Some parts of the stack may keep a pointer to the multicast even after that multicast has been removed from the interface.

When an interface is detached, all of the multicasts are removed. If the interface of the multicast passed in is no longer attached, this function will gracefully return, performing no work.

It is the callers responsibility to release the multicast address after calling this function.

errno_t ifnet_resolve_multicast(
    ifnet_t ifp,
    const struct sockaddr *proto_addr, 
    struct sockaddr *ll_addr,
    size_t ll_len);  

Parameters

interface

The interface.

proto_addr

A protocol address to be converted to a link-layer address.

ll_addr

Storage for the resulting link-layer address.

ll_len

Length of the storage for the link-layer address.

Return Value

0 on success. EOPNOTSUPP indicates the multicast address was not supported or could not be translated. Other errors may indicate other failures.

Discussion

Resolves a multicast address for an attached protocol to a link-layer address. If a link-layer address is passed in, the interface will verify that it is a valid multicast address.

errno_t ifnet_set_addrlen(
    ifnet_t interface,
    u_int8_t addrlen);  

Parameters

interface

The interface.

addrlen

The new address length.

Return Value

0 on success otherwise the errno error.

Discussion

This function is intended to be called by the driver. A kext must not call this function on an interface the kext does not own.

errno_t ifnet_set_baudrate(
    ifnet_t interface,
    u_int64_t baudrate);  

Parameters

interface

The interface.

baudrate

The new baudrate.

Return Value

0 on success otherwise the errno error.

Discussion

This function is intended to be called by the driver. A kext must not call this function on an interface the kext does not own.

errno_t ifnet_set_flags(
    ifnet_t interface,
    u_int16_t new_flags,
    u_int16_t mask);  

Parameters

interface

Interface to set the flags on.

new_flags

The new set of flags that should be set. These flags are defined in net/if.h

Return Value

0 on success otherwise the errno error.

Discussion

Sets the interface flags to new_flags. This function lets you specify which flags you want to change using the mask. The kernel will effectively take the lock, then set the interface's flags to (if_flags & ~mask) | (new_flags & mask).

errno_t ifnet_set_flags(
    ifnet_t interface,
    u_int16_t new_flags,
    u_int16_t mask);  

Parameters

interface

Interface to set the flags on.

new_flags

The new set of flags that should be set. These flags are defined in net/if.h

Return Value

0 on success otherwise the errno error.

Discussion

Sets the interface flags to new_flags. This function lets you specify which flags you want to change using the mask. The kernel will effectively take the lock, then set the interface's flags to (if_flags & ~mask) | (new_flags & mask).

errno_t ifnet_set_hdrlen(
    ifnet_t interface,
    u_int8_t hdrlen);  

Parameters

interface

The interface.

hdrlen

The new header length.

Return Value

0 on success otherwise the errno error.

Discussion

This function is intended to be called by the driver. A kext must not call this function on an interface the kext does not own.

errno_t ifnet_set_link_mib_data(
    ifnet_t interface,
    void *mibData,
    u_int32_t mibLen);  

Parameters

interface

Interface to set the unit number of.

mibData

A pointer to the data.

mibLen

Length of data pointed to.

Return Value

0 on success otherwise the errno error.

Discussion

Sets the mib link data. The ifnet_t will store the pointer you supply and copy mibLen bytes from the pointer whenever the sysctl for getting interface specific MIB data is used. Since the ifnet_t stores a pointer to your data instead of a copy, you may update the data at the address at any time.

This function is intended to be called by the driver. A kext must not call this function on an interface the kext does not own.

errno_t ifnet_set_lladdr(
    ifnet_t interface,
    const void*lladdr,
    size_t lladdr_len);  

Parameters

interface

The interface the link layer address is being changed on.

lladdr

A pointer to the raw link layer address (pointer to the 6 byte ethernet address for ethernet).

lladdr_len

The length, in bytes, of the link layer address.

Discussion

Sets the link-layer address for this interface.

errno_t ifnet_set_metric(
    ifnet_t interface,
    u_int32_t metric);  

Parameters

interface

The interface.

metric

The new metric.

Return Value

0 on success otherwise the errno error.

Discussion

This function is intended to be called by the driver. A kext must not call this function on an interface the kext does not own.

errno_t ifnet_set_mtu(
    ifnet_t interface,
    u_int32_t mtu);  

Parameters

interface

The interface.

mtu

The new MTU.

Return Value

0 on success otherwise the errno error.

Discussion

Sets the value of the MTU in the interface structure. Calling this function will not notify the driver that the MTU should be changed. Use the appropriate ioctl.

This function is intended to be called by the driver. A kext must not call this function on an interface the kext does not own.

errno_t ifnet_set_offload(
    ifnet_t interface,
    ifnet_offload_t offload);  

Parameters

interface

The interface.

offload

The new set of flags indicating which offload options the device supports.

mask

The mask of flags to be modified.

Return Value

0 on success otherwise the errno error.

Discussion

Sets a bitfield to indicate special hardware offload support provided by the interface such as hardware checksums and VLAN. This replaces the if_hwassist flags field. Any flags unrecognized by the stack will not be set.

errno_t ifnet_set_promiscuous(
    ifnet_t interface,
    int on);  

Parameters

interface

The interface to toggle promiscuous mode on.

on

If set, the number of promicuous on requests will be incremented. If this is the first requrest, promiscuous mode will be enabled. If this is not set, the number of promiscous clients will be decremented. If this causes the number to reach zero, promiscuous mode will be disabled.

Return Value

0 on success otherwise the errno error.

Discussion

Enable or disable promiscuous mode on the interface. The interface keeps an internal count of the number of times promiscuous mode has been enabled. Promiscuous mode is only disabled when this count reaches zero. Be sure to disable promiscuous mode only once for every time you enable it.

errno_t ifnet_set_stat(
    ifnet_t interface, 
    const struct ifnet_stats_param *stats);  

Parameters

interface

The interface.

counts

The new stats values.

Return Value

0 on success otherwise the errno error.

Discussion

This function is intended to be called by the driver. A kext must not call this function on an interface the kext does not own.

The one exception would be the case where a kext wants to zero all of the counters.

void* ifnet_softc(
    ifnet_t interface);  

Parameters

interface

Interface to retrieve the storage from.

Return Value

Driver's private storage.

Discussion

Returns the driver's private storage on the interface.

errno_t ifnet_stat(
    ifnet_t interface, 
    struct ifnet_stats_param *out_stats);  

Parameters

interface

The interface.

out_stats

Storage for the values.

Return Value

0 on success otherwise the errno error.

errno_t ifnet_stat_increment(
    ifnet_t interface, 
    const struct ifnet_stat_increment_param *counts);  

Parameters

interface

The interface.

counts

A pointer to a structure containing the amount to increment each counter by. Any counts not appearing in the ifnet_counter_increment structure are handled in the stack.

Return Value

0 on success otherwise the errno error.

Discussion

This function is intended to be called by the driver. A kext must not call this function on an interface the kext does not own.

errno_t ifnet_stat_increment_in(
    ifnet_t interface, 
    u_int32_t packets_in,
    u_int32_t bytes_in, 
    u_int32_t errors_in);  

Parameters

interface

The interface.

packets_in

The number of additional packets received.

bytes_in

The number of additional bytes received.

errors_in

The number of additional receive errors.

Return Value

0 on success otherwise the errno error.

Discussion

This function is intended to be called by the driver. This function allows a driver to update the inbound interface counts. The most efficient time to update these counts is when calling ifnet_input.

A lock protects the counts, this makes the increment functions expensive. The increment function will update the lastchanged value.

errno_t ifnet_stat_increment_out(
    ifnet_t interface, 
    u_int32_t packets_out,
    u_int32_t bytes_out, 
    u_int32_t errors_out);  

Parameters

interface

The interface.

packets_out

The number of additional packets sent.

bytes_out

The number of additional bytes sent.

errors_out

The number of additional send errors.

Return Value

0 on success otherwise the errno error.

Discussion

This function is intended to be called by the driver. This function allows a driver to update the outbound interface counts.

A lock protects the counts, this makes the increment functions expensive. The increment function will update the lastchanged value.

errno_t ifnet_touch_lastchange(
    ifnet_t interface);  

Parameters

interface

The interface.

Return Value

0 on success otherwise the errno error.

Discussion

Updates the lastchange value to now.

u_int8_t