blob: 96e09f9552bbcef20911603517aedd61ab9c136f [file] [log] [blame]
Peter Collingbourne49062a92013-07-09 22:03:17 +00001//===-- SpecialCaseList.cpp - special case list for sanitizers ------------===//
Kostya Serebryany01401ce2012-03-14 23:22:10 +00002//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// 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
Kostya Serebryany01401ce2012-03-14 23:22:10 +00006//
7//===----------------------------------------------------------------------===//
8//
Kostya Serebryany36dfc5c2012-08-24 16:40:11 +00009// This is a utility class for instrumentation passes (like AddressSanitizer
10// or ThreadSanitizer) to avoid instrumenting some functions or global
Peter Collingbourne49062a92013-07-09 22:03:17 +000011// variables, or to instrument some functions or global variables in a specific
12// way, based on a user-supplied list.
Kostya Serebryany01401ce2012-03-14 23:22:10 +000013//
14//===----------------------------------------------------------------------===//
15
Alexey Samsonovb7dd3292014-07-09 19:40:08 +000016#include "llvm/Support/SpecialCaseList.h"
Chandler Carruth8a8cd2b2014-01-07 11:48:04 +000017#include "llvm/ADT/SmallVector.h"
Kostya Serebryany01401ce2012-03-14 23:22:10 +000018#include "llvm/ADT/StringExtras.h"
Kostya Serebryany01401ce2012-03-14 23:22:10 +000019#include "llvm/Support/MemoryBuffer.h"
20#include "llvm/Support/Regex.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000021#include <string>
Rafael Espindolaa6e9c3e2014-06-12 17:38:55 +000022#include <system_error>
Chandler Carruthed0881b2012-12-03 16:50:05 +000023#include <utility>
Kostya Serebryany01401ce2012-03-14 23:22:10 +000024
Vlad Tsyrklevich998b2202017-09-25 22:11:11 +000025#include <stdio.h>
Kostya Serebryany01401ce2012-03-14 23:22:10 +000026namespace llvm {
27
Vlad Tsyrklevich998b2202017-09-25 22:11:11 +000028bool SpecialCaseList::Matcher::insert(std::string Regexp,
Mitch Phillips40d66632017-11-07 21:16:46 +000029 unsigned LineNumber,
Vlad Tsyrklevich998b2202017-09-25 22:11:11 +000030 std::string &REError) {
Mitch Phillipsfa2eda82017-10-24 23:56:12 +000031 if (Regexp.empty()) {
32 REError = "Supplied regexp was blank";
33 return false;
34 }
35
Vlad Tsyrklevich998b2202017-09-25 22:11:11 +000036 if (Regex::isLiteralERE(Regexp)) {
Mitch Phillips40d66632017-11-07 21:16:46 +000037 Strings[Regexp] = LineNumber;
Vlad Tsyrklevich998b2202017-09-25 22:11:11 +000038 return true;
Peter Collingbournebace6062013-08-05 17:48:04 +000039 }
Vlad Tsyrklevich998b2202017-09-25 22:11:11 +000040 Trigrams.insert(Regexp);
Peter Collingbournebace6062013-08-05 17:48:04 +000041
Vlad Tsyrklevich998b2202017-09-25 22:11:11 +000042 // Replace * with .*
43 for (size_t pos = 0; (pos = Regexp.find('*', pos)) != std::string::npos;
44 pos += strlen(".*")) {
45 Regexp.replace(pos, strlen("*"), ".*");
46 }
47
Mitch Phillips40d66632017-11-07 21:16:46 +000048 Regexp = (Twine("^(") + StringRef(Regexp) + ")$").str();
49
Vlad Tsyrklevich998b2202017-09-25 22:11:11 +000050 // Check that the regexp is valid.
51 Regex CheckRE(Regexp);
52 if (!CheckRE.isValid(REError))
53 return false;
54
Mitch Phillips40d66632017-11-07 21:16:46 +000055 RegExes.emplace_back(
56 std::make_pair(make_unique<Regex>(std::move(CheckRE)), LineNumber));
Vlad Tsyrklevich998b2202017-09-25 22:11:11 +000057 return true;
58}
59
Mitch Phillips40d66632017-11-07 21:16:46 +000060unsigned SpecialCaseList::Matcher::match(StringRef Query) const {
61 auto It = Strings.find(Query);
62 if (It != Strings.end())
63 return It->second;
Vlad Tsyrklevich998b2202017-09-25 22:11:11 +000064 if (Trigrams.isDefinitelyOut(Query))
65 return false;
Mitch Phillips40d66632017-11-07 21:16:46 +000066 for (auto& RegExKV : RegExes)
67 if (RegExKV.first->match(Query))
68 return RegExKV.second;
69 return 0;
Vlad Tsyrklevich998b2202017-09-25 22:11:11 +000070}
71
Alexey Samsonovb9b80272015-02-04 17:39:48 +000072std::unique_ptr<SpecialCaseList>
73SpecialCaseList::create(const std::vector<std::string> &Paths,
74 std::string &Error) {
75 std::unique_ptr<SpecialCaseList> SCL(new SpecialCaseList());
Vlad Tsyrklevich998b2202017-09-25 22:11:11 +000076 if (SCL->createInternal(Paths, Error))
77 return SCL;
78 return nullptr;
Alexey Samsonov9e4fdd22013-08-12 07:49:36 +000079}
80
David Blaikie15913f42014-09-02 18:13:54 +000081std::unique_ptr<SpecialCaseList> SpecialCaseList::create(const MemoryBuffer *MB,
82 std::string &Error) {
Ahmed Charles56440fd2014-03-06 05:51:42 +000083 std::unique_ptr<SpecialCaseList> SCL(new SpecialCaseList());
Vlad Tsyrklevich998b2202017-09-25 22:11:11 +000084 if (SCL->createInternal(MB, Error))
85 return SCL;
86 return nullptr;
Alexey Samsonov9e4fdd22013-08-12 07:49:36 +000087}
88
Alexey Samsonovb9b80272015-02-04 17:39:48 +000089std::unique_ptr<SpecialCaseList>
90SpecialCaseList::createOrDie(const std::vector<std::string> &Paths) {
Alexey Samsonove4b5fb82013-08-12 11:46:09 +000091 std::string Error;
Alexey Samsonovb9b80272015-02-04 17:39:48 +000092 if (auto SCL = create(Paths, Error))
Alexey Samsonove4b5fb82013-08-12 11:46:09 +000093 return SCL;
94 report_fatal_error(Error);
95}
96
Vlad Tsyrklevich998b2202017-09-25 22:11:11 +000097bool SpecialCaseList::createInternal(const std::vector<std::string> &Paths,
98 std::string &Error) {
99 StringMap<size_t> Sections;
100 for (const auto &Path : Paths) {
101 ErrorOr<std::unique_ptr<MemoryBuffer>> FileOrErr =
102 MemoryBuffer::getFile(Path);
103 if (std::error_code EC = FileOrErr.getError()) {
104 Error = (Twine("can't open file '") + Path + "': " + EC.message()).str();
105 return false;
106 }
107 std::string ParseError;
108 if (!parse(FileOrErr.get().get(), Sections, ParseError)) {
109 Error = (Twine("error parsing file '") + Path + "': " + ParseError).str();
110 return false;
111 }
112 }
Vlad Tsyrklevich998b2202017-09-25 22:11:11 +0000113 return true;
114}
115
116bool SpecialCaseList::createInternal(const MemoryBuffer *MB,
117 std::string &Error) {
118 StringMap<size_t> Sections;
119 if (!parse(MB, Sections, Error))
120 return false;
Vlad Tsyrklevich998b2202017-09-25 22:11:11 +0000121 return true;
122}
123
124bool SpecialCaseList::parse(const MemoryBuffer *MB,
125 StringMap<size_t> &SectionsMap,
126 std::string &Error) {
Kostya Serebryany36dfc5c2012-08-24 16:40:11 +0000127 // Iterate through each line in the blacklist file.
Kostya Serebryany01401ce2012-03-14 23:22:10 +0000128 SmallVector<StringRef, 16> Lines;
Mitch Phillips40d66632017-11-07 21:16:46 +0000129 MB->getBuffer().split(Lines, '\n');
Vlad Tsyrklevich998b2202017-09-25 22:11:11 +0000130
Mitch Phillips40d66632017-11-07 21:16:46 +0000131 unsigned LineNo = 1;
Vlad Tsyrklevich998b2202017-09-25 22:11:11 +0000132 StringRef Section = "*";
Mitch Phillips40d66632017-11-07 21:16:46 +0000133
Alexey Samsonovb9b80272015-02-04 17:39:48 +0000134 for (auto I = Lines.begin(), E = Lines.end(); I != E; ++I, ++LineNo) {
Mitch Phillips40d66632017-11-07 21:16:46 +0000135 *I = I->trim();
Alexey Samsonov84184422012-10-19 15:24:46 +0000136 // Ignore empty lines and lines starting with "#"
137 if (I->empty() || I->startswith("#"))
138 continue;
Vlad Tsyrklevich998b2202017-09-25 22:11:11 +0000139
140 // Save section names
141 if (I->startswith("[")) {
142 if (!I->endswith("]")) {
143 Error = (Twine("malformed section header on line ") + Twine(LineNo) +
144 ": " + *I).str();
145 return false;
146 }
147
148 Section = I->slice(1, I->size() - 1);
149
150 std::string REError;
151 Regex CheckRE(Section);
152 if (!CheckRE.isValid(REError)) {
153 Error =
154 (Twine("malformed regex for section ") + Section + ": '" + REError)
155 .str();
156 return false;
157 }
158
159 continue;
160 }
161
Kostya Serebryany36dfc5c2012-08-24 16:40:11 +0000162 // Get our prefix and unparsed regexp.
163 std::pair<StringRef, StringRef> SplitLine = I->split(":");
164 StringRef Prefix = SplitLine.first;
Peter Collingbourne49062a92013-07-09 22:03:17 +0000165 if (SplitLine.second.empty()) {
Nick Lewycky1af94eb2012-11-29 00:01:38 +0000166 // Missing ':' in the line.
Alexey Samsonovb9b80272015-02-04 17:39:48 +0000167 Error = (Twine("malformed line ") + Twine(LineNo) + ": '" +
Alexey Samsonov9e4fdd22013-08-12 07:49:36 +0000168 SplitLine.first + "'").str();
169 return false;
Nick Lewycky1af94eb2012-11-29 00:01:38 +0000170 }
Kostya Serebryany36dfc5c2012-08-24 16:40:11 +0000171
Peter Collingbourne49062a92013-07-09 22:03:17 +0000172 std::pair<StringRef, StringRef> SplitRegexp = SplitLine.second.split("=");
173 std::string Regexp = SplitRegexp.first;
174 StringRef Category = SplitRegexp.second;
175
Vlad Tsyrklevich998b2202017-09-25 22:11:11 +0000176 // Create this section if it has not been seen before.
177 if (SectionsMap.find(Section) == SectionsMap.end()) {
178 std::unique_ptr<Matcher> M = make_unique<Matcher>();
179 std::string REError;
Mitch Phillips40d66632017-11-07 21:16:46 +0000180 if (!M->insert(Section, LineNo, REError)) {
Vlad Tsyrklevich998b2202017-09-25 22:11:11 +0000181 Error = (Twine("malformed section ") + Section + ": '" + REError).str();
182 return false;
183 }
Peter Collingbournebace6062013-08-05 17:48:04 +0000184
Vlad Tsyrklevich998b2202017-09-25 22:11:11 +0000185 SectionsMap[Section] = Sections.size();
186 Sections.emplace_back(std::move(M));
Kostya Serebryany01401ce2012-03-14 23:22:10 +0000187 }
Kostya Serebryany36dfc5c2012-08-24 16:40:11 +0000188
Vlad Tsyrklevich998b2202017-09-25 22:11:11 +0000189 auto &Entry = Sections[SectionsMap[Section]].Entries[Prefix][Category];
Alexey Samsonov9e4fdd22013-08-12 07:49:36 +0000190 std::string REError;
Mitch Phillips40d66632017-11-07 21:16:46 +0000191 if (!Entry.insert(std::move(Regexp), LineNo, REError)) {
Alexey Samsonovb9b80272015-02-04 17:39:48 +0000192 Error = (Twine("malformed regex in line ") + Twine(LineNo) + ": '" +
Alexey Samsonov9e4fdd22013-08-12 07:49:36 +0000193 SplitLine.second + "': " + REError).str();
194 return false;
Kostya Serebryany36dfc5c2012-08-24 16:40:11 +0000195 }
Kostya Serebryany01401ce2012-03-14 23:22:10 +0000196 }
Alexey Samsonovb9b80272015-02-04 17:39:48 +0000197 return true;
198}
Kostya Serebryany36dfc5c2012-08-24 16:40:11 +0000199
Peter Collingbourned5feb7b2014-07-10 03:55:02 +0000200SpecialCaseList::~SpecialCaseList() {}
Kostya Serebryany36dfc5c2012-08-24 16:40:11 +0000201
Vlad Tsyrklevich998b2202017-09-25 22:11:11 +0000202bool SpecialCaseList::inSection(StringRef Section, StringRef Prefix,
203 StringRef Query, StringRef Category) const {
Mitch Phillips40d66632017-11-07 21:16:46 +0000204 return inSectionBlame(Section, Prefix, Query, Category);
Vlad Tsyrklevich998b2202017-09-25 22:11:11 +0000205}
206
Mitch Phillips40d66632017-11-07 21:16:46 +0000207unsigned SpecialCaseList::inSectionBlame(StringRef Section, StringRef Prefix,
208 StringRef Query,
209 StringRef Category) const {
210 for (auto &SectionIter : Sections)
211 if (SectionIter.SectionMatcher->match(Section)) {
212 unsigned Blame =
213 inSectionBlame(SectionIter.Entries, Prefix, Query, Category);
214 if (Blame)
215 return Blame;
216 }
217 return 0;
218}
219
220unsigned SpecialCaseList::inSectionBlame(const SectionEntries &Entries,
221 StringRef Prefix, StringRef Query,
222 StringRef Category) const {
Vlad Tsyrklevich998b2202017-09-25 22:11:11 +0000223 SectionEntries::const_iterator I = Entries.find(Prefix);
Mitch Phillips40d66632017-11-07 21:16:46 +0000224 if (I == Entries.end()) return 0;
Vlad Tsyrklevich998b2202017-09-25 22:11:11 +0000225 StringMap<Matcher>::const_iterator II = I->second.find(Category);
Mitch Phillips40d66632017-11-07 21:16:46 +0000226 if (II == I->second.end()) return 0;
Peter Collingbourne49062a92013-07-09 22:03:17 +0000227
Peter Collingbournebace6062013-08-05 17:48:04 +0000228 return II->getValue().match(Query);
Kostya Serebryany01401ce2012-03-14 23:22:10 +0000229}
230
231} // namespace llvm