lib/libutil/humanize_unsigned.c

   1 /*      $NetBSD: subr_humanize.c,v 1.1 2009/10/02 15:48:41 pooka Exp $  */
   2
   3 /*-
   4  * Copyright (c) 1997, 1998, 1999, 2002, 2007, 2008 The NetBSD Foundation, Inc.
   5  * All rights reserved.
   6  *
   7  * This code is derived from software contributed to The NetBSD Foundation
   8  * by Luke Mewburn.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29  * POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #include <stdio.h>
  33 #include <string.h>
  34
  35 #include "libutil.h"
  36
  37 /*
  38  * snprintf() `bytes' into `buf', reformatting it so that the number,
  39  * plus a possible `x' + suffix extension) fits into len bytes (including
  40  * the terminating NUL).
  41  * Returns the number of bytes stored in buf, or -1 if there was a problem.
  42  * E.g, given a len of 9 and a suffix of `B':
  43  *      bytes           result
  44  *      -----           ------
  45  *      99999           `99999 B'
  46  *      100000          `97 kB'
  47  *      66715648        `65152 kB'
  48  *      252215296       `240 MB'
  49  */
  50 int
  51 humanize_unsigned(char *buf, size_t len, uint64_t bytes, const char *suffix,
  52     int divisor)
  53 {
  54         /* prefixes are: (none), kilo, Mega, Giga, Tera, Peta, Exa */
  55         const char *prefixes;
  56         int             r;
  57         uint64_t        umax;
  58         size_t          i, suffixlen;
  59
  60         if (buf == NULL || suffix == NULL)
  61                 return (-1);
  62         if (len > 0)
  63                 buf[0] = '\0';
  64         suffixlen = strlen(suffix);
  65         /* check if enough room for `x y' + suffix + `\0' */
  66         if (len < 4 + suffixlen)
  67                 return (-1);
  68
  69         if (divisor == 1024) {
  70                 /*
  71                  * binary multiplies
  72                  * XXX IEC 60027-2 recommends Ki, Mi, Gi...
  73                  */
  74                 prefixes = " KMGTPE";
  75         } else
  76                 prefixes = " kMGTPE"; /* SI for decimal multiplies */
  77
  78         umax = 1;
  79         for (i = 0; i < len - suffixlen - 3; i++) {
  80                 umax *= 10;
  81                 if (umax > bytes)
  82                         break;
  83         }
  84         for (i = 0; bytes >= umax && prefixes[i + 1]; i++)
  85                 bytes /= divisor;
  86
  87         r = snprintf(buf, len, "%qu%s%c%s", (unsigned long long)bytes,
  88             i == 0 ? "" : " ", prefixes[i], suffix);
  89
  90         return (r);
  91 }
  92
  93 int
  94 format_bytes(char *buf, size_t len, uint64_t bytes)
  95 {
  96         int     rv;
  97         size_t  nlen;
  98
  99         rv = humanize_unsigned(buf, len, bytes, "B", 1024);
 100         if (rv != -1) {
 101                         /* nuke the trailing ` B' if it exists */
 102                 nlen = strlen(buf) - 2;
 103                 if (strcmp(&buf[nlen], " B") == 0)
 104                         buf[nlen] = '\0';
 105         }
 106         return (rv);
 107 }