Routing Rules

Allocation/Freeing
struct rtnl_rule *	rtnl_rule_alloc (void)
void	rtnl_rule_put (struct rtnl_rule *rule)

Cache Management
struct nl_cache *	rtnl_rule_alloc_cache_by_family (struct nl_handle *handle, int family)
	Build a rule cache including all rules of the specified family currently configured in the kernel.
struct nl_cache *	rtnl_rule_alloc_cache (struct nl_handle *handle)
	Build a rule cache including all rules currently configured in the kernel.

Rule Addition
struct nl_msg *	rtnl_rule_build_add_request (struct rtnl_rule *tmpl, int flags)
	Build netlink request message to add a new rule.
int	rtnl_rule_add (struct nl_handle *handle, struct rtnl_rule *tmpl, int flags)
	Add a new rule.

Rule Deletion
struct nl_msg *	rtnl_rule_build_delete_request (struct rtnl_rule *rule, int flags)
	Build a netlink request message to delete a rule.
int	rtnl_rule_delete (struct nl_handle *handle, struct rtnl_rule *rule, int flags)
	Delete a rule.

Attribute Modification
void	rtnl_rule_set_family (struct rtnl_rule *rule, int family)
int	rtnl_rule_get_family (struct rtnl_rule *rule)
void	rtnl_rule_set_prio (struct rtnl_rule *rule, int prio)
int	rtnl_rule_get_prio (struct rtnl_rule *rule)
void	rtnl_rule_set_mark (struct rtnl_rule *rule, uint64_t mark)
uint64_t	rtnl_rule_get_mark (struct rtnl_rule *rule)
void	rtnl_rule_set_table (struct rtnl_rule *rule, int table)
int	rtnl_rule_get_table (struct rtnl_rule *rule)
void	rtnl_rule_set_dsfield (struct rtnl_rule *rule, int dsfield)
int	rtnl_rule_get_dsfield (struct rtnl_rule *rule)
void	rtnl_rule_set_src_len (struct rtnl_rule *rule, int len)
int	rtnl_rule_get_src_len (struct rtnl_rule *rule)
void	rtnl_rule_set_dst_len (struct rtnl_rule *rule, int len)
int	rtnl_rule_get_dst_len (struct rtnl_rule *rule)
int	rtnl_rule_set_src (struct rtnl_rule *rule, struct nl_addr *src)
struct nl_addr *	rtnl_rule_get_src (struct rtnl_rule *rule)
int	rtnl_rule_set_dst (struct rtnl_rule *rule, struct nl_addr *dst)
struct nl_addr *	rtnl_rule_get_dst (struct rtnl_rule *rule)
int	rtnl_rule_set_iif (struct rtnl_rule *rule, const char *dev)
char *	rtnl_rule_get_iif (struct rtnl_rule *rule)
void	rtnl_rule_set_action (struct rtnl_rule *rule, int type)
int	rtnl_rule_get_action (struct rtnl_rule *rule)
void	rtnl_rule_set_realms (struct rtnl_rule *rule, realm_t realms)
realm_t	rtnl_rule_get_realms (struct rtnl_rule *rule)

Detailed Description

Function Documentation

rtnl_rule_alloc()

struct rtnl_rule * rtnl_rule_alloc

(

void

)

Definition at line 419 of file rule.c.

{
        return (struct rtnl_rule *) nl_object_alloc(&rule_obj_ops);
}

rtnl_rule_put()

void rtnl_rule_put

(

struct rtnl_rule *

rule

)

Definition at line 424 of file rule.c.

{
        nl_object_put((struct nl_object *) rule);
}

rtnl_rule_alloc_cache_by_family()

struct nl_cache * rtnl_rule_alloc_cache_by_family	(	struct nl_handle *	handle,
		int	family
	)

Parameters

handle	netlink handle
family	address family

Allocates a new rule cache, initializes it properly and updates it to include all rules of the specified address family currently configured in the kernel.

Note

The caller is responsible for destroying and freeing the cache after using it. (nl_cache_destroy_and_free())

Returns

