src/base/strings/safe_sprintf_unittest.cc

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "base/strings/safe_sprintf.h"
   6
   7 #include <stdio.h>
   8 #include <string.h>
   9
  10 #include <limits>
  11
  12 #include "base/logging.h"
  13 #include "base/memory/scoped_ptr.h"
  14 #include "testing/gtest/include/gtest/gtest.h"
  15
  16 // Death tests on Android are currently very flaky. No need to add more flaky
  17 // tests, as they just make it hard to spot real problems.
  18 // TODO(markus): See if the restrictions on Android can eventually be lifted.
  19 #if defined(GTEST_HAS_DEATH_TEST) && !defined(OS_ANDROID)
  20 #define ALLOW_DEATH_TEST
  21 #endif
  22
  23 namespace base {
  24 namespace strings {
  25
  26 TEST(SafeSPrintfTest, Empty) {
  27   char buf[2] = { 'X', 'X' };
  28
  29   // Negative buffer size should always result in an error.
  30   EXPECT_EQ(-1, SafeSNPrintf(buf, static_cast<size_t>(-1), ""));
  31   EXPECT_EQ('X', buf[0]);
  32   EXPECT_EQ('X', buf[1]);
  33
  34   // Zero buffer size should always result in an error.
  35   EXPECT_EQ(-1, SafeSNPrintf(buf, 0, ""));
  36   EXPECT_EQ('X', buf[0]);
  37   EXPECT_EQ('X', buf[1]);
  38
  39   // A one-byte buffer should always print a single NUL byte.
  40   EXPECT_EQ(0, SafeSNPrintf(buf, 1, ""));
  41   EXPECT_EQ(0, buf[0]);
  42   EXPECT_EQ('X', buf[1]);
  43   buf[0] = 'X';
  44
  45   // A larger buffer should leave the trailing bytes unchanged.
  46   EXPECT_EQ(0, SafeSNPrintf(buf, 2, ""));
  47   EXPECT_EQ(0, buf[0]);
  48   EXPECT_EQ('X', buf[1]);
  49   buf[0] = 'X';
  50
  51   // The same test using SafeSPrintf() instead of SafeSNPrintf().
  52   EXPECT_EQ(0, SafeSPrintf(buf, ""));
  53   EXPECT_EQ(0, buf[0]);
  54   EXPECT_EQ('X', buf[1]);
  55   buf[0] = 'X';
  56 }
  57
  58 TEST(SafeSPrintfTest, NoArguments) {
  59   // Output a text message that doesn't require any substitutions. This
  60   // is roughly equivalent to calling strncpy() (but unlike strncpy(), it does
  61   // always add a trailing NUL; it always deduplicates '%' characters).
  62   static const char text[] = "hello world";
  63   char ref[20], buf[20];
  64   memset(ref, 'X', sizeof(char) * arraysize(buf));
  65   memcpy(buf, ref, sizeof(buf));
  66
  67   // A negative buffer size should always result in an error.
  68   EXPECT_EQ(-1, SafeSNPrintf(buf, static_cast<size_t>(-1), text));
  69   EXPECT_TRUE(!memcmp(buf, ref, sizeof(buf)));
  70
  71   // Zero buffer size should always result in an error.
  72   EXPECT_EQ(-1, SafeSNPrintf(buf, 0, text));
  73   EXPECT_TRUE(!memcmp(buf, ref, sizeof(buf)));
  74
  75   // A one-byte buffer should always print a single NUL byte.
  76   EXPECT_EQ(static_cast<ssize_t>(sizeof(text))-1, SafeSNPrintf(buf, 1, text));
  77   EXPECT_EQ(0, buf[0]);
  78   EXPECT_TRUE(!memcmp(buf+1, ref+1, sizeof(buf)-1));
  79   memcpy(buf, ref, sizeof(buf));
  80
  81   // A larger (but limited) buffer should always leave the trailing bytes
  82   // unchanged.
  83   EXPECT_EQ(static_cast<ssize_t>(sizeof(text))-1, SafeSNPrintf(buf, 2, text));
  84   EXPECT_EQ(text[0], buf[0]);
  85   EXPECT_EQ(0, buf[1]);
  86   EXPECT_TRUE(!memcmp(buf+2, ref+2, sizeof(buf)-2));
  87   memcpy(buf, ref, sizeof(buf));
  88
  89   // A unrestricted buffer length should always leave the trailing bytes
  90   // unchanged.
  91   EXPECT_EQ(static_cast<ssize_t>(sizeof(text))-1,
  92             SafeSNPrintf(buf, sizeof(buf), text));
  93   EXPECT_EQ(std::string(text), std::string(buf));
  94   EXPECT_TRUE(!memcmp(buf + sizeof(text), ref + sizeof(text),
  95                       sizeof(buf) - sizeof(text)));
  96   memcpy(buf, ref, sizeof(buf));
  97
  98   // The same test using SafeSPrintf() instead of SafeSNPrintf().
  99   EXPECT_EQ(static_cast<ssize_t>(sizeof(text))-1, SafeSPrintf(buf, text));
 100   EXPECT_EQ(std::string(text), std::string(buf));
 101   EXPECT_TRUE(!memcmp(buf + sizeof(text), ref + sizeof(text),
 102                       sizeof(buf) - sizeof(text)));
 103   memcpy(buf, ref, sizeof(buf));
 104
 105   // Check for deduplication of '%' percent characters.
 106   EXPECT_EQ(1, SafeSPrintf(buf, "%%"));
 107   EXPECT_EQ(2, SafeSPrintf(buf, "%%%%"));
 108   EXPECT_EQ(2, SafeSPrintf(buf, "%%X"));
 109   EXPECT_EQ(3, SafeSPrintf(buf, "%%%%X"));
 110 #if defined(NDEBUG)
 111   EXPECT_EQ(1, SafeSPrintf(buf, "%"));
 112   EXPECT_EQ(2, SafeSPrintf(buf, "%%%"));
 113   EXPECT_EQ(2, SafeSPrintf(buf, "%X"));
 114   EXPECT_EQ(3, SafeSPrintf(buf, "%%%X"));
 115 #elif defined(ALLOW_DEATH_TEST)
 116   EXPECT_DEATH(SafeSPrintf(buf, "%"), "src.1. == '%'");
 117   EXPECT_DEATH(SafeSPrintf(buf, "%%%"), "src.1. == '%'");
 118   EXPECT_DEATH(SafeSPrintf(buf, "%X"), "src.1. == '%'");
 119   EXPECT_DEATH(SafeSPrintf(buf, "%%%X"), "src.1. == '%'");
 120 #endif
 121 }
 122
 123 TEST(SafeSPrintfTest, OneArgument) {
 124   // Test basic single-argument single-character substitution.
 125   const char text[] = "hello world";
 126   const char fmt[]  = "hello%cworld";
 127   char ref[20], buf[20];
 128   memset(ref, 'X', sizeof(buf));
 129   memcpy(buf, ref, sizeof(buf));
 130
 131   // A negative buffer size should always result in an error.
 132   EXPECT_EQ(-1, SafeSNPrintf(buf, static_cast<size_t>(-1), fmt, ' '));
 133   EXPECT_TRUE(!memcmp(buf, ref, sizeof(buf)));
 134
 135   // Zero buffer size should always result in an error.
 136   EXPECT_EQ(-1, SafeSNPrintf(buf, 0, fmt, ' '));
 137   EXPECT_TRUE(!memcmp(buf, ref, sizeof(buf)));
 138
 139   // A one-byte buffer should always print a single NUL byte.
 140   EXPECT_EQ(static_cast<ssize_t>(sizeof(text))-1,
 141             SafeSNPrintf(buf, 1, fmt, ' '));
 142   EXPECT_EQ(0, buf[0]);
 143   EXPECT_TRUE(!memcmp(buf+1, ref+1, sizeof(buf)-1));
 144   memcpy(buf, ref, sizeof(buf));
 145
 146   // A larger (but limited) buffer should always leave the trailing bytes
 147   // unchanged.
 148   EXPECT_EQ(static_cast<ssize_t>(sizeof(text))-1,
 149             SafeSNPrintf(buf, 2, fmt, ' '));
 150   EXPECT_EQ(text[0], buf[0]);
 151   EXPECT_EQ(0, buf[1]);
 152   EXPECT_TRUE(!memcmp(buf+2, ref+2, sizeof(buf)-2));
 153   memcpy(buf, ref, sizeof(buf));
 154
 155   // A unrestricted buffer length should always leave the trailing bytes
 156   // unchanged.
 157   EXPECT_EQ(static_cast<ssize_t>(sizeof(text))-1,
 158             SafeSNPrintf(buf, sizeof(buf), fmt, ' '));
 159   EXPECT_EQ(std::string(text), std::string(buf));
 160   EXPECT_TRUE(!memcmp(buf + sizeof(text), ref + sizeof(text),
 161                       sizeof(buf) - sizeof(text)));
 162   memcpy(buf, ref, sizeof(buf));
 163
 164   // The same test using SafeSPrintf() instead of SafeSNPrintf().
 165   EXPECT_EQ(static_cast<ssize_t>(sizeof(text))-1, SafeSPrintf(buf, fmt, ' '));
 166   EXPECT_EQ(std::string(text), std::string(buf));
 167   EXPECT_TRUE(!memcmp(buf + sizeof(text), ref + sizeof(text),
 168                       sizeof(buf) - sizeof(text)));
 169   memcpy(buf, ref, sizeof(buf));
 170
 171   // Check for deduplication of '%' percent characters.
 172   EXPECT_EQ(1, SafeSPrintf(buf, "%%", 0));
 173   EXPECT_EQ(2, SafeSPrintf(buf, "%%%%", 0));
 174   EXPECT_EQ(2, SafeSPrintf(buf, "%Y", 0));
 175   EXPECT_EQ(2, SafeSPrintf(buf, "%%Y", 0));
 176   EXPECT_EQ(3, SafeSPrintf(buf, "%%%Y", 0));
 177   EXPECT_EQ(3, SafeSPrintf(buf, "%%%%Y", 0));
 178 #if defined(NDEBUG)
 179   EXPECT_EQ(1, SafeSPrintf(buf, "%", 0));
 180   EXPECT_EQ(2, SafeSPrintf(buf, "%%%", 0));
 181 #elif defined(ALLOW_DEATH_TEST)
 182   EXPECT_DEATH(SafeSPrintf(buf, "%", 0), "ch");
 183   EXPECT_DEATH(SafeSPrintf(buf, "%%%", 0), "ch");
 184 #endif
 185 }
 186
 187 TEST(SafeSPrintfTest, MissingArg) {
 188 #if defined(NDEBUG)
 189   char buf[20];
 190   EXPECT_EQ(3, SafeSPrintf(buf, "%c%c", 'A'));
 191   EXPECT_EQ("A%c", std::string(buf));
 192 #elif defined(ALLOW_DEATH_TEST)
 193   char buf[20];
 194   EXPECT_DEATH(SafeSPrintf(buf, "%c%c", 'A'), "cur_arg < max_args");
 195 #endif
 196 }
 197
 198 TEST(SafeSPrintfTest, ASANFriendlyBufferTest) {
 199   // Print into a buffer that is sized exactly to size. ASAN can verify that
 200   // nobody attempts to write past the end of the buffer.
 201   // There is a more complicated test in PrintLongString() that covers a lot
 202   // more edge case, but it is also harder to debug in case of a failure.
 203   const char kTestString[] = "This is a test";
 204   scoped_ptr<char[]> buf(new char[sizeof(kTestString)]);
 205   EXPECT_EQ(static_cast<ssize_t>(sizeof(kTestString) - 1),
 206             SafeSNPrintf(buf.get(), sizeof(kTestString), kTestString));
 207   EXPECT_EQ(std::string(kTestString), std::string(buf.get()));
 208   EXPECT_EQ(static_cast<ssize_t>(sizeof(kTestString) - 1),
 209             SafeSNPrintf(buf.get(), sizeof(kTestString), "%s", kTestString));
 210   EXPECT_EQ(std::string(kTestString), std::string(buf.get()));
 211 }
 212
 213 TEST(SafeSPrintfTest, NArgs) {
 214   // Pre-C++11 compilers have a different code path, that can only print
 215   // up to ten distinct arguments.
 216   // We test both SafeSPrintf() and SafeSNPrintf(). This makes sure we don't
 217   // have typos in the copy-n-pasted code that is needed to deal with various
 218   // numbers of arguments.
 219   char buf[12];
 220   EXPECT_EQ(1, SafeSPrintf(buf, "%c", 1));
 221   EXPECT_EQ("\1", std::string(buf));
 222   EXPECT_EQ(2, SafeSPrintf(buf, "%c%c", 1, 2));
 223   EXPECT_EQ("\1\2", std::string(buf));
 224   EXPECT_EQ(3, SafeSPrintf(buf, "%c%c%c", 1, 2, 3));
 225   EXPECT_EQ("\1\2\3", std::string(buf));
 226   EXPECT_EQ(4, SafeSPrintf(buf, "%c%c%c%c", 1, 2, 3, 4));
 227   EXPECT_EQ("\1\2\3\4", std::string(buf));
 228   EXPECT_EQ(5, SafeSPrintf(buf, "%c%c%c%c%c", 1, 2, 3, 4, 5));
 229   EXPECT_EQ("\1\2\3\4\5", std::string(buf));
 230   EXPECT_EQ(6, SafeSPrintf(buf, "%c%c%c%c%c%c", 1, 2, 3, 4, 5, 6));
 231   EXPECT_EQ("\1\2\3\4\5\6", std::string(buf));
 232   EXPECT_EQ(7, SafeSPrintf(buf, "%c%c%c%c%c%c%c", 1, 2, 3, 4, 5, 6, 7));
 233   EXPECT_EQ("\1\2\3\4\5\6\7", std::string(buf));
 234   EXPECT_EQ(8, SafeSPrintf(buf, "%c%c%c%c%c%c%c%c", 1, 2, 3, 4, 5, 6, 7, 8));
 235   EXPECT_EQ("\1\2\3\4\5\6\7\10", std::string(buf));
 236   EXPECT_EQ(9, SafeSPrintf(buf, "%c%c%c%c%c%c%c%c%c",
 237                            1, 2, 3, 4, 5, 6, 7, 8, 9));
 238   EXPECT_EQ("\1\2\3\4\5\6\7\10\11", std::string(buf));
 239   EXPECT_EQ(10, SafeSPrintf(buf, "%c%c%c%c%c%c%c%c%c%c",
 240                             1, 2, 3, 4, 5, 6, 7, 8, 9, 10));
 241
 242   // Repeat all the tests with SafeSNPrintf() instead of SafeSPrintf().
 243   EXPECT_EQ("\1\2\3\4\5\6\7\10\11\12", std::string(buf));
 244   EXPECT_EQ(1, SafeSNPrintf(buf, 11, "%c", 1));
 245   EXPECT_EQ("\1", std::string(buf));
 246   EXPECT_EQ(2, SafeSNPrintf(buf, 11, "%c%c", 1, 2));
 247   EXPECT_EQ("\1\2", std::string(buf));
 248   EXPECT_EQ(3, SafeSNPrintf(buf, 11, "%c%c%c", 1, 2, 3));
 249   EXPECT_EQ("\1\2\3", std::string(buf));
 250   EXPECT_EQ(4, SafeSNPrintf(buf, 11, "%c%c%c%c", 1, 2, 3, 4));
 251   EXPECT_EQ("\1\2\3\4", std::string(buf));
 252   EXPECT_EQ(5, SafeSNPrintf(buf, 11, "%c%c%c%c%c", 1, 2, 3, 4, 5));
 253   EXPECT_EQ("\1\2\3\4\5", std::string(buf));
 254   EXPECT_EQ(6, SafeSNPrintf(buf, 11, "%c%c%c%c%c%c", 1, 2, 3, 4, 5, 6));
 255   EXPECT_EQ("\1\2\3\4\5\6", std::string(buf));
 256   EXPECT_EQ(7, SafeSNPrintf(buf, 11, "%c%c%c%c%c%c%c", 1, 2, 3, 4, 5, 6, 7));
 257   EXPECT_EQ("\1\2\3\4\5\6\7", std::string(buf));
 258   EXPECT_EQ(8, SafeSNPrintf(buf, 11, "%c%c%c%c%c%c%c%c",
 259                             1, 2, 3, 4, 5, 6, 7, 8));
 260   EXPECT_EQ("\1\2\3\4\5\6\7\10", std::string(buf));
 261   EXPECT_EQ(9, SafeSNPrintf(buf, 11, "%c%c%c%c%c%c%c%c%c",
 262                             1, 2, 3, 4, 5, 6, 7, 8, 9));
 263   EXPECT_EQ("\1\2\3\4\5\6\7\10\11", std::string(buf));
 264   EXPECT_EQ(10, SafeSNPrintf(buf, 11, "%c%c%c%c%c%c%c%c%c%c",
 265                              1, 2, 3, 4, 5, 6, 7, 8, 9, 10));
 266   EXPECT_EQ("\1\2\3\4\5\6\7\10\11\12", std::string(buf));
 267
 268   EXPECT_EQ(11, SafeSPrintf(buf, "%c%c%c%c%c%c%c%c%c%c%c",
 269                             1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11));
 270   EXPECT_EQ("\1\2\3\4\5\6\7\10\11\12\13", std::string(buf));
 271   EXPECT_EQ(11, SafeSNPrintf(buf, 12, "%c%c%c%c%c%c%c%c%c%c%c",
 272                              1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11));
 273   EXPECT_EQ("\1\2\3\4\5\6\7\10\11\12\13", std::string(buf));
 274 }
 275
 276 TEST(SafeSPrintfTest, DataTypes) {
 277   char buf[40];
 278
 279   // Bytes
 280   EXPECT_EQ(1, SafeSPrintf(buf, "%d", (uint8_t)1));
 281   EXPECT_EQ("1", std::string(buf));
 282   EXPECT_EQ(3, SafeSPrintf(buf, "%d", (uint8_t)-1));
 283   EXPECT_EQ("255", std::string(buf));
 284   EXPECT_EQ(1, SafeSPrintf(buf, "%d", (int8_t)1));
 285   EXPECT_EQ("1", std::string(buf));
 286   EXPECT_EQ(2, SafeSPrintf(buf, "%d", (int8_t)-1));
 287   EXPECT_EQ("-1", std::string(buf));
 288   EXPECT_EQ(4, SafeSPrintf(buf, "%d", (int8_t)-128));
 289   EXPECT_EQ("-128", std::string(buf));
 290
 291   // Half-words
 292   EXPECT_EQ(1, SafeSPrintf(buf, "%d", (uint16_t)1));
 293   EXPECT_EQ("1", std::string(buf));
 294   EXPECT_EQ(5, SafeSPrintf(buf, "%d", (uint16_t)-1));
 295   EXPECT_EQ("65535", std::string(buf));
 296   EXPECT_EQ(1, SafeSPrintf(buf, "%d", (int16_t)1));
 297   EXPECT_EQ("1", std::string(buf));
 298   EXPECT_EQ(2, SafeSPrintf(buf, "%d", (int16_t)-1));
 299   EXPECT_EQ("-1", std::string(buf));
 300   EXPECT_EQ(6, SafeSPrintf(buf, "%d", (int16_t)-32768));
 301   EXPECT_EQ("-32768", std::string(buf));
 302
 303   // Words
 304   EXPECT_EQ(1, SafeSPrintf(buf, "%d", (uint32_t)1));
 305   EXPECT_EQ("1", std::string(buf));
 306   EXPECT_EQ(10, SafeSPrintf(buf, "%d", (uint32_t)-1));
 307   EXPECT_EQ("4294967295", std::string(buf));
 308   EXPECT_EQ(1, SafeSPrintf(buf, "%d", (int32_t)1));
 309   EXPECT_EQ("1", std::string(buf));
 310   EXPECT_EQ(2, SafeSPrintf(buf, "%d", (int32_t)-1));
 311   EXPECT_EQ("-1", std::string(buf));
 312   // Work-around for an limitation of C90
 313   EXPECT_EQ(11, SafeSPrintf(buf, "%d", (int32_t)-2147483647-1));
 314   EXPECT_EQ("-2147483648", std::string(buf));
 315
 316   // Quads
 317   EXPECT_EQ(1, SafeSPrintf(buf, "%d", (uint64_t)1));
 318   EXPECT_EQ("1", std::string(buf));
 319   EXPECT_EQ(20, SafeSPrintf(buf, "%d", (uint64_t)-1));
 320   EXPECT_EQ("18446744073709551615", std::string(buf));
 321   EXPECT_EQ(1, SafeSPrintf(buf, "%d", (int64_t)1));
 322   EXPECT_EQ("1", std::string(buf));
 323   EXPECT_EQ(2, SafeSPrintf(buf, "%d", (int64_t)-1));
 324   EXPECT_EQ("-1", std::string(buf));
 325   // Work-around for an limitation of C90
 326   EXPECT_EQ(20, SafeSPrintf(buf, "%d", (int64_t)-9223372036854775807LL-1));
 327   EXPECT_EQ("-9223372036854775808", std::string(buf));
 328
 329   // Strings (both const and mutable).
 330   EXPECT_EQ(4, SafeSPrintf(buf, "test"));
 331   EXPECT_EQ("test", std::string(buf));
 332   EXPECT_EQ(4, SafeSPrintf(buf, buf));
 333   EXPECT_EQ("test", std::string(buf));
 334
 335   // Pointer
 336   char addr[20];
 337   sprintf(addr, "0x%llX", (unsigned long long)(uintptr_t)buf);
 338   SafeSPrintf(buf, "%p", buf);
 339   EXPECT_EQ(std::string(addr), std::string(buf));
 340   SafeSPrintf(buf, "%p", (const char *)buf);
 341   EXPECT_EQ(std::string(addr), std::string(buf));
 342   sprintf(addr, "0x%llX", (unsigned long long)(uintptr_t)sprintf);
 343   SafeSPrintf(buf, "%p", sprintf);
 344   EXPECT_EQ(std::string(addr), std::string(buf));
 345
 346   // Padding for pointers is a little more complicated because of the "0x"
 347   // prefix. Padding with '0' zeros is relatively straight-forward, but
 348   // padding with ' ' spaces requires more effort.
 349   sprintf(addr, "0x%017llX", (unsigned long long)(uintptr_t)buf);
 350   SafeSPrintf(buf, "%019p", buf);
 351   EXPECT_EQ(std::string(addr), std::string(buf));
 352   sprintf(addr, "0x%llX", (unsigned long long)(uintptr_t)buf);
 353   memset(addr, ' ',
 354          (char*)memmove(addr + sizeof(addr) - strlen(addr) - 1,
 355                         addr, strlen(addr)+1) - addr);
 356   SafeSPrintf(buf, "%19p", buf);
 357   EXPECT_EQ(std::string(addr), std::string(buf));
 358 }
 359
 360 namespace {
 361 void PrintLongString(char* buf, size_t sz) {
 362   // Output a reasonably complex expression into a limited-size buffer.
 363   // At least one byte is available for writing the NUL character.
 364   CHECK_GT(sz, static_cast<size_t>(0));
 365
 366   // Allocate slightly more space, so that we can verify that SafeSPrintf()
 367   // never writes past the end of the buffer.
 368   scoped_ptr<char[]> tmp(new char[sz+2]);
 369   memset(tmp.get(), 'X', sz+2);
 370
 371   // Use SafeSPrintf() to output a complex list of arguments:
 372   // - test padding and truncating %c single characters.
 373   // - test truncating %s simple strings.
 374   // - test mismatching arguments and truncating (for %d != %s).
 375   // - test zero-padding and truncating %x hexadecimal numbers.
 376   // - test outputting and truncating %d MININT.
 377   // - test outputting and truncating %p arbitrary pointer values.
 378   // - test outputting, padding and truncating NULL-pointer %s strings.
 379   char* out = tmp.get();
 380   size_t out_sz = sz;
 381   size_t len;
 382   for (scoped_ptr<char[]> perfect_buf;;) {
 383     size_t needed = SafeSNPrintf(out, out_sz,
 384 #if defined(NDEBUG)
 385                             "A%2cong %s: %d %010X %d %p%7s", 'l', "string", "",
 386 #else
 387                             "A%2cong %s: %%d %010X %d %p%7s", 'l', "string",
 388 #endif
 389                             0xDEADBEEF, std::numeric_limits<intptr_t>::min(),
 390                             PrintLongString, static_cast<char*>(NULL)) + 1;
 391
 392     // Various sanity checks:
 393     // The numbered of characters needed to print the full string should always
 394     // be bigger or equal to the bytes that have actually been output.
 395     len = strlen(tmp.get());
 396     CHECK_GE(needed, len+1);
 397
 398     // The number of characters output should always fit into the buffer that
 399     // was passed into SafeSPrintf().
 400     CHECK_LT(len, out_sz);
 401
 402     // The output is always terminated with a NUL byte (actually, this test is
 403     // always going to pass, as strlen() already verified this)
 404     EXPECT_FALSE(tmp[len]);
 405
 406     // ASAN can check that we are not overwriting buffers, iff we make sure the
 407     // buffer is exactly the size that we are expecting to be written. After
 408     // running SafeSNPrintf() the first time, it is possible to compute the
 409     // correct buffer size for this test. So, allocate a second buffer and run
 410     // the exact same SafeSNPrintf() command again.
 411     if (!perfect_buf.get()) {
 412       out_sz = std::min(needed, sz);
 413       out = new char[out_sz];
 414       perfect_buf.reset(out);
 415     } else {
 416       break;
 417     }
 418   }
 419
 420   // All trailing bytes are unchanged.
 421   for (size_t i = len+1; i < sz+2; ++i)
 422     EXPECT_EQ('X', tmp[i]);
 423
 424   // The text that was generated by SafeSPrintf() should always match the
 425   // equivalent text generated by sprintf(). Please note that the format
 426   // string for sprintf() is not complicated, as it does not have the
 427   // benefit of getting type information from the C++ compiler.
 428   //
 429   // N.B.: It would be so much cleaner to use snprintf(). But unfortunately,
 430   //       Visual Studio doesn't support this function, and the work-arounds
 431   //       are all really awkward.
 432   char ref[256];
 433   CHECK_LE(sz, sizeof(ref));
 434   sprintf(ref, "A long string: %%d 00DEADBEEF %lld 0x%llX <NULL>",
 435           static_cast<long long>(std::numeric_limits<intptr_t>::min()),
 436           static_cast<unsigned long long>(
 437             reinterpret_cast<uintptr_t>(PrintLongString)));
 438   ref[sz-1] = '\000';
 439
 440 #if defined(NDEBUG)
 441   const size_t kSSizeMax = std::numeric_limits<ssize_t>::max();
 442 #else
 443   const size_t kSSizeMax = internal::GetSafeSPrintfSSizeMaxForTest();
 444 #endif
 445
 446   // Compare the output from SafeSPrintf() to the one from sprintf().
 447   EXPECT_EQ(std::string(ref).substr(0, kSSizeMax-1), std::string(tmp.get()));
 448
 449   // We allocated a slightly larger buffer, so that we could perform some
 450   // extra sanity checks. Now that the tests have all passed, we copy the
 451   // data to the output buffer that the caller provided.
 452   memcpy(buf, tmp.get(), len+1);
 453 }
 454
 455 #if !defined(NDEBUG)
 456 class ScopedSafeSPrintfSSizeMaxSetter {
 457  public:
 458   ScopedSafeSPrintfSSizeMaxSetter(size_t sz) {
 459     old_ssize_max_ = internal::GetSafeSPrintfSSizeMaxForTest();
 460     internal::SetSafeSPrintfSSizeMaxForTest(sz);
 461   }
 462
 463   ~ScopedSafeSPrintfSSizeMaxSetter() {
 464     internal::SetSafeSPrintfSSizeMaxForTest(old_ssize_max_);
 465   }
 466
 467  private:
 468   size_t old_ssize_max_;
 469
 470   DISALLOW_COPY_AND_ASSIGN(ScopedSafeSPrintfSSizeMaxSetter);
 471 };
 472 #endif
 473
 474 }  // anonymous namespace
 475
 476 TEST(SafeSPrintfTest, Truncation) {
 477   // We use PrintLongString() to print a complex long string and then
 478   // truncate to all possible lengths. This ends up exercising a lot of
 479   // different code paths in SafeSPrintf() and IToASCII(), as truncation can
 480   // happen in a lot of different states.
 481   char ref[256];
 482   PrintLongString(ref, sizeof(ref));
 483   for (size_t i = strlen(ref)+1; i; --i) {
 484     char buf[sizeof(ref)];
 485     PrintLongString(buf, i);
 486     EXPECT_EQ(std::string(ref, i - 1), std::string(buf));
 487   }
 488
 489   // When compiling in debug mode, we have the ability to fake a small
 490   // upper limit for the maximum value that can be stored in an ssize_t.
 491   // SafeSPrintf() uses this upper limit to determine how many bytes it will
 492   // write to the buffer, even if the caller claimed a bigger buffer size.
 493   // Repeat the truncation test and verify that this other code path in
 494   // SafeSPrintf() works correctly, too.
 495 #if !defined(NDEBUG)
 496   for (size_t i = strlen(ref)+1; i > 1; --i) {
 497     ScopedSafeSPrintfSSizeMaxSetter ssize_max_setter(i);
 498     char buf[sizeof(ref)];
 499     PrintLongString(buf, sizeof(buf));
 500     EXPECT_EQ(std::string(ref, i - 1), std::string(buf));
 501   }
 502
 503   // kSSizeMax is also used to constrain the maximum amount of padding, before
 504   // SafeSPrintf() detects an error in the format string.
 505   ScopedSafeSPrintfSSizeMaxSetter ssize_max_setter(100);
 506   char buf[256];
 507   EXPECT_EQ(99, SafeSPrintf(buf, "%99c", ' '));
 508   EXPECT_EQ(std::string(99, ' '), std::string(buf));
 509   *buf = '\000';
 510 #if defined(ALLOW_DEATH_TEST)
 511   EXPECT_DEATH(SafeSPrintf(buf, "%100c", ' '), "padding <= max_padding");
 512 #endif
 513   EXPECT_EQ(0, *buf);
 514 #endif
 515 }
 516
 517 TEST(SafeSPrintfTest, Padding) {
 518   char buf[40], fmt[40];
 519
 520   // Chars %c
 521   EXPECT_EQ(1, SafeSPrintf(buf, "%c", 'A'));
 522   EXPECT_EQ("A", std::string(buf));
 523   EXPECT_EQ(2, SafeSPrintf(buf, "%2c", 'A'));
 524   EXPECT_EQ(" A", std::string(buf));
 525   EXPECT_EQ(2, SafeSPrintf(buf, "%02c", 'A'));
 526   EXPECT_EQ(" A", std::string(buf));
 527   EXPECT_EQ(4, SafeSPrintf(buf, "%-2c", 'A'));
 528   EXPECT_EQ("%-2c", std::string(buf));
 529   SafeSPrintf(fmt, "%%%dc", std::numeric_limits<ssize_t>::max() - 1);
 530   EXPECT_EQ(std::numeric_limits<ssize_t>::max()-1, SafeSPrintf(buf, fmt, 'A'));
 531   SafeSPrintf(fmt, "%%%dc",
 532               static_cast<size_t>(std::numeric_limits<ssize_t>::max()));
 533 #if defined(NDEBUG)
 534   EXPECT_EQ(2, SafeSPrintf(buf, fmt, 'A'));
 535   EXPECT_EQ("%c", std::string(buf));
 536 #elif defined(ALLOW_DEATH_TEST)
 537   EXPECT_DEATH(SafeSPrintf(buf, fmt, 'A'), "padding <= max_padding");
 538 #endif
 539
 540   // Octal %o
 541   EXPECT_EQ(1, SafeSPrintf(buf, "%o", 1));
 542   EXPECT_EQ("1", std::string(buf));
 543   EXPECT_EQ(2, SafeSPrintf(buf, "%2o", 1));
 544   EXPECT_EQ(" 1", std::string(buf));
 545   EXPECT_EQ(2, SafeSPrintf(buf, "%02o", 1));
 546   EXPECT_EQ("01", std::string(buf));
 547   EXPECT_EQ(12, SafeSPrintf(buf, "%12o", -1));
 548   EXPECT_EQ(" 37777777777", std::string(buf));
 549   EXPECT_EQ(12, SafeSPrintf(buf, "%012o", -1));
 550   EXPECT_EQ("037777777777", std::string(buf));
 551   EXPECT_EQ(23, SafeSPrintf(buf, "%23o", -1LL));
 552   EXPECT_EQ(" 1777777777777777777777", std::string(buf));
 553   EXPECT_EQ(23, SafeSPrintf(buf, "%023o", -1LL));
 554   EXPECT_EQ("01777777777777777777777", std::string(buf));
 555   EXPECT_EQ(3, SafeSPrintf(buf, "%2o", 0111));
 556   EXPECT_EQ("111", std::string(buf));
 557   EXPECT_EQ(4, SafeSPrintf(buf, "%-2o", 1));
 558   EXPECT_EQ("%-2o", std::string(buf));
 559   SafeSPrintf(fmt, "%%%do", std::numeric_limits<ssize_t>::max()-1);
 560   EXPECT_EQ(std::numeric_limits<ssize_t>::max()-1,
 561             SafeSNPrintf(buf, 4, fmt, 1));
 562   EXPECT_EQ("   ", std::string(buf));
 563   SafeSPrintf(fmt, "%%0%do", std::numeric_limits<ssize_t>::max()-1);
 564   EXPECT_EQ(std::numeric_limits<ssize_t>::max()-1,
 565             SafeSNPrintf(buf, 4, fmt, 1));
 566   EXPECT_EQ("000", std::string(buf));
 567   SafeSPrintf(fmt, "%%%do",
 568               static_cast<size_t>(std::numeric_limits<ssize_t>::max()));
 569 #if defined(NDEBUG)
 570   EXPECT_EQ(2, SafeSPrintf(buf, fmt, 1));
 571   EXPECT_EQ("%o", std::string(buf));
 572 #elif defined(ALLOW_DEATH_TEST)
 573   EXPECT_DEATH(SafeSPrintf(buf, fmt, 1), "padding <= max_padding");
 574 #endif
 575
 576   // Decimals %d
 577   EXPECT_EQ(1, SafeSPrintf(buf, "%d", 1));
 578   EXPECT_EQ("1", std::string(buf));
 579   EXPECT_EQ(2, SafeSPrintf(buf, "%2d", 1));
 580   EXPECT_EQ(" 1", std::string(buf));
 581   EXPECT_EQ(2, SafeSPrintf(buf, "%02d", 1));
 582   EXPECT_EQ("01", std::string(buf));
 583   EXPECT_EQ(3, SafeSPrintf(buf, "%3d", -1));
 584   EXPECT_EQ(" -1", std::string(buf));
 585   EXPECT_EQ(3, SafeSPrintf(buf, "%03d", -1));
 586   EXPECT_EQ("-01", std::string(buf));
 587   EXPECT_EQ(3, SafeSPrintf(buf, "%2d", 111));
 588   EXPECT_EQ("111", std::string(buf));
 589   EXPECT_EQ(4, SafeSPrintf(buf, "%2d", -111));
 590   EXPECT_EQ("-111", std::string(buf));
 591   EXPECT_EQ(4, SafeSPrintf(buf, "%-2d", 1));
 592   EXPECT_EQ("%-2d", std::string(buf));
 593   SafeSPrintf(fmt, "%%%dd", std::numeric_limits<ssize_t>::max()-1);
 594   EXPECT_EQ(std::numeric_limits<ssize_t>::max()-1,
 595             SafeSNPrintf(buf, 4, fmt, 1));
 596   EXPECT_EQ("   ", std::string(buf));
 597   SafeSPrintf(fmt, "%%0%dd", std::numeric_limits<ssize_t>::max()-1);
 598   EXPECT_EQ(std::numeric_limits<ssize_t>::max()-1,
 599             SafeSNPrintf(buf, 4, fmt, 1));
 600   EXPECT_EQ("000", std::string(buf));
 601   SafeSPrintf(fmt, "%%%dd",
 602               static_cast<size_t>(std::numeric_limits<ssize_t>::max()));
 603 #if defined(NDEBUG)
 604   EXPECT_EQ(2, SafeSPrintf(buf, fmt, 1));
 605   EXPECT_EQ("%d", std::string(buf));
 606 #elif defined(ALLOW_DEATH_TEST)
 607   EXPECT_DEATH(SafeSPrintf(buf, fmt, 1), "padding <= max_padding");
 608 #endif
 609
 610   // Hex %X
 611   EXPECT_EQ(1, SafeSPrintf(buf, "%X", 1));
 612   EXPECT_EQ("1", std::string(buf));
 613   EXPECT_EQ(2, SafeSPrintf(buf, "%2X", 1));
 614   EXPECT_EQ(" 1", std::string(buf));
 615   EXPECT_EQ(2, SafeSPrintf(buf, "%02X", 1));
 616   EXPECT_EQ("01", std::string(buf));
 617   EXPECT_EQ(9, SafeSPrintf(buf, "%9X", -1));
 618   EXPECT_EQ(" FFFFFFFF", std::string(buf));
 619   EXPECT_EQ(9, SafeSPrintf(buf, "%09X", -1));
 620   EXPECT_EQ("0FFFFFFFF", std::string(buf));
 621   EXPECT_EQ(17, SafeSPrintf(buf, "%17X", -1LL));
 622   EXPECT_EQ(" FFFFFFFFFFFFFFFF", std::string(buf));
 623   EXPECT_EQ(17, SafeSPrintf(buf, "%017X", -1LL));
 624   EXPECT_EQ("0FFFFFFFFFFFFFFFF", std::string(buf));
 625   EXPECT_EQ(3, SafeSPrintf(buf, "%2X", 0x111));
 626   EXPECT_EQ("111", std::string(buf));
 627   EXPECT_EQ(4, SafeSPrintf(buf, "%-2X", 1));
 628   EXPECT_EQ("%-2X", std::string(buf));
 629   SafeSPrintf(fmt, "%%%dX", std::numeric_limits<ssize_t>::max()-1);
 630   EXPECT_EQ(std::numeric_limits<ssize_t>::max()-1,
 631             SafeSNPrintf(buf, 4, fmt, 1));
 632   EXPECT_EQ("   ", std::string(buf));
 633   SafeSPrintf(fmt, "%%0%dX", std::numeric_limits<ssize_t>::max()-1);
 634   EXPECT_EQ(std::numeric_limits<ssize_t>::max()-1,
 635             SafeSNPrintf(buf, 4, fmt, 1));
 636   EXPECT_EQ("000", std::string(buf));
 637   SafeSPrintf(fmt, "%%%dX",
 638               static_cast<size_t>(std::numeric_limits<ssize_t>::max()));
 639 #if defined(NDEBUG)
 640   EXPECT_EQ(2, SafeSPrintf(buf, fmt, 1));
 641   EXPECT_EQ("%X", std::string(buf));
 642 #elif defined(ALLOW_DEATH_TEST)
 643   EXPECT_DEATH(SafeSPrintf(buf, fmt, 1), "padding <= max_padding");
 644 #endif
 645
 646   // Pointer %p
 647   EXPECT_EQ(3, SafeSPrintf(buf, "%p", (void*)1));
 648   EXPECT_EQ("0x1", std::string(buf));
 649   EXPECT_EQ(4, SafeSPrintf(buf, "%4p", (void*)1));
 650   EXPECT_EQ(" 0x1", std::string(buf));
 651   EXPECT_EQ(4, SafeSPrintf(buf, "%04p", (void*)1));
 652   EXPECT_EQ("0x01", std::string(buf));
 653   EXPECT_EQ(5, SafeSPrintf(buf, "%4p", (void*)0x111));
 654   EXPECT_EQ("0x111", std::string(buf));
 655   EXPECT_EQ(4, SafeSPrintf(buf, "%-2p", (void*)1));
 656   EXPECT_EQ("%-2p", std::string(buf));
 657   SafeSPrintf(fmt, "%%%dp", std::numeric_limits<ssize_t>::max()-1);
 658   EXPECT_EQ(std::numeric_limits<ssize_t>::max()-1,
 659             SafeSNPrintf(buf, 4, fmt, (void*)1));
 660   EXPECT_EQ("   ", std::string(buf));
 661   SafeSPrintf(fmt, "%%0%dp", std::numeric_limits<ssize_t>::max()-1);
 662   EXPECT_EQ(std::numeric_limits<ssize_t>::max()-1,
 663             SafeSNPrintf(buf, 4, fmt, (void*)1));
 664   EXPECT_EQ("0x0", std::string(buf));
 665   SafeSPrintf(fmt, "%%%dp",
 666               static_cast<size_t>(std::numeric_limits<ssize_t>::max()));
 667 #if defined(NDEBUG)
 668   EXPECT_EQ(2, SafeSPrintf(buf, fmt, 1));
 669   EXPECT_EQ("%p", std::string(buf));
 670 #elif defined(ALLOW_DEATH_TEST)
 671   EXPECT_DEATH(SafeSPrintf(buf, fmt, 1), "padding <= max_padding");
 672 #endif
 673
 674   // String
 675   EXPECT_EQ(1, SafeSPrintf(buf, "%s", "A"));
 676   EXPECT_EQ("A", std::string(buf));
 677   EXPECT_EQ(2, SafeSPrintf(buf, "%2s", "A"));
 678   EXPECT_EQ(" A", std::string(buf));
 679   EXPECT_EQ(2, SafeSPrintf(buf, "%02s", "A"));
 680   EXPECT_EQ(" A", std::string(buf));
 681   EXPECT_EQ(3, SafeSPrintf(buf, "%2s", "AAA"));
 682   EXPECT_EQ("AAA", std::string(buf));
 683   EXPECT_EQ(4, SafeSPrintf(buf, "%-2s", "A"));
 684   EXPECT_EQ("%-2s", std::string(buf));
 685   SafeSPrintf(fmt, "%%%ds", std::numeric_limits<ssize_t>::max()-1);
 686   EXPECT_EQ(std::numeric_limits<ssize_t>::max()-1,
 687             SafeSNPrintf(buf, 4, fmt, "A"));
 688   EXPECT_EQ("   ", std::string(buf));
 689   SafeSPrintf(fmt, "%%0%ds", std::numeric_limits<ssize_t>::max()-1);
 690   EXPECT_EQ(std::numeric_limits<ssize_t>::max()-1,
 691             SafeSNPrintf(buf, 4, fmt, "A"));
 692   EXPECT_EQ("   ", std::string(buf));
 693   SafeSPrintf(fmt, "%%%ds",
 694               static_cast<size_t>(std::numeric_limits<ssize_t>::max()));
 695 #if defined(NDEBUG)
 696   EXPECT_EQ(2, SafeSPrintf(buf, fmt, "A"));
 697   EXPECT_EQ("%s", std::string(buf));
 698 #elif defined(ALLOW_DEATH_TEST)
 699   EXPECT_DEATH(SafeSPrintf(buf, fmt, "A"), "padding <= max_padding");
 700 #endif
 701 }
 702
 703 TEST(SafeSPrintfTest, EmbeddedNul) {
 704   char buf[] = { 'X', 'X', 'X', 'X' };
 705   EXPECT_EQ(2, SafeSPrintf(buf, "%3c", 0));
 706   EXPECT_EQ(' ', buf[0]);
 707   EXPECT_EQ(' ', buf[1]);
 708   EXPECT_EQ(0,   buf[2]);
 709   EXPECT_EQ('X', buf[3]);
 710
 711   // Check handling of a NUL format character. N.B. this takes two different
 712   // code paths depending on whether we are actually passing arguments. If
 713   // we don't have any arguments, we are running in the fast-path code, that
 714   // looks (almost) like a strncpy().
 715 #if defined(NDEBUG)
 716   EXPECT_EQ(2, SafeSPrintf(buf, "%%%"));
 717   EXPECT_EQ("%%", std::string(buf));
 718   EXPECT_EQ(2, SafeSPrintf(buf, "%%%", 0));
 719   EXPECT_EQ("%%", std::string(buf));
 720 #elif defined(ALLOW_DEATH_TEST)
 721   EXPECT_DEATH(SafeSPrintf(buf, "%%%"), "src.1. == '%'");
 722   EXPECT_DEATH(SafeSPrintf(buf, "%%%", 0), "ch");
 723 #endif
 724 }
 725
 726 TEST(SafeSPrintfTest, EmitNULL) {
 727   char buf[40];
 728 #if defined(__GNUC__)
 729 #pragma GCC diagnostic push
 730 #pragma GCC diagnostic ignored "-Wconversion-null"
 731 #endif
 732   EXPECT_EQ(1, SafeSPrintf(buf, "%d", NULL));
 733   EXPECT_EQ("0", std::string(buf));
 734   EXPECT_EQ(3, SafeSPrintf(buf, "%p", NULL));
 735   EXPECT_EQ("0x0", std::string(buf));
 736   EXPECT_EQ(6, SafeSPrintf(buf, "%s", NULL));
 737   EXPECT_EQ("<NULL>", std::string(buf));
 738 #if defined(__GCC__)
 739 #pragma GCC diagnostic pop
 740 #endif
 741 }
 742
 743 TEST(SafeSPrintfTest, PointerSize) {
 744   // The internal data representation is a 64bit value, independent of the
 745   // native word size. We want to perform sign-extension for signed integers,
 746   // but we want to avoid doing so for pointer types. This could be a
 747   // problem on systems, where pointers are only 32bit. This tests verifies
 748   // that there is no such problem.
 749   char *str = reinterpret_cast<char *>(0x80000000u);
 750   void *ptr = str;
 751   char buf[40];
 752   EXPECT_EQ(10, SafeSPrintf(buf, "%p", str));
 753   EXPECT_EQ("0x80000000", std::string(buf));
 754   EXPECT_EQ(10, SafeSPrintf(buf, "%p", ptr));
 755   EXPECT_EQ("0x80000000", std::string(buf));
 756 }
 757
 758 }  // namespace strings
 759 }  // namespace base