Collection of helper functions. More...
Data Structures | |
| struct | nl_dump_params |
| Dumping parameters. More... | |
Enumerations | |
| enum | nl_dump_type { NL_DUMP_LINE , NL_DUMP_DETAILS , NL_DUMP_STATS , __NL_DUMP_MAX } |
| Enumeration of dumping variations (dp_type) More... | |
Variables | |
| int | nl_debug = 0 |
| Global variable indicating the desired level of debugging output. More... | |
Generic Unit Translations | |
| long | nl_size2int (const char *str) |
| Convert a character string to a size. More... | |
| char * | nl_size2str (const size_t size, char *buf, const size_t len) |
| Convert a size toa character string. More... | |
| long | nl_prob2int (const char *str) |
| Convert a character string to a probability. More... | |
Time Translations | |
| int | nl_get_user_hz (void) |
| Return the value of HZ. More... | |
| int | nl_get_psched_hz (void) |
| Return the value of packet scheduler HZ. More... | |
| uint32_t | nl_us2ticks (uint32_t us) |
| Convert micro seconds to ticks. More... | |
| uint32_t | nl_ticks2us (uint32_t ticks) |
| Convert ticks to micro seconds. More... | |
| int | nl_str2msec (const char *str, uint64_t *result) |
| char * | nl_msec2str (uint64_t msec, char *buf, size_t len) |
| Convert milliseconds to a character string. More... | |
| #define | USER_HZ 100 |
Netlink Family Translations | |
| char * | nl_nlfamily2str (int family, char *buf, size_t size) |
| int | nl_str2nlfamily (const char *name) |
Link Layer Protocol Translations | |
| char * | nl_llproto2str (int llproto, char *buf, size_t len) |
| int | nl_str2llproto (const char *name) |
Ethernet Protocol Translations | |
| char * | nl_ether_proto2str (int eproto, char *buf, size_t len) |
| int | nl_str2ether_proto (const char *name) |
Run-time version information | |
| const int | nl_ver_num = LIBNL_VER_NUM |
| const int | nl_ver_maj = LIBNL_VER_MAJ |
| const int | nl_ver_min = LIBNL_VER_MIN |
| const int | nl_ver_mic = LIBNL_VER_MIC |
Pretty Printing of Numbers | |
| double | nl_cancel_down_bytes (unsigned long long l, char **unit) |
| Cancel down a byte counter. More... | |
| double | nl_cancel_down_bits (unsigned long long l, char **unit) |
| Cancel down a bit counter. More... | |
| int | nl_rate2str (unsigned long long rate, int type, char *buf, size_t len) |
| double | nl_cancel_down_us (uint32_t l, char **unit) |
| Cancel down a micro second value. More... | |
IP Protocol Translations | |
| char * | nl_ip_proto2str (int proto, char *buf, size_t len) |
| int | nl_str2ip_proto (const char *name) |
Dumping Helpers | |
| void | nl_new_line (struct nl_dump_params *params) |
| Handle a new line while dumping. More... | |
| void | nl_dump (struct nl_dump_params *params, const char *fmt,...) |
| Dump a formatted character string. More... | |
| void | nl_dump_line (struct nl_dump_params *parms, const char *fmt,...) |
Probability Constants | |
| #define | NL_PROB_MIN 0x0 |
| Lower probability limit. More... | |
| #define | NL_PROB_MAX 0xffffffff |
| Upper probability limit nl_dump_type. More... | |
Detailed Description
Collection of helper functions.
Run-time version information.
Header
Macro Definition Documentation
◆ USER_HZ
◆ NL_PROB_MIN
◆ NL_PROB_MAX
| #define NL_PROB_MAX 0xffffffff |
Enumeration Type Documentation
◆ nl_dump_type
| enum nl_dump_type |
Function Documentation
◆ nl_cancel_down_bytes()
| double nl_cancel_down_bytes | ( | unsigned long long | l, |
| char ** | unit | ||
| ) |
Cancel down a byte counter.
- Parameters
-
l byte counter unit destination unit pointer
Cancels down a byte counter until it reaches a reasonable unit. The chosen unit is assigned to unit. This function assume 1024 bytes in one kilobyte
- Returns
- The cancelled down byte counter in the new unit.
◆ nl_cancel_down_bits()
| double nl_cancel_down_bits | ( | unsigned long long | l, |
| char ** | unit | ||
| ) |
Cancel down a bit counter.
- Parameters
-
l bit counter unit destination unit pointer
Cancels down bit counter until it reaches a reasonable unit. The chosen unit is assigned to unit. This function assume 1000 bits in one kilobit
- Returns
- The cancelled down bit counter in the new unit.
◆ nl_rate2str()
| int nl_rate2str | ( | unsigned long long | rate, |
| int | type, | ||
| char * | buf, | ||
| size_t | len | ||
| ) |
◆ nl_cancel_down_us()
| double nl_cancel_down_us | ( | uint32_t | l, |
| char ** | unit | ||
| ) |
◆ nl_size2int()
| long nl_size2int | ( | const char * | str | ) |
Convert a character string to a size.
- Parameters
-
str size encoded as character string
Converts the specified size as character to the corresponding number of bytes.
Supported formats are:
- b,kb/k,m/mb,gb/g for bytes
- bit,kbit/mbit/gbit
This function assume 1000 bits in one kilobit and 1024 bytes in one kilobyte
- Returns
- The number of bytes or -1 if the string is unparseable
◆ nl_size2str()
| char * nl_size2str | ( | const size_t | size, |
| char * | buf, | ||
| const size_t | len | ||
| ) |
Convert a size toa character string.
- Parameters
-
size Size in number of bytes buf Buffer to write character string to len Size of buf
This function converts a value in bytes to a human readable representation of it. The function uses IEC prefixes:
The highest prefix is used which ensures a result of >= 1.0, the result is provided as floating point number with a maximum precision of 2 digits:
- Returns
- pointer to buf
◆ nl_prob2int()
| long nl_prob2int | ( | const char * | str | ) |
Convert a character string to a probability.
- Parameters
-
str probability encoded as character string
Converts the specified probability as character to the corresponding probability number.
Supported formats are:
- 0.0-1.0
- 0%-100%
- Returns
- The probability relative to NL_PROB_MIN and NL_PROB_MAX
Definition at line 385 of file utils.c.
References NL_PROB_MAX.
◆ nl_get_user_hz()
◆ nl_get_psched_hz()
| int nl_get_psched_hz | ( | void | ) |
◆ nl_us2ticks()
| uint32_t nl_us2ticks | ( | uint32_t | us | ) |
Convert micro seconds to ticks.
- Parameters
-
us micro seconds
- Returns
- number of ticks
Definition at line 522 of file utils.c.
Referenced by rtnl_netem_set_delay(), rtnl_netem_set_jitter(), rtnl_qdisc_tbf_set_peakrate(), rtnl_qdisc_tbf_set_rate(), and rtnl_tc_build_rate_table().
Here is the caller graph for this function:
◆ nl_ticks2us()
| uint32_t nl_ticks2us | ( | uint32_t | ticks | ) |
Convert ticks to micro seconds.
- Parameters
-
ticks number of ticks
- Returns
- microseconds
Definition at line 534 of file utils.c.
Referenced by rtnl_netem_get_delay(), and rtnl_netem_get_jitter().
Here is the caller graph for this function:
◆ nl_str2msec()
◆ nl_msec2str()
| char * nl_msec2str | ( | uint64_t | msec, |
| char * | buf, | ||
| size_t | len | ||
| ) |
Convert milliseconds to a character string.
- Parameters
-
msec number of milliseconds buf destination buffer len buffer length
Converts milliseconds to a character string split up in days, hours, minutes, seconds, and milliseconds and stores it in the specified destination buffer.
- Returns
- The destination buffer.
◆ nl_nlfamily2str()
| char * nl_nlfamily2str | ( | int | family, |
| char * | buf, | ||
| size_t | size | ||
| ) |
◆ nl_str2nlfamily()
◆ nl_llproto2str()
| char * nl_llproto2str | ( | int | llproto, |
| char * | buf, | ||
| size_t | len | ||
| ) |
◆ nl_str2llproto()
◆ nl_ether_proto2str()
| char * nl_ether_proto2str | ( | int | eproto, |
| char * | buf, | ||
| size_t | len | ||
| ) |
◆ nl_str2ether_proto()
◆ nl_ip_proto2str()
| char * nl_ip_proto2str | ( | int | proto, |
| char * | buf, | ||
| size_t | len | ||
| ) |
◆ nl_str2ip_proto()
◆ nl_new_line()
| void nl_new_line | ( | struct nl_dump_params * | params | ) |
Handle a new line while dumping.
- Parameters
-
params Dumping parameters
This function must be called before dumping any onto a new line. It will ensure proper prefixing as specified by the dumping parameters.
- Note
- This function will NOT dump any newlines itself
Definition at line 906 of file utils.c.
References nl_dump_params::dp_buf, nl_dump_params::dp_buflen, nl_dump_params::dp_fd, nl_dump_params::dp_nl_cb, and nl_dump_params::dp_prefix.
◆ nl_dump()
| void nl_dump | ( | struct nl_dump_params * | params, |
| const char * | fmt, | ||
| ... | |||
| ) |
◆ nl_dump_line()
| void nl_dump_line | ( | struct nl_dump_params * | parms, |
| const char * | fmt, | ||
| ... | |||
| ) |
Variable Documentation
◆ nl_debug
| int nl_debug = 0 |
Global variable indicating the desired level of debugging output.
| Level | Messages Printed |
|---|---|
| 0 | Debugging output disabled |
| 1 | Warnings, important events and notifications |
| 2 | More or less important debugging messages |
| 3 | Repetitive events causing a flood of debugging messages |
| 4 | Even less important messages |
If available, the variable will be initialized to the value of the environment variable NLDBG. The default value is 0 (disabled).
For more information, see section Debugging (Netlink Core Library Development Guide).
