Modules

Links (Interfaces)
[Routing Family]

Modules

 Link Modules API
 

API for modules implementing specific link types/semantics.


 VLAN

Link Flags Translations



char * rtnl_link_flags2str (int flags, char *buf, size_t len)
int rtnl_link_str2flags (const char *name)

Link Statistics Translations



char * rtnl_link_stat2str (int st, char *buf, size_t len)
int rtnl_link_str2stat (const char *name)

Link Operstate Translations



char * rtnl_link_operstate2str (int st, char *buf, size_t len)
int rtnl_link_str2operstate (const char *name)

Link Mode Translations



char * rtnl_link_mode2str (int st, char *buf, size_t len)
int rtnl_link_str2mode (const char *name)

Allocation/Freeing



struct rtnl_link * rtnl_link_alloc (void)
void rtnl_link_put (struct rtnl_link *link)

Cache Management



int rtnl_link_alloc_cache (struct nl_sock *sk, int family, struct nl_cache **result)
 Allocate link cache and fill in all configured links.
struct rtnl_link * rtnl_link_get (struct nl_cache *cache, int ifindex)
 Look up link by interface index in the provided cache.
struct rtnl_link * rtnl_link_get_by_name (struct nl_cache *cache, const char *name)
 Look up link by link name in the provided cache.

Link Modifications



int rtnl_link_build_change_request (struct rtnl_link *old, struct rtnl_link *tmpl, int flags, struct nl_msg **result)
 Builds a netlink change request message to change link attributes.
int rtnl_link_change (struct nl_sock *sk, struct rtnl_link *old, struct rtnl_link *tmpl, int flags)
 Change link attributes.

Name <-> Index Translations



char * rtnl_link_i2name (struct nl_cache *cache, int ifindex, char *dst, size_t len)
 Translate an interface index to the corresponding link name.
int rtnl_link_name2i (struct nl_cache *cache, const char *name)
 Translate a link name to the corresponding interface index.

Attributes



void rtnl_link_set_qdisc (struct rtnl_link *link, const char *qdisc)
char * rtnl_link_get_qdisc (struct rtnl_link *link)
void rtnl_link_set_name (struct rtnl_link *link, const char *name)
char * rtnl_link_get_name (struct rtnl_link *link)
void rtnl_link_set_addr (struct rtnl_link *link, struct nl_addr *addr)
struct nl_addr * rtnl_link_get_addr (struct rtnl_link *link)
void rtnl_link_set_broadcast (struct rtnl_link *link, struct nl_addr *brd)
struct nl_addr * rtnl_link_get_broadcast (struct rtnl_link *link)
void rtnl_link_set_flags (struct rtnl_link *link, unsigned int flags)
void rtnl_link_unset_flags (struct rtnl_link *link, unsigned int flags)
unsigned int rtnl_link_get_flags (struct rtnl_link *link)
void rtnl_link_set_family (struct rtnl_link *link, int family)
int rtnl_link_get_family (struct rtnl_link *link)
void rtnl_link_set_arptype (struct rtnl_link *link, unsigned int arptype)
unsigned int rtnl_link_get_arptype (struct rtnl_link *link)
void rtnl_link_set_ifindex (struct rtnl_link *link, int ifindex)
int rtnl_link_get_ifindex (struct rtnl_link *link)
void rtnl_link_set_mtu (struct rtnl_link *link, unsigned int mtu)
unsigned int rtnl_link_get_mtu (struct rtnl_link *link)
void rtnl_link_set_txqlen (struct rtnl_link *link, unsigned int txqlen)
unsigned int rtnl_link_get_txqlen (struct rtnl_link *link)
void rtnl_link_set_weight (struct rtnl_link *link, unsigned int weight)
unsigned int rtnl_link_get_weight (struct rtnl_link *link)
void rtnl_link_set_link (struct rtnl_link *link, int ifindex)
int rtnl_link_get_link (struct rtnl_link *link)
void rtnl_link_set_master (struct rtnl_link *link, int ifindex)
int rtnl_link_get_master (struct rtnl_link *link)
void rtnl_link_set_operstate (struct rtnl_link *link, uint8_t operstate)
uint8_t rtnl_link_get_operstate (struct rtnl_link *link)
void rtnl_link_set_linkmode (struct rtnl_link *link, uint8_t linkmode)
uint8_t rtnl_link_get_linkmode (struct rtnl_link *link)
const char * rtnl_link_get_ifalias (struct rtnl_link *link)
 Return alias name of link (SNMP IfAlias).
