Addresses

Flags Translations
char *	rtnl_addr_flags2str (int flags, char *buf, size_t size)
int	rtnl_addr_str2flags (const char *name)

Allocation/Freeing
struct rtnl_addr *	rtnl_addr_alloc (void)
void	rtnl_addr_put (struct rtnl_addr *addr)

Cache Management
struct nl_cache *	rtnl_addr_alloc_cache (struct nl_handle *handle)

Addition
struct nl_msg *	rtnl_addr_build_add_request (struct rtnl_addr *addr, int flags)
	Build netlink request message to request addition of new address.
int	rtnl_addr_add (struct nl_handle *handle, struct rtnl_addr *addr, int flags)
	Request addition of new address.

Deletion
struct nl_msg *	rtnl_addr_build_delete_request (struct rtnl_addr *addr, int flags)
	Build a netlink request message to request deletion of an address.
int	rtnl_addr_delete (struct nl_handle *handle, struct rtnl_addr *addr, int flags)
	Request deletion of an address.

Attributes
void	rtnl_addr_set_label (struct rtnl_addr *addr, const char *label)
char *	rtnl_addr_get_label (struct rtnl_addr *addr)
void	rtnl_addr_set_ifindex (struct rtnl_addr *addr, int ifindex)
int	rtnl_addr_get_ifindex (struct rtnl_addr *addr)
void	rtnl_addr_set_family (struct rtnl_addr *addr, int family)
int	rtnl_addr_get_family (struct rtnl_addr *addr)
void	rtnl_addr_set_prefixlen (struct rtnl_addr *addr, int prefix)
int	rtnl_addr_get_prefixlen (struct rtnl_addr *addr)
void	rtnl_addr_set_scope (struct rtnl_addr *addr, int scope)
int	rtnl_addr_get_scope (struct rtnl_addr *addr)
void	rtnl_addr_set_flags (struct rtnl_addr *addr, unsigned int flags)
void	rtnl_addr_unset_flags (struct rtnl_addr *addr, unsigned int flags)
unsigned int	rtnl_addr_get_flags (struct rtnl_addr *addr)
int	rtnl_addr_set_local (struct rtnl_addr *addr, struct nl_addr *local)
struct nl_addr *	rtnl_addr_get_local (struct rtnl_addr *addr)
int	rtnl_addr_set_peer (struct rtnl_addr *addr, struct nl_addr *peer)
struct nl_addr *	rtnl_addr_get_peer (struct rtnl_addr *addr)
int	rtnl_addr_set_broadcast (struct rtnl_addr *addr, struct nl_addr *bcast)
struct nl_addr *	rtnl_addr_get_broadcast (struct rtnl_addr *addr)
int	rtnl_addr_set_anycast (struct rtnl_addr *addr, struct nl_addr *anycast)
struct nl_addr *	rtnl_addr_get_anycast (struct rtnl_addr *addr)
int	rtnl_addr_set_multicast (struct rtnl_addr *addr, struct nl_addr *multicast)
struct nl_addr *	rtnl_addr_get_multicast (struct rtnl_addr *addr)

Detailed Description

Note

The maximum size of an address label is IFNAMSIZ.

The address may not contain a prefix length if the peer address has been specified already.

1) Address Addition

// Allocate an empty address object to be filled out with the attributes
// of the new address.
struct rtnl_addr *addr = rtnl_addr_alloc();
 
// Fill out the mandatory attributes of the new address. Setting the
// local address will automatically set the address family and the
// prefix length to the correct values.
rtnl_addr_set_ifindex(addr, ifindex);
rtnl_addr_set_local(addr, local_addr);
 
// The label of the address can be specified, currently only supported
// by IPv4 and DECnet.
rtnl_addr_set_label(addr, "mylabel");
 
// The peer address can be specified if necessary, in either case a peer
// address will be sent to the kernel in order to fullfil the interface
// requirements. If none is set, it will equal the local address.
// Note: Real peer addresses are only supported by IPv4 for now.
rtnl_addr_set_peer(addr, peer_addr);
 
// In case you want to have the address have a scope other than global
// it may be overwritten using rtnl_addr_set_scope(). The scope currently
// cannot be set for IPv6 addresses.
rtnl_addr_set_scope(addr, rtnl_str2scope("site"));
 
// Broadcast and anycast address may be specified using the relevant
// functions, the address family will be verified if one of the other
// addresses has been set already. Currently only works for IPv4.
rtnl_addr_set_broadcast(addr, broadcast_addr);
rtnl_addr_set_anycast(addr, anycast_addr);
 
// Build the netlink message and send it to the kernel, the operation will
// block until the operation has been completed. Alternatively the required
// netlink message can be built using rtnl_addr_build_add_request() to be
// sent out using nl_send_auto_complete().
rtnl_addr_add(handle, addr, 0);
 
