folly/String.cpp

   1 /*
   2  * Copyright 2014 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 <glog/logging.h>
  29
  30 namespace folly {
  31
  32 namespace {
  33
  34 inline void stringPrintfImpl(std::string& output, const char* format,
  35                              va_list args) {
  36   // Tru to the space at the end of output for our output buffer.
  37   // Find out write point then inflate its size temporarily to its
  38   // capacity; we will later shrink it to the size needed to represent
  39   // the formatted string.  If this buffer isn't large enough, we do a
  40   // resize and try again.
  41
  42   const auto write_point = output.size();
  43   auto remaining = output.capacity() - write_point;
  44   output.resize(output.capacity());
  45
  46   va_list args_copy;
  47   va_copy(args_copy, args);
  48   int bytes_used = vsnprintf(&output[write_point], remaining, format,
  49                              args_copy);
  50   va_end(args_copy);
  51   if (bytes_used < 0) {
  52     throw std::runtime_error(
  53       to<std::string>("Invalid format string; snprintf returned negative "
  54                       "with format string: ", format));
  55   } else if (bytes_used < remaining) {
  56     // There was enough room, just shrink and return.
  57     output.resize(write_point + bytes_used);
  58   } else {
  59     output.resize(write_point + bytes_used + 1);
  60     remaining = bytes_used + 1;
  61     va_list args_copy;
  62     va_copy(args_copy, args);
  63     bytes_used = vsnprintf(&output[write_point], remaining, format,
  64                            args_copy);
  65     va_end(args_copy);
  66     if (bytes_used + 1 != remaining) {
  67       throw std::runtime_error(
  68         to<std::string>("vsnprint retry did not manage to work "
  69                         "with format string: ", format));
  70     }
  71     output.resize(write_point + bytes_used);
  72   }
  73 }
  74
  75 }  // anon namespace
  76
  77 std::string stringPrintf(const char* format, ...) {
  78   va_list ap;
  79   va_start(ap, format);
  80   SCOPE_EXIT {
  81     va_end(ap);
  82   };
  83   return stringVPrintf(format, ap);
  84 }
  85
  86 std::string stringVPrintf(const char* format, va_list ap) {
  87   // snprintf will tell us how large the output buffer should be, but
  88   // we then have to call it a second time, which is costly.  By
  89   // guestimating the final size, we avoid the double snprintf in many
  90   // cases, resulting in a performance win.  We use this constructor
  91   // of std::string to avoid a double allocation, though it does pad
  92   // the resulting string with nul bytes.  Our guestimation is twice
  93   // the format string size, or 32 bytes, whichever is larger.  This
  94   // is a hueristic that doesn't affect correctness but attempts to be
  95   // reasonably fast for the most common cases.
  96   std::string ret(std::max(size_t(32), strlen(format) * 2), '\0');
  97   ret.resize(0);
  98
  99   stringPrintfImpl(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   stringPrintfImpl(*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   stringPrintfImpl(*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(__APPLE__) || defined(__FreeBSD__) ||\
 334     defined(__CYGWIN__) || defined(__ANDROID__) ||\
 335     ((_POSIX_C_SOURCE >= 200112L || _XOPEN_SOURCE >= 600) && !_GNU_SOURCE)
 336   // Using XSI-compatible strerror_r
 337   int r = strerror_r(err, buf, sizeof(buf));
 338
 339   // OSX/FreeBSD use EINVAL and Linux uses -1 so just check for non-zero
 340   if (r != 0) {
 341     result = to<fbstring>(
 342       "Unknown error ", err,
 343       " (strerror_r failed with error ", errno, ")");
 344   } else {
 345     result.assign(buf);
 346   }
 347 #else
 348   // Using GNU strerror_r
 349   result.assign(strerror_r(err, buf, sizeof(buf)));
 350 #endif
 351
 352   return result;
 353 }
 354
 355 StringPiece skipWhitespace(StringPiece sp) {
 356   // Spaces other than ' ' characters are less common but should be
 357   // checked.  This configuration where we loop on the ' '
 358   // separately from oddspaces was empirically fastest.
 359   auto oddspace = [] (char c) {
 360     return c == '\n' || c == '\t' || c == '\r';
 361   };
 362
 363 loop:
 364   for (; !sp.empty() && sp.front() == ' '; sp.pop_front()) {
 365   }
 366   if (!sp.empty() && oddspace(sp.front())) {
 367     sp.pop_front();
 368     goto loop;
 369   }
 370
 371   return sp;
 372 }
 373
 374 namespace {
 375
 376 void toLowerAscii8(char& c) {
 377   // Branchless tolower, based on the input-rotating trick described
 378   // at http://www.azillionmonkeys.com/qed/asmexample.html
 379   //
 380   // This algorithm depends on an observation: each uppercase
 381   // ASCII character can be converted to its lowercase equivalent
 382   // by adding 0x20.
 383
 384   // Step 1: Clear the high order bit. We'll deal with it in Step 5.
 385   unsigned char rotated = c & 0x7f;
 386   // Currently, the value of rotated, as a function of the original c is:
 387   //   below 'A':   0- 64
 388   //   'A'-'Z':    65- 90
 389   //   above 'Z':  91-127
 390
 391   // Step 2: Add 0x25 (37)
 392   rotated += 0x25;
 393   // Now the value of rotated, as a function of the original c is:
 394   //   below 'A':   37-101
 395   //   'A'-'Z':    102-127
 396   //   above 'Z':  128-164
 397
 398   // Step 3: clear the high order bit
 399   rotated &= 0x7f;
 400   //   below 'A':   37-101
 401   //   'A'-'Z':    102-127
 402   //   above 'Z':    0- 36
 403
 404   // Step 4: Add 0x1a (26)
 405   rotated += 0x1a;
 406   //   below 'A':   63-127
 407   //   'A'-'Z':    128-153
 408   //   above 'Z':   25- 62
 409
 410   // At this point, note that only the uppercase letters have been
 411   // transformed into values with the high order bit set (128 and above).
 412
 413   // Step 5: Shift the high order bit 2 spaces to the right: the spot
 414   // where the only 1 bit in 0x20 is.  But first, how we ignored the
 415   // high order bit of the original c in step 1?  If that bit was set,
 416   // we may have just gotten a false match on a value in the range
 417   // 128+'A' to 128+'Z'.  To correct this, need to clear the high order
 418   // bit of rotated if the high order bit of c is set.  Since we don't
 419   // care about the other bits in rotated, the easiest thing to do
 420   // is invert all the bits in c and bitwise-and them with rotated.
 421   rotated &= ~c;
 422   rotated >>= 2;
 423
 424   // Step 6: Apply a mask to clear everything except the 0x20 bit
 425   // in rotated.
 426   rotated &= 0x20;
 427
 428   // At this point, rotated is 0x20 if c is 'A'-'Z' and 0x00 otherwise
 429
 430   // Step 7: Add rotated to c
 431   c += rotated;
 432 }
 433
 434 void toLowerAscii32(uint32_t& c) {
 435   // Besides being branchless, the algorithm in toLowerAscii8() has another
 436   // interesting property: None of the addition operations will cause
 437   // an overflow in the 8-bit value.  So we can pack four 8-bit values
 438   // into a uint32_t and run each operation on all four values in parallel
 439   // without having to use any CPU-specific SIMD instructions.
 440   uint32_t rotated = c & uint32_t(0x7f7f7f7fL);
 441   rotated += uint32_t(0x25252525L);
 442   rotated &= uint32_t(0x7f7f7f7fL);
 443   rotated += uint32_t(0x1a1a1a1aL);
 444
 445   // Step 5 involves a shift, so some bits will spill over from each
 446   // 8-bit value into the next.  But that's okay, because they're bits
 447   // that will be cleared by the mask in step 6 anyway.
 448   rotated &= ~c;
 449   rotated >>= 2;
 450   rotated &= uint32_t(0x20202020L);
 451   c += rotated;
 452 }
 453
 454 void toLowerAscii64(uint64_t& c) {
 455   // 64-bit version of toLower32
 456   uint64_t rotated = c & uint64_t(0x7f7f7f7f7f7f7f7fL);
 457   rotated += uint64_t(0x2525252525252525L);
 458   rotated &= uint64_t(0x7f7f7f7f7f7f7f7fL);
 459   rotated += uint64_t(0x1a1a1a1a1a1a1a1aL);
 460   rotated &= ~c;
 461   rotated >>= 2;
 462   rotated &= uint64_t(0x2020202020202020L);
 463   c += rotated;
 464 }
 465
 466 } // anon namespace
 467
 468 void toLowerAscii(char* str, size_t length) {
 469   static const size_t kAlignMask64 = 7;
 470   static const size_t kAlignMask32 = 3;
 471
 472   // Convert a character at a time until we reach an address that
 473   // is at least 32-bit aligned
 474   size_t n = (size_t)str;
 475   n &= kAlignMask32;
 476   n = std::min(n, length);
 477   size_t offset = 0;
 478   if (n != 0) {
 479     n = std::min(4 - n, length);
 480     do {
 481       toLowerAscii8(str[offset]);
 482       offset++;
 483     } while (offset < n);
 484   }
 485
 486   n = (size_t)(str + offset);
 487   n &= kAlignMask64;
 488   if ((n != 0) && (offset + 4 <= length)) {
 489     // The next address is 32-bit aligned but not 64-bit aligned.
 490     // Convert the next 4 bytes in order to get to the 64-bit aligned
 491     // part of the input.
 492     toLowerAscii32(*(uint32_t*)(str + offset));
 493     offset += 4;
 494   }
 495
 496   // Convert 8 characters at a time
 497   while (offset + 8 <= length) {
 498     toLowerAscii64(*(uint64_t*)(str + offset));
 499     offset += 8;
 500   }
 501
 502   // Convert 4 characters at a time
 503   while (offset + 4 <= length) {
 504     toLowerAscii32(*(uint32_t*)(str + offset));
 505     offset += 4;
 506   }
 507
 508   // Convert any characters remaining after the last 4-byte aligned group
 509   while (offset < length) {
 510     toLowerAscii8(str[offset]);
 511     offset++;
 512   }
 513 }
 514
 515 namespace detail {
 516
 517 size_t hexDumpLine(const void* ptr, size_t offset, size_t size,
 518                    std::string& line) {
 519   // Line layout:
 520   // 8: address
 521   // 1: space
 522   // (1+2)*16: hex bytes, each preceded by a space
 523   // 1: space separating the two halves
 524   // 3: "  |"
 525   // 16: characters
 526   // 1: "|"
 527   // Total: 78
 528   line.clear();
 529   line.reserve(78);
 530   const uint8_t* p = reinterpret_cast<const uint8_t*>(ptr) + offset;
 531   size_t n = std::min(size - offset, size_t(16));
 532   format("{:08x} ", offset).appendTo(line);
 533
 534   for (size_t i = 0; i < n; i++) {
 535     if (i == 8) {
 536       line.push_back(' ');
 537     }
 538     format(" {:02x}", p[i]).appendTo(line);
 539   }
 540
 541   // 3 spaces for each byte we're not printing, one separating the halves
 542   // if necessary
 543   line.append(3 * (16 - n) + (n <= 8), ' ');
 544   line.append("  |");
 545
 546   for (size_t i = 0; i < n; i++) {
 547     char c = (p[i] >= 32 && p[i] <= 126 ? static_cast<char>(p[i]) : '.');
 548     line.push_back(c);
 549   }
 550   line.append(16 - n, ' ');
 551   line.push_back('|');
 552   DCHECK_EQ(line.size(), 78);
 553
 554   return n;
 555 }
 556
 557 } // namespace detail
 558
 559 }   // namespace folly
 560
 561 #ifdef FOLLY_DEFINED_DMGL
 562 # undef FOLLY_DEFINED_DMGL
 563 # undef DMGL_NO_OPTS
 564 # undef DMGL_PARAMS
 565 # undef DMGL_ANSI
 566 # undef DMGL_JAVA
 567 # undef DMGL_VERBOSE
 568 # undef DMGL_TYPES
 569 # undef DMGL_RET_POSTFIX
 570 #endif