Blame


1 bbcba3ed 2022-01-10 op /* $OpenBSD: fmt_scaled.c,v 1.19 2020/10/12 22:08:34 deraadt Exp $ */
2 bbcba3ed 2022-01-10 op
3 bbcba3ed 2022-01-10 op /*
4 bbcba3ed 2022-01-10 op * Copyright (c) 2001, 2002, 2003 Ian F. Darwin. All rights reserved.
5 bbcba3ed 2022-01-10 op *
6 bbcba3ed 2022-01-10 op * Redistribution and use in source and binary forms, with or without
7 bbcba3ed 2022-01-10 op * modification, are permitted provided that the following conditions
8 bbcba3ed 2022-01-10 op * are met:
9 bbcba3ed 2022-01-10 op * 1. Redistributions of source code must retain the above copyright
10 bbcba3ed 2022-01-10 op * notice, this list of conditions and the following disclaimer.
11 bbcba3ed 2022-01-10 op * 2. Redistributions in binary form must reproduce the above copyright
12 bbcba3ed 2022-01-10 op * notice, this list of conditions and the following disclaimer in the
13 bbcba3ed 2022-01-10 op * documentation and/or other materials provided with the distribution.
14 bbcba3ed 2022-01-10 op * 3. The name of the author may not be used to endorse or promote products
15 bbcba3ed 2022-01-10 op * derived from this software without specific prior written permission.
16 bbcba3ed 2022-01-10 op *
17 bbcba3ed 2022-01-10 op * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 bbcba3ed 2022-01-10 op * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 bbcba3ed 2022-01-10 op * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 bbcba3ed 2022-01-10 op * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 bbcba3ed 2022-01-10 op * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 bbcba3ed 2022-01-10 op * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 bbcba3ed 2022-01-10 op * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 bbcba3ed 2022-01-10 op * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 bbcba3ed 2022-01-10 op * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 bbcba3ed 2022-01-10 op * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 bbcba3ed 2022-01-10 op */
28 bbcba3ed 2022-01-10 op
29 bbcba3ed 2022-01-10 op /*
30 bbcba3ed 2022-01-10 op * fmt_scaled: Format numbers scaled for human comprehension
31 bbcba3ed 2022-01-10 op * scan_scaled: Scan numbers in this format.
32 bbcba3ed 2022-01-10 op *
33 bbcba3ed 2022-01-10 op * "Human-readable" output uses 4 digits max, and puts a unit suffix at
34 bbcba3ed 2022-01-10 op * the end. Makes output compact and easy-to-read esp. on huge disks.
35 bbcba3ed 2022-01-10 op * Formatting code was originally in OpenBSD "df", converted to library routine.
36 bbcba3ed 2022-01-10 op * Scanning code written for OpenBSD libutil.
37 bbcba3ed 2022-01-10 op */
38 bbcba3ed 2022-01-10 op
39 bbcba3ed 2022-01-10 op #include "compat.h"
40 bbcba3ed 2022-01-10 op
41 bbcba3ed 2022-01-10 op #include <stdio.h>
42 bbcba3ed 2022-01-10 op #include <stdlib.h>
43 bbcba3ed 2022-01-10 op #include <errno.h>
44 bbcba3ed 2022-01-10 op #include <string.h>
45 bbcba3ed 2022-01-10 op #include <ctype.h>
46 bbcba3ed 2022-01-10 op #include <limits.h>
47 bbcba3ed 2022-01-10 op
48 bbcba3ed 2022-01-10 op typedef enum {
49 bbcba3ed 2022-01-10 op NONE = 0, KILO = 1, MEGA = 2, GIGA = 3, TERA = 4, PETA = 5, EXA = 6
50 bbcba3ed 2022-01-10 op } unit_type;
51 bbcba3ed 2022-01-10 op
52 bbcba3ed 2022-01-10 op /* These three arrays MUST be in sync! XXX make a struct */
53 bbcba3ed 2022-01-10 op static const unit_type units[] = { NONE, KILO, MEGA, GIGA, TERA, PETA, EXA };
54 bbcba3ed 2022-01-10 op static const char scale_chars[] = "BKMGTPE";
55 bbcba3ed 2022-01-10 op static const long long scale_factors[] = {
56 bbcba3ed 2022-01-10 op 1LL,
57 bbcba3ed 2022-01-10 op 1024LL,
58 bbcba3ed 2022-01-10 op 1024LL*1024,
59 bbcba3ed 2022-01-10 op 1024LL*1024*1024,
60 bbcba3ed 2022-01-10 op 1024LL*1024*1024*1024,
61 bbcba3ed 2022-01-10 op 1024LL*1024*1024*1024*1024,
62 bbcba3ed 2022-01-10 op 1024LL*1024*1024*1024*1024*1024,
63 bbcba3ed 2022-01-10 op };
64 bbcba3ed 2022-01-10 op #define SCALE_LENGTH (sizeof(units)/sizeof(units[0]))
65 bbcba3ed 2022-01-10 op
66 bbcba3ed 2022-01-10 op #define MAX_DIGITS (SCALE_LENGTH * 3) /* XXX strlen(sprintf("%lld", -1)? */
67 bbcba3ed 2022-01-10 op
68 bbcba3ed 2022-01-10 op /* Format the given "number" into human-readable form in "result".
69 bbcba3ed 2022-01-10 op * Result must point to an allocated buffer of length FMT_SCALED_STRSIZE.
70 bbcba3ed 2022-01-10 op * Return 0 on success, -1 and errno set if error.
71 bbcba3ed 2022-01-10 op */
72 bbcba3ed 2022-01-10 op int
73 bbcba3ed 2022-01-10 op fmt_scaled(long long number, char *result)
74 bbcba3ed 2022-01-10 op {
75 bbcba3ed 2022-01-10 op long long abval, fract = 0;
76 bbcba3ed 2022-01-10 op unsigned int i;
77 bbcba3ed 2022-01-10 op unit_type unit = NONE;
78 bbcba3ed 2022-01-10 op
79 bbcba3ed 2022-01-10 op /* Not every negative long long has a positive representation. */
80 bbcba3ed 2022-01-10 op if (number == LLONG_MIN) {
81 bbcba3ed 2022-01-10 op errno = ERANGE;
82 bbcba3ed 2022-01-10 op return -1;
83 bbcba3ed 2022-01-10 op }
84 bbcba3ed 2022-01-10 op
85 bbcba3ed 2022-01-10 op abval = llabs(number);
86 bbcba3ed 2022-01-10 op
87 bbcba3ed 2022-01-10 op /* Also check for numbers that are just too darned big to format. */
88 bbcba3ed 2022-01-10 op if (abval / 1024 >= scale_factors[SCALE_LENGTH-1]) {
89 bbcba3ed 2022-01-10 op errno = ERANGE;
90 bbcba3ed 2022-01-10 op return -1;
91 bbcba3ed 2022-01-10 op }
92 bbcba3ed 2022-01-10 op
93 bbcba3ed 2022-01-10 op /* scale whole part; get unscaled fraction */
94 bbcba3ed 2022-01-10 op for (i = 0; i < SCALE_LENGTH; i++) {
95 bbcba3ed 2022-01-10 op if (abval/1024 < scale_factors[i]) {
96 bbcba3ed 2022-01-10 op unit = units[i];
97 bbcba3ed 2022-01-10 op fract = (i == 0) ? 0 : abval % scale_factors[i];
98 bbcba3ed 2022-01-10 op number /= scale_factors[i];
99 bbcba3ed 2022-01-10 op if (i > 0)
100 bbcba3ed 2022-01-10 op fract /= scale_factors[i - 1];
101 bbcba3ed 2022-01-10 op break;
102 bbcba3ed 2022-01-10 op }
103 bbcba3ed 2022-01-10 op }
104 bbcba3ed 2022-01-10 op
105 bbcba3ed 2022-01-10 op fract = (10 * fract + 512) / 1024;
106 bbcba3ed 2022-01-10 op /* if the result would be >= 10, round main number */
107 bbcba3ed 2022-01-10 op if (fract >= 10) {
108 bbcba3ed 2022-01-10 op if (number >= 0)
109 bbcba3ed 2022-01-10 op number++;
110 bbcba3ed 2022-01-10 op else
111 bbcba3ed 2022-01-10 op number--;
112 bbcba3ed 2022-01-10 op fract = 0;
113 bbcba3ed 2022-01-10 op } else if (fract < 0) {
114 bbcba3ed 2022-01-10 op /* shouldn't happen */
115 bbcba3ed 2022-01-10 op fract = 0;
116 bbcba3ed 2022-01-10 op }
117 bbcba3ed 2022-01-10 op
118 bbcba3ed 2022-01-10 op if (number == 0)
119 bbcba3ed 2022-01-10 op strlcpy(result, "0B", FMT_SCALED_STRSIZE);
120 bbcba3ed 2022-01-10 op else if (unit == NONE || number >= 100 || number <= -100) {
121 bbcba3ed 2022-01-10 op if (fract >= 5) {
122 bbcba3ed 2022-01-10 op if (number >= 0)
123 bbcba3ed 2022-01-10 op number++;
124 bbcba3ed 2022-01-10 op else
125 bbcba3ed 2022-01-10 op number--;
126 bbcba3ed 2022-01-10 op }
127 bbcba3ed 2022-01-10 op (void)snprintf(result, FMT_SCALED_STRSIZE, "%lld%c",
128 bbcba3ed 2022-01-10 op number, scale_chars[unit]);
129 bbcba3ed 2022-01-10 op } else
130 bbcba3ed 2022-01-10 op (void)snprintf(result, FMT_SCALED_STRSIZE, "%lld.%1lld%c",
131 bbcba3ed 2022-01-10 op number, fract, scale_chars[unit]);
132 bbcba3ed 2022-01-10 op
133 bbcba3ed 2022-01-10 op return 0;
134 bbcba3ed 2022-01-10 op }
135 bbcba3ed 2022-01-10 op
136 bbcba3ed 2022-01-10 op #ifdef MAIN
137 bbcba3ed 2022-01-10 op /*
138 bbcba3ed 2022-01-10 op * This is the original version of the program in the man page.
139 bbcba3ed 2022-01-10 op * Copy-and-paste whatever you need from it.
140 bbcba3ed 2022-01-10 op */
141 bbcba3ed 2022-01-10 op int
142 bbcba3ed 2022-01-10 op main(int argc, char **argv)
143 bbcba3ed 2022-01-10 op {
144 bbcba3ed 2022-01-10 op char *cinput = "1.5K", buf[FMT_SCALED_STRSIZE];
145 bbcba3ed 2022-01-10 op long long ninput = 10483892, result;
146 bbcba3ed 2022-01-10 op
147 bbcba3ed 2022-01-10 op if (scan_scaled(cinput, &result) == 0)
148 bbcba3ed 2022-01-10 op printf("\"%s\" -> %lld\n", cinput, result);
149 bbcba3ed 2022-01-10 op else
150 bbcba3ed 2022-01-10 op perror(cinput);
151 bbcba3ed 2022-01-10 op
152 bbcba3ed 2022-01-10 op if (fmt_scaled(ninput, buf) == 0)
153 bbcba3ed 2022-01-10 op printf("%lld -> \"%s\"\n", ninput, buf);
154 bbcba3ed 2022-01-10 op else
155 bbcba3ed 2022-01-10 op fprintf(stderr, "%lld invalid (%s)\n", ninput, strerror(errno));
156 bbcba3ed 2022-01-10 op
157 bbcba3ed 2022-01-10 op return 0;
158 bbcba3ed 2022-01-10 op }
159 bbcba3ed 2022-01-10 op #endif