1 //===-- sanitizer_flag_parser.cc ------------------------------------------===//
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
7 //===----------------------------------------------------------------------===//
9 // This file is a part of ThreadSanitizer/AddressSanitizer runtime.
11 //===----------------------------------------------------------------------===//
13 #include "sanitizer_flag_parser.h"
15 #include "sanitizer_common.h"
16 #include "sanitizer_libc.h"
17 #include "sanitizer_flags.h"
18 #include "sanitizer_flag_parser.h"
20 namespace __sanitizer {
22 LowLevelAllocator FlagParser::Alloc;
25 static const int kMaxUnknownFlags = 20;
26 const char *unknown_flags_[kMaxUnknownFlags];
30 void Add(const char *name) {
31 CHECK_LT(n_unknown_flags_, kMaxUnknownFlags);
32 unknown_flags_[n_unknown_flags_++] = name;
36 if (!n_unknown_flags_) return;
37 Printf("WARNING: found %d unrecognized flag(s):\n", n_unknown_flags_);
38 for (int i = 0; i < n_unknown_flags_; ++i)
39 Printf(" %s\n", unknown_flags_[i]);
44 UnknownFlags unknown_flags;
46 void ReportUnrecognizedFlags() {
47 unknown_flags.Report();
50 char *FlagParser::ll_strndup(const char *s, uptr n) {
51 uptr len = internal_strnlen(s, n);
52 char *s2 = (char*)Alloc.Allocate(len + 1);
53 internal_memcpy(s2, s, len);
58 void FlagParser::PrintFlagDescriptions() {
59 Printf("Available flags for %s:\n", SanitizerToolName);
60 for (int i = 0; i < n_flags_; ++i)
61 Printf("\t%s\n\t\t- %s\n", flags_[i].name, flags_[i].desc);
64 void FlagParser::fatal_error(const char *err) {
65 Printf("%s: ERROR: %s\n", SanitizerToolName, err);
69 bool FlagParser::is_space(char c) {
70 return c == ' ' || c == ',' || c == ':' || c == '\n' || c == '\t' ||
74 void FlagParser::skip_whitespace() {
75 while (is_space(buf_[pos_])) ++pos_;
78 void FlagParser::parse_flag(const char *env_option_name) {
79 uptr name_start = pos_;
80 while (buf_[pos_] != 0 && buf_[pos_] != '=' && !is_space(buf_[pos_])) ++pos_;
81 if (buf_[pos_] != '=') {
82 if (env_option_name) {
83 Printf("%s: ERROR: expected '=' in %s\n", SanitizerToolName,
87 fatal_error("expected '='");
89 char *name = ll_strndup(buf_ + name_start, pos_ - name_start);
91 uptr value_start = ++pos_;
93 if (buf_[pos_] == '\'' || buf_[pos_] == '"') {
94 char quote = buf_[pos_++];
95 while (buf_[pos_] != 0 && buf_[pos_] != quote) ++pos_;
96 if (buf_[pos_] == 0) fatal_error("unterminated string");
97 value = ll_strndup(buf_ + value_start + 1, pos_ - value_start - 1);
98 ++pos_; // consume the closing quote
100 while (buf_[pos_] != 0 && !is_space(buf_[pos_])) ++pos_;
101 if (buf_[pos_] != 0 && !is_space(buf_[pos_]))
102 fatal_error("expected separator or eol");
103 value = ll_strndup(buf_ + value_start, pos_ - value_start);
106 bool res = run_handler(name, value);
107 if (!res) fatal_error("Flag parsing failed.");
110 void FlagParser::parse_flags(const char *env_option_name) {
113 if (buf_[pos_] == 0) break;
114 parse_flag(env_option_name);
117 // Do a sanity check for certain flags.
118 if (common_flags_dont_use.malloc_context_size < 1)
119 common_flags_dont_use.malloc_context_size = 1;
122 void FlagParser::ParseStringFromEnv(const char *env_name) {
123 const char *env = GetEnv(env_name);
124 VPrintf(1, "%s: %s\n", env_name, env ? env : "<empty>");
125 ParseString(env, env_name);
128 void FlagParser::ParseString(const char *s, const char *env_option_name) {
130 // Backup current parser state to allow nested ParseString() calls.
131 const char *old_buf_ = buf_;
132 uptr old_pos_ = pos_;
136 parse_flags(env_option_name);
142 bool FlagParser::ParseFile(const char *path, bool ignore_missing) {
143 static const uptr kMaxIncludeSize = 1 << 15;
145 uptr data_mapped_size;
148 if (!ReadFileToBuffer(path, &data, &data_mapped_size, &len,
149 Max(kMaxIncludeSize, GetPageSizeCached()), &err)) {
152 Printf("Failed to read options from '%s': error %d\n", path, err);
155 ParseString(data, path);
156 UnmapOrDie(data, data_mapped_size);
160 bool FlagParser::run_handler(const char *name, const char *value) {
161 for (int i = 0; i < n_flags_; ++i) {
162 if (internal_strcmp(name, flags_[i].name) == 0)
163 return flags_[i].handler->Parse(value);
165 // Unrecognized flag. This is not a fatal error, we may print a warning later.
166 unknown_flags.Add(name);
170 void FlagParser::RegisterHandler(const char *name, FlagHandlerBase *handler,
172 CHECK_LT(n_flags_, kMaxFlags);
173 flags_[n_flags_].name = name;
174 flags_[n_flags_].desc = desc;
175 flags_[n_flags_].handler = handler;
179 FlagParser::FlagParser() : n_flags_(0), buf_(nullptr), pos_(0) {
180 flags_ = (Flag *)Alloc.Allocate(sizeof(Flag) * kMaxFlags);
183 } // namespace __sanitizer