The new cache or NULL if an error occured.

Definition at line 449 of file rule.c.

{
        struct nl_cache * cache;
 
        cache = nl_cache_alloc(&rtnl_rule_ops);
        if (cache == NULL)
                return NULL;
 
        /* XXX RULE_CACHE_FAMILY(cache) = family; */
 
        if (handle && nl_cache_refill(handle, cache) < 0) {
                free(cache);
                return NULL;
        }
 
        return cache;
}

References nl_cache_alloc(), and nl_cache_refill().

Referenced by rtnl_rule_alloc_cache().

rtnl_rule_alloc_cache()

struct nl_cache * rtnl_rule_alloc_cache

(

struct nl_handle *

handle

)

Parameters

handle

netlink handle

Allocates a new rule cache, initializes it properly and updates it to include all rules currently configured in the kernel.

Note

The caller is responsible for destroying and freeing the cache after using it. (nl_cache_destroy_and_free())

Returns

The new cache or NULL if an error occured.

Definition at line 479 of file rule.c.

{
        return rtnl_rule_alloc_cache_by_family(handle, AF_UNSPEC);
}

References rtnl_rule_alloc_cache_by_family().

rtnl_rule_build_add_request()

struct nl_msg * rtnl_rule_build_add_request	(	struct rtnl_rule *	tmpl,
		int	flags
	)

Parameters

tmpl	template with data of new rule
flags	additional netlink message flags

Builds a new netlink message requesting a addition of a new rule. The netlink message header isn't fully equipped with all relevant fields and must thus be sent out via nl_send_auto_complete() or supplemented as needed. tmpl must contain the attributes of the new address set via rtnl_rule_set_* functions.

Returns

The netlink message

Definition at line 564 of file rule.c.

{
        return build_rule_msg(tmpl, RTM_NEWRULE, NLM_F_CREATE | flags);
}

References NLM_F_CREATE.

Referenced by rtnl_rule_add().

rtnl_rule_add()

int rtnl_rule_add	(	struct nl_handle *	handle,
		struct rtnl_rule *	tmpl,
		int	flags
	)

Parameters

handle	netlink handle
tmpl	template with requested changes
flags	additional netlink message flags

Builds a netlink message by calling rtnl_rule_build_add_request(), sends the request to the kernel and waits for the next ACK to be received and thus blocks until the request has been fullfilled.

Returns

0 on sucess or a negative error if an error occured.

Definition at line 581 of file rule.c.

{
        int err;
        struct nl_msg *msg;
        
        msg = rtnl_rule_build_add_request(tmpl, flags);
        if (!msg)
                return nl_errno(ENOMEM);
 
        err = nl_send_auto_complete(handle, msg);
        nlmsg_free(msg);
        if (err < 0)
                return err;
 
        return nl_wait_for_ack(handle);
}

References nl_send_auto_complete(), nl_wait_for_ack(), nlmsg_free(), and rtnl_rule_build_add_request().

rtnl_rule_build_delete_request()

struct nl_msg * rtnl_rule_build_delete_request	(	struct rtnl_rule *	rule,
		int	flags
	)

Parameters

rule	rule to delete
flags	additional netlink message flags

Builds a new netlink message requesting a deletion of a rule. The netlink message header isn't fully equipped with all relevant fields and must thus be sent out via nl_send_auto_complete() or supplemented as needed. rule must point to an existing address.

Returns

The netlink message

Definition at line 618 of file rule.c.

{
        return build_rule_msg(rule, RTM_DELRULE, flags);
}

Referenced by rtnl_rule_delete().

rtnl_rule_delete()

int rtnl_rule_delete	(	struct nl_handle *	handle,
		struct rtnl_rule *	rule,
		int	flags
	)

Parameters

handle	netlink handle
rule	rule to delete
flags	additional netlink message flags

Builds a netlink message by calling rtnl_rule_build_delete_request(), sends the request to the kernel and waits for the next ACK to be received and thus blocks until the request has been fullfilled.

Returns

0 on sucess or a negative error if an error occured.