void rtnl_link_set_ifalias (struct rtnl_link *link, const char *alias)
 Set alias name of link (SNMP IfAlias).
int rtnl_link_get_num_vf (struct rtnl_link *link, uint32_t *num_vf)
 Retrieve number of PCI VFs of link.
uint64_t rtnl_link_get_stat (struct rtnl_link *link, int id)
int rtnl_link_set_stat (struct rtnl_link *link, const unsigned int id, const uint64_t value)
 Set value of a link statistics counter.
int rtnl_link_set_info_type (struct rtnl_link *link, const char *type)
 Specify the info type of a link.
char * rtnl_link_get_info_type (struct rtnl_link *link)
 Return info type of a link.

Detailed Description

Link Identification
A link can be identified by either its interface index or by its name. The kernel favours the interface index but falls back to the interface name if the interface index is lesser-than 0 for kernels >= 2.6.11. Therefore you can request changes without mapping a interface name to the corresponding index first.
Changeable Attributes
  • Link layer address
  • Link layer broadcast address
  • device mapping (ifmap) (>= 2.6.9)
  • MTU (>= 2.6.9)
  • Transmission queue length (>= 2.6.9)
  • Weight (>= 2.6.9)
  • Link name (only via access through interface index) (>= 2.6.9)
  • Flags (>= 2.6.9)
    • IFF_DEBUG
    • IFF_NOTRAILERS
    • IFF_NOARP
    • IFF_DYNAMIC
    • IFF_MULTICAST
    • IFF_PORTSEL
    • IFF_AUTOMEDIA
    • IFF_UP
    • IFF_PROMISC
    • IFF_ALLMULTI
Link Flags (linux/if.h)
   IFF_UP            Status of link (up|down)
   IFF_BROADCAST     Indicates this link allows broadcasting
   IFF_MULTICAST     Indicates this link allows multicasting
   IFF_ALLMULTI      Indicates this link is doing multicast routing
   IFF_DEBUG         Tell the driver to do debugging (currently unused)
   IFF_LOOPBACK      This is the loopback link
   IFF_POINTOPOINT   Point-to-point link
   IFF_NOARP         Link is unable to perform ARP
   IFF_PROMISC       Status of promiscious mode flag
   IFF_MASTER        Used by teql
   IFF_SLAVE         Used by teql
   IFF_PORTSEL       Indicates this link allows port selection
   IFF_AUTOMEDIA     Indicates this link selects port automatically
   IFF_DYNAMIC       Indicates the address of this link is dynamic
   IFF_RUNNING       Link is running and carrier is ok.
   IFF_NOTRAILERS    Unused, BSD compat.
Notes on IFF_PROMISC and IFF_ALLMULTI flags
Although you can query the status of IFF_PROMISC and IFF_ALLMULTI they do not represent the actual state in the kernel but rather whether the flag has been enabled/disabled by userspace. The link may be in promiscious mode even if IFF_PROMISC is not set in a link dump request response because promiscity might be needed by the driver for a period of time.
Note:
The unit of the transmission queue length depends on the link type, a common unit is packets.
1) Retrieving information about available links
 // The first step is to retrieve a list of all available interfaces within
 // the kernel and put them into a cache.
 struct nl_cache *cache = rtnl_link_alloc_cache(sk);

 // In a second step, a specific link may be looked up by either interface
 // index or interface name.
 struct rtnl_link *link = rtnl_link_get_by_name(cache, "lo");

 // rtnl_link_get_by_name() is the short version for translating the
 // interface name to an interface index first like this:
 int ifindex = rtnl_link_name2i(cache, "lo");
 struct rtnl_link *link = rtnl_link_get(cache, ifindex);

 // After successful usage, the object must be given back to the cache
 rtnl_link_put(link);
