libnl  3.2.24-rc1
utils.c
1 /*
2  * lib/utils.c Utility Functions
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 
12 /**
13  * @ingroup core
14  * @defgroup utils Utilities
15  *
16  * Collection of helper functions
17  *
18  * @{
19  *
20  * Header
21  * ------
22  * ~~~~{.c}
23  * #include <netlink/utils.h>
24  * ~~~~
25  */
26 
27 #include <netlink-private/netlink.h>
28 #include <netlink/netlink.h>
29 #include <netlink/utils.h>
30 #include <linux/socket.h>
31 #include <stdlib.h> /* exit() */
32 
33 /**
34  * Global variable indicating the desired level of debugging output.
35  *
36  * Level | Messages Printed
37  * ----- | ---------------------------------------------------------
38  * 0 | Debugging output disabled
39  * 1 | Warnings, important events and notifications
40  * 2 | More or less important debugging messages
41  * 3 | Repetitive events causing a flood of debugging messages
42  * 4 | Even less important messages
43  *
44  * If available, the variable will be initialized to the value of the
45  * environment variable `NLDBG`. The default value is 0 (disabled).
46  *
47  * For more information, see section @core_doc{_debugging, Debugging}.
48  */
49 int nl_debug = 0;
50 
51 /** @cond SKIP */
52 #ifdef NL_DEBUG
53 struct nl_dump_params nl_debug_dp = {
54  .dp_type = NL_DUMP_DETAILS,
55 };
56 
57 static void __init nl_debug_init(void)
58 {
59  char *nldbg, *end;
60 
61  if ((nldbg = getenv("NLDBG"))) {
62  long level = strtol(nldbg, &end, 0);
63  if (nldbg != end)
64  nl_debug = level;
65  }
66 
67  nl_debug_dp.dp_fd = stderr;
68 }
69 #endif
70 
71 int __nl_read_num_str_file(const char *path, int (*cb)(long, const char *))
72 {
73  FILE *fd;
74  char buf[128];
75 
76  fd = fopen(path, "r");
77  if (fd == NULL)
78  return -nl_syserr2nlerr(errno);
79 
80  while (fgets(buf, sizeof(buf), fd)) {
81  int goodlen, err;
82  long num;
83  char *end;
84 
85  if (*buf == '#' || *buf == '\n' || *buf == '\r')
86  continue;
87 
88  num = strtol(buf, &end, 0);
89  if (end == buf) {
90  fclose(fd);
91  return -NLE_INVAL;
92  }
93 
94  if (num == LONG_MIN || num == LONG_MAX) {
95  fclose(fd);
96  return -NLE_RANGE;
97  }
98 
99  while (*end == ' ' || *end == '\t')
100  end++;
101 
102  goodlen = strcspn(end, "#\r\n\t ");
103  if (goodlen == 0) {
104  fclose(fd);
105  return -NLE_INVAL;
106  }
107 
108  end[goodlen] = '\0';
109 
110  err = cb(num, end);
111  if (err < 0) {
112  fclose(fd);
113  return err;
114  }
115  }
116 
117  fclose(fd);
118 
119  return 0;
120 }
121 /** @endcond */
122 
123 /**
124  * @name Pretty Printing of Numbers
125  * @{
126  */
127 
128 /**
129  * Cancel down a byte counter
130  * @arg l byte counter
131  * @arg unit destination unit pointer
132  *
133  * Cancels down a byte counter until it reaches a reasonable
134  * unit. The chosen unit is assigned to \a unit.
135  * This function assume 1024 bytes in one kilobyte
136  *
137  * @return The cancelled down byte counter in the new unit.
138  */
139 double nl_cancel_down_bytes(unsigned long long l, char **unit)
140 {
141  if (l >= 1099511627776LL) {
142  *unit = "TiB";
143  return ((double) l) / 1099511627776LL;
144  } else if (l >= 1073741824) {
145  *unit = "GiB";
146  return ((double) l) / 1073741824;
147  } else if (l >= 1048576) {
148  *unit = "MiB";
149  return ((double) l) / 1048576;
150  } else if (l >= 1024) {
151  *unit = "KiB";
152  return ((double) l) / 1024;
153  } else {
154  *unit = "B";
155  return (double) l;
156  }
157 }
158 
159 /**
160  * Cancel down a bit counter
161  * @arg l bit counter
162  * @arg unit destination unit pointer
163  *
164  * Cancels down bit counter until it reaches a reasonable
165  * unit. The chosen unit is assigned to \a unit.
166  * This function assume 1000 bits in one kilobit
167  *
168  * @return The cancelled down bit counter in the new unit.
169  */
170 double nl_cancel_down_bits(unsigned long long l, char **unit)
171 {
172  if (l >= 1000000000000ULL) {
173  *unit = "Tbit";
174  return ((double) l) / 1000000000000ULL;
175  }
176 
177  if (l >= 1000000000) {
178  *unit = "Gbit";
179  return ((double) l) / 1000000000;
180  }
181 
182  if (l >= 1000000) {
183  *unit = "Mbit";
184  return ((double) l) / 1000000;
185  }
186 
187  if (l >= 1000) {
188  *unit = "Kbit";
189  return ((double) l) / 1000;
190  }
191 
192  *unit = "bit";
193  return (double) l;
194 }
195 
196 int nl_rate2str(unsigned long long rate, int type, char *buf, size_t len)
197 {
198  char *unit;
199  double frac;
200 
201  switch (type) {
202  case NL_BYTE_RATE:
203  frac = nl_cancel_down_bytes(rate, &unit);
204  break;
205 
206  case NL_BIT_RATE:
207  frac = nl_cancel_down_bits(rate, &unit);
208  break;
209 
210  default:
211  BUG();
212  }
213 
214  return snprintf(buf, len, "%.2f%s/s", frac, unit);
215 }
216 
217 /**
218  * Cancel down a micro second value
219  * @arg l micro seconds
220  * @arg unit destination unit pointer
221  *
222  * Cancels down a microsecond counter until it reaches a
223  * reasonable unit. The chosen unit is assigned to \a unit.
224  *
225  * @return The cancelled down microsecond in the new unit
226  */
227 double nl_cancel_down_us(uint32_t l, char **unit)
228 {
229  if (l >= 1000000) {
230  *unit = "s";
231  return ((double) l) / 1000000;
232  } else if (l >= 1000) {
233  *unit = "ms";
234  return ((double) l) / 1000;
235  } else {
236  *unit = "us";
237  return (double) l;
238  }
239 }
240 
241 /** @} */
242 
243 /**
244  * @name Generic Unit Translations
245  * @{
246  */
247 
248 /**
249  * Convert a character string to a size
250  * @arg str size encoded as character string
251  *
252  * Converts the specified size as character to the corresponding
253  * number of bytes.
254  *
255  * Supported formats are:
256  * - b,kb/k,m/mb,gb/g for bytes
257  * - bit,kbit/mbit/gbit
258  *
259  * This function assume 1000 bits in one kilobit and
260  * 1024 bytes in one kilobyte
261  *
262  * @return The number of bytes or -1 if the string is unparseable
263  */
264 long nl_size2int(const char *str)
265 {
266  char *p;
267  long l = strtol(str, &p, 0);
268  if (p == str)
269  return -NLE_INVAL;
270 
271  if (*p) {
272  if (!strcasecmp(p, "kb") || !strcasecmp(p, "k"))
273  l *= 1024;
274  else if (!strcasecmp(p, "gb") || !strcasecmp(p, "g"))
275  l *= 1024*1024*1024;
276  else if (!strcasecmp(p, "gbit"))
277  l *= 1000000000L/8;
278  else if (!strcasecmp(p, "mb") || !strcasecmp(p, "m"))
279  l *= 1024*1024;
280  else if (!strcasecmp(p, "mbit"))
281  l *= 1000000/8;
282  else if (!strcasecmp(p, "kbit"))
283  l *= 1000/8;
284  else if (!strcasecmp(p, "bit"))
285  l /= 8;
286  else if (strcasecmp(p, "b") != 0)
287  return -NLE_INVAL;
288  }
289 
290  return l;
291 }
292 
293 static const struct {
294  double limit;
295  const char *unit;
296 } size_units[] = {
297  { 1024. * 1024. * 1024. * 1024. * 1024., "EiB" },
298  { 1024. * 1024. * 1024. * 1024., "TiB" },
299  { 1024. * 1024. * 1024., "GiB" },
300  { 1024. * 1024., "MiB" },
301  { 1024., "KiB" },
302  { 0., "B" },
303 };
304 
305 /**
306  * Convert a size toa character string
307  * @arg size Size in number of bytes
308  * @arg buf Buffer to write character string to
309  * @arg len Size of buf
310  *
311  * This function converts a value in bytes to a human readable representation
312  * of it. The function uses IEC prefixes:
313  *
314  * @code
315  * 1024 bytes => 1 KiB
316  * 1048576 bytes => 1 MiB
317  * @endcode
318  *
319  * The highest prefix is used which ensures a result of >= 1.0, the result
320  * is provided as floating point number with a maximum precision of 2 digits:
321  * @code
322  * 965176 bytes => 942.55 KiB
323  * @endcode
324  *
325  * @return pointer to buf
326  */
327 char *nl_size2str(const size_t size, char *buf, const size_t len)
328 {
329  size_t i;
330 
331  if (size == 0) {
332  snprintf(buf, len, "0B");
333  return buf;
334  }
335 
336  for (i = 0; i < ARRAY_SIZE(size_units); i++) {
337  if (size >= size_units[i].limit) {
338  snprintf(buf, len, "%.2g%s",
339  (double) size / size_units[i].limit,
340  size_units[i].unit);
341  return buf;
342  }
343  }
344 
345  BUG();
346 }
347 
348 /**
349  * Convert a character string to a probability
350  * @arg str probability encoded as character string
351  *
352  * Converts the specified probability as character to the
353  * corresponding probability number.
354  *
355  * Supported formats are:
356  * - 0.0-1.0
357  * - 0%-100%
358  *
359  * @return The probability relative to NL_PROB_MIN and NL_PROB_MAX
360  */
361 long nl_prob2int(const char *str)
362 {
363  char *p;
364  double d = strtod(str, &p);
365 
366  if (p == str)
367  return -NLE_INVAL;
368 
369  if (d > 1.0)
370  d /= 100.0f;
371 
372  if (d > 1.0f || d < 0.0f)
373  return -NLE_RANGE;
374 
375  if (*p && strcmp(p, "%") != 0)
376  return -NLE_INVAL;
377 
378  return rint(d * NL_PROB_MAX);
379 }
380 
381 /** @} */
382 
383 /**
384  * @name Time Translations
385  * @{
386  */
387 
388 #ifndef USER_HZ
389 #define USER_HZ 100
390 #endif
391 
392 static uint32_t user_hz = USER_HZ;
393 static uint32_t psched_hz = USER_HZ;
394 
395 static double ticks_per_usec = 1.0f;
396 
397 /* Retrieves the configured HZ and ticks/us value in the kernel.
398  * The value is cached. Supported ways of getting it:
399  *
400  * 1) environment variable
401  * 2) /proc/net/psched and sysconf
402  *
403  * Supports the environment variables:
404  * PROC_NET_PSCHED - may point to psched file in /proc
405  * PROC_ROOT - may point to /proc fs */
406 static void __init get_psched_settings(void)
407 {
408  char name[FILENAME_MAX];
409  FILE *fd;
410  int got_hz = 0;
411 
412  if (getenv("HZ")) {
413  long hz = strtol(getenv("HZ"), NULL, 0);
414 
415  if (LONG_MIN != hz && LONG_MAX != hz) {
416  user_hz = hz;
417  got_hz = 1;
418  }
419  }
420 
421  if (!got_hz)
422  user_hz = sysconf(_SC_CLK_TCK);
423 
424  psched_hz = user_hz;
425 
426  if (getenv("TICKS_PER_USEC")) {
427  double t = strtod(getenv("TICKS_PER_USEC"), NULL);
428  ticks_per_usec = t;
429  }
430  else {
431  if (getenv("PROC_NET_PSCHED"))
432  snprintf(name, sizeof(name), "%s", getenv("PROC_NET_PSCHED"));
433  else if (getenv("PROC_ROOT"))
434  snprintf(name, sizeof(name), "%s/net/psched",
435  getenv("PROC_ROOT"));
436  else
437  strncpy(name, "/proc/net/psched", sizeof(name) - 1);
438 
439  if ((fd = fopen(name, "r"))) {
440  unsigned int ns_per_usec, ns_per_tick, nom, denom;
441 
442  if (fscanf(fd, "%08x %08x %08x %08x",
443  &ns_per_usec, &ns_per_tick, &nom, &denom) != 4) {
444  NL_DBG(1, "Fatal error: can not read psched settings from \"%s\". " \
445  "Try to set TICKS_PER_USEC, PROC_NET_PSCHED or PROC_ROOT " \
446  "environment variables\n", name);
447  exit(1);
448  }
449 
450  ticks_per_usec = (double) ns_per_usec /
451  (double) ns_per_tick;
452 
453  if (nom == 1000000)
454  psched_hz = denom;
455 
456  fclose(fd);
457  }
458  }
459 }
460 
461 
462 /**
463  * Return the value of HZ
464  */
465 int nl_get_user_hz(void)
466 {
467  return user_hz;
468 }
469 
470 /**
471  * Return the value of packet scheduler HZ
472  */
473 int nl_get_psched_hz(void)
474 {
475  return psched_hz;
476 }
477 
478 /**
479  * Convert micro seconds to ticks
480  * @arg us micro seconds
481  * @return number of ticks
482  */
483 uint32_t nl_us2ticks(uint32_t us)
484 {
485  return us * ticks_per_usec;
486 }
487 
488 
489 /**
490  * Convert ticks to micro seconds
491  * @arg ticks number of ticks
492  * @return microseconds
493  */
494 uint32_t nl_ticks2us(uint32_t ticks)
495 {
496  return ticks / ticks_per_usec;
497 }
498 
499 int nl_str2msec(const char *str, uint64_t *result)
500 {
501  uint64_t total = 0, l;
502  int plen;
503  char *p;
504 
505  do {
506  l = strtoul(str, &p, 0);
507  if (p == str)
508  return -NLE_INVAL;
509  else if (*p) {
510  plen = strcspn(p, " \t");
511 
512  if (!plen)
513  total += l;
514  else if (!strncasecmp(p, "sec", plen))
515  total += (l * 1000);
516  else if (!strncasecmp(p, "min", plen))
517  total += (l * 1000*60);
518  else if (!strncasecmp(p, "hour", plen))
519  total += (l * 1000*60*60);
520  else if (!strncasecmp(p, "day", plen))
521  total += (l * 1000*60*60*24);
522  else
523  return -NLE_INVAL;
524 
525  str = p + plen;
526  } else
527  total += l;
528  } while (*str && *p);
529 
530  *result = total;
531 
532  return 0;
533 }
534 
535 /**
536  * Convert milliseconds to a character string
537  * @arg msec number of milliseconds
538  * @arg buf destination buffer
539  * @arg len buffer length
540  *
541  * Converts milliseconds to a character string split up in days, hours,
542  * minutes, seconds, and milliseconds and stores it in the specified
543  * destination buffer.
544  *
545  * @return The destination buffer.
546  */
547 char * nl_msec2str(uint64_t msec, char *buf, size_t len)
548 {
549  uint64_t split[5];
550  size_t i;
551  static const char *units[5] = {"d", "h", "m", "s", "msec"};
552  char * const buf_orig = buf;
553 
554 #define _SPLIT(idx, unit) if ((split[idx] = msec / unit)) msec %= unit
555  _SPLIT(0, 86400000); /* days */
556  _SPLIT(1, 3600000); /* hours */
557  _SPLIT(2, 60000); /* minutes */
558  _SPLIT(3, 1000); /* seconds */
559 #undef _SPLIT
560  split[4] = msec;
561 
562  if (msec == 0) {
563  snprintf(buf, len, "0msec");
564  return buf_orig;
565  }
566 
567  for (i = 0; i < ARRAY_SIZE(split) && len; i++) {
568  int l;
569  if (split[i] == 0)
570  continue;
571  l = snprintf(buf, len, "%s%" PRIu64 "%s",
572  (buf==buf_orig) ? "" : " ", split[i], units[i]);
573  buf += l;
574  len -= l;
575  }
576 
577  return buf_orig;
578 }
579 
580 /** @} */
581 
582 /**
583  * @name Netlink Family Translations
584  * @{
585  */
586 
587 static const struct trans_tbl nlfamilies[] = {
588  __ADD(NETLINK_ROUTE,route)
589  __ADD(NETLINK_USERSOCK,usersock)
590  __ADD(NETLINK_FIREWALL,firewall)
591  __ADD(NETLINK_INET_DIAG,inetdiag)
592  __ADD(NETLINK_NFLOG,nflog)
593  __ADD(NETLINK_XFRM,xfrm)
594  __ADD(NETLINK_SELINUX,selinux)
595  __ADD(NETLINK_ISCSI,iscsi)
596  __ADD(NETLINK_AUDIT,audit)
597  __ADD(NETLINK_FIB_LOOKUP,fib_lookup)
598  __ADD(NETLINK_CONNECTOR,connector)
599  __ADD(NETLINK_NETFILTER,netfilter)
600  __ADD(NETLINK_IP6_FW,ip6_fw)
601  __ADD(NETLINK_DNRTMSG,dnrtmsg)
602  __ADD(NETLINK_KOBJECT_UEVENT,kobject_uevent)
603  __ADD(NETLINK_GENERIC,generic)
604  __ADD(NETLINK_SCSITRANSPORT,scsitransport)
605  __ADD(NETLINK_ECRYPTFS,ecryptfs)
606 };
607 
608 char * nl_nlfamily2str(int family, char *buf, size_t size)
609 {
610  return __type2str(family, buf, size, nlfamilies,
611  ARRAY_SIZE(nlfamilies));
612 }
613 
614 int nl_str2nlfamily(const char *name)
615 {
616  return __str2type(name, nlfamilies, ARRAY_SIZE(nlfamilies));
617 }
618 
619 /**
620  * @}
621  */
622 
623 /**
624  * @name Link Layer Protocol Translations
625  * @{
626  */
627 
628 static const struct trans_tbl llprotos[] = {
629  {0, "generic"},
630  __ADD(ARPHRD_ETHER,ether)
631  __ADD(ARPHRD_EETHER,eether)
632  __ADD(ARPHRD_AX25,ax25)
633  __ADD(ARPHRD_PRONET,pronet)
634  __ADD(ARPHRD_CHAOS,chaos)
635  __ADD(ARPHRD_IEEE802,ieee802)
636  __ADD(ARPHRD_ARCNET,arcnet)
637  __ADD(ARPHRD_APPLETLK,atalk)
638  __ADD(ARPHRD_DLCI,dlci)
639  __ADD(ARPHRD_ATM,atm)
640  __ADD(ARPHRD_METRICOM,metricom)
641  __ADD(ARPHRD_IEEE1394,ieee1394)
642 #ifdef ARPHRD_EUI64
643  __ADD(ARPHRD_EUI64,eui64)
644 #endif
645  __ADD(ARPHRD_INFINIBAND,infiniband)
646  __ADD(ARPHRD_SLIP,slip)
647  __ADD(ARPHRD_CSLIP,cslip)
648  __ADD(ARPHRD_SLIP6,slip6)
649  __ADD(ARPHRD_CSLIP6,cslip6)
650  __ADD(ARPHRD_RSRVD,rsrvd)
651  __ADD(ARPHRD_ADAPT,adapt)
652  __ADD(ARPHRD_ROSE,rose)
653  __ADD(ARPHRD_X25,x25)
654 #ifdef ARPHRD_HWX25
655  __ADD(ARPHRD_HWX25,hwx25)
656 #endif
657  __ADD(ARPHRD_CAN,can)
658  __ADD(ARPHRD_PPP,ppp)
659  __ADD(ARPHRD_HDLC,hdlc)
660  __ADD(ARPHRD_LAPB,lapb)
661  __ADD(ARPHRD_DDCMP,ddcmp)
662  __ADD(ARPHRD_RAWHDLC,rawhdlc)
663  __ADD(ARPHRD_TUNNEL,ipip)
664  __ADD(ARPHRD_TUNNEL6,tunnel6)
665  __ADD(ARPHRD_FRAD,frad)
666  __ADD(ARPHRD_SKIP,skip)
667  __ADD(ARPHRD_LOOPBACK,loopback)
668  __ADD(ARPHRD_LOCALTLK,localtlk)
669  __ADD(ARPHRD_FDDI,fddi)
670  __ADD(ARPHRD_BIF,bif)
671  __ADD(ARPHRD_SIT,sit)
672  __ADD(ARPHRD_IPDDP,ip/ddp)
673  __ADD(ARPHRD_IPGRE,gre)
674  __ADD(ARPHRD_PIMREG,pimreg)
675  __ADD(ARPHRD_HIPPI,hippi)
676  __ADD(ARPHRD_ASH,ash)
677  __ADD(ARPHRD_ECONET,econet)
678  __ADD(ARPHRD_IRDA,irda)
679  __ADD(ARPHRD_FCPP,fcpp)
680  __ADD(ARPHRD_FCAL,fcal)
681  __ADD(ARPHRD_FCPL,fcpl)
682  __ADD(ARPHRD_FCFABRIC,fcfb_0)
683  __ADD(ARPHRD_FCFABRIC+1,fcfb_1)
684  __ADD(ARPHRD_FCFABRIC+2,fcfb_2)
685  __ADD(ARPHRD_FCFABRIC+3,fcfb_3)
686  __ADD(ARPHRD_FCFABRIC+4,fcfb_4)
687  __ADD(ARPHRD_FCFABRIC+5,fcfb_5)
688  __ADD(ARPHRD_FCFABRIC+6,fcfb_6)
689  __ADD(ARPHRD_FCFABRIC+7,fcfb_7)
690  __ADD(ARPHRD_FCFABRIC+8,fcfb_8)
691  __ADD(ARPHRD_FCFABRIC+9,fcfb_9)
692  __ADD(ARPHRD_FCFABRIC+10,fcfb_10)
693  __ADD(ARPHRD_FCFABRIC+11,fcfb_11)
694  __ADD(ARPHRD_FCFABRIC+12,fcfb_12)
695  __ADD(ARPHRD_IEEE802_TR,tr)
696  __ADD(ARPHRD_IEEE80211,ieee802.11)
697  __ADD(ARPHRD_PHONET,phonet)
698 #ifdef ARPHRD_CAIF
699  __ADD(ARPHRD_CAIF, caif)
700 #endif
701 #ifdef ARPHRD_IEEE80211_PRISM
702  __ADD(ARPHRD_IEEE80211_PRISM, ieee802.11_prism)
703 #endif
704 #ifdef ARPHRD_VOID
705  __ADD(ARPHRD_VOID,void)
706 #endif
707 #ifdef ARPHRD_NONE
708  __ADD(ARPHRD_NONE,nohdr)
709 #endif
710 };
711 
712 char * nl_llproto2str(int llproto, char *buf, size_t len)
713 {
714  return __type2str(llproto, buf, len, llprotos, ARRAY_SIZE(llprotos));
715 }
716 
717 int nl_str2llproto(const char *name)
718 {
719  return __str2type(name, llprotos, ARRAY_SIZE(llprotos));
720 }
721 
722 /** @} */
723 
724 
725 /**
726  * @name Ethernet Protocol Translations
727  * @{
728  */
729 
730 static const struct trans_tbl ether_protos[] = {
731  __ADD(ETH_P_LOOP,loop)
732  __ADD(ETH_P_PUP,pup)
733  __ADD(ETH_P_PUPAT,pupat)
734  __ADD(ETH_P_IP,ip)
735  __ADD(ETH_P_X25,x25)
736  __ADD(ETH_P_ARP,arp)
737  __ADD(ETH_P_BPQ,bpq)
738  __ADD(ETH_P_IEEEPUP,ieeepup)
739  __ADD(ETH_P_IEEEPUPAT,ieeepupat)
740  __ADD(ETH_P_DEC,dec)
741  __ADD(ETH_P_DNA_DL,dna_dl)
742  __ADD(ETH_P_DNA_RC,dna_rc)
743  __ADD(ETH_P_DNA_RT,dna_rt)
744  __ADD(ETH_P_LAT,lat)
745  __ADD(ETH_P_DIAG,diag)
746  __ADD(ETH_P_CUST,cust)
747  __ADD(ETH_P_SCA,sca)
748  __ADD(ETH_P_TEB,teb)
749  __ADD(ETH_P_RARP,rarp)
750  __ADD(ETH_P_ATALK,atalk)
751  __ADD(ETH_P_AARP,aarp)
752 #ifdef ETH_P_8021Q
753  __ADD(ETH_P_8021Q,802.1q)
754 #endif
755  __ADD(ETH_P_IPX,ipx)
756  __ADD(ETH_P_IPV6,ipv6)
757  __ADD(ETH_P_PAUSE,pause)
758  __ADD(ETH_P_SLOW,slow)
759 #ifdef ETH_P_WCCP
760  __ADD(ETH_P_WCCP,wccp)
761 #endif
762  __ADD(ETH_P_PPP_DISC,ppp_disc)
763  __ADD(ETH_P_PPP_SES,ppp_ses)
764  __ADD(ETH_P_MPLS_UC,mpls_uc)
765  __ADD(ETH_P_MPLS_MC,mpls_mc)
766  __ADD(ETH_P_ATMMPOA,atmmpoa)
767  __ADD(ETH_P_LINK_CTL,link_ctl)
768  __ADD(ETH_P_ATMFATE,atmfate)
769  __ADD(ETH_P_PAE,pae)
770  __ADD(ETH_P_AOE,aoe)
771  __ADD(ETH_P_TIPC,tipc)
772  __ADD(ETH_P_1588,ieee1588)
773  __ADD(ETH_P_FCOE,fcoe)
774  __ADD(ETH_P_FIP,fip)
775  __ADD(ETH_P_EDSA,edsa)
776  __ADD(ETH_P_EDP2,edp2)
777  __ADD(ETH_P_802_3,802.3)
778  __ADD(ETH_P_AX25,ax25)
779  __ADD(ETH_P_ALL,all)
780  __ADD(ETH_P_802_2,802.2)
781  __ADD(ETH_P_SNAP,snap)
782  __ADD(ETH_P_DDCMP,ddcmp)
783  __ADD(ETH_P_WAN_PPP,wan_ppp)
784  __ADD(ETH_P_PPP_MP,ppp_mp)
785  __ADD(ETH_P_LOCALTALK,localtalk)
786  __ADD(ETH_P_CAN,can)
787  __ADD(ETH_P_PPPTALK,ppptalk)
788  __ADD(ETH_P_TR_802_2,tr_802.2)
789  __ADD(ETH_P_MOBITEX,mobitex)
790  __ADD(ETH_P_CONTROL,control)
791  __ADD(ETH_P_IRDA,irda)
792  __ADD(ETH_P_ECONET,econet)
793  __ADD(ETH_P_HDLC,hdlc)
794  __ADD(ETH_P_ARCNET,arcnet)
795  __ADD(ETH_P_DSA,dsa)
796  __ADD(ETH_P_TRAILER,trailer)
797  __ADD(ETH_P_PHONET,phonet)
798  __ADD(ETH_P_IEEE802154,ieee802154)
799  __ADD(ETH_P_CAIF,caif)
800 };
801 
802 char *nl_ether_proto2str(int eproto, char *buf, size_t len)
803 {
804  return __type2str(eproto, buf, len, ether_protos,
805  ARRAY_SIZE(ether_protos));
806 }
807 
808 int nl_str2ether_proto(const char *name)
809 {
810  return __str2type(name, ether_protos, ARRAY_SIZE(ether_protos));
811 }
812 
813 /** @} */
814 
815 /**
816  * @name IP Protocol Translations
817  * @{
818  */
819 
820 char *nl_ip_proto2str(int proto, char *buf, size_t len)
821 {
822  struct protoent *p = getprotobynumber(proto);
823 
824  if (p) {
825  snprintf(buf, len, "%s", p->p_name);
826  return buf;
827  }
828 
829  snprintf(buf, len, "0x%x", proto);
830  return buf;
831 }
832 
833 int nl_str2ip_proto(const char *name)
834 {
835  struct protoent *p = getprotobyname(name);
836  unsigned long l;
837  char *end;
838 
839  if (p)
840  return p->p_proto;
841 
842  l = strtoul(name, &end, 0);
843  if (l == ULONG_MAX || *end != '\0')
844  return -NLE_OBJ_NOTFOUND;
845 
846  return (int) l;
847 }
848 
849 /** @} */
850 
851 /**
852  * @name Dumping Helpers
853  * @{
854  */
855 
856 /**
857  * Handle a new line while dumping
858  * @arg params Dumping parameters
859  *
860  * This function must be called before dumping any onto a
861  * new line. It will ensure proper prefixing as specified
862  * by the dumping parameters.
863  *
864  * @note This function will NOT dump any newlines itself
865  */
866 void nl_new_line(struct nl_dump_params *params)
867 {
868  params->dp_line++;
869 
870  if (params->dp_prefix) {
871  int i;
872  for (i = 0; i < params->dp_prefix; i++) {
873  if (params->dp_fd)
874  fprintf(params->dp_fd, " ");
875  else if (params->dp_buf)
876  strncat(params->dp_buf, " ",
877  params->dp_buflen -
878  strlen(params->dp_buf) - 1);
879  }
880  }
881 
882  if (params->dp_nl_cb)
883  params->dp_nl_cb(params, params->dp_line);
884 }
885 
886 static void dump_one(struct nl_dump_params *parms, const char *fmt,
887  va_list args)
888 {
889  if (parms->dp_fd)
890  vfprintf(parms->dp_fd, fmt, args);
891  else if (parms->dp_buf || parms->dp_cb) {
892  char *buf = NULL;
893  if (vasprintf(&buf, fmt, args) >= 0) {
894  if (parms->dp_cb)
895  parms->dp_cb(parms, buf);
896  else
897  strncat(parms->dp_buf, buf,
898  parms->dp_buflen -
899  strlen(parms->dp_buf) - 1);
900  free(buf);
901  }
902  }
903 }
904 
905 
906 /**
907  * Dump a formatted character string
908  * @arg params Dumping parameters
909  * @arg fmt printf style formatting string
910  * @arg ... Arguments to formatting string
911  *
912  * Dumps a printf style formatting string to the output device
913  * as specified by the dumping parameters.
914  */
915 void nl_dump(struct nl_dump_params *params, const char *fmt, ...)
916 {
917  va_list args;
918 
919  va_start(args, fmt);
920  dump_one(params, fmt, args);
921  va_end(args);
922 }
923 
924 void nl_dump_line(struct nl_dump_params *parms, const char *fmt, ...)
925 {
926  va_list args;
927 
928  nl_new_line(parms);
929 
930  va_start(args, fmt);
931  dump_one(parms, fmt, args);
932  va_end(args);
933 }
934 
935 
936 /** @} */
937 
938 /** @cond SKIP */
939 
940 int __trans_list_add(int i, const char *a, struct nl_list_head *head)
941 {
942  struct trans_list *tl;
943 
944  tl = calloc(1, sizeof(*tl));
945  if (!tl)
946  return -NLE_NOMEM;
947 
948  tl->i = i;
949  tl->a = strdup(a);
950 
951  nl_list_add_tail(&tl->list, head);
952 
953  return 0;
954 }
955 
956 void __trans_list_clear(struct nl_list_head *head)
957 {
958  struct trans_list *tl, *next;
959 
960  nl_list_for_each_entry_safe(tl, next, head, list) {
961  free(tl->a);
962  free(tl);
963  }
964 
965  nl_init_list_head(head);
966 }
967 
968 char *__type2str(int type, char *buf, size_t len,
969  const struct trans_tbl *tbl, size_t tbl_len)
970 {
971  size_t i;
972  for (i = 0; i < tbl_len; i++) {
973  if (tbl[i].i == type) {
974  snprintf(buf, len, "%s", tbl[i].a);
975  return buf;
976  }
977  }
978 
979  snprintf(buf, len, "0x%x", type);
980  return buf;
981 }
982 
983 char *__list_type2str(int type, char *buf, size_t len,
984  struct nl_list_head *head)
985 {
986  struct trans_list *tl;
987 
988  nl_list_for_each_entry(tl, head, list) {
989  if (tl->i == type) {
990  snprintf(buf, len, "%s", tl->a);
991  return buf;
992  }
993  }
994 
995  snprintf(buf, len, "0x%x", type);
996  return buf;
997 }
998 
999 char *__flags2str(int flags, char *buf, size_t len,
1000  const struct trans_tbl *tbl, size_t tbl_len)
1001 {
1002  size_t i;
1003  int tmp = flags;
1004 
1005  memset(buf, 0, len);
1006 
1007  for (i = 0; i < tbl_len; i++) {
1008  if (tbl[i].i & tmp) {
1009  tmp &= ~tbl[i].i;
1010  strncat(buf, tbl[i].a, len - strlen(buf) - 1);
1011  if ((tmp & flags))
1012  strncat(buf, ",", len - strlen(buf) - 1);
1013  }
1014  }
1015 
1016  return buf;
1017 }
1018 
1019 int __str2type(const char *buf, const struct trans_tbl *tbl, size_t tbl_len)
1020 {
1021  unsigned long l;
1022  char *end;
1023  size_t i;
1024 
1025  if (*buf == '\0')
1026  return -NLE_INVAL;
1027 
1028  for (i = 0; i < tbl_len; i++)
1029  if (!strcasecmp(tbl[i].a, buf))
1030  return tbl[i].i;
1031 
1032  l = strtoul(buf, &end, 0);
1033  if (l == ULONG_MAX || *end != '\0')
1034  return -NLE_OBJ_NOTFOUND;
1035 
1036  return (int) l;
1037 }
1038 
1039 int __list_str2type(const char *buf, struct nl_list_head *head)
1040 {
1041  struct trans_list *tl;
1042  unsigned long l;
1043  char *end;
1044 
1045  if (*buf == '\0')
1046  return -NLE_INVAL;
1047 
1048  nl_list_for_each_entry(tl, head, list) {
1049  if (!strcasecmp(tl->a, buf))
1050  return tl->i;
1051  }
1052 
1053  l = strtoul(buf, &end, 0);
1054  if (l == ULONG_MAX || *end != '\0')
1055  return -NLE_OBJ_NOTFOUND;
1056 
1057  return (int) l;
1058 }
1059 
1060 int __str2flags(const char *buf, const struct trans_tbl *tbl, size_t tbl_len)
1061 {
1062  int flags = 0;
1063  size_t i;
1064  size_t len; /* ptrdiff_t ? */
1065  char *p = (char *) buf, *t;
1066 
1067  for (;;) {
1068  if (*p == ' ')
1069  p++;
1070 
1071  t = strchr(p, ',');
1072  len = t ? t - p : strlen(p);
1073  for (i = 0; i < tbl_len; i++)
1074  if (len == strlen(tbl[i].a) &&
1075  !strncasecmp(tbl[i].a, p, len))
1076  flags |= tbl[i].i;
1077 
1078  if (!t)
1079  return flags;
1080 
1081  p = ++t;
1082  }
1083 
1084  return 0;
1085 }
1086 
1087 void dump_from_ops(struct nl_object *obj, struct nl_dump_params *params)
1088 {
1089  int type = params->dp_type;
1090 
1091  if (type < 0 || type > NL_DUMP_MAX)
1092  BUG();
1093 
1094  params->dp_line = 0;
1095 
1096  if (params->dp_dump_msgtype) {
1097 #if 0
1098  /* XXX */
1099  char buf[64];
1100 
1101  dp_dump_line(params, 0, "%s ",
1102  nl_cache_mngt_type2name(obj->ce_ops,
1103  obj->ce_ops->co_protocol,
1104  obj->ce_msgtype,
1105  buf, sizeof(buf)));
1106 #endif
1107  params->dp_pre_dump = 1;
1108  }
1109 
1110  if (obj->ce_ops->oo_dump[type])
1111  obj->ce_ops->oo_dump[type](obj, params);
1112 }
1113 
1114 /** @endcond */
1115 
1116 /** @} */