folly/String.cpp

   1 /*
   2  * Copyright 2015 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <folly/String.h>
  18
  19 #include <folly/Format.h>
  20 #include <folly/ScopeGuard.h>
  21
  22 #include <cerrno>
  23 #include <cstdarg>
  24 #include <cstring>
  25 #include <stdexcept>
  26 #include <iterator>
  27 #include <cctype>
  28 #include <string.h>
  29 #include <glog/logging.h>
  30
  31 namespace folly {
  32
  33 namespace {
  34
  35 int stringAppendfImplHelper(char* buf,
  36                             size_t bufsize,
  37                             const char* format,
  38                             va_list args) {
  39   va_list args_copy;
  40   va_copy(args_copy, args);
  41   int bytes_used = vsnprintf(buf, bufsize, format, args_copy);
  42   va_end(args_copy);
  43   return bytes_used;
  44 }
  45
  46 void stringAppendfImpl(std::string& output, const char* format, va_list args) {
  47   // Very simple; first, try to avoid an allocation by using an inline
  48   // buffer.  If that fails to hold the output string, allocate one on
  49   // the heap, use it instead.
  50   //
  51   // It is hard to guess the proper size of this buffer; some
  52   // heuristics could be based on the number of format characters, or
  53   // static analysis of a codebase.  Or, we can just pick a number
  54   // that seems big enough for simple cases (say, one line of text on
  55   // a terminal) without being large enough to be concerning as a
  56   // stack variable.
  57   std::array<char, 128> inline_buffer;
  58
  59   int bytes_used = stringAppendfImplHelper(
  60       inline_buffer.data(), inline_buffer.size(), format, args);
  61   if (bytes_used < 0) {
  62     throw std::runtime_error(to<std::string>(
  63         "Invalid format string; snprintf returned negative "
  64         "with format string: ",
  65         format));
  66   }
  67
  68   if (static_cast<size_t>(bytes_used) < inline_buffer.size()) {
  69     output.append(inline_buffer.data(), bytes_used);
  70     return;
  71   }
  72
  73   // Couldn't fit.  Heap allocate a buffer, oh well.
  74   std::unique_ptr<char[]> heap_buffer(new char[bytes_used + 1]);
  75   int final_bytes_used =
  76       stringAppendfImplHelper(heap_buffer.get(), bytes_used + 1, format, args);
  77   // The second call can take fewer bytes if, for example, we were printing a
  78   // string buffer with null-terminating char using a width specifier -
  79   // vsnprintf("%.*s", buf.size(), buf)
  80   CHECK(bytes_used >= final_bytes_used);
  81
  82   // We don't keep the trailing '\0' in our output string
  83   output.append(heap_buffer.get(), final_bytes_used);
  84 }
  85
  86 } // anon namespace
  87
  88 std::string stringPrintf(const char* format, ...) {
  89   va_list ap;
  90   va_start(ap, format);
  91   SCOPE_EXIT {
  92     va_end(ap);
  93   };
  94   return stringVPrintf(format, ap);
  95 }
  96
  97 std::string stringVPrintf(const char* format, va_list ap) {
  98   std::string ret;
  99   stringAppendfImpl(ret, format, ap);
 100   return ret;
 101 }
 102
 103 // Basic declarations; allow for parameters of strings and string
 104 // pieces to be specified.
 105 std::string& stringAppendf(std::string* output, const char* format, ...) {
 106   va_list ap;
 107   va_start(ap, format);
 108   SCOPE_EXIT {
 109     va_end(ap);
 110   };
 111   return stringVAppendf(output, format, ap);
 112 }
 113
 114 std::string& stringVAppendf(std::string* output,
 115                             const char* format,
 116                             va_list ap) {
 117   stringAppendfImpl(*output, format, ap);
 118   return *output;
 119 }
 120
 121 void stringPrintf(std::string* output, const char* format, ...) {
 122   va_list ap;
 123   va_start(ap, format);
 124   SCOPE_EXIT {
 125     va_end(ap);
 126   };
 127   return stringVPrintf(output, format, ap);
 128 }
 129
 130 void stringVPrintf(std::string* output, const char* format, va_list ap) {
 131   output->clear();
 132   stringAppendfImpl(*output, format, ap);
 133 };
 134
 135 namespace {
 136
 137 struct PrettySuffix {
 138   const char* suffix;
 139   double val;
 140 };
 141
 142 const PrettySuffix kPrettyTimeSuffixes[] = {
 143   { "s ", 1e0L },
 144   { "ms", 1e-3L },
 145   { "us", 1e-6L },
 146   { "ns", 1e-9L },
 147   { "ps", 1e-12L },
 148   { "s ", 0 },
 149   { 0, 0 },
 150 };
 151
 152 const PrettySuffix kPrettyBytesMetricSuffixes[] = {
 153   { "TB", 1e12L },
 154   { "GB", 1e9L },
 155   { "MB", 1e6L },
 156   { "kB", 1e3L },
 157   { "B ", 0L },
 158   { 0, 0 },
 159 };
 160
 161 const PrettySuffix kPrettyBytesBinarySuffixes[] = {
 162   { "TB", int64_t(1) << 40 },
 163   { "GB", int64_t(1) << 30 },
 164   { "MB", int64_t(1) << 20 },
 165   { "kB", int64_t(1) << 10 },
 166   { "B ", 0L },
 167   { 0, 0 },
 168 };
 169
 170 const PrettySuffix kPrettyBytesBinaryIECSuffixes[] = {
 171   { "TiB", int64_t(1) << 40 },
 172   { "GiB", int64_t(1) << 30 },
 173   { "MiB", int64_t(1) << 20 },
 174   { "KiB", int64_t(1) << 10 },
 175   { "B  ", 0L },
 176   { 0, 0 },
 177 };
 178
 179 const PrettySuffix kPrettyUnitsMetricSuffixes[] = {
 180   { "tril", 1e12L },
 181   { "bil",  1e9L },
 182   { "M",    1e6L },
 183   { "k",    1e3L },
 184   { " ",      0  },
 185   { 0, 0 },
 186 };
 187
 188 const PrettySuffix kPrettyUnitsBinarySuffixes[] = {
 189   { "T", int64_t(1) << 40 },
 190   { "G", int64_t(1) << 30 },
 191   { "M", int64_t(1) << 20 },
 192   { "k", int64_t(1) << 10 },
 193   { " ", 0 },
 194   { 0, 0 },
 195 };
 196
 197 const PrettySuffix kPrettyUnitsBinaryIECSuffixes[] = {
 198   { "Ti", int64_t(1) << 40 },
 199   { "Gi", int64_t(1) << 30 },
 200   { "Mi", int64_t(1) << 20 },
 201   { "Ki", int64_t(1) << 10 },
 202   { "  ", 0 },
 203   { 0, 0 },
 204 };
 205
 206 const PrettySuffix kPrettySISuffixes[] = {
 207   { "Y", 1e24L },
 208   { "Z", 1e21L },
 209   { "E", 1e18L },
 210   { "P", 1e15L },
 211   { "T", 1e12L },
 212   { "G", 1e9L },
 213   { "M", 1e6L },
 214   { "k", 1e3L },
 215   { "h", 1e2L },
 216   { "da", 1e1L },
 217   { "d", 1e-1L },
 218   { "c", 1e-2L },
 219   { "m", 1e-3L },
 220   { "u", 1e-6L },
 221   { "n", 1e-9L },
 222   { "p", 1e-12L },
 223   { "f", 1e-15L },
 224   { "a", 1e-18L },
 225   { "z", 1e-21L },
 226   { "y", 1e-24L },
 227   { " ", 0 },
 228   { 0, 0}
 229 };
 230
 231 const PrettySuffix* const kPrettySuffixes[PRETTY_NUM_TYPES] = {
 232   kPrettyTimeSuffixes,
 233   kPrettyBytesMetricSuffixes,
 234   kPrettyBytesBinarySuffixes,
 235   kPrettyBytesBinaryIECSuffixes,
 236   kPrettyUnitsMetricSuffixes,
 237   kPrettyUnitsBinarySuffixes,
 238   kPrettyUnitsBinaryIECSuffixes,
 239   kPrettySISuffixes,
 240 };
 241
 242 }  // namespace
 243
 244 std::string prettyPrint(double val, PrettyType type, bool addSpace) {
 245   char buf[100];
 246
 247   // pick the suffixes to use
 248   assert(type >= 0);
 249   assert(type < PRETTY_NUM_TYPES);
 250   const PrettySuffix* suffixes = kPrettySuffixes[type];
 251
 252   // find the first suffix we're bigger than -- then use it
 253   double abs_val = fabs(val);
 254   for (int i = 0; suffixes[i].suffix; ++i) {
 255     if (abs_val >= suffixes[i].val) {
 256       snprintf(buf, sizeof buf, "%.4g%s%s",
 257                (suffixes[i].val ? (val / suffixes[i].val)
 258                                 : val),
 259                (addSpace ? " " : ""),
 260                suffixes[i].suffix);
 261       return std::string(buf);
 262     }
 263   }
 264
 265   // no suffix, we've got a tiny value -- just print it in sci-notation
 266   snprintf(buf, sizeof buf, "%.4g", val);
 267   return std::string(buf);
 268 }
 269
 270 //TODO:
 271 //1) Benchmark & optimize
 272 double prettyToDouble(folly::StringPiece *const prettyString,
 273                       const PrettyType type) {
 274   double value = folly::to<double>(prettyString);
 275   while (prettyString->size() > 0 && std::isspace(prettyString->front())) {
 276     prettyString->advance(1); //Skipping spaces between number and suffix
 277   }
 278   const PrettySuffix* suffixes = kPrettySuffixes[type];
 279   int longestPrefixLen = -1;
 280   int bestPrefixId = -1;
 281   for (int j = 0 ; suffixes[j].suffix; ++j) {
 282     if (suffixes[j].suffix[0] == ' '){//Checking for " " -> number rule.
 283       if (longestPrefixLen == -1) {
 284         longestPrefixLen = 0; //No characters to skip
 285         bestPrefixId = j;
 286       }
 287     } else if (prettyString->startsWith(suffixes[j].suffix)) {
 288       int suffixLen = strlen(suffixes[j].suffix);
 289       //We are looking for a longest suffix matching prefix of the string
 290       //after numeric value. We need this in case suffixes have common prefix.
 291       if (suffixLen > longestPrefixLen) {
 292         longestPrefixLen = suffixLen;
 293         bestPrefixId = j;
 294       }
 295     }
 296   }
 297   if (bestPrefixId == -1) { //No valid suffix rule found
 298     throw std::invalid_argument(folly::to<std::string>(
 299             "Unable to parse suffix \"",
 300             prettyString->toString(), "\""));
 301   }
 302   prettyString->advance(longestPrefixLen);
 303   return suffixes[bestPrefixId].val ? value * suffixes[bestPrefixId].val :
 304                                       value;
 305 }
 306
 307 double prettyToDouble(folly::StringPiece prettyString, const PrettyType type){
 308   double result = prettyToDouble(&prettyString, type);
 309   detail::enforceWhitespace(prettyString.data(),
 310                             prettyString.data() + prettyString.size());
 311   return result;
 312 }
 313
 314 std::string hexDump(const void* ptr, size_t size) {
 315   std::ostringstream os;
 316   hexDump(ptr, size, std::ostream_iterator<StringPiece>(os, "\n"));
 317   return os.str();
 318 }
 319
 320 fbstring errnoStr(int err) {
 321   int savedErrno = errno;
 322
 323   // Ensure that we reset errno upon exit.
 324   auto guard(makeGuard([&] { errno = savedErrno; }));
 325
 326   char buf[1024];
 327   buf[0] = '\0';
 328
 329   fbstring result;
 330
 331   // https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man3/strerror_r.3.html
 332   // http://www.kernel.org/doc/man-pages/online/pages/man3/strerror.3.html
 333 #if defined(_WIN32) && (defined(__MINGW32__) || defined(_MSC_VER))
 334   // mingw64 has no strerror_r, but Windows has strerror_s, which C11 added
 335   // as well. So maybe we should use this across all platforms (together
 336   // with strerrorlen_s). Note strerror_r and _s have swapped args.
 337   int r = strerror_s(buf, sizeof(buf), err);
 338   if (r != 0) {
 339     result = to<fbstring>(
 340       "Unknown error ", err,
 341       " (strerror_r failed with error ", errno, ")");
 342   } else {
 343     result.assign(buf);
 344   }
 345 #elif defined(FOLLY_HAVE_XSI_STRERROR_R) || \
 346   defined(__APPLE__) || defined(__ANDROID__)
 347   // Using XSI-compatible strerror_r
 348   int r = strerror_r(err, buf, sizeof(buf));
 349
 350   // OSX/FreeBSD use EINVAL and Linux uses -1 so just check for non-zero
 351   if (r != 0) {
 352     result = to<fbstring>(
 353       "Unknown error ", err,
 354       " (strerror_r failed with error ", errno, ")");
 355   } else {
 356     result.assign(buf);
 357   }
 358 #else
 359   // Using GNU strerror_r
 360   result.assign(strerror_r(err, buf, sizeof(buf)));
 361 #endif
 362
 363   return result;
 364 }
 365
 366 namespace {
 367
 368 void toLowerAscii8(char& c) {
 369   // Branchless tolower, based on the input-rotating trick described
 370   // at http://www.azillionmonkeys.com/qed/asmexample.html
 371   //
 372   // This algorithm depends on an observation: each uppercase
 373   // ASCII character can be converted to its lowercase equivalent
 374   // by adding 0x20.
 375
 376   // Step 1: Clear the high order bit. We'll deal with it in Step 5.
 377   unsigned char rotated = c & 0x7f;
 378   // Currently, the value of rotated, as a function of the original c is:
 379   //   below 'A':   0- 64
 380   //   'A'-'Z':    65- 90
 381   //   above 'Z':  91-127
 382
 383   // Step 2: Add 0x25 (37)
 384   rotated += 0x25;
 385   // Now the value of rotated, as a function of the original c is:
 386   //   below 'A':   37-101
 387   //   'A'-'Z':    102-127
 388   //   above 'Z':  128-164
 389
 390   // Step 3: clear the high order bit
 391   rotated &= 0x7f;
 392   //   below 'A':   37-101
 393   //   'A'-'Z':    102-127
 394   //   above 'Z':    0- 36
 395
 396   // Step 4: Add 0x1a (26)
 397   rotated += 0x1a;
 398   //   below 'A':   63-127
 399   //   'A'-'Z':    128-153
 400   //   above 'Z':   25- 62
 401
 402   // At this point, note that only the uppercase letters have been
 403   // transformed into values with the high order bit set (128 and above).
 404
 405   // Step 5: Shift the high order bit 2 spaces to the right: the spot
 406   // where the only 1 bit in 0x20 is.  But first, how we ignored the
 407   // high order bit of the original c in step 1?  If that bit was set,
 408   // we may have just gotten a false match on a value in the range
 409   // 128+'A' to 128+'Z'.  To correct this, need to clear the high order
 410   // bit of rotated if the high order bit of c is set.  Since we don't
 411   // care about the other bits in rotated, the easiest thing to do
 412   // is invert all the bits in c and bitwise-and them with rotated.
 413   rotated &= ~c;
 414   rotated >>= 2;
 415
 416   // Step 6: Apply a mask to clear everything except the 0x20 bit
 417   // in rotated.
 418   rotated &= 0x20;
 419
 420   // At this point, rotated is 0x20 if c is 'A'-'Z' and 0x00 otherwise
 421
 422   // Step 7: Add rotated to c
 423   c += rotated;
 424 }
 425
 426 void toLowerAscii32(uint32_t& c) {
 427   // Besides being branchless, the algorithm in toLowerAscii8() has another
 428   // interesting property: None of the addition operations will cause
 429   // an overflow in the 8-bit value.  So we can pack four 8-bit values
 430   // into a uint32_t and run each operation on all four values in parallel
 431   // without having to use any CPU-specific SIMD instructions.
 432   uint32_t rotated = c & uint32_t(0x7f7f7f7fL);
 433   rotated += uint32_t(0x25252525L);
 434   rotated &= uint32_t(0x7f7f7f7fL);
 435   rotated += uint32_t(0x1a1a1a1aL);
 436
 437   // Step 5 involves a shift, so some bits will spill over from each
 438   // 8-bit value into the next.  But that's okay, because they're bits
 439   // that will be cleared by the mask in step 6 anyway.
 440   rotated &= ~c;
 441   rotated >>= 2;
 442   rotated &= uint32_t(0x20202020L);
 443   c += rotated;
 444 }
 445
 446 void toLowerAscii64(uint64_t& c) {
 447   // 64-bit version of toLower32
 448   uint64_t rotated = c & uint64_t(0x7f7f7f7f7f7f7f7fL);
 449   rotated += uint64_t(0x2525252525252525L);
 450   rotated &= uint64_t(0x7f7f7f7f7f7f7f7fL);
 451   rotated += uint64_t(0x1a1a1a1a1a1a1a1aL);
 452   rotated &= ~c;
 453   rotated >>= 2;
 454   rotated &= uint64_t(0x2020202020202020L);
 455   c += rotated;
 456 }
 457
 458 } // anon namespace
 459
 460 void toLowerAscii(char* str, size_t length) {
 461   static const size_t kAlignMask64 = 7;
 462   static const size_t kAlignMask32 = 3;
 463
 464   // Convert a character at a time until we reach an address that
 465   // is at least 32-bit aligned
 466   size_t n = (size_t)str;
 467   n &= kAlignMask32;
 468   n = std::min(n, length);
 469   size_t offset = 0;
 470   if (n != 0) {
 471     n = std::min(4 - n, length);
 472     do {
 473       toLowerAscii8(str[offset]);
 474       offset++;
 475     } while (offset < n);
 476   }
 477
 478   n = (size_t)(str + offset);
 479   n &= kAlignMask64;
 480   if ((n != 0) && (offset + 4 <= length)) {
 481     // The next address is 32-bit aligned but not 64-bit aligned.
 482     // Convert the next 4 bytes in order to get to the 64-bit aligned
 483     // part of the input.
 484     toLowerAscii32(*(uint32_t*)(str + offset));
 485     offset += 4;
 486   }
 487
 488   // Convert 8 characters at a time
 489   while (offset + 8 <= length) {
 490     toLowerAscii64(*(uint64_t*)(str + offset));
 491     offset += 8;
 492   }
 493
 494   // Convert 4 characters at a time
 495   while (offset + 4 <= length) {
 496     toLowerAscii32(*(uint32_t*)(str + offset));
 497     offset += 4;
 498   }
 499
 500   // Convert any characters remaining after the last 4-byte aligned group
 501   while (offset < length) {
 502     toLowerAscii8(str[offset]);
 503     offset++;
 504   }
 505 }
 506
 507 namespace detail {
 508
 509 size_t hexDumpLine(const void* ptr, size_t offset, size_t size,
 510                    std::string& line) {
 511   // Line layout:
 512   // 8: address
 513   // 1: space
 514   // (1+2)*16: hex bytes, each preceded by a space
 515   // 1: space separating the two halves
 516   // 3: "  |"
 517   // 16: characters
 518   // 1: "|"
 519   // Total: 78
 520   line.clear();
 521   line.reserve(78);
 522   const uint8_t* p = reinterpret_cast<const uint8_t*>(ptr) + offset;
 523   size_t n = std::min(size - offset, size_t(16));
 524   format("{:08x} ", offset).appendTo(line);
 525
 526   for (size_t i = 0; i < n; i++) {
 527     if (i == 8) {
 528       line.push_back(' ');
 529     }
 530     format(" {:02x}", p[i]).appendTo(line);
 531   }
 532
 533   // 3 spaces for each byte we're not printing, one separating the halves
 534   // if necessary
 535   line.append(3 * (16 - n) + (n <= 8), ' ');
 536   line.append("  |");
 537
 538   for (size_t i = 0; i < n; i++) {
 539     char c = (p[i] >= 32 && p[i] <= 126 ? static_cast<char>(p[i]) : '.');
 540     line.push_back(c);
 541   }
 542   line.append(16 - n, ' ');
 543   line.push_back('|');
 544   DCHECK_EQ(line.size(), 78);
 545
 546   return n;
 547 }
 548
 549 } // namespace detail
 550
 551 }   // namespace folly
 552
 553 #ifdef FOLLY_DEFINED_DMGL
 554 # undef FOLLY_DEFINED_DMGL
 555 # undef DMGL_NO_OPTS
 556 # undef DMGL_PARAMS
 557 # undef DMGL_ANSI
 558 # undef DMGL_JAVA
 559 # undef DMGL_VERBOSE
 560 # undef DMGL_TYPES
 561 # undef DMGL_RET_POSTFIX
 562 #endif