Coverage Report

Created: 2022-01-25 06:29

/Users/buildslave/jenkins/workspace/coverage/llvm-project/clang/lib/Lex/HeaderMap.cpp
Line
Count
Source (jump to first uncovered line)
1
//===--- HeaderMap.cpp - A file that acts like dir of symlinks ------------===//
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
//
9
// This file implements the HeaderMap interface.
10
//
11
//===----------------------------------------------------------------------===//
12
13
#include "clang/Lex/HeaderMap.h"
14
#include "clang/Lex/HeaderMapTypes.h"
15
#include "clang/Basic/CharInfo.h"
16
#include "clang/Basic/FileManager.h"
17
#include "llvm/ADT/SmallString.h"
18
#include "llvm/Support/Compiler.h"
19
#include "llvm/Support/DataTypes.h"
20
#include "llvm/Support/MathExtras.h"
21
#include "llvm/Support/MemoryBuffer.h"
22
#include "llvm/Support/SwapByteOrder.h"
23
#include "llvm/Support/Debug.h"
24
#include <cstring>
25
#include <memory>
26
using namespace clang;
27
28
/// HashHMapKey - This is the 'well known' hash function required by the file
29
/// format, used to look up keys in the hash table.  The hash table uses simple
30
/// linear probing based on this function.
31
64
static inline unsigned HashHMapKey(StringRef Str) {
32
64
  unsigned Result = 0;
33
64
  const char *S = Str.begin(), *End = Str.end();
34
35
653
  for (; S != End; 
S++589
)
36
589
    Result += toLowercase(*S) * 13;
37
64
  return Result;
38
64
}
39
40
41
42
//===----------------------------------------------------------------------===//
43
// Verification and Construction
44
//===----------------------------------------------------------------------===//
45
46
/// HeaderMap::Create - This attempts to load the specified file as a header
47
/// map.  If it doesn't look like a HeaderMap, it gives up and returns null.
48
/// If it looks like a HeaderMap but is obviously corrupted, it puts a reason
49
/// into the string error argument and returns null.
50
std::unique_ptr<HeaderMap> HeaderMap::Create(const FileEntry *FE,
51
39
                                             FileManager &FM) {
52
  // If the file is too small to be a header map, ignore it.
53
39
  unsigned FileSize = FE->getSize();
54
39
  if (FileSize <= sizeof(HMapHeader)) 
return nullptr4
;
55
56
35
  auto FileBuffer = FM.getBufferForFile(FE);
57
35
  if (!FileBuffer || !*FileBuffer)
58
0
    return nullptr;
59
35
  bool NeedsByteSwap;
60
35
  if (!checkHeader(**FileBuffer, NeedsByteSwap))
61
0
    return nullptr;
62
35
  return std::unique_ptr<HeaderMap>(new HeaderMap(std::move(*FileBuffer), NeedsByteSwap));
63
35
}
64
65
bool HeaderMapImpl::checkHeader(const llvm::MemoryBuffer &File,
66
48
                                bool &NeedsByteSwap) {
67
48
  if (File.getBufferSize() <= sizeof(HMapHeader))
68
2
    return false;
69
46
  const char *FileStart = File.getBufferStart();
70
71
  // We know the file is at least as big as the header, check it now.
72
46
  const HMapHeader *Header = reinterpret_cast<const HMapHeader*>(FileStart);
73
74
  // Sniff it to see if it's a headermap by checking the magic number and
75
  // version.
76
46
  if (Header->Magic == HMAP_HeaderMagicNumber &&
77
46
      
Header->Version == HMAP_HeaderVersion44
)
78
43
    NeedsByteSwap = false;
79
3
  else if (Header->Magic == llvm::ByteSwap_32(HMAP_HeaderMagicNumber) &&
80
3
           
Header->Version == llvm::ByteSwap_16(HMAP_HeaderVersion)1
)
81
1
    NeedsByteSwap = true;  // Mixed endianness headermap.
82
2
  else
83
2
    return false;  // Not a header map.
84
85
44
  if (Header->Reserved != 0)
86
1
    return false;
87
88
  // Check the number of buckets.  It should be a power of two, and there
89
  // should be enough space in the file for all of them.
90
43
  uint32_t NumBuckets = NeedsByteSwap
91
43
                            ? 
llvm::sys::getSwappedBytes(Header->NumBuckets)1
92
43
                            : 
Header->NumBuckets42
;
93
43
  if (!llvm::isPowerOf2_32(NumBuckets))
94
2
    return false;
95
41
  if (File.getBufferSize() <
96
41
      sizeof(HMapHeader) + sizeof(HMapBucket) * NumBuckets)
97
1
    return false;
98
99
  // Okay, everything looks good.
100
40
  return true;
101
41
}
102
103
//===----------------------------------------------------------------------===//
104
//  Utility Methods
105
//===----------------------------------------------------------------------===//
106
107
108
/// getFileName - Return the filename of the headermap.
109
1
StringRef HeaderMapImpl::getFileName() const {
110
1
  return FileBuffer->getBufferIdentifier();
111
1
}
112
113
402
unsigned HeaderMapImpl::getEndianAdjustedWord(unsigned X) const {
114
402
  if (!NeedsBSwap) return X;
115
0
  return llvm::ByteSwap_32(X);
116
402
}
117
118
/// getHeader - Return a reference to the file header, in unbyte-swapped form.
119
/// This method cannot fail.
120
156
const HMapHeader &HeaderMapImpl::getHeader() const {
121
  // We know the file is at least as big as the header.  Return it.
122
156
  return *reinterpret_cast<const HMapHeader*>(FileBuffer->getBufferStart());
123
156
}
124
125
/// getBucket - Return the specified hash table bucket from the header map,
126
/// bswap'ing its fields as appropriate.  If the bucket number is not valid,
127
/// this return a bucket with an empty key (0).
128
82
HMapBucket HeaderMapImpl::getBucket(unsigned BucketNo) const {
129
82
  assert(FileBuffer->getBufferSize() >=
130
82
             sizeof(HMapHeader) + sizeof(HMapBucket) * BucketNo &&
131
82
         "Expected bucket to be in range");
132
133
0
  HMapBucket Result;
134
82
  Result.Key = HMAP_EmptyBucketKey;
135
136
82
  const HMapBucket *BucketArray =
137
82
    reinterpret_cast<const HMapBucket*>(FileBuffer->getBufferStart() +
138
82
                                        sizeof(HMapHeader));
139
82
  const HMapBucket *BucketPtr = BucketArray+BucketNo;
140
141
  // Load the values, bswapping as needed.
142
82
  Result.Key    = getEndianAdjustedWord(BucketPtr->Key);
143
82
  Result.Prefix = getEndianAdjustedWord(BucketPtr->Prefix);
144
82
  Result.Suffix = getEndianAdjustedWord(BucketPtr->Suffix);
145
82
  return Result;
146
82
}
147
148
91
Optional<StringRef> HeaderMapImpl::getString(unsigned StrTabIdx) const {
149
  // Add the start of the string table to the idx.
150
91
  StrTabIdx += getEndianAdjustedWord(getHeader().StringsOffset);
151
152
  // Check for invalid index.
153
91
  if (StrTabIdx >= FileBuffer->getBufferSize())
154
0
    return None;
155
156
91
  const char *Data = FileBuffer->getBufferStart() + StrTabIdx;
157
91
  unsigned MaxLen = FileBuffer->getBufferSize() - StrTabIdx;
158
91
  unsigned Len = strnlen(Data, MaxLen);
159
160
  // Check whether the buffer is null-terminated.
161
91
  if (Len == MaxLen && 
Data[Len - 1]2
)
162
2
    return None;
163
164
89
  return StringRef(Data, Len);
165
91
}
166
167
//===----------------------------------------------------------------------===//
168
// The Main Drivers
169
//===----------------------------------------------------------------------===//
170
171
/// dump - Print the contents of this headermap to stderr.
172
0
LLVM_DUMP_METHOD void HeaderMapImpl::dump() const {
173
0
  const HMapHeader &Hdr = getHeader();
174
0
  unsigned NumBuckets = getEndianAdjustedWord(Hdr.NumBuckets);
175
176
0
  llvm::dbgs() << "Header Map " << getFileName() << ":\n  " << NumBuckets
177
0
               << ", " << getEndianAdjustedWord(Hdr.NumEntries) << "\n";
178
179
0
  auto getStringOrInvalid = [this](unsigned Id) -> StringRef {
180
0
    if (Optional<StringRef> S = getString(Id))
181
0
      return *S;
182
0
    return "<invalid>";
183
0
  };
184
185
0
  for (unsigned i = 0; i != NumBuckets; ++i) {
186
0
    HMapBucket B = getBucket(i);
187
0
    if (B.Key == HMAP_EmptyBucketKey) continue;
188
189
0
    StringRef Key = getStringOrInvalid(B.Key);
190
0
    StringRef Prefix = getStringOrInvalid(B.Prefix);
191
0
    StringRef Suffix = getStringOrInvalid(B.Suffix);
192
0
    llvm::dbgs() << "  " << i << ". " << Key << " -> '" << Prefix << "' '"
193
0
                 << Suffix << "'\n";
194
0
  }
195
0
}
196
197
StringRef HeaderMapImpl::lookupFilename(StringRef Filename,
198
64
                                        SmallVectorImpl<char> &DestPath) const {
199
64
  const HMapHeader &Hdr = getHeader();
200
64
  unsigned NumBuckets = getEndianAdjustedWord(Hdr.NumBuckets);
201
202
  // Don't probe infinitely.  This should be checked before constructing.
203
64
  assert(llvm::isPowerOf2_32(NumBuckets) && "Expected power of 2");
204
205
  // Linearly probe the hash table.
206
80
  for (unsigned Bucket = HashHMapKey(Filename);; 
++Bucket16
) {
207
80
    HMapBucket B = getBucket(Bucket & (NumBuckets-1));
208
80
    if (B.Key == HMAP_EmptyBucketKey) 
return StringRef()40
; // Hash miss.
209
210
    // See if the key matches.  If not, probe on.
211
40
    Optional<StringRef> Key = getString(B.Key);
212
40
    if (LLVM_UNLIKELY(!Key))
213
0
      continue;
214
40
    if (!Filename.equals_insensitive(*Key))
215
16
      continue;
216
217
    // If so, we have a match in the hash table.  Construct the destination
218
    // path.
219
24
    Optional<StringRef> Prefix = getString(B.Prefix);
220
24
    Optional<StringRef> Suffix = getString(B.Suffix);
221
222
24
    DestPath.clear();
223
24
    if (LLVM_LIKELY(Prefix && Suffix)) {
224
22
      DestPath.append(Prefix->begin(), Prefix->end());
225
22
      DestPath.append(Suffix->begin(), Suffix->end());
226
22
    }
227
24
    return StringRef(DestPath.begin(), DestPath.size());
228
40
  }
229
64
}
230
231
1
StringRef HeaderMapImpl::reverseLookupFilename(StringRef DestPath) const {
232
1
  if (!ReverseMap.empty())
233
0
    return ReverseMap.lookup(DestPath);
234
235
1
  const HMapHeader &Hdr = getHeader();
236
1
  unsigned NumBuckets = getEndianAdjustedWord(Hdr.NumBuckets);
237
1
  StringRef RetKey;
238
3
  for (unsigned i = 0; i != NumBuckets; 
++i2
) {
239
2
    HMapBucket B = getBucket(i);
240
2
    if (B.Key == HMAP_EmptyBucketKey)
241
1
      continue;
242
243
1
    Optional<StringRef> Key = getString(B.Key);
244
1
    Optional<StringRef> Prefix = getString(B.Prefix);
245
1
    Optional<StringRef> Suffix = getString(B.Suffix);
246
1
    if (LLVM_LIKELY(Key && Prefix && Suffix)) {
247
1
      SmallVector<char, 1024> Buf;
248
1
      Buf.append(Prefix->begin(), Prefix->end());
249
1
      Buf.append(Suffix->begin(), Suffix->end());
250
1
      StringRef Value(Buf.begin(), Buf.size());
251
1
      ReverseMap[Value] = *Key;
252
253
1
      if (DestPath == Value)
254
1
        RetKey = *Key;
255
1
    }
256
1
  }
257
1
  return RetKey;
258
1
}