]> git.ozlabs.org Git - ccan/blobdiff - ccan/tally/tally.c
tally: Adapt tally_num to Samba coding conventions
[ccan] / ccan / tally / tally.c
index 1433a3aa2650e45cf2bfc44c3bce646400f8dfba..52bd4e11b903b661360390bd1c96dc34a875ed2b 100644 (file)
@@ -1,4 +1,4 @@
-#include "config.h"
+/* Licensed under LGPLv3+ - see LICENSE file for details */
 #include <ccan/tally/tally.h>
 #include <ccan/build_assert/build_assert.h>
 #include <ccan/likely/likely.h>
@@ -7,57 +7,55 @@
 #include <string.h>
 #include <stdio.h>
 #include <assert.h>
+#include <stdlib.h>
 
-#define MAX_STEP_BITS (sizeof(size_t)*CHAR_BIT)
+#define SIZET_BITS (sizeof(size_t)*CHAR_BIT)
 
 /* We use power of 2 steps.  I tried being tricky, but it got buggy. */
 struct tally {
        ssize_t min, max;
        size_t total[2];
        /* This allows limited frequency analysis. */
-       size_t buckets;
-       size_t step_bits;
-       size_t counts[1 /* [buckets] */ ];
+       unsigned buckets, step_bits;
+       size_t counts[1 /* Actually: [buckets] */ ];
 };
 
-struct tally *tally_new(size_t buckets)
+struct tally *tally_new(unsigned buckets)
 {
        struct tally *tally;
 
-       /* Check for overflow. */
-       if (buckets && SIZE_MAX / buckets < sizeof(tally->counts[0]))
+       /* There is always 1 bucket. */
+       if (buckets == 0) {
+               buckets = 1;
+       }
+
+       /* Overly cautious check for overflow. */
+       if (sizeof(*tally) * buckets / sizeof(*tally) != buckets) {
+               return NULL;
+       }
+
+       tally = (struct tally *)malloc(
+               sizeof(*tally) + sizeof(tally->counts[0])*(buckets-1));
+       if (tally == NULL) {
                return NULL;
-       tally = malloc(sizeof(*tally) + sizeof(tally->counts[0])*buckets);
-       if (tally) {
-               /* SSIZE_MAX isn't portable, so make it one of these types. */
-               BUILD_ASSERT(sizeof(tally->min) == sizeof(int)
-                            || sizeof(tally->min) == sizeof(long)
-                            || sizeof(tally->min) == sizeof(long long));
-               if (sizeof(tally->min) == sizeof(int)) {
-                       tally->min = INT_MAX;
-                       tally->max = INT_MIN;
-               } else if (sizeof(tally->min) == sizeof(long)) {
-                       tally->min = LONG_MAX;
-                       tally->max = LONG_MIN;
-               } else if (sizeof(tally->min) == sizeof(long long)) {
-                       tally->min = (ssize_t)LLONG_MAX;
-                       tally->max = (ssize_t)LLONG_MIN;
-               }
-               tally->total[0] = tally->total[1] = 0;
-               /* There is always 1 bucket. */
-               tally->buckets = buckets+1;
-               tally->step_bits = 0;
-               memset(tally->counts, 0, sizeof(tally->counts[0])*(buckets+1));
        }
+
+       tally->max = ((size_t)1 << (SIZET_BITS - 1));
+       tally->min = ~tally->max;
+       tally->total[0] = tally->total[1] = 0;
+       tally->buckets = buckets;
+       tally->step_bits = 0;
+       memset(tally->counts, 0, sizeof(tally->counts[0])*buckets);
        return tally;
 }
 
 static unsigned bucket_of(ssize_t min, unsigned step_bits, ssize_t val)
 {
        /* Don't over-shift. */
-       if (step_bits == MAX_STEP_BITS)
+       if (step_bits == SIZET_BITS) {
                return 0;
-       assert(step_bits < MAX_STEP_BITS);
+       }
+       assert(step_bits < SIZET_BITS);
        return (size_t)(val - min) >> step_bits;
 }
 
@@ -65,17 +63,19 @@ static unsigned bucket_of(ssize_t min, unsigned step_bits, ssize_t val)
 static ssize_t bucket_min(ssize_t min, unsigned step_bits, unsigned b)
 {
        /* Don't over-shift. */
-       if (step_bits == MAX_STEP_BITS)
+       if (step_bits == SIZET_BITS) {
                return min;
-       assert(step_bits < MAX_STEP_BITS);
+       }
+       assert(step_bits < SIZET_BITS);
        return min + ((ssize_t)b << step_bits);
 }
 
 /* Does shifting by this many bits truncate the number? */
 static bool shift_overflows(size_t num, unsigned bits)
 {
-       if (bits == 0)
+       if (bits == 0) {
                return false;
+       }
 
        return ((num << bits) >> 1) != (num << (bits - 1));
 }
@@ -88,8 +88,9 @@ static void renormalize(struct tally *tally,
        unsigned int i, old_min;
 
        /* Uninitialized?  Don't do anything... */
-       if (tally->max < tally->min)
+       if (tally->max < tally->min) {
                goto update;
+       }
 
        /* If we don't have sufficient range, increase step bits until
         * buckets cover entire range of ssize_t anyway. */
@@ -137,15 +138,17 @@ void tally_add(struct tally *tally, ssize_t val)
                new_max = val;
                need_renormalize = true;
        }
-       if (need_renormalize)
+       if (need_renormalize) {
                renormalize(tally, new_min, new_max);
+       }
 
        /* 128-bit arithmetic!  If we didn't want exact mean, we could just
         * pull it out of counts. */
-       if (val > 0 && tally->total[0] + val < tally->total[0])
+       if (val > 0 && tally->total[0] + val < tally->total[0]) {
                tally->total[1]++;
-       else if (val < 0 && tally->total[0] + val > tally->total[0])
+       } else if (val < 0 && tally->total[0] + val > tally->total[0]) {
                tally->total[1]--;
+       }
        tally->total[0] += val;
        tally->counts[bucket_of(tally->min, tally->step_bits, val)]++;
 }
