flags_parser.cpp 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164
  1. //===-- flags_parser.cpp ----------------------------------------*- C++ -*-===//
  2. //
  3. // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
  4. // See https://llvm.org/LICENSE.txt for license information.
  5. // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
  6. //
  7. //===----------------------------------------------------------------------===//
  8. #include "flags_parser.h"
  9. #include "common.h"
  10. #include "report.h"
  11. #include <stdlib.h>
  12. #include <string.h>
  13. namespace scudo {
  14. class UnknownFlagsRegistry {
  15. static const u32 MaxUnknownFlags = 16;
  16. const char *UnknownFlagsNames[MaxUnknownFlags];
  17. u32 NumberOfUnknownFlags;
  18. public:
  19. void add(const char *Name) {
  20. CHECK_LT(NumberOfUnknownFlags, MaxUnknownFlags);
  21. UnknownFlagsNames[NumberOfUnknownFlags++] = Name;
  22. }
  23. void report() {
  24. if (!NumberOfUnknownFlags)
  25. return;
  26. Printf("Scudo WARNING: found %d unrecognized flag(s):\n",
  27. NumberOfUnknownFlags);
  28. for (u32 I = 0; I < NumberOfUnknownFlags; ++I)
  29. Printf(" %s\n", UnknownFlagsNames[I]);
  30. NumberOfUnknownFlags = 0;
  31. }
  32. };
  33. static UnknownFlagsRegistry UnknownFlags;
  34. void reportUnrecognizedFlags() { UnknownFlags.report(); }
  35. void FlagParser::printFlagDescriptions() {
  36. Printf("Available flags for Scudo:\n");
  37. for (u32 I = 0; I < NumberOfFlags; ++I)
  38. Printf("\t%s\n\t\t- %s\n", Flags[I].Name, Flags[I].Desc);
  39. }
  40. static bool isSeparator(char C) {
  41. return C == ' ' || C == ',' || C == ':' || C == '\n' || C == '\t' ||
  42. C == '\r';
  43. }
  44. static bool isSeparatorOrNull(char C) { return !C || isSeparator(C); }
  45. void FlagParser::skipWhitespace() {
  46. while (isSeparator(Buffer[Pos]))
  47. ++Pos;
  48. }
  49. void FlagParser::parseFlag() {
  50. const uptr NameStart = Pos;
  51. while (Buffer[Pos] != '=' && !isSeparatorOrNull(Buffer[Pos]))
  52. ++Pos;
  53. if (Buffer[Pos] != '=')
  54. reportError("expected '='");
  55. const char *Name = Buffer + NameStart;
  56. const uptr ValueStart = ++Pos;
  57. const char *Value;
  58. if (Buffer[Pos] == '\'' || Buffer[Pos] == '"') {
  59. const char Quote = Buffer[Pos++];
  60. while (Buffer[Pos] != 0 && Buffer[Pos] != Quote)
  61. ++Pos;
  62. if (Buffer[Pos] == 0)
  63. reportError("unterminated string");
  64. Value = Buffer + ValueStart + 1;
  65. ++Pos; // consume the closing quote
  66. } else {
  67. while (!isSeparatorOrNull(Buffer[Pos]))
  68. ++Pos;
  69. Value = Buffer + ValueStart;
  70. }
  71. if (!runHandler(Name, Value))
  72. reportError("flag parsing failed.");
  73. }
  74. void FlagParser::parseFlags() {
  75. while (true) {
  76. skipWhitespace();
  77. if (Buffer[Pos] == 0)
  78. break;
  79. parseFlag();
  80. }
  81. }
  82. void FlagParser::parseString(const char *S) {
  83. if (!S)
  84. return;
  85. // Backup current parser state to allow nested parseString() calls.
  86. const char *OldBuffer = Buffer;
  87. const uptr OldPos = Pos;
  88. Buffer = S;
  89. Pos = 0;
  90. parseFlags();
  91. Buffer = OldBuffer;
  92. Pos = OldPos;
  93. }
  94. inline bool parseBool(const char *Value, bool *b) {
  95. if (strncmp(Value, "0", 1) == 0 || strncmp(Value, "no", 2) == 0 ||
  96. strncmp(Value, "false", 5) == 0) {
  97. *b = false;
  98. return true;
  99. }
  100. if (strncmp(Value, "1", 1) == 0 || strncmp(Value, "yes", 3) == 0 ||
  101. strncmp(Value, "true", 4) == 0) {
  102. *b = true;
  103. return true;
  104. }
  105. return false;
  106. }
  107. bool FlagParser::runHandler(const char *Name, const char *Value) {
  108. for (u32 I = 0; I < NumberOfFlags; ++I) {
  109. const uptr Len = strlen(Flags[I].Name);
  110. if (strncmp(Name, Flags[I].Name, Len) != 0 || Name[Len] != '=')
  111. continue;
  112. bool Ok = false;
  113. switch (Flags[I].Type) {
  114. case FlagType::FT_bool:
  115. Ok = parseBool(Value, reinterpret_cast<bool *>(Flags[I].Var));
  116. if (!Ok)
  117. reportInvalidFlag("bool", Value);
  118. break;
  119. case FlagType::FT_int:
  120. char *ValueEnd;
  121. *reinterpret_cast<int *>(Flags[I].Var) =
  122. static_cast<int>(strtol(Value, &ValueEnd, 10));
  123. Ok =
  124. *ValueEnd == '"' || *ValueEnd == '\'' || isSeparatorOrNull(*ValueEnd);
  125. if (!Ok)
  126. reportInvalidFlag("int", Value);
  127. break;
  128. }
  129. return Ok;
  130. }
  131. // Unrecognized flag. This is not a fatal error, we may print a warning later.
  132. UnknownFlags.add(Name);
  133. return true;
  134. }
  135. void FlagParser::registerFlag(const char *Name, const char *Desc, FlagType Type,
  136. void *Var) {
  137. CHECK_LT(NumberOfFlags, MaxFlags);
  138. Flags[NumberOfFlags].Name = Name;
  139. Flags[NumberOfFlags].Desc = Desc;
  140. Flags[NumberOfFlags].Type = Type;
  141. Flags[NumberOfFlags].Var = Var;
  142. ++NumberOfFlags;
  143. }
  144. } // namespace scudo