/* * netlink/utils.h Utility Functions * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation version 2.1 * of the License. * * Copyright (c) 2003-2012 Thomas Graf */ #ifndef NETLINK_UTILS_H_ #define NETLINK_UTILS_H_ #include #include #ifdef __cplusplus extern "C" { #endif /** * @name Probability Constants * @{ */ /** * Lower probability limit * @ingroup utils */ #define NL_PROB_MIN 0x0 /** * Upper probability limit nl_dump_type * @ingroup utils */ #define NL_PROB_MAX 0xffffffff /** @} */ enum { NL_BYTE_RATE, NL_BIT_RATE, }; /* unit pretty-printing */ extern double nl_cancel_down_bytes(unsigned long long, char **); extern double nl_cancel_down_bits(unsigned long long, char **); extern int nl_rate2str(unsigned long long, int, char *, size_t); extern double nl_cancel_down_us(uint32_t, char **); /* generic unit translations */ extern long nl_size2int(const char *); extern char * nl_size2str(const size_t, char *, const size_t); extern long nl_prob2int(const char *); /* time translations */ extern int nl_get_user_hz(void); extern int nl_get_psched_hz(void); extern uint32_t nl_us2ticks(uint32_t); extern uint32_t nl_ticks2us(uint32_t); extern int nl_str2msec(const char *, uint64_t *); extern char * nl_msec2str(uint64_t, char *, size_t); /* link layer protocol translations */ extern char * nl_llproto2str(int, char *, size_t); extern int nl_str2llproto(const char *); /* ethernet protocol translations */ extern char * nl_ether_proto2str(int, char *, size_t); extern int nl_str2ether_proto(const char *); /* IP protocol translations */ extern char * nl_ip_proto2str(int, char *, size_t); extern int nl_str2ip_proto(const char *); /* Dumping helpers */ extern void nl_new_line(struct nl_dump_params *); extern void nl_dump(struct nl_dump_params *, const char *, ...); extern void nl_dump_line(struct nl_dump_params *, const char *, ...); enum { NL_CAPABILITY_NONE, /** * rtnl_route_build_msg() no longer guesses the route scope * if explicitly set to RT_SCOPE_NOWHERE. * @ingroup utils */ NL_CAPABILITY_ROUTE_BUILD_MSG_SET_SCOPE = 1, #define NL_CAPABILITY_ROUTE_BUILD_MSG_SET_SCOPE NL_CAPABILITY_ROUTE_BUILD_MSG_SET_SCOPE /** * rtnl_link_veth_get_peer() now returns a reference that is owned by the * caller and must be released by the caller with rtnl_link_put(). */ NL_CAPABILITY_ROUTE_LINK_VETH_GET_PEER_OWN_REFERENCE = 2, #define NL_CAPABILITY_ROUTE_LINK_VETH_GET_PEER_OWN_REFERENCE NL_CAPABILITY_ROUTE_LINK_VETH_GET_PEER_OWN_REFERENCE /** * rtnl_u32_add_action() and rtnl_basic_add_action() now grab a reference to act * caller are free to release its own */ NL_CAPABILITY_ROUTE_LINK_CLS_ADD_ACT_OWN_REFERENCE = 3, #define NL_CAPABILITY_ROUTE_LINK_CLS_ADD_ACT_OWN_REFERENCE NL_CAPABILITY_ROUTE_LINK_CLS_ADD_ACT_OWN_REFERENCE /** * Indicate that the local port is unspecified until the user accesses * it (via nl_socket_get_local_port()) or until nl_connect(). More importantly, * if the port is left unspecified, nl_connect() will retry generating another * port when bind() fails with ADDRINUSE. */ NL_CAPABILITY_NL_CONNECT_RETRY_GENERATE_PORT_ON_ADDRINUSE = 4, #define NL_CAPABILITY_NL_CONNECT_RETRY_GENERATE_PORT_ON_ADDRINUSE NL_CAPABILITY_NL_CONNECT_RETRY_GENERATE_PORT_ON_ADDRINUSE /** * Indicate that rtnl_link_get_kernel() fails with -NLE_OPNOTSUPP in case * of older kernals not supporting lookup by ifname. This changes behavior * from returning -NLE_INVAL to return -NLE_OPNOTSUPP. */ NL_CAPABILITY_ROUTE_LINK_GET_KERNEL_FAIL_OPNOTSUPP = 5, #define NL_CAPABILITY_ROUTE_LINK_GET_KERNEL_FAIL_OPNOTSUPP NL_CAPABILITY_ROUTE_LINK_GET_KERNEL_FAIL_OPNOTSUPP /** * Also consider the a_cacheinfo field (ADDR_ATTR_CACHEINFO) that contains the * address timestamps and expiry when comparing struct rtnl_addr objects with * nl_object_diff(). */ NL_CAPABILITY_ROUTE_ADDR_COMPARE_CACHEINFO = 6, #define NL_CAPABILITY_ROUTE_ADDR_COMPARE_CACHEINFO NL_CAPABILITY_ROUTE_ADDR_COMPARE_CACHEINFO /** * The library version is libnl3 3.2.26 or newer. This capability should never be backported. */ NL_CAPABILITY_VERSION_3_2_26 = 7, #define NL_CAPABILITY_VERSION_3_2_26 NL_CAPABILITY_VERSION_3_2_26 /** * nl_recv() fails with NLE_MSG_TRUNC if a message got truncated * with NL_MSG_PEEK disabled. Previously, the failed message was wrongly * discarded and the next message received. */ NL_CAPABILITY_NL_RECV_FAIL_TRUNC_NO_PEEK = 8, #define NL_CAPABILITY_NL_RECV_FAIL_TRUNC_NO_PEEK NL_CAPABILITY_NL_RECV_FAIL_TRUNC_NO_PEEK /** * rtnl_link_build_change_request() and rtnl_link_change() would set ifi.ifi_flags but leave * ifi.ifi_change at zero. This was later fixed to set ifi.ifi_change to the flags that are actually * set in changes. */ NL_CAPABILITY_LINK_BUILD_CHANGE_REQUEST_SET_CHANGE = 9, #define NL_CAPABILITY_LINK_BUILD_CHANGE_REQUEST_SET_CHANGE NL_CAPABILITY_LINK_BUILD_CHANGE_REQUEST_SET_CHANGE /** * Between 3.2.14 (64fcb47a36ec12d7e7f00605f6a8952ce985dd08) and 3.2.22 (8571f58f23763d8db7365d02c9b27832ad3d7005), * rtnl_neigh_get() behaved differently and only returned objects with family AF_UNSPEC. * This capability indicates, that the function was fixed. The absense of the capability, * doesn't indicate however which behavior the function will have. So beware. */ NL_CAPABILITY_RTNL_NEIGH_GET_FILTER_AF_UNSPEC_FIX = 10, #define NL_CAPABILITY_RTNL_NEIGH_GET_FILTER_AF_UNSPEC_FIX NL_CAPABILITY_RTNL_NEIGH_GET_FILTER_AF_UNSPEC_FIX /** * The library version is libnl3 3.2.27 or newer. This capability should never be backported. */ NL_CAPABILITY_VERSION_3_2_27 = 11, #define NL_CAPABILITY_VERSION_3_2_27 NL_CAPABILITY_VERSION_3_2_27 __NL_CAPABILITY_MAX, NL_CAPABILITY_MAX = (__NL_CAPABILITY_MAX - 1), #define NL_CAPABILITY_MAX NL_CAPABILITY_MAX /** * The range 0x7000 to 0x7FFF is reserved for private capabilities. Upstream libnl3 will * not register capabilities in this range. However, instead of adding private capabilities, * better register their number with upstream libnl3. */ #define NL_CAPABILITY_IS_USER_RESERVED(cap) ( ((cap) & ~0x0FFF) == 0x7000 ) }; int nl_has_capability (int capability); #ifdef __cplusplus } #endif #endif