Definition at line 635 of file rule.c.

{
        int err;
        struct nl_msg *msg;
        
        msg = rtnl_rule_build_delete_request(rule, flags);
        if (!msg)
                return nl_errno(ENOMEM);
 
        err = nl_send_auto_complete(handle, msg);
        nlmsg_free(msg);
        if (err < 0)
                return err;
 
        return nl_wait_for_ack(handle);
}

References nl_send_auto_complete(), nl_wait_for_ack(), nlmsg_free(), and rtnl_rule_build_delete_request().

rtnl_rule_set_family()

void rtnl_rule_set_family	(	struct rtnl_rule *	rule,
		int	family
	)

Definition at line 660 of file rule.c.

{
        rule->r_family = family;
        rule->ce_mask |= RULE_ATTR_FAMILY;
}

rtnl_rule_get_family()

int rtnl_rule_get_family

(

struct rtnl_rule *

rule

)

Definition at line 666 of file rule.c.

{
        if (rule->ce_mask & RULE_ATTR_FAMILY)
                return rule->r_family;
        else
                return AF_UNSPEC;
}

rtnl_rule_set_prio()

void rtnl_rule_set_prio	(	struct rtnl_rule *	rule,
		int	prio
	)

Definition at line 674 of file rule.c.

{
        rule->r_prio = prio;
        rule->ce_mask |= RULE_ATTR_PRIO;
}

rtnl_rule_get_prio()

int rtnl_rule_get_prio

(

struct rtnl_rule *

rule

)

Definition at line 680 of file rule.c.

{
        if (rule->ce_mask & RULE_ATTR_PRIO)
                return rule->r_prio;
        else
                return -1;
}

rtnl_rule_set_mark()

void rtnl_rule_set_mark	(	struct rtnl_rule *	rule,
		uint64_t	mark
	)

Definition at line 688 of file rule.c.

{
        rule->r_mark = mark;
        rule->ce_mask |= RULE_ATTR_MARK;
}

rtnl_rule_get_mark()

uint64_t rtnl_rule_get_mark

(

struct rtnl_rule *

rule

)

Definition at line 694 of file rule.c.

{
        if (rule->ce_mask & RULE_ATTR_MARK)
                return rule->r_mark;
        else
                return UINT_LEAST64_MAX;
}

rtnl_rule_set_table()

void rtnl_rule_set_table	(	struct rtnl_rule *	rule,
		int	table
	)

Definition at line 702 of file rule.c.

{
        rule->r_table = table;
        rule->ce_mask |= RULE_ATTR_TABLE;
}

rtnl_rule_get_table()

int rtnl_rule_get_table

(

struct rtnl_rule *

rule

)

Definition at line 708 of file rule.c.

{
        if (rule->ce_mask & RULE_ATTR_TABLE)
                return rule->r_table;
        else
                return -1;
}

rtnl_rule_set_dsfield()

void rtnl_rule_set_dsfield	(	struct rtnl_rule *	rule,
		int	dsfield
	)

Definition at line 716 of file rule.c.

{
        rule->r_dsfield = dsfield;
        rule->ce_mask |= RULE_ATTR_DSFIELD;
}

rtnl_rule_get_dsfield()

int rtnl_rule_get_dsfield

(

struct rtnl_rule *

rule

)

Definition at line 722 of file rule.c.

{
        if (rule->ce_mask & RULE_ATTR_DSFIELD)
                return rule->r_dsfield;
        else
                return -1;
}

rtnl_rule_set_src_len()

void rtnl_rule_set_src_len	(	struct rtnl_rule *	rule,
		int	len
	)

Definition at line 730 of file rule.c.

{
        rule->r_src_len = len;
        if (rule->ce_mask & RULE_ATTR_SRC)
                nl_addr_set_prefixlen(rule->r_src, len);
        rule->ce_mask |= RULE_ATTR_SRC_LEN;
}

rtnl_rule_get_src_len()

int rtnl_rule_get_src_len

(

struct rtnl_rule *

rule

)

Definition at line 738 of file rule.c.