// Free the memory
rtnl_addr_put(addr);

2) Address Deletion

// Allocate an empty address object to be filled out with the attributes
// matching the address to be deleted. Alternatively a fully equipped
// address object out of a cache can be used instead.
struct rtnl_addr *addr = rtnl_addr_alloc();
 
// The only mandatory parameter besides the address family is the interface
// index the address is on, i.e. leaving out all other parameters will
// result in all addresses of the specified address family interface tuple
// to be deleted.
rtnl_addr_set_ifindex(addr, ifindex);
 
// Specyfing the address family manually is only required if neither the
// local nor peer address have been specified.
rtnl_addr_set_family(addr, AF_INET);
 
// Specyfing the local address is optional but the best choice to delete
// specific addresses.
rtnl_addr_set_local(addr, local_addr);
 
// The label of the address can be specified, currently only supported
// by IPv4 and DECnet.
rtnl_addr_set_label(addr, "mylabel");
 
// The peer address can be specified if necessary, in either case a peer
// address will be sent to the kernel in order to fullfil the interface
// requirements. If none is set, it will equal the local address.
// Note: Real peer addresses are only supported by IPv4 for now.
rtnl_addr_set_peer(addr, peer_addr);
 
// Build the netlink message and send it to the kernel, the operation will
// block until the operation has been completed. Alternatively the required
// netlink message can be built using rtnl_addr_build_delete_request()
// to be sent out using nl_send_auto_complete().
rtnl_addr_delete(handle, addr, 0);
 
// Free the memory
rtnl_addr_put(addr);

Function Documentation

rtnl_addr_alloc()

struct rtnl_addr * rtnl_addr_alloc

(

void

)

Definition at line 625 of file addr.c.

{
        return (struct rtnl_addr *) nl_object_alloc(&addr_obj_ops);
}

rtnl_addr_put()

void rtnl_addr_put

(

struct rtnl_addr *

addr

)

Definition at line 630 of file addr.c.

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

rtnl_addr_alloc_cache()

struct nl_cache * rtnl_addr_alloc_cache

(

struct nl_handle *

handle

)

Definition at line 642 of file addr.c.

{
        struct nl_cache *cache;
        
        cache = nl_cache_alloc(&rtnl_addr_ops);
        if (!cache)
                return NULL;
 
        if (handle && nl_cache_refill(handle, cache) < 0) {
                nl_cache_free(cache);
                return NULL;
        }
 
        return cache;
}

rtnl_addr_build_add_request()

struct nl_msg * rtnl_addr_build_add_request	(	struct rtnl_addr *	addr,
		int	flags
	)

Parameters

addr	Address object representing the new address.
flags	Additional netlink message flags.

Builds a new netlink message requesting the addition of a new address. 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.

Minimal required attributes:

• interface index (rtnl_addr_set_ifindex())
• local address (rtnl_addr_set_local())

The scope will default to universe except for loopback addresses in which case a host scope is used if not specified otherwise.

Note

Free the memory after usage using nlmsg_free().

Returns

Newly allocated netlink message or NULL if an error occured.

Definition at line 737 of file addr.c.

{
        int required = ADDR_ATTR_IFINDEX | ADDR_ATTR_FAMILY |
                       ADDR_ATTR_PREFIXLEN | ADDR_ATTR_LOCAL;
 
        if ((addr->ce_mask & required) != required) {
                nl_error(EINVAL, "Missing mandatory attributes, required are: "
                                 "ifindex, family, prefixlen, local address.");
                return NULL;
        }
        
        return build_addr_msg(addr, RTM_NEWADDR, NLM_F_CREATE | flags);
}

References NLM_F_CREATE.

Referenced by rtnl_addr_add().

rtnl_addr_add()

int rtnl_addr_add	(	struct nl_handle *	handle,
		struct rtnl_addr *	addr,
		int	flags
	)

Parameters

handle	Netlink handle.
addr	Address object representing the new address.
flags	Additional netlink message flags.

Builds a netlink message by calling rtnl_addr_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.

See also

rtnl_addr_build_add_request()

Returns

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

Definition at line 765 of file addr.c.

