Utilities

Data Structures

struct  nl_dump_params
 Dumping parameters. More...

Modules

 Abstract Address
 Abstract Data

Enumerations

enum  nl_dump_type {
  NL_DUMP_BRIEF, NL_DUMP_FULL, NL_DUMP_STATS, NL_DUMP_XML,
  NL_DUMP_ENV, NL_DUMP_EVENTS, __NL_DUMP_MAX
}
 

Dumping types (dp_type).

More...

Variables

int nl_debug = 0
 Debug level.
struct nl_dump_params nl_debug_dp

Error Code Helpers



int nl_get_errno (void)
char * nl_geterror (void)
 Return error message for an error code.
void nl_perror (const char *s)
 Print a libnl error message.

Time Translations



int nl_get_hz (void)
 Return the value of HZ.
uint32_t nl_us2ticks (uint32_t us)
 Convert micro seconds to ticks.
uint32_t nl_ticks2us (uint32_t ticks)
 Convert ticks to micro seconds.
long nl_time2int (const char *str)
char * nl_msec2str (uint64_t msec, char *buf, size_t len)
 Convert milliseconds to a character string.

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)

Unit Pretty-Printing



double nl_cancel_down_bytes (unsigned long long l, char **unit)
 Cancel down a byte counter.
double nl_cancel_down_bits (unsigned long long l, char **unit)
 Cancel down a bit counter.
double nl_cancel_down_us (uint32_t l, char **unit)
 Cancel down a micro second value.

Generic Unit Translations



long nl_size2int (const char *str)
 Convert a character string to a size.
long nl_prob2int (const char *str)
 Convert a character string to a probability.

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, int line)
 Handle a new line while dumping.
void nl_dump (struct nl_dump_params *params, const char *fmt,...)
 Dump a formatted character string.

Probability Constants



#define NL_PROB_MIN   0x0
 Lower probability limit.
#define NL_PROB_MAX   0xffffffff
 Upper probability limit.

Enumeration Type Documentation

Enumerator:
NL_DUMP_BRIEF 

Dump object in a brief one-liner.

NL_DUMP_FULL 

Dump all attributes but no statistics.

NL_DUMP_STATS 

Dump all attributes including statistics.

NL_DUMP_XML 

Dump all attribtes in XML format.

NL_DUMP_ENV 

Dump all attribtues as env variables.

NL_DUMP_EVENTS 

Dump event.

Definition at line 21 of file types.h.

00021                   {
00022         NL_DUMP_BRIEF,          /**< Dump object in a brief one-liner */
00023         NL_DUMP_FULL,           /**< Dump all attributes but no statistics */
00024         NL_DUMP_STATS,          /**< Dump all attributes including statistics */
00025         NL_DUMP_XML,            /**< Dump all attribtes in XML format */
00026         NL_DUMP_ENV,            /**< Dump all attribtues as env variables */
00027         NL_DUMP_EVENTS,         /**< Dump event */
00028         __NL_DUMP_MAX,
00029 };


Function Documentation

char* nl_geterror ( void   ) 
Returns:
error message

Definition at line 142 of file utils.c.

Referenced by nl_perror().

00143 {
00144         if (errbuf)
00145                 return errbuf;
00146 
00147         if (nlerrno)
00148                 return strerror(nlerrno);
00149 
00150         return "Sucess\n";
00151 }

void nl_perror ( const char *  s  ) 
Parameters:
s error message prefix

Prints the error message of the call that failed last.

If s is not NULL and *s is not a null byte the argument string is printed, followed by a colon and a blank. Then the error message and a new-line.

Definition at line 163 of file utils.c.

References nl_geterror().

00164 {
00165         if (s && *s)
00166                 fprintf(stderr, "%s: %s\n", s, nl_geterror());
00167         else
00168                 fprintf(stderr, "%s\n", nl_geterror());
00169 }

double nl_cancel_down_bytes ( unsigned long long  l,
char **  unit 
)
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.

Returns:
The cancelled down byte counter in the new unit.

Definition at line 188 of file utils.c.

00189 {
00190         if (l >= 1099511627776LL) {
00191                 *unit = "TiB";
00192                 return ((double) l) / 1099511627776LL;
00193         } else if (l >= 1073741824) {
00194                 *unit = "GiB";
00195                 return ((double) l) / 1073741824;
00196         } else if (l >= 1048576) {
00197                 *unit = "MiB";
00198                 return ((double) l) / 1048576;
00199         } else if (l >= 1024) {
00200                 *unit = "KiB";
00201                 return ((double) l) / 1024;
00202         } else {
00203                 *unit = "B";
00204                 return (double) l;
00205         }
00206 }

double nl_cancel_down_bits ( unsigned long long  l,
char **  unit 
)
Parameters:
l bit counter
unit destination unit pointer

Cancels downa bit counter until it reaches a reasonable unit. The chosen unit is assigned to unit.

Returns:
The cancelled down bit counter in the new unit.

Definition at line 218 of file utils.c.

00219 {
00220         if (l >= 1099511627776ULL) {
00221                 *unit = "Tbit";
00222                 return ((double) l) / 1099511627776ULL;
00223         } else if (l >= 1073741824) {
00224                 *unit = "Gbit";
00225                 return ((double) l) / 1073741824;
00226         } else if (l >= 1048576) {
00227                 *unit = "Mbit";
00228                 return ((double) l) / 1048576;
00229         } else if (l >= 1024) {
00230                 *unit = "Kbit";
00231                 return ((double) l) / 1024;
00232         } else {
00233                 *unit = "bit";
00234                 return (double) l;
00235         }
00236                 
00237 }