2) Changing link attributes
 // In order to change any attributes of an existing link, we must allocate
 // a new link to hold the change requests:
 struct rtnl_link *request = rtnl_link_alloc();

 // Now we can go on and specify the attributes we want to change:
 rtnl_link_set_weight(request, 300);
 rtnl_link_set_mtu(request, 1360);

 // We can also shut an interface down administratively
 rtnl_link_unset_flags(request, rtnl_link_str2flags("up"));

 // Actually, we should know which link to change, so let's look it up
 struct rtnl_link *old = rtnl_link_get(cache, "eth0");

 // Two ways exist to commit this change request, the first one is to
 // build the required netlink message and send it out in one single
 // step:
 rtnl_link_change(sk, old, request, 0);

 // An alternative way is to build the netlink message and send it
 // out yourself using nl_send_auto_complete()
 struct nl_msg *msg = rtnl_link_build_change_request(old, request);
 nl_send_auto_complete(sk, nlmsg_hdr(msg));
 nlmsg_free(msg);

 // Don't forget to give back the link object ;->
 rtnl_link_put(old);
3) Link Type Specific Attributes
 // Some link types offer additional parameters and statistics specific
 // to their type. F.e. a VLAN link can be configured like this:
 //
 // Allocate a new link and set the info type to "vlan". This is required
 // to prepare the link to hold vlan specific attributes.
 struct rtnl_link *request = rtnl_link_alloc();
 rtnl_link_set_info_type(request, "vlan");

 // Now vlan specific attributes can be set:
 rtnl_link_vlan_set_id(request, 10);
 rtnl_link_vlan_set_ingress_map(request, 2, 8);

 // Of course the attributes can also be read, check the info type
 // to make sure you are using the right access functions:
 char *type = rtnl_link_get_info_type(link);
 if (!strcmp(type, "vlan"))
        int id = rtnl_link_vlan_get_id(link);

Function Documentation

int rtnl_link_alloc_cache ( struct nl_sock *  sk,
int  family,
struct nl_cache **  result 
)

Allocate link cache and fill in all configured links.

Parameters:
sk Netlink socket.
family Link address family or AF_UNSPEC
result Pointer to store resulting cache.

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

Returns:
0 on success or a negative error code.

Definition at line 952 of file link.c.

References nl_cache_alloc(), nl_cache_free(), and nl_cache_refill().

Here is the call graph for this function:

struct rtnl_link* rtnl_link_get ( struct nl_cache *  cache,
int  ifindex 
) [read]

Look up link by interface index in the provided cache.

Parameters:
cache link cache
ifindex link interface index

The caller owns a reference on the returned object and must give the object back via rtnl_link_put().

Returns:
pointer to link inside the cache or NULL if no match was found.

Definition at line 982 of file link.c.

References nl_object_get().

Referenced by rtnl_link_i2name().

Here is the call graph for this function:

Here is the caller graph for this function:

struct rtnl_link* rtnl_link_get_by_name ( struct nl_cache *  cache,
const char *  name 
) [read]

Look up link by link name in the provided cache.

Parameters:
cache link cache
name link name

The caller owns a reference on the returned object and must give the object back via rtnl_link_put().

Returns:
pointer to link inside the cache or NULL if no match was found.

Definition at line 1009 of file link.c.

References nl_object_get().

Referenced by rtnl_link_name2i().

Here is the call graph for this function:

Here is the caller graph for this function:

int rtnl_link_build_change_request ( struct rtnl_link *  old,
struct rtnl_link *  tmpl,
int  flags,
struct nl_msg **  result 
)

Builds a netlink change request message to change link attributes.

Parameters:
old link to be changed
tmpl template with requested changes
flags additional netlink message flags

Builds a new netlink message requesting a change of link attributes. The netlink message header isn't fully equipped with all relevant fields and must be sent out via nl_send_auto_complete() or supplemented as needed. old must point to a link currently configured in the kernel and tmpl must contain the attributes to be changed set via rtnl_link_set_* functions.

