#include <net/route.h>

net/route.h

includes: sys/appleapiopts.h, stdint.h, sys/types.h, sys/socket.h

80 macros · 6 structs

structrt_metrics

These numbers are used by reliable protocols for determining retransmission behavior and are included in the routing structure.

size 56, align 4

u_int32_t	rmx_locks	Kernel leaves these values alone
u_int32_t	rmx_mtu	MTU for this path
u_int32_t	rmx_hopcount	max hops expected
int32_t	rmx_expire	lifetime for route, e.g. redirect
u_int32_t	rmx_recvpipe	inbound delay-bandwidth product
u_int32_t	rmx_sendpipe	outbound delay-bandwidth product
u_int32_t	rmx_ssthresh	outbound gateway buffer limit
u_int32_t	rmx_rtt	estimated round trip time
u_int32_t	rmx_rttvar	estimated rtt variance
u_int32_t	rmx_pksent	packets sent using this route
u_int32_t[4]	rmx_filler	will be used for TCP's peer-MSS cache

macroRTM_RTTUNIT

rmx_rtt and rmx_rttvar are stored as microseconds;

#define RTM_RTTUNIT 1000000

units for rtt, rttvar, as units per sec

macroRTF_UP

#define RTF_UP 0x1

route usable

macroRTF_GATEWAY

#define RTF_GATEWAY 0x2

destination is a gateway

macroRTF_HOST

#define RTF_HOST 0x4

host entry (net otherwise)

macroRTF_REJECT

#define RTF_REJECT 0x8

host or net unreachable

macroRTF_DYNAMIC

#define RTF_DYNAMIC 0x10

created dynamically (by redirect)

macroRTF_MODIFIED

#define RTF_MODIFIED 0x20

modified dynamically (by redirect)

macroRTF_DONE

#define RTF_DONE 0x40

message confirmed

macroRTF_DELCLONE

#define RTF_DELCLONE 0x80

delete cloned route

macroRTF_CLONING

#define RTF_CLONING 0x100

generate new routes on use

macroRTF_XRESOLVE

#define RTF_XRESOLVE 0x200

external daemon resolves name

macroRTF_LLINFO

#define RTF_LLINFO 0x400

generated by link layer (e.g. ARP)

macroRTF_STATIC

#define RTF_STATIC 0x800

manually added

macroRTF_BLACKHOLE

#define RTF_BLACKHOLE 0x1000

just discard pkts (during updates)

macroRTF_NOIFREF

#define RTF_NOIFREF 0x2000

not eligible for RTF_IFREF

macroRTF_PROTO2

#define RTF_PROTO2 0x4000

protocol specific routing flag

macroRTF_PROTO1

#define RTF_PROTO1 0x8000

protocol specific routing flag

macroRTF_PRCLONING

#define RTF_PRCLONING 0x10000

protocol requires cloning

macroRTF_WASCLONED

#define RTF_WASCLONED 0x20000

route generated through cloning

macroRTF_PROTO3

#define RTF_PROTO3 0x40000

protocol specific routing flag

macroRTF_PINNED

0x80000 unused

#define RTF_PINNED 0x100000

future use

macroRTF_LOCAL

#define RTF_LOCAL 0x200000

route represents a local address

macroRTF_BROADCAST

#define RTF_BROADCAST 0x400000

route represents a bcast address

macroRTF_MULTICAST

#define RTF_MULTICAST 0x800000

route represents a mcast address

macroRTF_IFSCOPE

#define RTF_IFSCOPE 0x1000000

has valid interface scope

macroRTF_CONDEMNED

#define RTF_CONDEMNED 0x2000000

defunct; no longer modifiable

macroRTF_IFREF

#define RTF_IFREF 0x4000000

route holds a ref to interface

macroRTF_PROXY

#define RTF_PROXY 0x8000000

proxying, no interface scope

macroRTF_ROUTER

#define RTF_ROUTER 0x10000000

host is a router

macroRTF_DEAD

#define RTF_DEAD 0x20000000

Route entry is being freed

macroRTF_GLOBAL

#define RTF_GLOBAL 0x40000000

route to destination of the global internet

macroRTPRF_OURS

#define RTPRF_OURS RTF_PROTO3

set on routes we manage

macroIS_DIRECT_HOSTROUTE

#define IS_DIRECT_HOSTROUTE(rt) (((rt)->rt_flags & (RTF_HOST | RTF_GATEWAY)) == RTF_HOST)

macroIS_DYNAMIC_DIRECT_HOSTROUTE

#define IS_DYNAMIC_DIRECT_HOSTROUTE(rt) (((rt)->rt_flags & (RTF_CLONING | RTF_PRCLONING | RTF_HOST | RTF_LLINFO |
	    RTF_WASCLONED | RTF_GATEWAY)) ==
	 (RTF_HOST | RTF_LLINFO | RTF_WASCLONED))

macroIS_LOCALNET_ROUTE

#define IS_LOCALNET_ROUTE(rt) (!((rt)->rt_flags & RTF_LOCAL) &&
     ((((rt)->rt_flags & (RTF_HOST | RTF_GATEWAY)) == RTF_HOST) ||
     ((rt)->rt_flags & (RTF_MULTICAST | RTF_BROADCAST))))

structrtstat

Routing statistics.

size 12, align 2

short	rts_badredirect	bogus redirect calls
short	rts_dynamic	routes created by redirects
short	rts_newgateway	routes modified by redirects
short	rts_unreach	lookups which failed
short	rts_wildcard	lookups satisfied by a wildcard
short	rts_badrtgwroute	route to gateway is not direct

structrt_msghdr

Structures for routing messages.

size 92, align 4

u_short	rtm_msglen	to skip over non-understood messages
u_char	rtm_version	future binary compatibility
u_char	rtm_type	message type
u_short	rtm_index	index for associated ifp
int	rtm_flags	flags, incl. kern & message, e.g. DONE
int	rtm_addrs	bitmask identifying sockaddrs in msg
pid_t	rtm_pid	identify sender
int	rtm_seq	for sender to identify action
int	rtm_errno	why failed
int	rtm_use	from rtentry
u_int32_t	rtm_inits	which metrics we are initializing
struct rt_metrics	rtm_rmx	metrics themselves

structrt_msghdr2

size 92, align 4

u_short	rtm_msglen	to skip over non-understood messages
u_char	rtm_version	future binary compatibility
u_char	rtm_type	message type
u_short	rtm_index	index for associated ifp
int	rtm_flags	flags, incl. kern & message, e.g. DONE
int	rtm_addrs	bitmask identifying sockaddrs in msg
int32_t	rtm_refcnt	reference count
int	rtm_parentflags	flags of the parent route
int	rtm_reserved	reserved field set to 0
int	rtm_use	from rtentry
u_int32_t	rtm_inits	which metrics we are initializing
struct rt_metrics	rtm_rmx	metrics themselves