double nl_cancel_down_us ( uint32_t  l,
char **  unit 
)
Parameters:
l micro seconds
unit destination unit pointer

Cancels down a microsecond counter until it reaches a reasonable unit. The chosen unit is assigned to unit.

Returns:
The cancelled down microsecond in the new unit

Definition at line 249 of file utils.c.

00250 {
00251         if (l >= 1000000) {
00252                 *unit = "s";
00253                 return ((double) l) / 1000000;
00254         } else if (l >= 1000) {
00255                 *unit = "ms";
00256                 return ((double) l) / 1000;
00257         } else {
00258                 *unit = "us";
00259                 return (double) l;
00260         }
00261 }

long nl_size2int ( const char *  str  ) 
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
Returns:
The number of bytes or -1 if the string is unparseable

Definition at line 283 of file utils.c.

00284 {
00285         char *p;
00286         long l = strtol(str, &p, 0);
00287         if (p == str)
00288                 return -1;
00289 
00290         if (*p) {
00291                 if (!strcasecmp(p, "kb") || !strcasecmp(p, "k"))
00292                         l *= 1024;
00293                 else if (!strcasecmp(p, "gb") || !strcasecmp(p, "g"))
00294                         l *= 1024*1024*1024;
00295                 else if (!strcasecmp(p, "gbit"))
00296                         l *= 1024*1024*1024/8;
00297                 else if (!strcasecmp(p, "mb") || !strcasecmp(p, "m"))
00298                         l *= 1024*1024;
00299                 else if (!strcasecmp(p, "mbit"))
00300                         l *= 1024*1024/8;
00301                 else if (!strcasecmp(p, "kbit"))
00302                         l *= 1024/8;
00303                 else if (!strcasecmp(p, "bit"))
00304                         l /= 8;
00305                 else if (strcasecmp(p, "b") != 0)
00306                         return -1;
00307         }
00308 
00309         return l;
00310 }

long nl_prob2int ( const char *  str  ) 
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 325 of file utils.c.

References NL_PROB_MAX.

00326 {
00327         char *p;
00328         double d = strtod(str, &p);
00329 
00330         if (p == str)
00331                 return -1;
00332 
00333         if (d > 1.0)
00334                 d /= 100.0f;
00335 
00336         if (d > 1.0f || d < 0.0f)
00337                 return -1;
00338 
00339         if (*p && strcmp(p, "%") != 0)
00340                 return -1;
00341 
00342         return rint(d * NL_PROB_MAX);
00343 }

uint32_t nl_us2ticks ( uint32_t  us  ) 
Parameters:
us micro seconds
Returns:
number of ticks

Definition at line 429 of file utils.c.

Referenced by rtnl_netem_set_delay(), and rtnl_netem_set_jitter().

00430 {
00431         return us * ticks_per_usec;
00432 }

uint32_t nl_ticks2us ( uint32_t  ticks  ) 
Parameters:
ticks number of ticks
Returns:
microseconds

Definition at line 440 of file utils.c.

Referenced by rtnl_netem_get_delay(), and rtnl_netem_get_jitter().

00441 {
00442         return ticks / ticks_per_usec;
00443 }

char* nl_msec2str ( uint64_t  msec,
char *  buf,
size_t  len 
)
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.

Definition at line 478 of file utils.c.

00479 {
00480         int i, split[5];
00481         char *units[] = {"d", "h", "m", "s", "msec"};
00482 
00483 #define _SPLIT(idx, unit) if ((split[idx] = msec / unit) > 0) msec %= unit
00484         _SPLIT(0, 86400000);    /* days */
00485         _SPLIT(1, 3600000);     /* hours */
00486         _SPLIT(2, 60000);       /* minutes */
00487         _SPLIT(3, 1000);        /* seconds */
00488 #undef  _SPLIT
00489         split[4] = msec;
00490 
00491         memset(buf, 0, len);
00492 
00493         for (i = 0; i < ARRAY_SIZE(split); i++) {
00494                 if (split[i] > 0) {
00495                         char t[64];
00496                         snprintf(t, sizeof(t), "%s%d%s",
00497                                  strlen(buf) ? " " : "", split[i], units[i]);
00498                         strncat(buf, t, len - strlen(buf) - 1);
00499                 }
00500         }
00501 
00502         return buf;
00503 }

void nl_new_line ( struct nl_dump_params params,
int  line 
)
Parameters:
params Dumping parameters
line Number of lines dumped already.

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 725 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.

00726 {
00727         if (params->dp_prefix) {
00728                 int i;
00729                 for (i = 0; i < params->dp_prefix; i++) {
00730                         if (params->dp_fd)
00731                                 fprintf(params->dp_fd, " ");
00732                         else if (params->dp_buf)
00733                                 strncat(params->dp_buf, " ",
00734                                         params->dp_buflen -
00735                                         sizeof(params->dp_buf) - 1);
00736                 }
00737         }
00738 
00739         if (params->dp_nl_cb)
00740                 params->dp_nl_cb(params, line);
00741 }

void nl_dump ( struct nl_dump_params params,
const char *  fmt,
  ... 
)
Parameters:
params Dumping parameters
fmt printf style formatting string
... Arguments to formatting string

Dumps a printf style formatting string to the output device as specified by the dumping parameters.

Definition at line 752 of file utils.c.

00753 {
00754         va_list args;
00755 
00756         va_start(args, fmt);
00757         __dp_dump(params, fmt, args);
00758         va_end(args);
00759 }


Variable Documentation

struct nl_dump_params nl_debug_dp
Initial value:
 {
        .dp_type = NL_DUMP_FULL,
}

Definition at line 27 of file utils.c.


Generated on 30 Oct 2009 for libnl by  doxygen 1.6.1