Returns:
New netlink message
Note:
Not all attributes can be changed, see Changeable Attributes for more details.

Definition at line 1052 of file link.c.

References nla_nest_end(), nla_nest_start(), NLA_PUT_ADDR, NLA_PUT_STRING, NLA_PUT_U32, NLA_PUT_U8, nlmsg_alloc_simple(), nlmsg_append(), and nlmsg_free().

Referenced by rtnl_link_change().

Here is the call graph for this function:

Here is the caller graph for this function:

int rtnl_link_change ( struct nl_sock *  sk,
struct rtnl_link *  old,
struct rtnl_link *  tmpl,
int  flags 
)

Change link attributes.

Parameters:
sk Netlink socket.
old link to be changed
tmpl template with requested changes
flags additional netlink message flags

Builds a new netlink message by calling rtnl_link_build_change_request(), sends the request to the kernel and waits for the next ACK to be received, i.e. blocks until the request has been processed.

Returns:
0 on success or a negative error code
Note:
Not all attributes can be changed, see Changeable Attributes for more details.

Definition at line 1148 of file link.c.

References nlmsg_free(), and rtnl_link_build_change_request().

Here is the call graph for this function:

char* rtnl_link_i2name ( struct nl_cache *  cache,
int  ifindex,
char *  dst,
size_t  len 
)

Translate an interface index to the corresponding link name.

Parameters:
cache link cache
ifindex link interface index
dst destination buffer
len length of destination buffer

Translates the specified interface index to the corresponding link name and stores the name in the destination buffer.

Returns:
link name or NULL if no match was found.

Definition at line 1184 of file link.c.

References rtnl_link_get().

Here is the call graph for this function:

int rtnl_link_name2i ( struct nl_cache *  cache,
const char *  name 
)

Translate a link name to the corresponding interface index.

Parameters:
cache link cache
name link name
Returns:
interface index or 0 if no match was found.

Definition at line 1205 of file link.c.

References rtnl_link_get_by_name().

Here is the call graph for this function:

const char* rtnl_link_get_ifalias ( struct rtnl_link *  link  ) 

Return alias name of link (SNMP IfAlias).

Parameters:
link Link object
Returns:
Alias name or NULL if not set.

Definition at line 1612 of file link.c.

void rtnl_link_set_ifalias ( struct rtnl_link *  link,
const char *  alias 
)

Set alias name of link (SNMP IfAlias).

Parameters:
link Link object
alias Alias name or NULL to unset

Sets the alias name of the link to the specified name. The alias name can be unset by specyfing NULL as the alias. The name will be strdup()ed, so no need to provide a persistent character string.

Definition at line 1626 of file link.c.

int rtnl_link_get_num_vf ( struct rtnl_link *  link,
uint32_t *  num_vf 
)

Retrieve number of PCI VFs of link.

Parameters:
link Link object
num_vf Pointer to store number of VFs
Returns:
0 if value is available or -NLE_OPNOTSUPP if not.

Definition at line 1644 of file link.c.

int rtnl_link_set_stat ( struct rtnl_link *  link,
const unsigned int  id,
const uint64_t  value 
)

Set value of a link statistics counter.

Parameters:
link Link object
id Counter ID
value New value
Returns:
0 on success or a negative error code

Definition at line 1669 of file link.c.

int rtnl_link_set_info_type ( struct rtnl_link *  link,
const char *  type 
)

Specify the info type of a link.

Parameters:
link link object
type info type

Looks up the info type and prepares the link to store info type specific attributes. If an info type has been assigned already it will be released with all changes lost.

Returns:
0 on success or a negative errror code.

Definition at line 1691 of file link.c.

References rtnl_link_info_ops::io_alloc, and rtnl_link_info_ops_lookup().

Here is the call graph for this function:

char* rtnl_link_get_info_type ( struct rtnl_link *  link  ) 

Return info type of a link.

Parameters:
link link object
Note:
The returned pointer is only valid as long as the link exists
Returns:
Info type name or NULL if unknown.

Definition at line 1717 of file link.c.