libnl 1.1.4
link.h
1/*
2 * netlink/route/link.h Links (Interfaces)
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation version 2.1
7 * of the License.
8 *
9 * Copyright (c) 2003-2006 Thomas Graf <tgraf@suug.ch>
10 */
11
12#ifndef NETLINK_LINK_H_
13#define NETLINK_LINK_H_
14
15#include <netlink/netlink.h>
16#include <netlink/cache.h>
17#include <netlink/addr.h>
18
19#ifdef __cplusplus
20extern "C" {
21#endif
22
23struct rtnl_link;
24
25enum rtnl_link_st {
26 RTNL_LINK_RX_PACKETS,
27 RTNL_LINK_TX_PACKETS,
28 RTNL_LINK_RX_BYTES,
29 RTNL_LINK_TX_BYTES,
30 RTNL_LINK_RX_ERRORS,
31 RTNL_LINK_TX_ERRORS,
32 RTNL_LINK_RX_DROPPED,
33 RTNL_LINK_TX_DROPPED,
34 RTNL_LINK_RX_COMPRESSED,
35 RTNL_LINK_TX_COMPRESSED,
36 RTNL_LINK_RX_FIFO_ERR,
37 RTNL_LINK_TX_FIFO_ERR,
38 RTNL_LINK_RX_LEN_ERR,
39 RTNL_LINK_RX_OVER_ERR,
40 RTNL_LINK_RX_CRC_ERR,
41 RTNL_LINK_RX_FRAME_ERR,
42 RTNL_LINK_RX_MISSED_ERR,
43 RTNL_LINK_TX_ABORT_ERR,
44 RTNL_LINK_TX_CARRIER_ERR,
45 RTNL_LINK_TX_HBEAT_ERR,
46 RTNL_LINK_TX_WIN_ERR,
47 RTNL_LINK_TX_COLLISIONS,
48 RTNL_LINK_MULTICAST,
49 __RTNL_LINK_STATS_MAX,
50};
51
52#define RTNL_LINK_STATS_MAX (__RTNL_LINK_STATS_MAX - 1)
53
54/**
55 * Special interface index stating the link was not found.
56 * @ingroup link
57 */
58#define RTNL_LINK_NOT_FOUND -1
59
60/* link object allocation/freeage */
61extern struct rtnl_link * rtnl_link_alloc(void);
62extern void rtnl_link_put(struct rtnl_link *);
63extern void rtnl_link_free(struct rtnl_link *);
64
65/* link cache management */
66extern struct nl_cache * rtnl_link_alloc_cache(struct nl_handle *);
67extern struct rtnl_link * rtnl_link_get(struct nl_cache *, int);
68extern struct rtnl_link * rtnl_link_get_by_name(struct nl_cache *,
69 const char *);
70
71
72/* Link Modifications */
73extern struct nl_msg * rtnl_link_build_change_request(struct rtnl_link *,
74 struct rtnl_link *,
75 int);
76extern int rtnl_link_change(struct nl_handle *,
77 struct rtnl_link *,
78 struct rtnl_link *, int);
79
80/* Name <-> Index Translations */
81extern char * rtnl_link_i2name(struct nl_cache *, int,
82 char *, size_t);
83extern int rtnl_link_name2i(struct nl_cache *,
84 const char *);
85
86/* Name <-> Statistic Translations */
87extern char * rtnl_link_stat2str(int, char *, size_t);
88extern int rtnl_link_str2stat(const char *);
89
90/* Link Flags Translations */
91extern char * rtnl_link_flags2str(int, char *, size_t);
92extern int rtnl_link_str2flags(const char *);
93
94extern char * rtnl_link_operstate2str(int, char *, size_t);
95extern int rtnl_link_str2operstate(const char *);
96
97extern char * rtnl_link_mode2str(int, char *, size_t);
98extern int rtnl_link_str2mode(const char *);
99
100/* Access Functions */
101extern void rtnl_link_set_qdisc(struct rtnl_link *,
102 const char *);
103extern char * rtnl_link_get_qdisc(struct rtnl_link *);
104
105extern void rtnl_link_set_name(struct rtnl_link *,
106 const char *);
107extern char * rtnl_link_get_name(struct rtnl_link *);
108
109extern void rtnl_link_set_flags(struct rtnl_link *,
110 unsigned int);
111extern void rtnl_link_unset_flags(struct rtnl_link *,
112 unsigned int);
113extern unsigned int rtnl_link_get_flags(struct rtnl_link *);
114
115extern void rtnl_link_set_mtu(struct rtnl_link *,
116 unsigned int);
117extern unsigned int rtnl_link_get_mtu(struct rtnl_link *);
118
119extern void rtnl_link_set_txqlen(struct rtnl_link *,
120 unsigned int);
121extern unsigned int rtnl_link_get_txqlen(struct rtnl_link *);
122
123extern void rtnl_link_set_weight(struct rtnl_link *,
124 unsigned int);
125extern unsigned int rtnl_link_get_weight(struct rtnl_link *);
126
127extern void rtnl_link_set_ifindex(struct rtnl_link *, int);
128extern int rtnl_link_get_ifindex(struct rtnl_link *);
129
130extern void rtnl_link_set_family(struct rtnl_link *, int);
131extern int rtnl_link_get_family(struct rtnl_link *);
132
133extern void rtnl_link_set_arptype(struct rtnl_link *,
134 unsigned int);
135extern unsigned int rtnl_link_get_arptype(struct rtnl_link *);
136
137extern void rtnl_link_set_addr(struct rtnl_link *,
138 struct nl_addr *);
139extern struct nl_addr * rtnl_link_get_addr(struct rtnl_link *);
140
141extern void rtnl_link_set_broadcast(struct rtnl_link *,
142 struct nl_addr *);
143extern struct nl_addr * rtnl_link_get_broadcast(struct rtnl_link *);
144
145extern void rtnl_link_set_link(struct rtnl_link *, int);
146extern int rtnl_link_get_link(struct rtnl_link *);
147
148extern void rtnl_link_set_master(struct rtnl_link *, int);
149extern int rtnl_link_get_master(struct rtnl_link *);
150
151extern void rtnl_link_set_operstate(struct rtnl_link *,
152 uint8_t);
153extern uint8_t rtnl_link_get_operstate(struct rtnl_link *);
154
155extern void rtnl_link_set_linkmode(struct rtnl_link *,
156 uint8_t);
157extern uint8_t rtnl_link_get_linkmode(struct rtnl_link *);
158
159extern uint64_t rtnl_link_get_stat(struct rtnl_link *, int);
160
161extern int rtnl_link_set_info_type(struct rtnl_link *,
162 const char *);
163extern char * rtnl_link_get_info_type(struct rtnl_link *);
164
165#ifdef __cplusplus
166}
167#endif
168
169#endif
rtnl_link_get_by_name
struct rtnl_link * rtnl_link_get_by_name(struct nl_cache *, const char *)
Look up link by link name in the provided cache.
Definition: link.c:922
rtnl_link_name2i
int rtnl_link_name2i(struct nl_cache *, const char *)
Translate a link name to the corresponding interface index.
Definition: link.c:1106
rtnl_link_build_change_request
struct nl_msg * rtnl_link_build_change_request(struct rtnl_link *, struct rtnl_link *, int)
Builds a netlink change request message to change link attributes.
Definition: link.c:965
rtnl_link_get
struct rtnl_link * rtnl_link_get(struct nl_cache *, int)
Look up link by interface index in the provided cache.
Definition: link.c:895
rtnl_link_change
int rtnl_link_change(struct nl_handle *, struct rtnl_link *, struct rtnl_link *, int)
Change link attributes.
Definition: link.c:1048
rtnl_link_get_info_type
char * rtnl_link_get_info_type(struct rtnl_link *)
Return info type of a link.
Definition: link.c:1527
rtnl_link_i2name
char * rtnl_link_i2name(struct nl_cache *, int, char *, size_t)
Translate an interface index to the corresponding link name.
Definition: link.c:1085
rtnl_link_set_info_type
int rtnl_link_set_info_type(struct rtnl_link *, const char *)
Specify the info type of a link.
Definition: link.c:1501
rtnl_link_alloc_cache
struct nl_cache * rtnl_link_alloc_cache(struct nl_handle *)
Allocate link cache and fill in all configured links.
Definition: link.c:869
Generated by doxygen 1.9.6