{
        struct nl_msg *msg;
        int err;
 
        msg = rtnl_addr_build_add_request(addr, flags);
        if (!msg)
                return nl_get_errno();
 
        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_addr_build_add_request().

rtnl_addr_build_delete_request()

struct nl_msg * rtnl_addr_build_delete_request	(	struct rtnl_addr *	addr,
		int	flags
	)

Parameters

addr	Address object to be deleteted.
flags	Additional netlink message flags.

Builds a new netlink message requesting a deletion of an address. 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.

Minimal required attributes:

• interface index (rtnl_addr_set_ifindex())
• address family (rtnl_addr_set_family())

Optional attributes:

• local address (rtnl_addr_set_local())
• label (rtnl_addr_set_label(), IPv4/DECnet only)
• peer address (rtnl_addr_set_peer(), IPv4 only)

Note

Free the memory after usage using nlmsg_free().

Returns

Newly allocated netlink message or NULL if an error occured.

Definition at line 811 of file addr.c.

{
        int required = ADDR_ATTR_IFINDEX | ADDR_ATTR_FAMILY;
 
        if ((addr->ce_mask & required) != required) {
                nl_error(EINVAL, "Missing mandatory attributes, required are: "
                                 "ifindex, family");
                return NULL;
        }
        
        return build_addr_msg(addr, RTM_DELADDR, flags);
}

Referenced by rtnl_addr_delete().

rtnl_addr_delete()

int rtnl_addr_delete	(	struct nl_handle *	handle,
		struct rtnl_addr *	addr,
		int	flags
	)

Parameters

handle	Netlink handle.
addr	Address object to be deleted.
flags	Additional netlink message flags.

Builds a netlink message by calling rtnl_addr_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.

See also

rtnl_addr_build_delete_request();

Returns

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

Definition at line 838 of file addr.c.

{
        struct nl_msg *msg;
        int err;
 
        msg = rtnl_addr_build_delete_request(addr, flags);
        if (!msg)
                return nl_get_errno();
 
        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_addr_build_delete_request().

rtnl_addr_set_label()

void rtnl_addr_set_label	(	struct rtnl_addr *	addr,
		const char *	label
	)

Definition at line 863 of file addr.c.

{
        strncpy(addr->a_label, label, sizeof(addr->a_label) - 1);
        addr->ce_mask |= ADDR_ATTR_LABEL;
}

rtnl_addr_get_label()

char * rtnl_addr_get_label

(

struct rtnl_addr *

addr

)

Definition at line 869 of file addr.c.

{
        if (addr->ce_mask & ADDR_ATTR_LABEL)
                return addr->a_label;
        else
                return NULL;
}

rtnl_addr_set_ifindex()

void rtnl_addr_set_ifindex	(	struct rtnl_addr *	addr,
		int	ifindex
	)

Definition at line 877 of file addr.c.

{
        addr->a_ifindex = ifindex;
        addr->ce_mask |= ADDR_ATTR_IFINDEX;
}

rtnl_addr_get_ifindex()

int rtnl_addr_get_ifindex

(

struct rtnl_addr *

addr

)

Definition at line 883 of file addr.c.

{
        if (addr->ce_mask & ADDR_ATTR_IFINDEX)
                return addr->a_ifindex;
        else
                return RTNL_LINK_NOT_FOUND;
}

rtnl_addr_set_family()

void rtnl_addr_set_family	(	struct rtnl_addr *	addr,
		int	family
	)

Definition at line 891 of file addr.c.

{
        addr->a_family = family;
        addr->ce_mask |= ADDR_ATTR_FAMILY;
}

rtnl_addr_get_family()

int rtnl_addr_get_family

(

struct rtnl_addr *

addr

)

Definition at line 897 of file addr.c.

{
        if (addr->ce_mask & ADDR_ATTR_FAMILY)
                return addr->a_family;
        else
                return AF_UNSPEC;
}

rtnl_addr_set_prefixlen()

void rtnl_addr_set_prefixlen	(	struct rtnl_addr *	addr,
		int	prefix
	)

Definition at line 905 of file addr.c.

{
        addr->a_prefixlen = prefix;
        addr->ce_mask |= ADDR_ATTR_PREFIXLEN;
}

rtnl_addr_get_prefixlen()

int rtnl_addr_get_prefixlen

(

struct rtnl_addr *

addr

)

Definition at line 911 of file addr.c.

{
        if (addr->ce_mask & ADDR_ATTR_PREFIXLEN)
                return addr->a_prefixlen;
        else
                return -1;
}

rtnl_addr_set_scope()

void rtnl_addr_set_scope	(	struct rtnl_addr *	addr,
		int	scope
	)

Definition at line 919 of file addr.c.

{
        addr->a_scope = scope;
        addr->ce_mask |= ADDR_ATTR_SCOPE;
}

rtnl_addr_get_scope()

int rtnl_addr_get_scope

(

struct rtnl_addr *

addr

)

Definition at line 925 of file addr.c.

{
        if (addr->ce_mask & ADDR_ATTR_SCOPE)
                return addr->a_scope;
        else
                return -1;
}

rtnl_addr_set_flags()

void rtnl_addr_set_flags	(	struct rtnl_addr *	addr,
		unsigned int	flags
	)

Definition at line 933 of file addr.c.

{
        addr->a_flag_mask |= flags;
        addr->a_flags |= flags;
        addr->ce_mask |= ADDR_ATTR_FLAGS;
}

rtnl_addr_unset_flags()

void rtnl_addr_unset_flags	(	struct rtnl_addr *	addr,
		unsigned int	flags
	)

Definition at line 940 of file addr.c.

{
        addr->a_flag_mask |= flags;
        addr->a_flags &= ~flags;
        addr->ce_mask |= ADDR_ATTR_FLAGS;
}

rtnl_addr_get_flags()

unsigned int rtnl_addr_get_flags

(

struct rtnl_addr *

addr

)

Definition at line 947 of file addr.c.

{
        return addr->a_flags;
}

rtnl_addr_set_local()

int rtnl_addr_set_local	(	struct rtnl_addr *	addr,
		struct nl_addr *	local
	)

Definition at line 970 of file addr.c.

{
        int err;
 
        err = __assign_addr(addr, &addr->a_local, local, ADDR_ATTR_LOCAL);
        if (err < 0)
                return err;
 
        if (!(addr->ce_mask & ADDR_ATTR_PEER)) {
                addr->a_prefixlen = nl_addr_get_prefixlen(addr->a_local);
                addr->ce_mask |= ADDR_ATTR_PREFIXLEN;
        }
 
        return 0;
}

rtnl_addr_get_local()

struct nl_addr * rtnl_addr_get_local

(

struct rtnl_addr *

addr

)

Definition at line 986 of file addr.c.

{
        if (addr->ce_mask & ADDR_ATTR_LOCAL)
                return addr->a_local;
        else
                return NULL;
}

rtnl_addr_set_peer()

int rtnl_addr_set_peer	(	struct rtnl_addr *	addr,
		struct nl_addr *	peer
	)

Definition at line 994 of file addr.c.

{
        return __assign_addr(addr, &addr->a_peer, peer, ADDR_ATTR_PEER);
 
        addr->a_prefixlen = nl_addr_get_prefixlen(addr->a_peer);
        addr->ce_mask |= ADDR_ATTR_PREFIXLEN;
 
        return 0;
}

rtnl_addr_get_peer()

struct nl_addr * rtnl_addr_get_peer

(

struct rtnl_addr *

addr

)

Definition at line 1004 of file addr.c.

{
        if (addr->ce_mask & ADDR_ATTR_PEER)
                return addr->a_peer;
        else
                return NULL;
}

rtnl_addr_set_broadcast()

int rtnl_addr_set_broadcast	(	struct rtnl_addr *	addr,
		struct nl_addr *	bcast
	)

Definition at line 1012 of file addr.c.

{
        return __assign_addr(addr, &addr->a_bcast, bcast, ADDR_ATTR_BROADCAST);
}

rtnl_addr_get_broadcast()

struct nl_addr * rtnl_addr_get_broadcast

(

struct rtnl_addr *

addr

)

Definition at line 1017 of file addr.c.

{
        if (addr->ce_mask & ADDR_ATTR_BROADCAST)
                return addr->a_bcast;
        else
                return NULL;
}

rtnl_addr_set_anycast()

int rtnl_addr_set_anycast	(	struct rtnl_addr *	addr,
		struct nl_addr *	anycast
	)

Definition at line 1025 of file addr.c.

{
        return __assign_addr(addr, &addr->a_anycast, anycast,
                             ADDR_ATTR_ANYCAST);
}

rtnl_addr_get_anycast()

struct nl_addr * rtnl_addr_get_anycast

(

struct rtnl_addr *

addr

)

Definition at line 1031 of file addr.c.

{
        if (addr->ce_mask & ADDR_ATTR_ANYCAST)
                return addr->a_anycast;
        else
                return NULL;
}

rtnl_addr_set_multicast()

int rtnl_addr_set_multicast	(	struct rtnl_addr *	addr,
		struct nl_addr *	multicast
	)

Definition at line 1039 of file addr.c.

{
        return __assign_addr(addr, &addr->a_multicast, multicast,
                             ADDR_ATTR_MULTICAST);
}

rtnl_addr_get_multicast()

struct nl_addr * rtnl_addr_get_multicast

(

struct rtnl_addr *

addr

)

Definition at line 1045 of file addr.c.

{
        if (addr->ce_mask & ADDR_ATTR_MULTICAST)
                return addr->a_multicast;
        else
                return NULL;
}

rtnl_addr_flags2str()

char * rtnl_addr_flags2str	(	int	flags,
		char *	buf,
		size_t	size
	)

Definition at line 1067 of file addr.c.

{
        return __flags2str(flags, buf, size, addr_flags,
                           ARRAY_SIZE(addr_flags));
}

rtnl_addr_str2flags()

int rtnl_addr_str2flags

(

const char *

name

)

Definition at line 1073 of file addr.c.

{
        return __str2flags(name, addr_flags, ARRAY_SIZE(addr_flags));
}