{
        if (rule->ce_mask & RULE_ATTR_SRC_LEN)
                return rule->r_src_len;
        else
                return -1;
}

rtnl_rule_set_dst_len()

void rtnl_rule_set_dst_len	(	struct rtnl_rule *	rule,
		int	len
	)

Definition at line 746 of file rule.c.

{
        rule->r_dst_len = len;
        if (rule->ce_mask & RULE_ATTR_DST)
                nl_addr_set_prefixlen(rule->r_dst, len);
        rule->ce_mask |= RULE_ATTR_DST_LEN;
}

rtnl_rule_get_dst_len()

int rtnl_rule_get_dst_len

(

struct rtnl_rule *

rule

)

Definition at line 754 of file rule.c.

{
        if (rule->ce_mask & RULE_ATTR_DST_LEN)
                return rule->r_dst_len;
        else
                return -1;
}

rtnl_rule_set_src()

int rtnl_rule_set_src	(	struct rtnl_rule *	rule,
		struct nl_addr *	src
	)

Definition at line 783 of file rule.c.

{
        return __assign_addr(rule, &rule->r_src, src, &rule->r_src_len,
                             RULE_ATTR_SRC | RULE_ATTR_SRC_LEN);
}

rtnl_rule_get_src()

struct nl_addr * rtnl_rule_get_src

(

struct rtnl_rule *

rule

)

Definition at line 789 of file rule.c.

{
        if (rule->ce_mask & RULE_ATTR_SRC)
                return rule->r_src;
        else
                return NULL;
}

rtnl_rule_set_dst()

int rtnl_rule_set_dst	(	struct rtnl_rule *	rule,
		struct nl_addr *	dst
	)

Definition at line 797 of file rule.c.

{
        return __assign_addr(rule, &rule->r_dst, dst, &rule->r_dst_len,
                             RULE_ATTR_DST | RULE_ATTR_DST_LEN);
}

rtnl_rule_get_dst()

struct nl_addr * rtnl_rule_get_dst

(

struct rtnl_rule *

rule

)

Definition at line 803 of file rule.c.

{
        if (rule->ce_mask & RULE_ATTR_DST)
                return rule->r_dst;
        else
                return NULL;
}

rtnl_rule_set_iif()

int rtnl_rule_set_iif	(	struct rtnl_rule *	rule,
		const char *	dev
	)

Definition at line 811 of file rule.c.

{
        if (strlen(dev) > IFNAMSIZ-1)
                return nl_errno(ERANGE);
 
        strcpy(rule->r_iif, dev);
        rule->ce_mask |= RULE_ATTR_IIF;
        return 0;
}

rtnl_rule_get_iif()

char * rtnl_rule_get_iif

(

struct rtnl_rule *

rule

)

Definition at line 821 of file rule.c.

{
        if (rule->ce_mask & RULE_ATTR_IIF)
                return rule->r_iif;
        else
                return NULL;
}

rtnl_rule_set_action()

void rtnl_rule_set_action	(	struct rtnl_rule *	rule,
		int	type
	)

Definition at line 829 of file rule.c.

{
        rule->r_type = type;
        rule->ce_mask |= RULE_ATTR_TYPE;
}

rtnl_rule_get_action()

int rtnl_rule_get_action

(

struct rtnl_rule *

rule

)

Definition at line 835 of file rule.c.

{
        if (rule->ce_mask & RULE_ATTR_TYPE)
                return rule->r_type;
        else
                return nl_errno(ENOENT);
}

rtnl_rule_set_realms()

void rtnl_rule_set_realms	(	struct rtnl_rule *	rule,
		realm_t	realms
	)

Definition at line 843 of file rule.c.

{
        rule->r_realms = realms;
        rule->ce_mask |= RULE_ATTR_REALMS;
}

rtnl_rule_get_realms()

realm_t rtnl_rule_get_realms

(

struct rtnl_rule *

rule

)

Definition at line 849 of file rule.c.

{
        if (rule->ce_mask & RULE_ATTR_REALMS)
                return rule->r_realms;
        else
                return 0;
}