link.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259
  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-2012 Thomas Graf <tgraf@suug.ch>
  10. */
  11. #ifndef NETLINK_LINK_H_
  12. #define NETLINK_LINK_H_
  13. #include <netlink/netlink.h>
  14. #include <netlink/cache.h>
  15. #include <netlink/addr.h>
  16. #include <sys/types.h>
  17. #ifdef __cplusplus
  18. extern "C" {
  19. #endif
  20. /**
  21. * @struct rtnl_link link.h "netlink/route/link.h"
  22. * @brief Link object
  23. * @implements nl_object
  24. * @ingroup link
  25. *
  26. * @copydoc private_struct
  27. */
  28. struct rtnl_link;
  29. /**
  30. * @ingroup link
  31. */
  32. typedef enum {
  33. RTNL_LINK_RX_PACKETS, /*!< Packets received */
  34. RTNL_LINK_TX_PACKETS, /*!< Packets sent */
  35. RTNL_LINK_RX_BYTES, /*!< Bytes received */
  36. RTNL_LINK_TX_BYTES, /*!< Bytes sent */
  37. RTNL_LINK_RX_ERRORS, /*!< Receive errors */
  38. RTNL_LINK_TX_ERRORS, /*!< Send errors */
  39. RTNL_LINK_RX_DROPPED, /*!< Received packets dropped */
  40. RTNL_LINK_TX_DROPPED, /*!< Packets dropped during transmit */
  41. RTNL_LINK_RX_COMPRESSED, /*!< Compressed packets received */
  42. RTNL_LINK_TX_COMPRESSED, /*!< Compressed packets sent */
  43. RTNL_LINK_RX_FIFO_ERR, /*!< Receive FIFO errors */
  44. RTNL_LINK_TX_FIFO_ERR, /*!< Send FIFO errors */
  45. RTNL_LINK_RX_LEN_ERR, /*!< Length errors */
  46. RTNL_LINK_RX_OVER_ERR, /*!< Over errors */
  47. RTNL_LINK_RX_CRC_ERR, /*!< CRC errors */
  48. RTNL_LINK_RX_FRAME_ERR, /*!< Frame errors */
  49. RTNL_LINK_RX_MISSED_ERR, /*!< Missed errors */
  50. RTNL_LINK_TX_ABORT_ERR, /*!< Aborted errors */
  51. RTNL_LINK_TX_CARRIER_ERR, /*!< Carrier errors */
  52. RTNL_LINK_TX_HBEAT_ERR, /*!< Heartbeat errors */
  53. RTNL_LINK_TX_WIN_ERR, /*!< Window errors */
  54. RTNL_LINK_COLLISIONS, /*!< Send collisions */
  55. RTNL_LINK_MULTICAST, /*!< Multicast */
  56. RTNL_LINK_IP6_INPKTS, /*!< IPv6 SNMP InReceives */
  57. RTNL_LINK_IP6_INHDRERRORS, /*!< IPv6 SNMP InHdrErrors */
  58. RTNL_LINK_IP6_INTOOBIGERRORS, /*!< IPv6 SNMP InTooBigErrors */
  59. RTNL_LINK_IP6_INNOROUTES, /*!< IPv6 SNMP InNoRoutes */
  60. RTNL_LINK_IP6_INADDRERRORS, /*!< IPv6 SNMP InAddrErrors */
  61. RTNL_LINK_IP6_INUNKNOWNPROTOS, /*!< IPv6 SNMP InUnknownProtos */
  62. RTNL_LINK_IP6_INTRUNCATEDPKTS, /*!< IPv6 SNMP InTruncatedPkts */
  63. RTNL_LINK_IP6_INDISCARDS, /*!< IPv6 SNMP InDiscards */
  64. RTNL_LINK_IP6_INDELIVERS, /*!< IPv6 SNMP InDelivers */
  65. RTNL_LINK_IP6_OUTFORWDATAGRAMS, /*!< IPv6 SNMP OutForwDatagrams */
  66. RTNL_LINK_IP6_OUTPKTS, /*!< IPv6 SNMP OutRequests */
  67. RTNL_LINK_IP6_OUTDISCARDS, /*!< IPv6 SNMP OutDiscards */
  68. RTNL_LINK_IP6_OUTNOROUTES, /*!< IPv6 SNMP OutNoRoutes */
  69. RTNL_LINK_IP6_REASMTIMEOUT, /*!< IPv6 SNMP ReasmTimeout */
  70. RTNL_LINK_IP6_REASMREQDS, /*!< IPv6 SNMP ReasmReqds */
  71. RTNL_LINK_IP6_REASMOKS, /*!< IPv6 SNMP ReasmOKs */
  72. RTNL_LINK_IP6_REASMFAILS, /*!< IPv6 SNMP ReasmFails */
  73. RTNL_LINK_IP6_FRAGOKS, /*!< IPv6 SNMP FragOKs */
  74. RTNL_LINK_IP6_FRAGFAILS, /*!< IPv6 SNMP FragFails */
  75. RTNL_LINK_IP6_FRAGCREATES, /*!< IPv6 SNMP FragCreates */
  76. RTNL_LINK_IP6_INMCASTPKTS, /*!< IPv6 SNMP InMcastPkts */
  77. RTNL_LINK_IP6_OUTMCASTPKTS, /*!< IPv6 SNMP OutMcastPkts */
  78. RTNL_LINK_IP6_INBCASTPKTS, /*!< IPv6 SNMP InBcastPkts */
  79. RTNL_LINK_IP6_OUTBCASTPKTS, /*!< IPv6 SNMP OutBcastPkts */
  80. RTNL_LINK_IP6_INOCTETS, /*!< IPv6 SNMP InOctets */
  81. RTNL_LINK_IP6_OUTOCTETS, /*!< IPv6 SNMP OutOctets */
  82. RTNL_LINK_IP6_INMCASTOCTETS, /*!< IPv6 SNMP InMcastOctets */
  83. RTNL_LINK_IP6_OUTMCASTOCTETS, /*!< IPv6 SNMP OutMcastOctets */
  84. RTNL_LINK_IP6_INBCASTOCTETS, /*!< IPv6 SNMP InBcastOctets */
  85. RTNL_LINK_IP6_OUTBCASTOCTETS, /*!< IPv6 SNMP OutBcastOctets */
  86. RTNL_LINK_ICMP6_INMSGS, /*!< ICMPv6 SNMP InMsgs */
  87. RTNL_LINK_ICMP6_INERRORS, /*!< ICMPv6 SNMP InErrors */
  88. RTNL_LINK_ICMP6_OUTMSGS, /*!< ICMPv6 SNMP OutMsgs */
  89. RTNL_LINK_ICMP6_OUTERRORS, /*!< ICMPv6 SNMP OutErrors */
  90. RTNL_LINK_ICMP6_CSUMERRORS, /*!< ICMPv6 SNMP InCsumErrors */
  91. RTNL_LINK_IP6_CSUMERRORS, /*!< IPv6 SNMP InCsumErrors */
  92. RTNL_LINK_IP6_NOECTPKTS, /*!< IPv6 SNMP InNoECTPkts */
  93. RTNL_LINK_IP6_ECT1PKTS, /*!< IPv6 SNMP InECT1Pkts */
  94. RTNL_LINK_IP6_ECT0PKTS, /*!< IPv6 SNMP InECT0Pkts */
  95. RTNL_LINK_IP6_CEPKTS, /*!< IPv6 SNMP InCEPkts */
  96. __RTNL_LINK_STATS_MAX,
  97. } rtnl_link_stat_id_t;
  98. #define RTNL_LINK_STATS_MAX (__RTNL_LINK_STATS_MAX - 1)
  99. extern struct nla_policy rtln_link_policy[];
  100. extern struct rtnl_link *rtnl_link_alloc(void);
  101. extern void rtnl_link_put(struct rtnl_link *);
  102. extern int rtnl_link_alloc_cache(struct nl_sock *, int, struct nl_cache **);
  103. extern int rtnl_link_alloc_cache_flags(struct nl_sock *, int,
  104. struct nl_cache **,
  105. unsigned int flags);
  106. extern struct rtnl_link *rtnl_link_get(struct nl_cache *, int);
  107. extern struct rtnl_link *rtnl_link_get_by_name(struct nl_cache *, const char *);
  108. extern int rtnl_link_build_add_request(struct rtnl_link *, int,
  109. struct nl_msg **);
  110. extern int rtnl_link_add(struct nl_sock *, struct rtnl_link *, int);
  111. extern int rtnl_link_build_change_request(struct rtnl_link *,
  112. struct rtnl_link *, int,
  113. struct nl_msg **);
  114. extern int rtnl_link_change(struct nl_sock *, struct rtnl_link *,
  115. struct rtnl_link *, int);
  116. extern int rtnl_link_build_delete_request(const struct rtnl_link *,
  117. struct nl_msg **);
  118. extern int rtnl_link_delete(struct nl_sock *, const struct rtnl_link *);
  119. extern int rtnl_link_build_get_request(int, const char *,
  120. struct nl_msg **);
  121. extern int rtnl_link_get_kernel(struct nl_sock *, int, const char *,
  122. struct rtnl_link **);
  123. /* Name <-> Index Translations */
  124. extern char * rtnl_link_i2name(struct nl_cache *, int, char *, size_t);
  125. extern int rtnl_link_name2i(struct nl_cache *, const char *);
  126. /* Name <-> Statistic Translations */
  127. extern char * rtnl_link_stat2str(int, char *, size_t);
  128. extern int rtnl_link_str2stat(const char *);
  129. /* Link Flags Translations */
  130. extern char * rtnl_link_flags2str(int, char *, size_t);
  131. extern int rtnl_link_str2flags(const char *);
  132. extern char * rtnl_link_operstate2str(uint8_t, char *, size_t);
  133. extern int rtnl_link_str2operstate(const char *);
  134. extern char * rtnl_link_mode2str(uint8_t, char *, size_t);
  135. extern int rtnl_link_str2mode(const char *);
  136. /* Carrier State Translations */
  137. extern char * rtnl_link_carrier2str(uint8_t, char *, size_t);
  138. extern int rtnl_link_str2carrier(const char *);
  139. /* Access Functions */
  140. extern void rtnl_link_set_qdisc(struct rtnl_link *, const char *);
  141. extern char * rtnl_link_get_qdisc(struct rtnl_link *);
  142. extern void rtnl_link_set_name(struct rtnl_link *, const char *);
  143. extern char * rtnl_link_get_name(struct rtnl_link *);
  144. extern void rtnl_link_set_group(struct rtnl_link *, uint32_t);
  145. extern uint32_t rtnl_link_get_group(struct rtnl_link *);
  146. extern void rtnl_link_set_flags(struct rtnl_link *, unsigned int);
  147. extern void rtnl_link_unset_flags(struct rtnl_link *, unsigned int);
  148. extern unsigned int rtnl_link_get_flags(struct rtnl_link *);
  149. extern void rtnl_link_set_mtu(struct rtnl_link *, unsigned int);
  150. extern unsigned int rtnl_link_get_mtu(struct rtnl_link *);
  151. extern void rtnl_link_set_txqlen(struct rtnl_link *, unsigned int);
  152. extern unsigned int rtnl_link_get_txqlen(struct rtnl_link *);
  153. extern void rtnl_link_set_ifindex(struct rtnl_link *, int);
  154. extern int rtnl_link_get_ifindex(struct rtnl_link *);
  155. extern void rtnl_link_set_family(struct rtnl_link *, int);
  156. extern int rtnl_link_get_family(struct rtnl_link *);
  157. extern void rtnl_link_set_arptype(struct rtnl_link *, unsigned int);
  158. extern unsigned int rtnl_link_get_arptype(struct rtnl_link *);
  159. extern void rtnl_link_set_addr(struct rtnl_link *, struct nl_addr *);
  160. extern struct nl_addr *rtnl_link_get_addr(struct rtnl_link *);
  161. extern void rtnl_link_set_broadcast(struct rtnl_link *, struct nl_addr *);
  162. extern struct nl_addr *rtnl_link_get_broadcast(struct rtnl_link *);
  163. extern void rtnl_link_set_link(struct rtnl_link *, int);
  164. extern int rtnl_link_get_link(struct rtnl_link *);
  165. extern void rtnl_link_set_master(struct rtnl_link *, int);
  166. extern int rtnl_link_get_master(struct rtnl_link *);
  167. extern void rtnl_link_set_carrier(struct rtnl_link *, uint8_t);
  168. extern uint8_t rtnl_link_get_carrier(struct rtnl_link *);
  169. extern void rtnl_link_set_operstate(struct rtnl_link *, uint8_t);
  170. extern uint8_t rtnl_link_get_operstate(struct rtnl_link *);
  171. extern void rtnl_link_set_linkmode(struct rtnl_link *, uint8_t);
  172. extern uint8_t rtnl_link_get_linkmode(struct rtnl_link *);
  173. int rtnl_link_set_link_netnsid(struct rtnl_link *link, int32_t link_netnsid);
  174. int rtnl_link_get_link_netnsid(const struct rtnl_link *link, int32_t *out_link_netnsid);
  175. extern const char * rtnl_link_get_ifalias(struct rtnl_link *);
  176. extern void rtnl_link_set_ifalias(struct rtnl_link *, const char *);
  177. extern int rtnl_link_get_num_vf(struct rtnl_link *, uint32_t *);
  178. extern uint64_t rtnl_link_get_stat(struct rtnl_link *, rtnl_link_stat_id_t);
  179. extern int rtnl_link_set_stat(struct rtnl_link *, rtnl_link_stat_id_t,
  180. const uint64_t);
  181. extern int rtnl_link_set_type(struct rtnl_link *, const char *);
  182. extern char * rtnl_link_get_type(struct rtnl_link *);
  183. extern void rtnl_link_set_promiscuity(struct rtnl_link *, uint32_t);
  184. extern uint32_t rtnl_link_get_promiscuity(struct rtnl_link *);
  185. extern void rtnl_link_set_num_tx_queues(struct rtnl_link *, uint32_t);
  186. extern uint32_t rtnl_link_get_num_tx_queues(struct rtnl_link *);
  187. extern void rtnl_link_set_num_rx_queues(struct rtnl_link *, uint32_t);
  188. extern uint32_t rtnl_link_get_num_rx_queues(struct rtnl_link *);
  189. extern struct nl_data * rtnl_link_get_phys_port_id(struct rtnl_link *);
  190. extern void rtnl_link_set_ns_fd(struct rtnl_link *, int);
  191. extern int rtnl_link_get_ns_fd(struct rtnl_link *);
  192. extern void rtnl_link_set_ns_pid(struct rtnl_link *, pid_t);
  193. extern pid_t rtnl_link_get_ns_pid(struct rtnl_link *);
  194. extern int rtnl_link_enslave_ifindex(struct nl_sock *, int, int);
  195. extern int rtnl_link_enslave(struct nl_sock *, struct rtnl_link *,
  196. struct rtnl_link *);
  197. extern int rtnl_link_release_ifindex(struct nl_sock *, int);
  198. extern int rtnl_link_release(struct nl_sock *, struct rtnl_link *);
  199. extern int rtnl_link_fill_info(struct nl_msg *, struct rtnl_link *);
  200. extern int rtnl_link_info_parse(struct rtnl_link *, struct nlattr **);
  201. /* deprecated */
  202. extern int rtnl_link_set_info_type(struct rtnl_link *, const char *) __attribute__((deprecated));
  203. extern char * rtnl_link_get_info_type(struct rtnl_link *) __attribute__((deprecated));
  204. extern void rtnl_link_set_weight(struct rtnl_link *, unsigned int) __attribute__((deprecated));
  205. extern unsigned int rtnl_link_get_weight(struct rtnl_link *) __attribute__((deprecated));
  206. #ifdef __cplusplus
  207. }
  208. #endif
  209. #endif