decimal_width: avoid integer overflow

The decimal_width function originally appeared in blame.c as "lineno_width", and was designed for calculating the print-width of small-ish integer values (line numbers in text files). In ec7ff5b, it was made into a reusable function, and in dc801e7, we started using it to align diffstats. Binary files in a diffstat show byte counts rather than line numbers, meaning they can be quite large (e.g., consider adding or removing a 2GB file). decimal_width is not up to the challenge for two reasons: 1. It takes the value as an "int", whereas large files may easily surpass this. The value may be truncated, in which case we will produce an incorrect value. 2. It counts "up" by repeatedly multiplying another integer by 10 until it surpasses the value. This can cause an infinite loop when the value is close to the largest representable integer. For example, consider using a 32-bit signed integer, and a value of 2,140,000,000 (just shy of 2^31-1). We will count up and eventually see that 1,000,000,000 is smaller than our value. The next step would be to multiply by 10 and see that 10,000,000,000 is too large, ending the loop. But we can't represent that value, and we have signed overflow. This is technically undefined behavior, but a common behavior is to lose the high bits, in which case our iterator will certainly be less than the number. So we'll keep multiplying, overflow again, and so on. This patch changes the argument to a uintmax_t (the same type we use to store the diffstat information for binary filese), and counts "down" by repeatedly dividing our value by 10. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Jeff King committed Feb 5, 2015 at 03:14 UTC d306f3d3513c62342fec4e31457766f2473f9e9a
2 files changed +5 -5
cache.h
+1 -1
@@ -1213,7 +1213,7 @@ extern const char *pager_program;
1213 extern int pager_in_use(void);
1214 extern int pager_use_color;
1215 extern int term_columns(void);
1216 -extern int decimal_width(int);
1216 +extern int decimal_width(uintmax_t);
1217 extern int check_pager_config(const char *cmd);
1218
1219 extern const char *editor_program;
pager.c
+4 -4
@@ -139,12 +139,12 @@ int term_columns(void)
139 /*
140 * How many columns do we need to show this number in decimal?
141 */
142 -int decimal_width(int number)
142 +int decimal_width(uintmax_t number)
143 {
144 - int i, width;
144 + int width;
145
146 - for (width = 1, i = 10; i <= number; width++)
147 - i *= 10;
146 + for (width = 1; number >= 10; width++)
147 + number /= 10;
148 return width;
149 }
150