@@ -153,8 +156,9 @@ void tally_add(struct tally *tally, ssize_t val)
 size_t tally_num(const struct tally *tally)
 {
        size_t i, num = 0;
-       for (i = 0; i < tally->buckets; i++)
+       for (i = 0; i < tally->buckets; i++) {
                num += tally->counts[i];
+       }
        return num;
 }
 
@@ -324,6 +328,33 @@ ssize_t tally_mean(const struct tally *tally)
        return divls64(tally->total[1], tally->total[0], count);
 }
 
+ssize_t tally_total(const struct tally *tally, ssize_t *overflow)
+{
+       if (overflow) {
+               *overflow = tally->total[1];
+               return tally->total[0];
+       }
+
+       /* If result is negative, make sure we can represent it. */
+       if (tally->total[1] & ((size_t)1 << (SIZET_BITS-1))) {
+               /* Must have only underflowed once, and must be able to
+                * represent result at ssize_t. */
+               if ((~tally->total[1])+1 != 0
+                   || (ssize_t)tally->total[0] >= 0) {
+                       /* Underflow, return minimum. */
+                       return (ssize_t)((size_t)1 << (SIZET_BITS - 1));
+               }
+       } else {
+               /* Result is positive, must not have overflowed, and must be
+                * able to represent as ssize_t. */
+               if (tally->total[1] || (ssize_t)tally->total[0] < 0) {
+                       /* Overflow.  Return maximum. */
+                       return (ssize_t)~((size_t)1 << (SIZET_BITS - 1));
+               }
+       }
+       return tally->total[0];
+}
+
 static ssize_t bucket_range(const struct tally *tally, unsigned b, size_t *err)
 {
        ssize_t min, max;
@@ -408,7 +439,7 @@ char *tally_histogram(const struct tally *tally,
        } else {
                /* We create a temporary then renormalize so < height. */
                /* FIXME: Antialias properly! */
-               tmp = tally_new(tally->buckets-1);
+               tmp = tally_new(tally->buckets);
                if (!tmp)
                        return NULL;
                tmp->min = tally->min;
@@ -417,7 +448,7 @@ char *tally_histogram(const struct tally *tally,
                memcpy(tmp->counts, tally->counts,
                       sizeof(tally->counts[0]) * tmp->buckets);
                while ((max_bucket = get_max_bucket(tmp)) >= height)
-                       renormalize(tmp, tmp->min, tmp->max *= 2);
+                       renormalize(tmp, tmp->min, tmp->max * 2);
                /* Restore max */
                tmp->max = tally->max;
                tally = tmp;
@@ -431,28 +462,37 @@ char *tally_histogram(const struct tally *tally,
                        largest_bucket = tally->counts[i];
        }
 
-       p = graph = malloc(height * (width + 1) + 1);
+       p = graph = (char *)malloc(height * (width + 1) + 1);
        if (!graph) {
                free(tmp);
                return NULL;
        }
+
        for (i = 0; i < height; i++) {
-               unsigned covered = 0;
-               count = (double)tally->counts[i] / largest_bucket * width;
+               unsigned covered = 1, row;
 
-               if (i == 0)
+               /* People expect minimum at the bottom. */
+               row = height - i - 1;
+               count = (double)tally->counts[row] / largest_bucket * (width-1)+1;
+
+               if (row == 0)
                        covered = snprintf(p, width, "%zi", tally->min);
-               else if (i == height - 1)
+               else if (row == height - 1)
                        covered = snprintf(p, width, "%zi", tally->max);
-               if (covered) {
-                       if (covered > width)
-                               covered = width;
-                       p += covered;
-                       if (count > covered)
-                               count -= covered;
-                       else
-                               count = 0;
-               }
+               else if (row == bucket_of(tally->min, tally->step_bits, 0))
+                       *p = '+';
+               else
+                       *p = '|';
+
+               if (covered > width)
+                       covered = width;
+               p += covered;
+
+               if (count > covered)
+                       count -= covered;
+               else
+                       count = 0;
+
                memset(p, '*', count);
                p += count;
                *p = '\n';