net/kpi_interfacefilter.h Kernel.framework

@typedef iff_input_func @discussion iff_input_func is used to filter incoming packets. The interface is only valid for the duration of the filter call. If you need to keep a reference to the interface, be sure to call ifnet_reference and ifnet_release. The packets passed to the inbound filter are different from those passed to the outbound filter. Packets to the inbound filter have the frame header passed in separately from the rest of the packet. The outbound data filters is passed the whole packet including the frame header. The frame header usually preceeds the data in the mbuf. This ensures that the frame header will be a valid pointer as long as the mbuf is not freed. If you need to change the frame header to point somewhere else, the recommended method is to prepend a new frame header to the mbuf chain (mbuf_prepend), set the header to point to that data, then call mbuf_adj to move the mbuf data pointer back to the start of the packet payload. @param cookie The cookie specified when this filter was attached. @param interface The interface the packet was recieved on. @param protocol The protocol of this packet. If you specified a protocol when attaching your filter, the protocol will only ever be the protocol you specified. @param data The inbound packet, after the frame header as determined by the interface. @param frame_ptr A pointer to the pointer to the frame header. The frame header length can be found by inspecting the interface's frame header length (ifnet_hdrlen). @result Return: 0 - The caller will continue with normal processing of the packet. EJUSTRETURN - The caller will stop processing the packet, the packet will not be freed. Anything Else - The caller will free the packet and stop processing.

typedef errno_t (*)(void *, ifnet_t, protocol_family_t, mbuf_t *, char **) iff_input_func;

@typedef iff_output_func @discussion iff_output_func is used to filter fully formed outbound packets. The interface is only valid for the duration of the filter call. If you need to keep a reference to the interface, be sure to call ifnet_reference and ifnet_release. @param cookie The cookie specified when this filter was attached. @param interface The interface the packet is being transmitted on. @param data The fully formed outbound packet in a chain of mbufs. The frame header is already included. The filter function may modify the packet or return a different mbuf chain. @result Return: 0 - The caller will continue with normal processing of the packet. EJUSTRETURN - The caller will stop processing the packet, the packet will not be freed. Anything Else - The caller will free the packet and stop processing.

typedef errno_t (*)(void *, ifnet_t, protocol_family_t, mbuf_t *) iff_output_func;

@typedef iff_event_func @discussion iff_event_func is used to filter interface specific events. The interface is only valid for the duration of the filter call. If you need to keep a reference to the interface, be sure to call ifnet_reference and ifnet_release. @param cookie The cookie specified when this filter was attached. @param interface The interface the packet is being transmitted on. @param event_msg The kernel event, may not be changed.

typedef void (*)(void *, ifnet_t, protocol_family_t, const struct kev_msg *) iff_event_func;

@typedef iff_ioctl_func @discussion iff_ioctl_func is used to filter ioctls sent to an interface. The interface is only valid for the duration of the filter call. If you need to keep a reference to the interface, be sure to call ifnet_reference and ifnet_release. 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. @param cookie The cookie specified when this filter was attached. @param interface The interface the packet is being transmitted on. @param ioctl_cmd The ioctl command. @param ioctl_arg A pointer to the ioctl argument. @result Return: 0 - This filter function handled the ioctl. EOPNOTSUPP - This filter function does not understand/did not handle this ioctl. EJUSTRETURN - This filter function handled the ioctl, processing should stop. Anything Else - Processing will stop, the error will be returned.

typedef errno_t (*)(void *, ifnet_t, protocol_family_t, unsigned long, void *) iff_ioctl_func;

@typedef iff_detached_func @discussion iff_detached_func is called to notify the filter that it has been detached from an interface. This is the last call to the filter that will be made. A filter may be detached if the interface is detached or the detach filter function is called. In the case that the interface is being detached, your filter's event function will be called with the interface detaching event before the your detached function will be called. @param cookie The cookie specified when this filter was attached. @param interface The interface this filter was detached from.

typedef void (*iff_detached_func)(void *cookie, ifnet_t interface)

__NKE_API_DEPRECATED
extern errno_t iflt_attach(
	ifnet_t interface,
	const struct iff_filter *filter,
	interface_filter_t *filter_ref
)

@function iflt_attach @discussion Attaches an interface filter to an interface. @param interface The interface the filter should be attached to. @param filter A structure defining the filter. @param filter_ref A reference to the filter used to detach. @result 0 on success otherwise the errno error.

__NKE_API_DEPRECATED
extern void iflt_detach(interface_filter_t filter_ref)

@function iflt_detach @discussion Detaches an interface filter from an interface. @param filter_ref The reference to the filter from iflt_attach.