Coverage Report

Created: 2020-09-22 08:39

/Users/buildslave/jenkins/workspace/coverage/llvm-project/clang/lib/Analysis/ThreadSafety.cpp
Line
Count
Source (jump to first uncovered line)
1
//===- ThreadSafety.cpp ---------------------------------------------------===//
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
// A intra-procedural analysis for thread safety (e.g. deadlocks and race
10
// conditions), based off of an annotation system.
11
//
12
// See http://clang.llvm.org/docs/ThreadSafetyAnalysis.html
13
// for more information.
14
//
15
//===----------------------------------------------------------------------===//
16
17
#include "clang/Analysis/Analyses/ThreadSafety.h"
18
#include "clang/AST/Attr.h"
19
#include "clang/AST/Decl.h"
20
#include "clang/AST/DeclCXX.h"
21
#include "clang/AST/DeclGroup.h"
22
#include "clang/AST/Expr.h"
23
#include "clang/AST/ExprCXX.h"
24
#include "clang/AST/OperationKinds.h"
25
#include "clang/AST/Stmt.h"
26
#include "clang/AST/StmtVisitor.h"
27
#include "clang/AST/Type.h"
28
#include "clang/Analysis/Analyses/PostOrderCFGView.h"
29
#include "clang/Analysis/Analyses/ThreadSafetyCommon.h"
30
#include "clang/Analysis/Analyses/ThreadSafetyTIL.h"
31
#include "clang/Analysis/Analyses/ThreadSafetyTraverse.h"
32
#include "clang/Analysis/Analyses/ThreadSafetyUtil.h"
33
#include "clang/Analysis/AnalysisDeclContext.h"
34
#include "clang/Analysis/CFG.h"
35
#include "clang/Basic/Builtins.h"
36
#include "clang/Basic/LLVM.h"
37
#include "clang/Basic/OperatorKinds.h"
38
#include "clang/Basic/SourceLocation.h"
39
#include "clang/Basic/Specifiers.h"
40
#include "llvm/ADT/ArrayRef.h"
41
#include "llvm/ADT/DenseMap.h"
42
#include "llvm/ADT/ImmutableMap.h"
43
#include "llvm/ADT/Optional.h"
44
#include "llvm/ADT/PointerIntPair.h"
45
#include "llvm/ADT/STLExtras.h"
46
#include "llvm/ADT/SmallVector.h"
47
#include "llvm/ADT/StringRef.h"
48
#include "llvm/Support/Allocator.h"
49
#include "llvm/Support/Casting.h"
50
#include "llvm/Support/ErrorHandling.h"
51
#include "llvm/Support/raw_ostream.h"
52
#include <algorithm>
53
#include <cassert>
54
#include <functional>
55
#include <iterator>
56
#include <memory>
57
#include <string>
58
#include <type_traits>
59
#include <utility>
60
#include <vector>
61
62
using namespace clang;
63
using namespace threadSafety;
64
65
// Key method definition
66
2.16k
ThreadSafetyHandler::~ThreadSafetyHandler() = default;
67
68
/// Issue a warning about an invalid lock expression
69
static void warnInvalidLock(ThreadSafetyHandler &Handler,
70
                            const Expr *MutexExp, const NamedDecl *D,
71
0
                            const Expr *DeclExp, StringRef Kind) {
72
0
  SourceLocation Loc;
73
0
  if (DeclExp)
74
0
    Loc = DeclExp->getExprLoc();
75
76
  // FIXME: add a note about the attribute location in MutexExp or D
77
0
  if (Loc.isValid())
78
0
    Handler.handleInvalidLockExp(Kind, Loc);
79
0
}
80
81
namespace {
82
83
/// A set of CapabilityExpr objects, which are compiled from thread safety
84
/// attributes on a function.
85
class CapExprSet : public SmallVector<CapabilityExpr, 4> {
86
public:
87
  /// Push M onto list, but discard duplicates.
88
4.90k
  void push_back_nodup(const CapabilityExpr &CapE) {
89
4.90k
    iterator It = std::find_if(begin(), end(),
90
1.09k
                               [=](const CapabilityExpr &CapE2) {
91
1.09k
      return CapE.equals(CapE2);
92
1.09k
    });
93
4.90k
    if (It == end())
94
4.47k
      push_back(CapE);
95
4.90k
  }
96
};
97
98
class FactManager;
99
class FactSet;
100
101
/// This is a helper class that stores a fact that is known at a
102
/// particular point in program execution.  Currently, a fact is a capability,
103
/// along with additional information, such as where it was acquired, whether
104
/// it is exclusive or shared, etc.
105
///
106
/// FIXME: this analysis does not currently support re-entrant locking.
107
class FactEntry : public CapabilityExpr {
108
private:
109
  /// Exclusive or shared.
110
  LockKind LKind;
111
112
  /// Where it was acquired.
113
  SourceLocation AcquireLoc;
114
115
  /// True if the lock was asserted.
116
  bool Asserted;
117
118
  /// True if the lock was declared.
119
  bool Declared;
120
121
public:
122
  FactEntry(const CapabilityExpr &CE, LockKind LK, SourceLocation Loc,
123
            bool Asrt, bool Declrd = false)
124
      : CapabilityExpr(CE), LKind(LK), AcquireLoc(Loc), Asserted(Asrt),
125
4.53k
        Declared(Declrd) {}
126
4.53k
  virtual ~FactEntry() = default;
127
128
2.22k
  LockKind kind() const { return LKind;      }
129
3.16k
  SourceLocation loc() const { return AcquireLoc; }
130
5.52k
  bool asserted() const { return Asserted; }
131
2.52k
  bool declared() const { return Declared; }
132
133
503
  void setDeclared(bool D) { Declared = D; }
134
135
  virtual void
136
  handleRemovalFromIntersection(const FactSet &FSet, FactManager &FactMan,
137
                                SourceLocation JoinLoc, LockErrorKind LEK,
138
                                ThreadSafetyHandler &Handler) const = 0;
139
  virtual void handleLock(FactSet &FSet, FactManager &FactMan,
140
                          const FactEntry &entry, ThreadSafetyHandler &Handler,
141
                          StringRef DiagKind) const = 0;
142
  virtual void handleUnlock(FactSet &FSet, FactManager &FactMan,
143
                            const CapabilityExpr &Cp, SourceLocation UnlockLoc,
144
                            bool FullyRemove, ThreadSafetyHandler &Handler,
145
                            StringRef DiagKind) const = 0;
146
147
  // Return true if LKind >= LK, where exclusive > shared
148
1.77k
  bool isAtLeast(LockKind LK) const {
149
1.77k
    return  (LKind == LK_Exclusive) || 
(LK == LK_Shared)327
;
150
1.77k
  }
151
};
152
153
using FactID = unsigned short;
154
155
/// FactManager manages the memory for all facts that are created during
156
/// the analysis of a single routine.
157
class FactManager {
158
private:
159
  std::vector<std::unique_ptr<const FactEntry>> Facts;
160
161
public:
162
4.38k
  FactID newFact(std::unique_ptr<FactEntry> Entry) {
163
4.38k
    Facts.push_back(std::move(Entry));
164
4.38k
    return static_cast<unsigned short>(Facts.size() - 1);
165
4.38k
  }
166
167
26.4k
  const FactEntry &operator[](FactID F) const { return *Facts[F]; }
168
};
169
170
/// A FactSet is the set of facts that are known to be true at a
171
/// particular program point.  FactSets must be small, because they are
172
/// frequently copied, and are thus implemented as a set of indices into a
173
/// table maintained by a FactManager.  A typical FactSet only holds 1 or 2
174
/// locks, so we can get away with doing a linear search for lookup.  Note
175
/// that a hashtable or map is inappropriate in this case, because lookups
176
/// may involve partial pattern matches, rather than exact matches.
177
class FactSet {
178
private:
179
  using FactVec = SmallVector<FactID, 4>;
180
181
  FactVec FactIDs;
182
183
public:
184
  using iterator = FactVec::iterator;
185
  using const_iterator = FactVec::const_iterator;
186
187
4.99k
  iterator begin() { return FactIDs.begin(); }
188
15.9k
  const_iterator begin() const { return FactIDs.begin(); }
189
190
7.34k
  iterator end() { return FactIDs.end(); }
191
29.1k
  const_iterator end() const { return FactIDs.end(); }
192
193
0
  bool isEmpty() const { return FactIDs.size() == 0; }
194
195
  // Return true if the set contains only negative facts
196
58
  bool isEmpty(FactManager &FactMan) const {
197
34
    for (const auto FID : *this) {
198
34
      if (!FactMan[FID].negative())
199
24
        return false;
200
34
    }
201
34
    return true;
202
58
  }
203
204
0
  void addLockByID(FactID ID) { FactIDs.push_back(ID); }
205
206
4.38k
  FactID addLock(FactManager &FM, std::unique_ptr<FactEntry> Entry) {
207
4.38k
    FactID F = FM.newFact(std::move(Entry));
208
4.38k
    FactIDs.push_back(F);
209
4.38k
    return F;
210
4.38k
  }
211
212
2.48k
  bool removeLock(FactManager& FM, const CapabilityExpr &CapE) {
213
2.48k
    unsigned n = FactIDs.size();
214
2.48k
    if (n == 0)
215
0
      return false;
216
217
3.25k
    
for (unsigned i = 0; 2.48k
i < n-1;
++i770
) {
218
1.63k
      if (FM[FactIDs[i]].matches(CapE)) {
219
862
        FactIDs[i] = FactIDs[n-1];
220
862
        FactIDs.pop_back();
221
862
        return true;
222
862
      }
223
1.63k
    }
224
1.62k
    if (FM[FactIDs[n-1]].matches(CapE)) {
225
1.61k
      FactIDs.pop_back();
226
1.61k
      return true;
227
1.61k
    }
228
12
    return false;
229
12
  }
230
231
2.34k
  iterator findLockIter(FactManager &FM, const CapabilityExpr &CapE) {
232
1.61k
    return std::find_if(begin(), end(), [&](FactID ID) {
233
1.61k
      return FM[ID].matches(CapE);
234
1.61k
    });
235
2.34k
  }
236
237
8.65k
  const FactEntry *findLock(FactManager &FM, const CapabilityExpr &CapE) const {
238
8.01k
    auto I = std::find_if(begin(), end(), [&](FactID ID) {
239
8.01k
      return FM[ID].matches(CapE);
240
8.01k
    });
241
5.06k
    return I != end() ? 
&FM[*I]3.58k
: nullptr;
242
8.65k
  }
243
244
  const FactEntry *findLockUniv(FactManager &FM,
245
2.91k
                                const CapabilityExpr &CapE) const {
246
2.86k
    auto I = std::find_if(begin(), end(), [&](FactID ID) -> bool {
247
2.86k
      return FM[ID].matchesUniv(CapE);
248
2.86k
    });
249
1.77k
    return I != end() ? &FM[*I] : 
nullptr1.14k
;
250
2.91k
  }
251
252
  const FactEntry *findPartialMatch(FactManager &FM,
253
1.14k
                                    const CapabilityExpr &CapE) const {
254
518
    auto I = std::find_if(begin(), end(), [&](FactID ID) -> bool {
255
518
      return FM[ID].partiallyMatches(CapE);
256
518
    });
257
1.07k
    return I != end() ? 
&FM[*I]76
: nullptr;
258
1.14k
  }
259
260
490
  bool containsMutexDecl(FactManager &FM, const ValueDecl* Vd) const {
261
193
    auto I = std::find_if(begin(), end(), [&](FactID ID) -> bool {
262
193
      return FM[ID].valueDecl() == Vd;
263
193
    });
264
490
    return I != end();
265
490
  }
266
};
267
268
class ThreadSafetyAnalyzer;
269
270
} // namespace
271
272
namespace clang {
273
namespace threadSafety {
274
275
class BeforeSet {
276
private:
277
  using BeforeVect = SmallVector<const ValueDecl *, 4>;
278
279
  struct BeforeInfo {
280
    BeforeVect Vect;
281
    int Visited = 0;
282
283
771
    BeforeInfo() = default;
284
    BeforeInfo(BeforeInfo &&) = default;
285
  };
286
287
  using BeforeMap =
288
      llvm::DenseMap<const ValueDecl *, std::unique_ptr<BeforeInfo>>;
289
  using CycleMap = llvm::DenseMap<const ValueDecl *, bool>;
290
291
public:
292
34
  BeforeSet() = default;
293
294
  BeforeInfo* insertAttrExprs(const ValueDecl* Vd,
295
                              ThreadSafetyAnalyzer& Analyzer);
296
297
  BeforeInfo *getBeforeInfoForDecl(const ValueDecl *Vd,
298
                                   ThreadSafetyAnalyzer &Analyzer);
299
300
  void checkBeforeAfter(const ValueDecl* Vd,
301
                        const FactSet& FSet,
302
                        ThreadSafetyAnalyzer& Analyzer,
303
                        SourceLocation Loc, StringRef CapKind);
304
305
private:
306
  BeforeMap BMap;
307
  CycleMap CycMap;
308
};
309
310
} // namespace threadSafety
311
} // namespace clang
312
313
namespace {
314
315
class LocalVariableMap;
316
317
using LocalVarContext = llvm::ImmutableMap<const NamedDecl *, unsigned>;
318
319
/// A side (entry or exit) of a CFG node.
320
enum CFGBlockSide { CBS_Entry, CBS_Exit };
321
322
/// CFGBlockInfo is a struct which contains all the information that is
323
/// maintained for each block in the CFG.  See LocalVariableMap for more
324
/// information about the contexts.
325
struct CFGBlockInfo {
326
  // Lockset held at entry to block
327
  FactSet EntrySet;
328
329
  // Lockset held at exit from block
330
  FactSet ExitSet;
331
332
  // Context held at entry to block
333
  LocalVarContext EntryContext;
334
335
  // Context held at exit from block
336
  LocalVarContext ExitContext;
337
338
  // Location of first statement in block
339
  SourceLocation EntryLoc;
340
341
  // Location of last statement in block.
342
  SourceLocation ExitLoc;
343
344
  // Used to replay contexts later
345
  unsigned EntryIndex;
346
347
  // Is this block reachable?
348
  bool Reachable = false;
349
350
0
  const FactSet &getSet(CFGBlockSide Side) const {
351
0
    return Side == CBS_Entry ? EntrySet : ExitSet;
352
0
  }
353
354
0
  SourceLocation getLocation(CFGBlockSide Side) const {
355
0
    return Side == CBS_Entry ? EntryLoc : ExitLoc;
356
0
  }
357
358
private:
359
  CFGBlockInfo(LocalVarContext EmptyCtx)
360
2.04k
      : EntryContext(EmptyCtx), ExitContext(EmptyCtx) {}
361
362
public:
363
  static CFGBlockInfo getEmptyBlockInfo(LocalVariableMap &M);
364
};
365
366
// A LocalVariableMap maintains a map from local variables to their currently
367
// valid definitions.  It provides SSA-like functionality when traversing the
368
// CFG.  Like SSA, each definition or assignment to a variable is assigned a
369
// unique name (an integer), which acts as the SSA name for that definition.
370
// The total set of names is shared among all CFG basic blocks.
371
// Unlike SSA, we do not rewrite expressions to replace local variables declrefs
372
// with their SSA-names.  Instead, we compute a Context for each point in the
373
// code, which maps local variables to the appropriate SSA-name.  This map
374
// changes with each assignment.
375
//
376
// The map is computed in a single pass over the CFG.  Subsequent analyses can
377
// then query the map to find the appropriate Context for a statement, and use
378
// that Context to look up the definitions of variables.
379
class LocalVariableMap {
380
public:
381
  using Context = LocalVarContext;
382
383
  /// A VarDefinition consists of an expression, representing the value of the
384
  /// variable, along with the context in which that expression should be
385
  /// interpreted.  A reference VarDefinition does not itself contain this
386
  /// information, but instead contains a pointer to a previous VarDefinition.
387
  struct VarDefinition {
388
  public:
389
    friend class LocalVariableMap;
390
391
    // The original declaration for this variable.
392
    const NamedDecl *Dec;
393
394
    // The expression for this variable, OR
395
    const Expr *Exp = nullptr;
396
397
    // Reference to another VarDefinition
398
    unsigned Ref = 0;
399
400
    // The map with which Exp should be interpreted.
401
    Context Ctx;
402
403
32
    bool isReference() { return !Exp; }
404
405
  private:
406
    // Create ordinary variable definition
407
    VarDefinition(const NamedDecl *D, const Expr *E, Context C)
408
715
        : Dec(D), Exp(E), Ctx(C) {}
409
410
    // Create reference to previous definition
411
    VarDefinition(const NamedDecl *D, unsigned R, Context C)
412
2.19k
        : Dec(D), Ref(R), Ctx(C) {}
413
  };
414
415
private:
416
  Context::Factory ContextFactory;
417
  std::vector<VarDefinition> VarDefinitions;
418
  std::vector<unsigned> CtxIndices;
419
  std::vector<std::pair<const Stmt *, Context>> SavedContexts;
420
421
public:
422
2.16k
  LocalVariableMap() {
423
    // index 0 is a placeholder for undefined variables (aka phi-nodes).
424
2.16k
    VarDefinitions.push_back(VarDefinition(nullptr, 0u, getEmptyContext()));
425
2.16k
  }
426
427
  /// Look up a definition, within the given context.
428
0
  const VarDefinition* lookup(const NamedDecl *D, Context Ctx) {
429
0
    const unsigned *i = Ctx.lookup(D);
430
0
    if (!i)
431
0
      return nullptr;
432
0
    assert(*i < VarDefinitions.size());
433
0
    return &VarDefinitions[*i];
434
0
  }
435
436
  /// Look up the definition for D within the given context.  Returns
437
  /// NULL if the expression is not statically known.  If successful, also
438
  /// modifies Ctx to hold the context of the return Expr.
439
172
  const Expr* lookupExpr(const NamedDecl *D, Context &Ctx) {
440
172
    const unsigned *P = Ctx.lookup(D);
441
172
    if (!P)
442
40
      return nullptr;
443
444
132
    unsigned i = *P;
445
156
    while (i > 0) {
446
136
      if (VarDefinitions[i].Exp) {
447
112
        Ctx = VarDefinitions[i].Ctx;
448
112
        return VarDefinitions[i].Exp;
449
112
      }
450
24
      i = VarDefinitions[i].Ref;
451
24
    }
452
20
    return nullptr;
453
132
  }
454
455
4.31k
  Context getEmptyContext() { return ContextFactory.getEmptyMap(); }
456
457
  /// Return the next context after processing S.  This function is used by
458
  /// clients of the class to get the appropriate context when traversing the
459
  /// CFG.  It must be called for every assignment or DeclStmt.
460
2.42k
  Context getNextContext(unsigned &CtxIndex, const Stmt *S, Context C) {
461
2.42k
    if (SavedContexts[CtxIndex+1].first == S) {
462
734
      CtxIndex++;
463
734
      Context Result = SavedContexts[CtxIndex].second;
464
734
      return Result;
465
734
    }
466
1.68k
    return C;
467
1.68k
  }
468
469
0
  void dumpVarDefinitionName(unsigned i) {
470
0
    if (i == 0) {
471
0
      llvm::errs() << "Undefined";
472
0
      return;
473
0
    }
474
0
    const NamedDecl *Dec = VarDefinitions[i].Dec;
475
0
    if (!Dec) {
476
0
      llvm::errs() << "<<NULL>>";
477
0
      return;
478
0
    }
479
0
    Dec->printName(llvm::errs());
480
0
    llvm::errs() << "." << i << " " << ((const void*) Dec);
481
0
  }
482
483
  /// Dumps an ASCII representation of the variable map to llvm::errs()
484
0
  void dump() {
485
0
    for (unsigned i = 1, e = VarDefinitions.size(); i < e; ++i) {
486
0
      const Expr *Exp = VarDefinitions[i].Exp;
487
0
      unsigned Ref = VarDefinitions[i].Ref;
488
0
489
0
      dumpVarDefinitionName(i);
490
0
      llvm::errs() << " = ";
491
0
      if (Exp) Exp->dump();
492
0
      else {
493
0
        dumpVarDefinitionName(Ref);
494
0
        llvm::errs() << "\n";
495
0
      }
496
0
    }
497
0
  }
498
499
  /// Dumps an ASCII representation of a Context to llvm::errs()
500
0
  void dumpContext(Context C) {
501
0
    for (Context::iterator I = C.begin(), E = C.end(); I != E; ++I) {
502
0
      const NamedDecl *D = I.getKey();
503
0
      D->printName(llvm::errs());
504
0
      const unsigned *i = C.lookup(D);
505
0
      llvm::errs() << " -> ";
506
0
      dumpVarDefinitionName(*i);
507
0
      llvm::errs() << "\n";
508
0
    }
509
0
  }
510
511
  /// Builds the variable map.
512
  void traverseCFG(CFG *CFGraph, const PostOrderCFGView *SortedGraph,
513
                   std::vector<CFGBlockInfo> &BlockInfo);
514
515
protected:
516
  friend class VarMapBuilder;
517
518
  // Get the current context index
519
7.48k
  unsigned getContextIndex() { return SavedContexts.size()-1; }
520
521
  // Save the current context for later replay
522
10.2k
  void saveContext(const Stmt *S, Context C) {
523
10.2k
    SavedContexts.push_back(std::make_pair(S, C));
524
10.2k
  }
525
526
  // Adds a new definition to the given context, and returns a new context.
527
  // This method should be called when declaring a new variable.
528
572
  Context addDefinition(const NamedDecl *D, const Expr *Exp, Context Ctx) {
529
572
    assert(!Ctx.contains(D));
530
572
    unsigned newID = VarDefinitions.size();
531
572
    Context NewCtx = ContextFactory.add(Ctx, D, newID);
532
572
    VarDefinitions.push_back(VarDefinition(D, Exp, Ctx));
533
572
    return NewCtx;
534
572
  }
535
536
  // Add a new reference to an existing definition.
537
32
  Context addReference(const NamedDecl *D, unsigned i, Context Ctx) {
538
32
    unsigned newID = VarDefinitions.size();
539
32
    Context NewCtx = ContextFactory.add(Ctx, D, newID);
540
32
    VarDefinitions.push_back(VarDefinition(D, i, Ctx));
541
32
    return NewCtx;
542
32
  }
543
544
  // Updates a definition only if that definition is already in the map.
545
  // This method should be called when assigning to an existing variable.
546
143
  Context updateDefinition(const NamedDecl *D, Expr *Exp, Context Ctx) {
547
143
    if (Ctx.contains(D)) {
548
143
      unsigned newID = VarDefinitions.size();
549
143
      Context NewCtx = ContextFactory.remove(Ctx, D);
550
143
      NewCtx = ContextFactory.add(NewCtx, D, newID);
551
143
      VarDefinitions.push_back(VarDefinition(D, Exp, Ctx));
552
143
      return NewCtx;
553
143
    }
554
0
    return Ctx;
555
0
  }
556
557
  // Removes a definition from the context, but keeps the variable name
558
  // as a valid variable.  The index 0 is a placeholder for cleared definitions.
559
27
  Context clearDefinition(const NamedDecl *D, Context Ctx) {
560
27
    Context NewCtx = Ctx;
561
27
    if (NewCtx.contains(D)) {
562
27
      NewCtx = ContextFactory.remove(NewCtx, D);
563
27
      NewCtx = ContextFactory.add(NewCtx, D, 0);
564
27
    }
565
27
    return NewCtx;
566
27
  }
567
568
  // Remove a definition entirely frmo the context.
569
12
  Context removeDefinition(const NamedDecl *D, Context Ctx) {
570
12
    Context NewCtx = Ctx;
571
12
    if (NewCtx.contains(D)) {
572
12
      NewCtx = ContextFactory.remove(NewCtx, D);
573
12
    }
574
12
    return NewCtx;
575
12
  }
576
577
  Context intersectContexts(Context C1, Context C2);
578
  Context createReferenceContext(Context C);
579
  void intersectBackEdge(Context C1, Context C2);
580
};
581
582
} // namespace
583
584
// This has to be defined after LocalVariableMap.
585
2.04k
CFGBlockInfo CFGBlockInfo::getEmptyBlockInfo(LocalVariableMap &M) {
586
2.04k
  return CFGBlockInfo(M.getEmptyContext());
587
2.04k
}
588
589
namespace {
590
591
/// Visitor which builds a LocalVariableMap
592
class VarMapBuilder : public ConstStmtVisitor<VarMapBuilder> {
593
public:
594
  LocalVariableMap* VMap;
595
  LocalVariableMap::Context Ctx;
596
597
  VarMapBuilder(LocalVariableMap *VM, LocalVariableMap::Context C)
598
7.48k
      : VMap(VM), Ctx(C) {}
599
600
  void VisitDeclStmt(const DeclStmt *S);
601
  void VisitBinaryOperator(const BinaryOperator *BO);
602
};
603
604
} // namespace
605
606
// Add new local variables to the variable map
607
920
void VarMapBuilder::VisitDeclStmt(const DeclStmt *S) {
608
920
  bool modifiedCtx = false;
609
920
  const DeclGroupRef DGrp = S->getDeclGroup();
610
920
  for (const auto *D : DGrp) {
611
920
    if (const auto *VD = dyn_cast_or_null<VarDecl>(D)) {
612
920
      const Expr *E = VD->getInit();
613
614
      // Add local variables with trivial type to the variable map
615
920
      QualType T = VD->getType();
616
920
      if (T.isTrivialType(VD->getASTContext())) {
617
572
        Ctx = VMap->addDefinition(VD, E, Ctx);
618
572
        modifiedCtx = true;
619
572
      }
620
920
    }
621
920
  }
622
920
  if (modifiedCtx)
623
572
    VMap->saveContext(S, Ctx);
624
920
}
625
626
// Update local variable definitions in variable map
627
1.89k
void VarMapBuilder::VisitBinaryOperator(const BinaryOperator *BO) {
628
1.89k
  if (!BO->isAssignmentOp())
629
389
    return;
630
631
1.50k
  Expr *LHSExp = BO->getLHS()->IgnoreParenCasts();
632
633
  // Update the variable map and current context.
634
1.50k
  if (const auto *DRE = dyn_cast<DeclRefExpr>(LHSExp)) {
635
334
    const ValueDecl *VDec = DRE->getDecl();
636
334
    if (Ctx.lookup(VDec)) {
637
162
      if (BO->getOpcode() == BO_Assign)
638
143
        Ctx = VMap->updateDefinition(VDec, BO->getRHS(), Ctx);
639
19
      else
640
        // FIXME -- handle compound assignment operators
641
19
        Ctx = VMap->clearDefinition(VDec, Ctx);
642
162
      VMap->saveContext(BO, Ctx);
643
162
    }
644
334
  }
645
1.50k
}
646
647
// Computes the intersection of two contexts.  The intersection is the
648
// set of variables which have the same definition in both contexts;
649
// variables with different definitions are discarded.
650
LocalVariableMap::Context
651
592
LocalVariableMap::intersectContexts(Context C1, Context C2) {
652
592
  Context Result = C1;
653
280
  for (const auto &P : C1) {
654
280
    const NamedDecl *Dec = P.first;
655
280
    const unsigned *i2 = C2.lookup(Dec);
656
280
    if (!i2)             // variable doesn't exist on second path
657
12
      Result = removeDefinition(Dec, Result);
658
268
    else if (*i2 != P.second)  // variable exists, but has different definition
659
8
      Result = clearDefinition(Dec, Result);
660
280
  }
661
592
  return Result;
662
592
}
663
664
// For every variable in C, create a new variable that refers to the
665
// definition in C.  Return a new context that contains these new variables.
666
// (We use this for a naive implementation of SSA on loop back-edges.)
667
106
LocalVariableMap::Context LocalVariableMap::createReferenceContext(Context C) {
668
106
  Context Result = getEmptyContext();
669
106
  for (const auto &P : C)
670
32
    Result = addReference(P.first, P.second, Result);
671
106
  return Result;
672
106
}
673
674
// This routine also takes the intersection of C1 and C2, but it does so by
675
// altering the VarDefinitions.  C1 must be the result of an earlier call to
676
// createReferenceContext.
677
98
void LocalVariableMap::intersectBackEdge(Context C1, Context C2) {
678
32
  for (const auto &P : C1) {
679
32
    unsigned i1 = P.second;
680
32
    VarDefinition *VDef = &VarDefinitions[i1];
681
32
    assert(VDef->isReference());
682
683
32
    const unsigned *i2 = C2.lookup(P.first);
684
32
    if (!i2 || (*i2 != i1))
685
12
      VDef->Ref = 0;    // Mark this variable as undefined
686
32
  }
687
98
}
688
689
// Traverse the CFG in topological order, so all predecessors of a block
690
// (excluding back-edges) are visited before the block itself.  At
691
// each point in the code, we calculate a Context, which holds the set of
692
// variable definitions which are visible at that point in execution.
693
// Visible variables are mapped to their definitions using an array that
694
// contains all definitions.
695
//
696
// At join points in the CFG, the set is computed as the intersection of
697
// the incoming sets along each edge, E.g.
698
//
699
//                       { Context                 | VarDefinitions }
700
//   int x = 0;          { x -> x1                 | x1 = 0 }
701
//   int y = 0;          { x -> x1, y -> y1        | y1 = 0, x1 = 0 }
702
//   if (b) x = 1;       { x -> x2, y -> y1        | x2 = 1, y1 = 0, ... }
703
//   else   x = 2;       { x -> x3, y -> y1        | x3 = 2, x2 = 1, ... }
704
//   ...                 { y -> y1  (x is unknown) | x3 = 2, x2 = 1, ... }
705
//
706
// This is essentially a simpler and more naive version of the standard SSA
707
// algorithm.  Those definitions that remain in the intersection are from blocks
708
// that strictly dominate the current block.  We do not bother to insert proper
709
// phi nodes, because they are not used in our analysis; instead, wherever
710
// a phi node would be required, we simply remove that definition from the
711
// context (E.g. x above).
712
//
713
// The initial traversal does not capture back-edges, so those need to be
714
// handled on a separate pass.  Whenever the first pass encounters an
715
// incoming back edge, it duplicates the context, creating new definitions
716
// that refer back to the originals.  (These correspond to places where SSA
717
// might have to insert a phi node.)  On the second pass, these definitions are
718
// set to NULL if the variable has changed on the back-edge (i.e. a phi
719
// node was actually required.)  E.g.
720
//
721
//                       { Context           | VarDefinitions }
722
//   int x = 0, y = 0;   { x -> x1, y -> y1  | y1 = 0, x1 = 0 }
723
//   while (b)           { x -> x2, y -> y1  | [1st:] x2=x1; [2nd:] x2=NULL; }
724
//     x = x+1;          { x -> x3, y -> y1  | x3 = x2 + 1, ... }
725
//   ...                 { y -> y1           | x3 = 2, x2 = 1, ... }
726
void LocalVariableMap::traverseCFG(CFG *CFGraph,
727
                                   const PostOrderCFGView *SortedGraph,
728
2.04k
                                   std::vector<CFGBlockInfo> &BlockInfo) {
729
2.04k
  PostOrderCFGView::CFGBlockSet VisitedBlocks(CFGraph);
730
731
2.04k
  CtxIndices.resize(CFGraph->getNumBlockIDs());
732
733
7.48k
  for (const auto *CurrBlock : *SortedGraph) {
734
7.48k
    unsigned CurrBlockID = CurrBlock->getBlockID();
735
7.48k
    CFGBlockInfo *CurrBlockInfo = &BlockInfo[CurrBlockID];
736
737
7.48k
    VisitedBlocks.insert(CurrBlock);
738
739
    // Calculate the entry context for the current block
740
7.48k
    bool HasBackEdges = false;
741
7.48k
    bool CtxInit = true;
742
7.48k
    for (CFGBlock::const_pred_iterator PI = CurrBlock->pred_begin(),
743
13.6k
         PE  = CurrBlock->pred_end(); PI != PE; 
++PI6.13k
) {
744
      // if *PI -> CurrBlock is a back edge, so skip it
745
6.13k
      if (*PI == nullptr || !VisitedBlocks.alreadySet(*PI)) {
746
106
        HasBackEdges = true;
747
106
        continue;
748
106
      }
749
750
6.02k
      unsigned PrevBlockID = (*PI)->getBlockID();
751
6.02k
      CFGBlockInfo *PrevBlockInfo = &BlockInfo[PrevBlockID];
752
753
6.02k
      if (CtxInit) {
754
5.43k
        CurrBlockInfo->EntryContext = PrevBlockInfo->ExitContext;
755
5.43k
        CtxInit = false;
756
5.43k
      }
757
592
      else {
758
592
        CurrBlockInfo->EntryContext =
759
592
          intersectContexts(CurrBlockInfo->EntryContext,
760
592
                            PrevBlockInfo->ExitContext);
761
592
      }
762
6.02k
    }
763
764
    // Duplicate the context if we have back-edges, so we can call
765
    // intersectBackEdges later.
766
7.48k
    if (HasBackEdges)
767
106
      CurrBlockInfo->EntryContext =
768
106
        createReferenceContext(CurrBlockInfo->EntryContext);
769
770
    // Create a starting context index for the current block
771
7.48k
    saveContext(nullptr, CurrBlockInfo->EntryContext);
772
7.48k
    CurrBlockInfo->EntryIndex = getContextIndex();
773
774
    // Visit all the statements in the basic block.
775
7.48k
    VarMapBuilder VMapBuilder(this, CurrBlockInfo->EntryContext);
776
34.4k
    for (const auto &BI : *CurrBlock) {
777
34.4k
      switch (BI.getKind()) {
778
34.1k
        case CFGElement::Statement: {
779
34.1k
          CFGStmt CS = BI.castAs<CFGStmt>();
780
34.1k
          VMapBuilder.Visit(CS.getStmt());
781
34.1k
          break;
782
0
        }
783
314
        default:
784
314
          break;
785
34.4k
      }
786
34.4k
    }
787
7.48k
    CurrBlockInfo->ExitContext = VMapBuilder.Ctx;
788
789
    // Mark variables on back edges as "unknown" if they've been changed.
790
7.48k
    for (CFGBlock::const_succ_iterator SI = CurrBlock->succ_begin(),
791
13.6k
         SE  = CurrBlock->succ_end(); SI != SE; 
++SI6.13k
) {
792
      // if CurrBlock -> *SI is *not* a back edge
793
6.13k
      if (*SI == nullptr || 
!VisitedBlocks.alreadySet(*SI)6.12k
)
794
6.03k
        continue;
795
796
98
      CFGBlock *FirstLoopBlock = *SI;
797
98
      Context LoopBegin = BlockInfo[FirstLoopBlock->getBlockID()].EntryContext;
798
98
      Context LoopEnd   = CurrBlockInfo->ExitContext;
799
98
      intersectBackEdge(LoopBegin, LoopEnd);
800
98
    }
801
7.48k
  }
802
803
  // Put an extra entry at the end of the indexed context array
804
2.04k
  unsigned exitID = CFGraph->getExit().getBlockID();
805
2.04k
  saveContext(nullptr, BlockInfo[exitID].ExitContext);
806
2.04k
}
807
808
/// Find the appropriate source locations to use when producing diagnostics for
809
/// each block in the CFG.
810
static void findBlockLocations(CFG *CFGraph,
811
                               const PostOrderCFGView *SortedGraph,
812
2.04k
                               std::vector<CFGBlockInfo> &BlockInfo) {
813
7.48k
  for (const auto *CurrBlock : *SortedGraph) {
814
7.48k
    CFGBlockInfo *CurrBlockInfo = &BlockInfo[CurrBlock->getBlockID()];
815
816
    // Find the source location of the last statement in the block, if the
817
    // block is not empty.
818
7.48k
    if (const Stmt *S = CurrBlock->getTerminatorStmt()) {
819
716
      CurrBlockInfo->EntryLoc = CurrBlockInfo->ExitLoc = S->getBeginLoc();
820
6.76k
    } else {
821
6.76k
      for (CFGBlock::const_reverse_iterator BI = CurrBlock->rbegin(),
822
7.04k
           BE = CurrBlock->rend(); BI != BE; 
++BI280
) {
823
        // FIXME: Handle other CFGElement kinds.
824
2.85k
        if (Optional<CFGStmt> CS = BI->getAs<CFGStmt>()) {
825
2.57k
          CurrBlockInfo->ExitLoc = CS->getStmt()->getBeginLoc();
826
2.57k
          break;
827
2.57k
        }
828
2.85k
      }
829
6.76k
    }
830
831
7.48k
    if (CurrBlockInfo->ExitLoc.isValid()) {
832
      // This block contains at least one statement. Find the source location
833
      // of the first statement in the block.
834
3.27k
      for (const auto &BI : *CurrBlock) {
835
        // FIXME: Handle other CFGElement kinds.
836
3.27k
        if (Optional<CFGStmt> CS = BI.getAs<CFGStmt>()) {
837
3.27k
          CurrBlockInfo->EntryLoc = CS->getStmt()->getBeginLoc();
838
3.27k
          break;
839
3.27k
        }
840
3.27k
      }
841
4.18k
    } else if (CurrBlock->pred_size() == 1 && 
*CurrBlock->pred_begin()1.92k
&&
842
1.92k
               CurrBlock != &CFGraph->getExit()) {
843
      // The block is empty, and has a single predecessor. Use its exit
844
      // location.
845
78
      CurrBlockInfo->EntryLoc = CurrBlockInfo->ExitLoc =
846
78
          BlockInfo[(*CurrBlock->pred_begin())->getBlockID()].ExitLoc;
847
78
    }
848
7.48k
  }
849
2.04k
}
850
851
namespace {
852
853
class LockableFactEntry : public FactEntry {
854
private:
855
  /// managed by ScopedLockable object
856
  bool Managed;
857
858
public:
859
  LockableFactEntry(const CapabilityExpr &CE, LockKind LK, SourceLocation Loc,
860
                    bool Mng = false, bool Asrt = false)
861
4.29k
      : FactEntry(CE, LK, Loc, Asrt), Managed(Mng) {}
862
863
  void
864
  handleRemovalFromIntersection(const FactSet &FSet, FactManager &FactMan,
865
                                SourceLocation JoinLoc, LockErrorKind LEK,
866
1.58k
                                ThreadSafetyHandler &Handler) const override {
867
1.58k
    if (!Managed && 
!asserted()1.56k
&&
!negative()1.52k
&&
!isUniversal()169
) {
868
165
      Handler.handleMutexHeldEndOfScope("mutex", toString(), loc(), JoinLoc,
869
165
                                        LEK);
870
165
    }
871
1.58k
  }
872
873
  void handleLock(FactSet &FSet, FactManager &FactMan, const FactEntry &entry,
874
                  ThreadSafetyHandler &Handler,
875
67
                  StringRef DiagKind) const override {
876
67
    Handler.handleDoubleLock(DiagKind, entry.toString(), loc(), entry.loc());
877
67
  }
878
879
  void handleUnlock(FactSet &FSet, FactManager &FactMan,
880
                    const CapabilityExpr &Cp, SourceLocation UnlockLoc,
881
                    bool FullyRemove, ThreadSafetyHandler &Handler,
882
1.45k
                    StringRef DiagKind) const override {
883
1.45k
    FSet.removeLock(FactMan, Cp);
884
1.45k
    if (!Cp.negative()) {
885
1.45k
      FSet.addLock(FactMan, std::make_unique<LockableFactEntry>(
886
1.45k
                                !Cp, LK_Exclusive, UnlockLoc));
887
1.45k
    }
888
1.45k
  }
889
};
890
891
class ScopedLockableFactEntry : public FactEntry {
892
private:
893
  enum UnderlyingCapabilityKind {
894
    UCK_Acquired,          ///< Any kind of acquired capability.
895
    UCK_ReleasedShared,    ///< Shared capability that was released.
896
    UCK_ReleasedExclusive, ///< Exclusive capability that was released.
897
  };
898
899
  using UnderlyingCapability =
900
      llvm::PointerIntPair<const til::SExpr *, 2, UnderlyingCapabilityKind>;
901
902
  SmallVector<UnderlyingCapability, 4> UnderlyingMutexes;
903
904
public:
905
  ScopedLockableFactEntry(const CapabilityExpr &CE, SourceLocation Loc)
906
246
      : FactEntry(CE, LK_Exclusive, Loc, false) {}
907
908
214
  void addLock(const CapabilityExpr &M) {
909
214
    UnderlyingMutexes.emplace_back(M.sexpr(), UCK_Acquired);
910
214
  }
911
912
28
  void addExclusiveUnlock(const CapabilityExpr &M) {
913
28
    UnderlyingMutexes.emplace_back(M.sexpr(), UCK_ReleasedExclusive);
914
28
  }
915
916
8
  void addSharedUnlock(const CapabilityExpr &M) {
917
8
    UnderlyingMutexes.emplace_back(M.sexpr(), UCK_ReleasedShared);
918
8
  }
919
920
  void
921
  handleRemovalFromIntersection(const FactSet &FSet, FactManager &FactMan,
922
                                SourceLocation JoinLoc, LockErrorKind LEK,
923
28
                                ThreadSafetyHandler &Handler) const override {
924
28
    for (const auto &UnderlyingMutex : UnderlyingMutexes) {
925
28
      const auto *Entry = FSet.findLock(
926
28
          FactMan, CapabilityExpr(UnderlyingMutex.getPointer(), false));
927
28
      if ((UnderlyingMutex.getInt() == UCK_Acquired && Entry) ||
928
16
          (UnderlyingMutex.getInt() != UCK_Acquired && 
!Entry0
)) {
929
        // If this scoped lock manages another mutex, and if the underlying
930
        // mutex is still/not held, then warn about the underlying mutex.
931
12
        Handler.handleMutexHeldEndOfScope(
932
12
            "mutex", sx::toString(UnderlyingMutex.getPointer()), loc(), JoinLoc,
933
12
            LEK);
934
12
      }
935
28
    }
936
28
  }
937
938
  void handleLock(FactSet &FSet, FactManager &FactMan, const FactEntry &entry,
939
                  ThreadSafetyHandler &Handler,
940
56
                  StringRef DiagKind) const override {
941
56
    for (const auto &UnderlyingMutex : UnderlyingMutexes) {
942
56
      CapabilityExpr UnderCp(UnderlyingMutex.getPointer(), false);
943
944
56
      if (UnderlyingMutex.getInt() == UCK_Acquired)
945
48
        lock(FSet, FactMan, UnderCp, entry.kind(), entry.loc(), &Handler,
946
48
             DiagKind);
947
8
      else
948
8
        unlock(FSet, FactMan, UnderCp, entry.loc(), &Handler, DiagKind);
949
56
    }
950
56
  }
951
952
  void handleUnlock(FactSet &FSet, FactManager &FactMan,
953
                    const CapabilityExpr &Cp, SourceLocation UnlockLoc,
954
                    bool FullyRemove, ThreadSafetyHandler &Handler,
955
322
                    StringRef DiagKind) const override {
956
322
    assert(!Cp.negative() && "Managing object cannot be negative.");
957
326
    for (const auto &UnderlyingMutex : UnderlyingMutexes) {
958
326
      CapabilityExpr UnderCp(UnderlyingMutex.getPointer(), false);
959
960
      // Remove/lock the underlying mutex if it exists/is still unlocked; warn
961
      // on double unlocking/locking if we're not destroying the scoped object.
962
222
      ThreadSafetyHandler *TSHandler = FullyRemove ? nullptr : 
&Handler104
;
963
326
      if (UnderlyingMutex.getInt() == UCK_Acquired) {
964
270
        unlock(FSet, FactMan, UnderCp, UnlockLoc, TSHandler, DiagKind);
965
56
      } else {
966
56
        LockKind kind = UnderlyingMutex.getInt() == UCK_ReleasedShared
967
8
                            ? LK_Shared
968
48
                            : LK_Exclusive;
969
56
        lock(FSet, FactMan, UnderCp, kind, UnlockLoc, TSHandler, DiagKind);
970
56
      }
971
326
    }
972
322
    if (FullyRemove)
973
218
      FSet.removeLock(FactMan, Cp);
974
322
  }
975
976
private:
977
  void lock(FactSet &FSet, FactManager &FactMan, const CapabilityExpr &Cp,
978
            LockKind kind, SourceLocation loc, ThreadSafetyHandler *Handler,
979
104
            StringRef DiagKind) const {
980
104
    if (const FactEntry *Fact = FSet.findLock(FactMan, Cp)) {
981
20
      if (Handler)
982
12
        Handler->handleDoubleLock(DiagKind, Cp.toString(), Fact->loc(), loc);
983
84
    } else {
984
84
      FSet.removeLock(FactMan, !Cp);
985
84
      FSet.addLock(FactMan,
986
84
                   std::make_unique<LockableFactEntry>(Cp, kind, loc));
987
84
    }
988
104
  }
989
990
  void unlock(FactSet &FSet, FactManager &FactMan, const CapabilityExpr &Cp,
991
              SourceLocation loc, ThreadSafetyHandler *Handler,
992
278
              StringRef DiagKind) const {
993
278
    if (FSet.findLock(FactMan, Cp)) {
994
230
      FSet.removeLock(FactMan, Cp);
995
230
      FSet.addLock(FactMan, std::make_unique<LockableFactEntry>(
996
230
                                !Cp, LK_Exclusive, loc));
997
48
    } else if (Handler) {
998
16
      SourceLocation PrevLoc;
999
16
      if (const FactEntry *Neg = FSet.findLock(FactMan, !Cp))
1000
12
        PrevLoc = Neg->loc();
1001
16
      Handler->handleUnmatchedUnlock(DiagKind, Cp.toString(), loc, PrevLoc);
1002
16
    }
1003
278
  }
1004
};
1005
1006
/// Class which implements the core thread safety analysis routines.
1007
class ThreadSafetyAnalyzer {
1008
  friend class BuildLockset;
1009
  friend class threadSafety::BeforeSet;
1010
1011
  llvm::BumpPtrAllocator Bpa;
1012
  threadSafety::til::MemRegionRef Arena;
1013
  threadSafety::SExprBuilder SxBuilder;
1014
1015
  ThreadSafetyHandler &Handler;
1016
  const CXXMethodDecl *CurrentMethod;
1017
  LocalVariableMap LocalVarMap;
1018
  FactManager FactMan;
1019
  std::vector<CFGBlockInfo> BlockInfo;
1020
1021
  BeforeSet *GlobalBeforeSet;
1022
1023
public:
1024
  ThreadSafetyAnalyzer(ThreadSafetyHandler &H, BeforeSet* Bset)
1025
2.16k
      : Arena(&Bpa), SxBuilder(Arena), Handler(H), GlobalBeforeSet(Bset) {}
1026
1027
  bool inCurrentScope(const CapabilityExpr &CapE);
1028
1029
  void addLock(FactSet &FSet, std::unique_ptr<FactEntry> Entry,
1030
               StringRef DiagKind, bool ReqAttr = false);
1031
  void removeLock(FactSet &FSet, const CapabilityExpr &CapE,
1032
                  SourceLocation UnlockLoc, bool FullyRemove, LockKind Kind,
1033
                  StringRef DiagKind);
1034
1035
  template <typename AttrType>
1036
  void getMutexIDs(CapExprSet &Mtxs, AttrType *Attr, const Expr *Exp,
1037
                   const NamedDecl *D, VarDecl *SelfDecl = nullptr);
1038
1039
  template <class AttrType>
1040
  void getMutexIDs(CapExprSet &Mtxs, AttrType *Attr, const Expr *Exp,
1041
                   const NamedDecl *D,
1042
                   const CFGBlock *PredBlock, const CFGBlock *CurrBlock,
1043
                   Expr *BrE, bool Neg);
1044
1045
  const CallExpr* getTrylockCallExpr(const Stmt *Cond, LocalVarContext C,
1046
                                     bool &Negate);
1047
1048
  void getEdgeLockset(FactSet &Result, const FactSet &ExitSet,
1049
                      const CFGBlock* PredBlock,
1050
                      const CFGBlock *CurrBlock);
1051
1052
  void intersectAndWarn(FactSet &FSet1, const FactSet &FSet2,
1053
                        SourceLocation JoinLoc,
1054
                        LockErrorKind LEK1, LockErrorKind LEK2,
1055
                        bool Modify=true);
1056
1057
  void intersectAndWarn(FactSet &FSet1, const FactSet &FSet2,
1058
                        SourceLocation JoinLoc, LockErrorKind LEK1,
1059
670
                        bool Modify=true) {
1060
670
    intersectAndWarn(FSet1, FSet2, JoinLoc, LEK1, LEK1, Modify);
1061
670
  }
1062
1063
  void runAnalysis(AnalysisDeclContext &AC);
1064
};
1065
1066
} // namespace
1067
1068
/// Process acquired_before and acquired_after attributes on Vd.
1069
BeforeSet::BeforeInfo* BeforeSet::insertAttrExprs(const ValueDecl* Vd,
1070
771
    ThreadSafetyAnalyzer& Analyzer) {
1071
  // Create a new entry for Vd.
1072
771
  BeforeInfo *Info = nullptr;
1073
771
  {
1074
    // Keep InfoPtr in its own scope in case BMap is modified later and the
1075
    // reference becomes invalid.
1076
771
    std::unique_ptr<BeforeInfo> &InfoPtr = BMap[Vd];
1077
771
    if (!InfoPtr)
1078
771
      InfoPtr.reset(new BeforeInfo());
1079
771
    Info = InfoPtr.get();
1080
771
  }
1081
1082
137
  for (const auto *At : Vd->attrs()) {
1083
137
    switch (At->getKind()) {
1084
52
      case attr::AcquiredBefore: {
1085
52
        const auto *A = cast<AcquiredBeforeAttr>(At);
1086
1087
        // Read exprs from the attribute, and add them to BeforeVect.
1088
64
        for (const auto *Arg : A->args()) {
1089
64
          CapabilityExpr Cp =
1090
64
            Analyzer.SxBuilder.translateAttrExpr(Arg, nullptr);
1091
64
          if (const ValueDecl *Cpvd = Cp.valueDecl()) {
1092
60
            Info->Vect.push_back(Cpvd);
1093
60
            const auto It = BMap.find(Cpvd);
1094
60
            if (It == BMap.end())
1095
40
              insertAttrExprs(Cpvd, Analyzer);
1096
60
          }
1097
64
        }
1098
52
        break;
1099
0
      }
1100
85
      case attr::AcquiredAfter: {
1101
85
        const auto *A = cast<AcquiredAfterAttr>(At);
1102
1103
        // Read exprs from the attribute, and add them to BeforeVect.
1104
93
        for (const auto *Arg : A->args()) {
1105
93
          CapabilityExpr Cp =
1106
93
            Analyzer.SxBuilder.translateAttrExpr(Arg, nullptr);
1107
93
          if (const ValueDecl *ArgVd = Cp.valueDecl()) {
1108
            // Get entry for mutex listed in attribute
1109
93
            BeforeInfo *ArgInfo = getBeforeInfoForDecl(ArgVd, Analyzer);
1110
93
            ArgInfo->Vect.push_back(Vd);
1111
93
          }
1112
93
        }
1113
85
        break;
1114
0
      }
1115
0
      default:
1116
0
        break;
1117
137
    }
1118
137
  }
1119
1120
771
  return Info;
1121
771
}
1122
1123
BeforeSet::BeforeInfo *
1124
BeforeSet::getBeforeInfoForDecl(const ValueDecl *Vd,
1125
2.56k
                                ThreadSafetyAnalyzer &Analyzer) {
1126
2.56k
  auto It = BMap.find(Vd);
1127
2.56k
  BeforeInfo *Info = nullptr;
1128
2.56k
  if (It == BMap.end())
1129
731
    Info = insertAttrExprs(Vd, Analyzer);
1130
1.83k
  else
1131
1.83k
    Info = It->second.get();
1132
2.56k
  assert(Info && "BMap contained nullptr?");
1133
2.56k
  return Info;
1134
2.56k
}
1135
1136
/// Return true if any mutexes in FSet are in the acquired_before set of Vd.
1137
void BeforeSet::checkBeforeAfter(const ValueDecl* StartVd,
1138
                                 const FactSet& FSet,
1139
                                 ThreadSafetyAnalyzer& Analyzer,
1140
2.02k
                                 SourceLocation Loc, StringRef CapKind) {
1141
2.02k
  SmallVector<BeforeInfo*, 8> InfoVect;
1142
1143
  // Do a depth-first traversal of Vd.
1144
  // Return true if there are cycles.
1145
2.51k
  std::function<bool (const ValueDecl*)> traverse = [&](const ValueDecl* Vd) {
1146
2.51k
    if (!Vd)
1147
44
      return false;
1148
1149
2.47k
    BeforeSet::BeforeInfo *Info = getBeforeInfoForDecl(Vd, Analyzer);
1150
1151
2.47k
    if (Info->Visited == 1)
1152
32
      return true;
1153
1154
2.44k
    if (Info->Visited == 2)
1155
16
      return false;
1156
1157
2.42k
    if (Info->Vect.empty())
1158
1.97k
      return false;
1159
1160
450
    InfoVect.push_back(Info);
1161
450
    Info->Visited = 1;
1162
490
    for (const auto *Vdb : Info->Vect) {
1163
      // Exclude mutexes in our immediate before set.
1164
490
      if (FSet.containsMutexDecl(Analyzer.FactMan, Vdb)) {
1165
49
        StringRef L1 = StartVd->getName();
1166
49
        StringRef L2 = Vdb->getName();
1167
49
        Analyzer.Handler.handleLockAcquiredBefore(CapKind, L1, L2, Loc);
1168
49
      }
1169
      // Transitively search other before sets, and warn on cycles.
1170
490
      if (traverse(Vdb)) {
1171
32
        if (CycMap.find(Vd) == CycMap.end()) {
1172
20
          CycMap.insert(std::make_pair(Vd, true));
1173
20
          StringRef L1 = Vd->getName();
1174
20
          Analyzer.Handler.handleBeforeAfterCycle(L1, Vd->getLocation());
1175
20
        }
1176
32
      }
1177
490
    }
1178
450
    Info->Visited = 2;
1179
450
    return false;
1180
450
  };
1181
1182
2.02k
  traverse(StartVd);
1183
1184
2.02k
  for (auto *Info : InfoVect)
1185
450
    Info->Visited = 0;
1186
2.02k
}
1187
1188
/// Gets the value decl pointer from DeclRefExprs or MemberExprs.
1189
17.8k
static const ValueDecl *getValueDecl(const Expr *Exp) {
1190
17.8k
  if (const auto *CE = dyn_cast<ImplicitCastExpr>(Exp))
1191
0
    return getValueDecl(CE->getSubExpr());
1192
1193
17.8k
  if (const auto *DR = dyn_cast<DeclRefExpr>(Exp))
1194
5.00k
    return DR->getDecl();
1195
1196
12.8k
  if (const auto *ME = dyn_cast<MemberExpr>(Exp))
1197
8.16k
    return ME->getMemberDecl();
1198
1199
4.67k
  return nullptr;
1200
4.67k
}
1201
1202
namespace {
1203
1204
template <typename Ty>
1205
class has_arg_iterator_range {
1206
  using yes = char[1];
1207
  using no = char[2];
1208
1209
  template <typename Inner>
1210
  static yes& test(Inner *I, decltype(I->args()) * = nullptr);
1211
1212
  template <typename>
1213
  static no& test(...);
1214
1215
public:
1216
  static const bool value = sizeof(test<Ty>(nullptr)) == sizeof(yes);
1217
};
1218
1219
} // namespace
1220
1221
4.02k
static StringRef ClassifyDiagnostic(const CapabilityAttr *A) {
1222
4.02k
  return A->getName();
1223
4.02k
}
1224
1225
4.56k
static StringRef ClassifyDiagnostic(QualType VDT) {
1226
  // We need to look at the declaration of the type of the value to determine
1227
  // which it is. The type should either be a record or a typedef, or a pointer
1228
  // or reference thereof.
1229
4.56k
  if (const auto *RT = VDT->getAs<RecordType>()) {
1230
4.13k
    if (const auto *RD = RT->getDecl())
1231
4.13k
      if (const auto *CA = RD->getAttr<CapabilityAttr>())
1232
3.98k
        return ClassifyDiagnostic(CA);
1233
425
  } else if (const auto *TT = VDT->getAs<TypedefType>()) {
1234
44
    if (const auto *TD = TT->getDecl())
1235
44
      if (const auto *CA = TD->getAttr<CapabilityAttr>())
1236
44
        return ClassifyDiagnostic(CA);
1237
381
  } else if (VDT->isPointerType() || 
VDT->isReferenceType()6
)
1238
377
    return ClassifyDiagnostic(VDT->getPointeeType());
1239
1240
156
  return "mutex";
1241
156
}
1242
1243
4.18k
static StringRef ClassifyDiagnostic(const ValueDecl *VD) {
1244
4.18k
  assert(VD && "No ValueDecl passed");
1245
1246
  // The ValueDecl is the declaration of a mutex or role (hopefully).
1247
4.18k
  return ClassifyDiagnostic(VD->getType());
1248
4.18k
}
1249
1250
template <typename AttrTy>
1251
static std::enable_if_t<!has_arg_iterator_range<AttrTy>::value, StringRef>
1252
2.32k
ClassifyDiagnostic(const AttrTy *A) {
1253
2.32k
  if (const ValueDecl *VD = getValueDecl(A->getArg()))
1254
2.13k
    return ClassifyDiagnostic(VD);
1255
184
  return "mutex";
1256
184
}
ThreadSafety.cpp:std::__1::enable_if<!(has_arg_iterator_range<clang::PtGuardedByAttr>::value), llvm::StringRef>::type ClassifyDiagnostic<clang::PtGuardedByAttr>(clang::PtGuardedByAttr const*)
Line
Count
Source
1252
388
ClassifyDiagnostic(const AttrTy *A) {
1253
388
  if (const ValueDecl *VD = getValueDecl(A->getArg()))
1254
388
    return ClassifyDiagnostic(VD);
1255
0
  return "mutex";
1256
0
}
ThreadSafety.cpp:std::__1::enable_if<!(has_arg_iterator_range<clang::GuardedByAttr>::value), llvm::StringRef>::type ClassifyDiagnostic<clang::GuardedByAttr>(clang::GuardedByAttr const*)
Line
Count
Source
1252
1.93k
ClassifyDiagnostic(const AttrTy *A) {
1253
1.93k
  if (const ValueDecl *VD = getValueDecl(A->getArg()))
1254
1.74k
    return ClassifyDiagnostic(VD);
1255
184
  return "mutex";
1256
184
}
1257
1258
template <typename AttrTy>
1259
static std::enable_if_t<has_arg_iterator_range<AttrTy>::value, StringRef>
1260
5.42k
ClassifyDiagnostic(const AttrTy *A) {
1261
2.40k
  for (const auto *Arg : A->args()) {
1262
2.40k
    if (const ValueDecl *VD = getValueDecl(Arg))
1263
2.04k
      return ClassifyDiagnostic(VD);
1264
2.40k
  }
1265
3.37k
  return "mutex";
1266
5.42k
}
ThreadSafety.cpp:std::__1::enable_if<has_arg_iterator_range<clang::RequiresCapabilityAttr>::value, llvm::StringRef>::type ClassifyDiagnostic<clang::RequiresCapabilityAttr>(clang::RequiresCapabilityAttr const*)
Line
Count
Source
1260
1.05k
ClassifyDiagnostic(const AttrTy *A) {
1261
1.08k
  for (const auto *Arg : A->args()) {
1262
1.08k
    if (const ValueDecl *VD = getValueDecl(Arg))
1263
848
      return ClassifyDiagnostic(VD);
1264
1.08k
  }
1265
202
  return "mutex";
1266
1.05k
}
ThreadSafety.cpp:std::__1::enable_if<has_arg_iterator_range<clang::ReleaseCapabilityAttr>::value, llvm::StringRef>::type ClassifyDiagnostic<clang::ReleaseCapabilityAttr>(clang::ReleaseCapabilityAttr const*)
Line
Count
Source
1260
1.99k
ClassifyDiagnostic(const AttrTy *A) {
1261
459
  for (const auto *Arg : A->args()) {
1262
459
    if (const ValueDecl *VD = getValueDecl(Arg))
1263
415
      return ClassifyDiagnostic(VD);
1264
459
  }
1265
1.57k
  return "mutex";
1266
1.99k
}
ThreadSafety.cpp:std::__1::enable_if<has_arg_iterator_range<clang::AcquireCapabilityAttr>::value, llvm::StringRef>::type ClassifyDiagnostic<clang::AcquireCapabilityAttr>(clang::AcquireCapabilityAttr const*)
Line
Count
Source
1260
1.82k
ClassifyDiagnostic(const AttrTy *A) {
1261
592
  for (const auto *Arg : A->args()) {
1262
592
    if (const ValueDecl *VD = getValueDecl(Arg))
1263
536
      return ClassifyDiagnostic(VD);
1264
592
  }
1265
1.28k
  return "mutex";
1266
1.82k
}
ThreadSafety.cpp:std::__1::enable_if<has_arg_iterator_range<clang::TryAcquireCapabilityAttr>::value, llvm::StringRef>::type ClassifyDiagnostic<clang::TryAcquireCapabilityAttr>(clang::TryAcquireCapabilityAttr const*)
Line
Count
Source
1260
168
ClassifyDiagnostic(const AttrTy *A) {
1261
52
  for (const auto *Arg : A->args()) {
1262
52
    if (const ValueDecl *VD = getValueDecl(Arg))
1263
48
      return ClassifyDiagnostic(VD);
1264
52
  }
1265
120
  return "mutex";
1266
168
}
ThreadSafety.cpp:std::__1::enable_if<has_arg_iterator_range<clang::ExclusiveTrylockFunctionAttr>::value, llvm::StringRef>::type ClassifyDiagnostic<clang::ExclusiveTrylockFunctionAttr>(clang::ExclusiveTrylockFunctionAttr const*)
Line
Count
Source
1260
156
ClassifyDiagnostic(const AttrTy *A) {
1261
44
  for (const auto *Arg : A->args()) {
1262
44
    if (const ValueDecl *VD = getValueDecl(Arg))
1263
40
      return ClassifyDiagnostic(VD);
1264
44
  }
1265
116
  return "mutex";
1266
156
}
ThreadSafety.cpp:std::__1::enable_if<has_arg_iterator_range<clang::SharedTrylockFunctionAttr>::value, llvm::StringRef>::type ClassifyDiagnostic<clang::SharedTrylockFunctionAttr>(clang::SharedTrylockFunctionAttr const*)
Line
Count
Source
1260
12
ClassifyDiagnostic(const AttrTy *A) {
1261
8
  for (const auto *Arg : A->args()) {
1262
8
    if (const ValueDecl *VD = getValueDecl(Arg))
1263
8
      return ClassifyDiagnostic(VD);
1264
8
  }
1265
4
  return "mutex";
1266
12
}
ThreadSafety.cpp:std::__1::enable_if<has_arg_iterator_range<clang::AssertExclusiveLockAttr>::value, llvm::StringRef>::type ClassifyDiagnostic<clang::AssertExclusiveLockAttr>(clang::AssertExclusiveLockAttr const*)
Line
Count
Source
1260
34
ClassifyDiagnostic(const AttrTy *A) {
1261
10
  for (const auto *Arg : A->args()) {
1262
10
    if (const ValueDecl *VD = getValueDecl(Arg))
1263
10
      return ClassifyDiagnostic(VD);
1264
10
  }
1265
24
  return "mutex";
1266
34
}
ThreadSafety.cpp:std::__1::enable_if<has_arg_iterator_range<clang::AssertSharedLockAttr>::value, llvm::StringRef>::type ClassifyDiagnostic<clang::AssertSharedLockAttr>(clang::AssertSharedLockAttr const*)
Line
Count
Source
1260
10
ClassifyDiagnostic(const AttrTy *A) {
1261
8
  for (const auto *Arg : A->args()) {
1262
8
    if (const ValueDecl *VD = getValueDecl(Arg))
1263
8
      return ClassifyDiagnostic(VD);
1264
8
  }
1265
2
  return "mutex";
1266
10
}
ThreadSafety.cpp:std::__1::enable_if<has_arg_iterator_range<clang::AssertCapabilityAttr>::value, llvm::StringRef>::type ClassifyDiagnostic<clang::AssertCapabilityAttr>(clang::AssertCapabilityAttr const*)
Line
Count
Source
1260
44
ClassifyDiagnostic(const AttrTy *A) {
1261
18
  for (const auto *Arg : A->args()) {
1262
18
    if (const ValueDecl *VD = getValueDecl(Arg))
1263
18
      return ClassifyDiagnostic(VD);
1264
18
  }
1265
26
  return "mutex";
1266
44
}
ThreadSafety.cpp:std::__1::enable_if<has_arg_iterator_range<clang::LocksExcludedAttr>::value, llvm::StringRef>::type ClassifyDiagnostic<clang::LocksExcludedAttr>(clang::LocksExcludedAttr const*)
Line
Count
Source
1260
134
ClassifyDiagnostic(const AttrTy *A) {
1261
134
  for (const auto *Arg : A->args()) {
1262
134
    if (const ValueDecl *VD = getValueDecl(Arg))
1263
118
      return ClassifyDiagnostic(VD);
1264
134
  }
1265
16
  return "mutex";
1266
134
}
1267
1268
1.93k
bool ThreadSafetyAnalyzer::inCurrentScope(const CapabilityExpr &CapE) {
1269
1.93k
  if (!CurrentMethod)
1270
969
      return false;
1271
967
  if (const auto *P = dyn_cast_or_null<til::Project>(CapE.sexpr())) {
1272
807
    const auto *VD = P->clangDecl();
1273
807
    if (VD)
1274
807
      return VD->getDeclContext() == CurrentMethod->getDeclContext();
1275
160
  }
1276
160
  return false;
1277
160
}
1278
1279
/// Add a new lock to the lockset, warning if the lock is already there.
1280
/// \param ReqAttr -- true if this is part of an initial Requires attribute.
1281
void ThreadSafetyAnalyzer::addLock(FactSet &FSet,
1282
                                   std::unique_ptr<FactEntry> Entry,
1283
2.68k
                                   StringRef DiagKind, bool ReqAttr) {
1284
2.68k
  if (Entry->shouldIgnore())
1285
0
    return;
1286
1287
2.68k
  if (!ReqAttr && 
!Entry->negative()2.18k
) {
1288
    // look for the negative capability, and remove it from the fact set.
1289
2.18k
    CapabilityExpr NegC = !*Entry;
1290
2.18k
    const FactEntry *Nen = FSet.findLock(FactMan, NegC);
1291
2.18k
    if (Nen) {
1292
274
      FSet.removeLock(FactMan, NegC);
1293
274
    }
1294
1.91k
    else {
1295
1.91k
      if (inCurrentScope(*Entry) && 
!Entry->asserted()731
)
1296
643
        Handler.handleNegativeNotHeld(DiagKind, Entry->toString(),
1297
643
                                      NegC.toString(), Entry->loc());
1298
1.91k
    }
1299
2.18k
  }
1300
1301
  // Check before/after constraints
1302
2.68k
  if (Handler.issueBetaWarnings() &&
1303
2.60k
      !Entry->asserted() && 
!Entry->declared()2.52k
) {
1304
2.02k
    GlobalBeforeSet->checkBeforeAfter(Entry->valueDecl(), FSet, *this,
1305
2.02k
                                      Entry->loc(), DiagKind);
1306
2.02k
  }
1307
1308
  // FIXME: Don't always warn when we have support for reentrant locks.
1309
2.68k
  if (const FactEntry *Cp = FSet.findLock(FactMan, *Entry)) {
1310
151
    if (!Entry->asserted())
1311
123
      Cp->handleLock(FSet, FactMan, *Entry, Handler, DiagKind);
1312
2.53k
  } else {
1313
2.53k
    FSet.addLock(FactMan, std::move(Entry));
1314
2.53k
  }
1315
2.68k
}
1316
1317
/// Remove a lock from the lockset, warning if the lock is not there.
1318
/// \param UnlockLoc The source location of the unlock (only used in error msg)
1319
void ThreadSafetyAnalyzer::removeLock(FactSet &FSet, const CapabilityExpr &Cp,
1320
                                      SourceLocation UnlockLoc,
1321
                                      bool FullyRemove, LockKind ReceivedKind,
1322
1.86k
                                      StringRef DiagKind) {
1323
1.86k
  if (Cp.shouldIgnore())
1324
0
    return;
1325
1326
1.86k
  const FactEntry *LDat = FSet.findLock(FactMan, Cp);
1327
1.86k
  if (!LDat) {
1328
84
    SourceLocation PrevLoc;
1329
84
    if (const FactEntry *Neg = FSet.findLock(FactMan, !Cp))
1330
42
      PrevLoc = Neg->loc();
1331
84
    Handler.handleUnmatchedUnlock(DiagKind, Cp.toString(), UnlockLoc, PrevLoc);
1332
84
    return;
1333
84
  }
1334
1335
  // Generic lock removal doesn't care about lock kind mismatches, but
1336
  // otherwise diagnose when the lock kinds are mismatched.
1337
1.78k
  if (ReceivedKind != LK_Generic && 
LDat->kind() != ReceivedKind186
) {
1338
18
    Handler.handleIncorrectUnlockKind(DiagKind, Cp.toString(), LDat->kind(),
1339
18
                                      ReceivedKind, LDat->loc(), UnlockLoc);
1340
18
  }
1341
1342
1.78k
  LDat->handleUnlock(FSet, FactMan, Cp, UnlockLoc, FullyRemove, Handler,
1343
1.78k
                     DiagKind);
1344
1.78k
}
1345
1346
/// Extract the list of mutexIDs from the attribute on an expression,
1347
/// and push them onto Mtxs, discarding any duplicates.
1348
template <typename AttrType>
1349
void ThreadSafetyAnalyzer::getMutexIDs(CapExprSet &Mtxs, AttrType *Attr,
1350
                                       const Expr *Exp, const NamedDecl *D,
1351
4.56k
                                       VarDecl *SelfDecl) {
1352
4.56k
  if (Attr->args_size() == 0) {
1353
    // The mutex held is the "this" object.
1354
2.93k
    CapabilityExpr Cp = SxBuilder.translateAttrExpr(nullptr, D, Exp, SelfDecl);
1355
2.93k
    if (Cp.isInvalid()) {
1356
0
       warnInvalidLock(Handler, nullptr, D, Exp, ClassifyDiagnostic(Attr));
1357
0
       return;
1358
0
    }
1359
    //else
1360
2.93k
    if (!Cp.shouldIgnore())
1361
2.93k
      Mtxs.push_back_nodup(Cp);
1362
2.93k
    return;
1363
2.93k
  }
1364
1365
1.98k
  
for (const auto *Arg : Attr->args())1.63k
{
1366
1.98k
    CapabilityExpr Cp = SxBuilder.translateAttrExpr(Arg, D, Exp, SelfDecl);
1367
1.98k
    if (Cp.isInvalid()) {
1368
0
       warnInvalidLock(Handler, nullptr, D, Exp, ClassifyDiagnostic(Attr));
1369
0
       continue;
1370
0
    }
1371
    //else
1372
1.98k
    if (!Cp.shouldIgnore())
1373
1.97k
      Mtxs.push_back_nodup(Cp);
1374
1.98k
  }
1375
1.63k
}
ThreadSafety.cpp:void (anonymous namespace)::ThreadSafetyAnalyzer::getMutexIDs<clang::RequiresCapabilityAttr const>((anonymous namespace)::CapExprSet&, clang::RequiresCapabilityAttr const*, clang::Expr const*, clang::NamedDecl const*, clang::VarDecl*)
Line
Count
Source
1351
414
                                       VarDecl *SelfDecl) {
1352
414
  if (Attr->args_size() == 0) {
1353
    // The mutex held is the "this" object.
1354
0
    CapabilityExpr Cp = SxBuilder.translateAttrExpr(nullptr, D, Exp, SelfDecl);
1355
0
    if (Cp.isInvalid()) {
1356
0
       warnInvalidLock(Handler, nullptr, D, Exp, ClassifyDiagnostic(Attr));
1357
0
       return;
1358
0
    }
1359
    //else
1360
0
    if (!Cp.shouldIgnore())
1361
0
      Mtxs.push_back_nodup(Cp);
1362
0
    return;
1363
0
  }
1364
1365
466
  
for (const auto *Arg : Attr->args())414
{
1366
466
    CapabilityExpr Cp = SxBuilder.translateAttrExpr(Arg, D, Exp, SelfDecl);
1367
466
    if (Cp.isInvalid()) {
1368
0
       warnInvalidLock(Handler, nullptr, D, Exp, ClassifyDiagnostic(Attr));
1369
0
       continue;
1370
0
    }
1371
    //else
1372
466
    if (!Cp.shouldIgnore())
1373
466
      Mtxs.push_back_nodup(Cp);
1374
466
  }
1375
414
}
ThreadSafety.cpp:void (anonymous namespace)::ThreadSafetyAnalyzer::getMutexIDs<clang::ReleaseCapabilityAttr const>((anonymous namespace)::CapExprSet&, clang::ReleaseCapabilityAttr const*, clang::Expr const*, clang::NamedDecl const*, clang::VarDecl*)
Line
Count
Source
1351
2.07k
                                       VarDecl *SelfDecl) {
1352
2.07k
  if (Attr->args_size() == 0) {
1353
    // The mutex held is the "this" object.
1354
1.53k
    CapabilityExpr Cp = SxBuilder.translateAttrExpr(nullptr, D, Exp, SelfDecl);
1355
1.53k
    if (Cp.isInvalid()) {
1356
0
       warnInvalidLock(Handler, nullptr, D, Exp, ClassifyDiagnostic(Attr));
1357
0
       return;
1358
0
    }
1359
    //else
1360
1.53k
    if (!Cp.shouldIgnore())
1361
1.53k
      Mtxs.push_back_nodup(Cp);
1362
1.53k
    return;
1363
1.53k
  }
1364
1365
696
  
for (const auto *Arg : Attr->args())536
{
1366
696
    CapabilityExpr Cp = SxBuilder.translateAttrExpr(Arg, D, Exp, SelfDecl);
1367
696
    if (Cp.isInvalid()) {
1368
0
       warnInvalidLock(Handler, nullptr, D, Exp, ClassifyDiagnostic(Attr));
1369
0
       continue;
1370
0
    }
1371
    //else
1372
696
    if (!Cp.shouldIgnore())
1373
692
      Mtxs.push_back_nodup(Cp);
1374
696
  }
1375
536
}
ThreadSafety.cpp:void (anonymous namespace)::ThreadSafetyAnalyzer::getMutexIDs<clang::AcquireCapabilityAttr const>((anonymous namespace)::CapExprSet&, clang::AcquireCapabilityAttr const*, clang::Expr const*, clang::NamedDecl const*, clang::VarDecl*)
Line
Count
Source
1351
1.82k
                                       VarDecl *SelfDecl) {
1352
1.82k
  if (Attr->args_size() == 0) {
1353
    // The mutex held is the "this" object.
1354
1.23k
    CapabilityExpr Cp = SxBuilder.translateAttrExpr(nullptr, D, Exp, SelfDecl);
1355
1.23k
    if (Cp.isInvalid()) {
1356
0
       warnInvalidLock(Handler, nullptr, D, Exp, ClassifyDiagnostic(Attr));
1357
0
       return;
1358
0
    }
1359
    //else
1360
1.23k
    if (!Cp.shouldIgnore())
1361
1.23k
      Mtxs.push_back_nodup(Cp);
1362
1.23k
    return;
1363
1.23k
  }
1364
1365
724
  
for (const auto *Arg : Attr->args())592
{
1366
724
    CapabilityExpr Cp = SxBuilder.translateAttrExpr(Arg, D, Exp, SelfDecl);
1367
724
    if (Cp.isInvalid()) {
1368
0
       warnInvalidLock(Handler, nullptr, D, Exp, ClassifyDiagnostic(Attr));
1369
0
       continue;
1370
0
    }
1371
    //else
1372
724
    if (!Cp.shouldIgnore())
1373
716
      Mtxs.push_back_nodup(Cp);
1374
724
  }
1375
592
}
ThreadSafety.cpp:void (anonymous namespace)::ThreadSafetyAnalyzer::getMutexIDs<clang::TryAcquireCapabilityAttr const>((anonymous namespace)::CapExprSet&, clang::TryAcquireCapabilityAttr const*, clang::Expr const*, clang::NamedDecl const*, clang::VarDecl*)
Line
Count
Source
1351
84
                                       VarDecl *SelfDecl) {
1352
84
  if (Attr->args_size() == 0) {
1353
    // The mutex held is the "this" object.
1354
58
    CapabilityExpr Cp = SxBuilder.translateAttrExpr(nullptr, D, Exp, SelfDecl);
1355
58
    if (Cp.isInvalid()) {
1356
0
       warnInvalidLock(Handler, nullptr, D, Exp, ClassifyDiagnostic(Attr));
1357
0
       return;
1358
0
    }
1359
    //else
1360
58
    if (!Cp.shouldIgnore())
1361
58
      Mtxs.push_back_nodup(Cp);
1362
58
    return;
1363
58
  }
1364
1365
26
  for (const auto *Arg : Attr->args()) {
1366
26
    CapabilityExpr Cp = SxBuilder.translateAttrExpr(Arg, D, Exp, SelfDecl);
1367
26
    if (Cp.isInvalid()) {
1368
0
       warnInvalidLock(Handler, nullptr, D, Exp, ClassifyDiagnostic(Attr));
1369
0
       continue;
1370
0
    }
1371
    //else
1372
26
    if (!Cp.shouldIgnore())
1373
26
      Mtxs.push_back_nodup(Cp);
1374
26
  }
1375
26
}
ThreadSafety.cpp:void (anonymous namespace)::ThreadSafetyAnalyzer::getMutexIDs<clang::ExclusiveTrylockFunctionAttr const>((anonymous namespace)::CapExprSet&, clang::ExclusiveTrylockFunctionAttr const*, clang::Expr const*, clang::NamedDecl const*, clang::VarDecl*)
Line
Count
Source
1351
78
                                       VarDecl *SelfDecl) {
1352
78
  if (Attr->args_size() == 0) {
1353
    // The mutex held is the "this" object.
1354
56
    CapabilityExpr Cp = SxBuilder.translateAttrExpr(nullptr, D, Exp, SelfDecl);
1355
56
    if (Cp.isInvalid()) {
1356
0
       warnInvalidLock(Handler, nullptr, D, Exp, ClassifyDiagnostic(Attr));
1357
0
       return;
1358
0
    }
1359
    //else
1360
56
    if (!Cp.shouldIgnore())
1361
56
      Mtxs.push_back_nodup(Cp);
1362
56
    return;
1363
56
  }
1364
1365
22
  for (const auto *Arg : Attr->args()) {
1366
22
    CapabilityExpr Cp = SxBuilder.translateAttrExpr(Arg, D, Exp, SelfDecl);
1367
22
    if (Cp.isInvalid()) {
1368
0
       warnInvalidLock(Handler, nullptr, D, Exp, ClassifyDiagnostic(Attr));
1369
0
       continue;
1370
0
    }
1371
    //else
1372
22
    if (!Cp.shouldIgnore())
1373
22
      Mtxs.push_back_nodup(Cp);
1374
22
  }
1375
22
}
ThreadSafety.cpp:void (anonymous namespace)::ThreadSafetyAnalyzer::getMutexIDs<clang::SharedTrylockFunctionAttr const>((anonymous namespace)::CapExprSet&, clang::SharedTrylockFunctionAttr const*, clang::Expr const*, clang::NamedDecl const*, clang::VarDecl*)
Line
Count
Source
1351
6
                                       VarDecl *SelfDecl) {
1352
6
  if (Attr->args_size() == 0) {
1353
    // The mutex held is the "this" object.
1354
2
    CapabilityExpr Cp = SxBuilder.translateAttrExpr(nullptr, D, Exp, SelfDecl);
1355
2
    if (Cp.isInvalid()) {
1356
0
       warnInvalidLock(Handler, nullptr, D, Exp, ClassifyDiagnostic(Attr));
1357
0
       return;
1358
0
    }
1359
    //else
1360
2
    if (!Cp.shouldIgnore())
1361
2
      Mtxs.push_back_nodup(Cp);
1362
2
    return;
1363
2
  }
1364
1365
4
  for (const auto *Arg : Attr->args()) {
1366
4
    CapabilityExpr Cp = SxBuilder.translateAttrExpr(Arg, D, Exp, SelfDecl);
1367
4
    if (Cp.isInvalid()) {
1368
0
       warnInvalidLock(Handler, nullptr, D, Exp, ClassifyDiagnostic(Attr));
1369
0
       continue;
1370
0
    }
1371
    //else
1372
4
    if (!Cp.shouldIgnore())
1373
4
      Mtxs.push_back_nodup(Cp);
1374
4
  }
1375
4
}
ThreadSafety.cpp:void (anonymous namespace)::ThreadSafetyAnalyzer::getMutexIDs<clang::AssertExclusiveLockAttr const>((anonymous namespace)::CapExprSet&, clang::AssertExclusiveLockAttr const*, clang::Expr const*, clang::NamedDecl const*, clang::VarDecl*)
Line
Count
Source
1351
32
                                       VarDecl *SelfDecl) {
1352
32
  if (Attr->args_size() == 0) {
1353
    // The mutex held is the "this" object.
1354
24
    CapabilityExpr Cp = SxBuilder.translateAttrExpr(nullptr, D, Exp, SelfDecl);
1355
24
    if (Cp.isInvalid()) {
1356
0
       warnInvalidLock(Handler, nullptr, D, Exp, ClassifyDiagnostic(Attr));
1357
0
       return;
1358
0
    }
1359
    //else
1360
24
    if (!Cp.shouldIgnore())
1361
24
      Mtxs.push_back_nodup(Cp);
1362
24
    return;
1363
24
  }
1364
1365
10
  
for (const auto *Arg : Attr->args())8
{
1366
10
    CapabilityExpr Cp = SxBuilder.translateAttrExpr(Arg, D, Exp, SelfDecl);
1367
10
    if (Cp.isInvalid()) {
1368
0
       warnInvalidLock(Handler, nullptr, D, Exp, ClassifyDiagnostic(Attr));
1369
0
       continue;
1370
0
    }
1371
    //else
1372
10
    if (!Cp.shouldIgnore())
1373
10
      Mtxs.push_back_nodup(Cp);
1374
10
  }
1375
8
}
ThreadSafety.cpp:void (anonymous namespace)::ThreadSafetyAnalyzer::getMutexIDs<clang::AssertSharedLockAttr const>((anonymous namespace)::CapExprSet&, clang::AssertSharedLockAttr const*, clang::Expr const*, clang::NamedDecl const*, clang::VarDecl*)
Line
Count
Source
1351
8
                                       VarDecl *SelfDecl) {
1352
8
  if (Attr->args_size() == 0) {
1353
    // The mutex held is the "this" object.
1354
2
    CapabilityExpr Cp = SxBuilder.translateAttrExpr(nullptr, D, Exp, SelfDecl);
1355
2
    if (Cp.isInvalid()) {
1356
0
       warnInvalidLock(Handler, nullptr, D, Exp, ClassifyDiagnostic(Attr));
1357
0
       return;
1358
0
    }
1359
    //else
1360
2
    if (!Cp.shouldIgnore())
1361
2
      Mtxs.push_back_nodup(Cp);
1362
2
    return;
1363
2
  }
1364
1365
8
  
for (const auto *Arg : Attr->args())6
{
1366
8
    CapabilityExpr Cp = SxBuilder.translateAttrExpr(Arg, D, Exp, SelfDecl);
1367
8
    if (Cp.isInvalid()) {
1368
0
       warnInvalidLock(Handler, nullptr, D, Exp, ClassifyDiagnostic(Attr));
1369
0
       continue;
1370
0
    }
1371
    //else
1372
8
    if (!Cp.shouldIgnore())
1373
8
      Mtxs.push_back_nodup(Cp);
1374
8
  }
1375
6
}
ThreadSafety.cpp:void (anonymous namespace)::ThreadSafetyAnalyzer::getMutexIDs<clang::AssertCapabilityAttr const>((anonymous namespace)::CapExprSet&, clang::AssertCapabilityAttr const*, clang::Expr const*, clang::NamedDecl const*, clang::VarDecl*)
Line
Count
Source
1351
40
                                       VarDecl *SelfDecl) {
1352
40
  if (Attr->args_size() == 0) {
1353
    // The mutex held is the "this" object.
1354
26
    CapabilityExpr Cp = SxBuilder.translateAttrExpr(nullptr, D, Exp, SelfDecl);
1355
26
    if (Cp.isInvalid()) {
1356
0
       warnInvalidLock(Handler, nullptr, D, Exp, ClassifyDiagnostic(Attr));
1357
0
       return;
1358
0
    }
1359
    //else
1360
26
    if (!Cp.shouldIgnore())
1361
26
      Mtxs.push_back_nodup(Cp);
1362
26
    return;
1363
26
  }
1364
1365
18
  
for (const auto *Arg : Attr->args())14
{
1366
18
    CapabilityExpr Cp = SxBuilder.translateAttrExpr(Arg, D, Exp, SelfDecl);
1367
18
    if (Cp.isInvalid()) {
1368
0
       warnInvalidLock(Handler, nullptr, D, Exp, ClassifyDiagnostic(Attr));
1369
0
       continue;
1370
0
    }
1371
    //else
1372
18
    if (!Cp.shouldIgnore())
1373
18
      Mtxs.push_back_nodup(Cp);
1374
18
  }
1375
14
}
ThreadSafety.cpp:void (anonymous namespace)::ThreadSafetyAnalyzer::getMutexIDs<clang::LocksExcludedAttr const>((anonymous namespace)::CapExprSet&, clang::LocksExcludedAttr const*, clang::Expr const*, clang::NamedDecl const*, clang::VarDecl*)
Line
Count
Source
1351
8
                                       VarDecl *SelfDecl) {
1352
8
  if (Attr->args_size() == 0) {
1353
    // The mutex held is the "this" object.
1354
0
    CapabilityExpr Cp = SxBuilder.translateAttrExpr(nullptr, D, Exp, SelfDecl);
1355
0
    if (Cp.isInvalid()) {
1356
0
       warnInvalidLock(Handler, nullptr, D, Exp, ClassifyDiagnostic(Attr));
1357
0
       return;
1358
0
    }
1359
    //else
1360
0
    if (!Cp.shouldIgnore())
1361
0
      Mtxs.push_back_nodup(Cp);
1362
0
    return;
1363
0
  }
1364
1365
8
  for (const auto *Arg : Attr->args()) {
1366
8
    CapabilityExpr Cp = SxBuilder.translateAttrExpr(Arg, D, Exp, SelfDecl);
1367
8
    if (Cp.isInvalid()) {
1368
0
       warnInvalidLock(Handler, nullptr, D, Exp, ClassifyDiagnostic(Attr));
1369
0
       continue;
1370
0
    }
1371
    //else
1372
8
    if (!Cp.shouldIgnore())
1373
8
      Mtxs.push_back_nodup(Cp);
1374
8
  }
1375
8
}
1376
1377
/// Extract the list of mutexIDs from a trylock attribute.  If the
1378
/// trylock applies to the given edge, then push them onto Mtxs, discarding
1379
/// any duplicates.
1380
template <class AttrType>
1381
void ThreadSafetyAnalyzer::getMutexIDs(CapExprSet &Mtxs, AttrType *Attr,
1382
                                       const Expr *Exp, const NamedDecl *D,
1383
                                       const CFGBlock *PredBlock,
1384
                                       const CFGBlock *CurrBlock,
1385
336
                                       Expr *BrE, bool Neg) {
1386
  // Find out which branch has the lock
1387
336
  bool branch = false;
1388
336
  if (const auto *BLE = dyn_cast_or_null<CXXBoolLiteralExpr>(BrE))
1389
272
    branch = BLE->getValue();
1390
64
  else if (const auto *ILE = dyn_cast_or_null<IntegerLiteral>(BrE))
1391
64
    branch = ILE->getValue().getBoolValue();
1392
1393
336
  int branchnum = branch ? 0 : 
10
;
1394
336
  if (Neg)
1395
144
    branchnum = !branchnum;
1396
1397
  // If we've taken the trylock branch, then add the lock
1398
336
  int i = 0;
1399
336
  for (CFGBlock::const_succ_iterator SI = PredBlock->succ_begin(),
1400
1.00k
       SE = PredBlock->succ_end(); SI != SE && 
i < 2672
;
++SI, ++i672
) {
1401
672
    if (*SI == CurrBlock && 
i == branchnum336
)
1402
168
      getMutexIDs(Mtxs, Attr, Exp, D);
1403
672
  }
1404
336
}
ThreadSafety.cpp:void (anonymous namespace)::ThreadSafetyAnalyzer::getMutexIDs<clang::TryAcquireCapabilityAttr const>((anonymous namespace)::CapExprSet&, clang::TryAcquireCapabilityAttr const*, clang::Expr const*, clang::NamedDecl const*, clang::CFGBlock const*, clang::CFGBlock const*, clang::Expr*, bool)
Line
Count
Source
1385
168
                                       Expr *BrE, bool Neg) {
1386
  // Find out which branch has the lock
1387
168
  bool branch = false;
1388
168
  if (const auto *BLE = dyn_cast_or_null<CXXBoolLiteralExpr>(BrE))
1389
136
    branch = BLE->getValue();
1390
32
  else if (const auto *ILE = dyn_cast_or_null<IntegerLiteral>(BrE))
1391
32
    branch = ILE->getValue().getBoolValue();
1392
1393
168
  int branchnum = branch ? 0 : 
10
;
1394
168
  if (Neg)
1395
72
    branchnum = !branchnum;
1396
1397
  // If we've taken the trylock branch, then add the lock
1398
168
  int i = 0;
1399
168
  for (CFGBlock::const_succ_iterator SI = PredBlock->succ_begin(),
1400
504
       SE = PredBlock->succ_end(); SI != SE && 
i < 2336
;
++SI, ++i336
) {
1401
336
    if (*SI == CurrBlock && 
i == branchnum168
)
1402
84
      getMutexIDs(Mtxs, Attr, Exp, D);
1403
336
  }
1404
168
}
ThreadSafety.cpp:void (anonymous namespace)::ThreadSafetyAnalyzer::getMutexIDs<clang::ExclusiveTrylockFunctionAttr const>((anonymous namespace)::CapExprSet&, clang::ExclusiveTrylockFunctionAttr const*, clang::Expr const*, clang::NamedDecl const*, clang::CFGBlock const*, clang::CFGBlock const*, clang::Expr*, bool)
Line
Count
Source
1385
156
                                       Expr *BrE, bool Neg) {
1386
  // Find out which branch has the lock
1387
156
  bool branch = false;
1388
156
  if (const auto *BLE = dyn_cast_or_null<CXXBoolLiteralExpr>(BrE))
1389
124
    branch = BLE->getValue();
1390
32
  else if (const auto *ILE = dyn_cast_or_null<IntegerLiteral>(BrE))
1391
32
    branch = ILE->getValue().getBoolValue();
1392
1393
156
  int branchnum = branch ? 0 : 
10
;
1394
156
  if (Neg)
1395
68
    branchnum = !branchnum;
1396
1397
  // If we've taken the trylock branch, then add the lock
1398
156
  int i = 0;
1399
156
  for (CFGBlock::const_succ_iterator SI = PredBlock->succ_begin(),
1400
468
       SE = PredBlock->succ_end(); SI != SE && 
i < 2312
;
++SI, ++i312
) {
1401
312
    if (*SI == CurrBlock && 
i == branchnum156
)
1402
78
      getMutexIDs(Mtxs, Attr, Exp, D);
1403
312
  }
1404
156
}
ThreadSafety.cpp:void (anonymous namespace)::ThreadSafetyAnalyzer::getMutexIDs<clang::SharedTrylockFunctionAttr const>((anonymous namespace)::CapExprSet&, clang::SharedTrylockFunctionAttr const*, clang::Expr const*, clang::NamedDecl const*, clang::CFGBlock const*, clang::CFGBlock const*, clang::Expr*, bool)
Line
Count
Source
1385
12
                                       Expr *BrE, bool Neg) {
1386
  // Find out which branch has the lock
1387
12
  bool branch = false;
1388
12
  if (const auto *BLE = dyn_cast_or_null<CXXBoolLiteralExpr>(BrE))
1389
12
    branch = BLE->getValue();
1390
0
  else if (const auto *ILE = dyn_cast_or_null<IntegerLiteral>(BrE))
1391
0
    branch = ILE->getValue().getBoolValue();
1392
1393
12
  int branchnum = branch ? 0 : 
10
;
1394
12
  if (Neg)
1395
4
    branchnum = !branchnum;
1396
1397
  // If we've taken the trylock branch, then add the lock
1398
12
  int i = 0;
1399
12
  for (CFGBlock::const_succ_iterator SI = PredBlock->succ_begin(),
1400
36
       SE = PredBlock->succ_end(); SI != SE && 
i < 224
;
++SI, ++i24
) {
1401
24
    if (*SI == CurrBlock && 
i == branchnum12
)
1402
6
      getMutexIDs(Mtxs, Attr, Exp, D);
1403
24
  }
1404
12
}
1405
1406
496
static bool getStaticBooleanValue(Expr *E, bool &TCond) {
1407
496
  if (isa<CXXNullPtrLiteralExpr>(E) || 
isa<GNUNullExpr>(E)488
) {
1408
8
    TCond = false;
1409
8
    return true;
1410
488
  } else if (const auto *BLE = dyn_cast<CXXBoolLiteralExpr>(E)) {
1411
16
    TCond = BLE->getValue();
1412
16
    return true;
1413
472
  } else if (const auto *ILE = dyn_cast<IntegerLiteral>(E)) {
1414
360
    TCond = ILE->getValue().getBoolValue();
1415
360
    return true;
1416
112
  } else if (auto *CE = dyn_cast<ImplicitCastExpr>(E))
1417
80
    return getStaticBooleanValue(CE->getSubExpr(), TCond);
1418
32
  return false;
1419
32
}
1420
1421
// If Cond can be traced back to a function call, return the call expression.
1422
// The negate variable should be called with false, and will be set to true
1423
// if the function call is negated, e.g. if (!mu.tryLock(...))
1424
const CallExpr* ThreadSafetyAnalyzer::getTrylockCallExpr(const Stmt *Cond,
1425
                                                         LocalVarContext C,
1426
2.86k
                                                         bool &Negate) {
1427
2.86k
  if (!Cond)
1428
60
    return nullptr;
1429
1430
2.80k
  if (const auto *CallExp = dyn_cast<CallExpr>(Cond)) {
1431
782
    if (CallExp->getBuiltinCallee() == Builtin::BI__builtin_expect)
1432
16
      return getTrylockCallExpr(CallExp->getArg(0), C, Negate);
1433
766
    return CallExp;
1434
766
  }
1435
2.02k
  else if (const auto *PE = dyn_cast<ParenExpr>(Cond))
1436
32
    return getTrylockCallExpr(PE->getSubExpr(), C, Negate);
1437
1.99k
  else if (const auto *CE = dyn_cast<ImplicitCastExpr>(Cond))
1438
772
    return getTrylockCallExpr(CE->getSubExpr(), C, Negate);
1439
1.22k
  else if (const auto *FE = dyn_cast<FullExpr>(Cond))
1440
8
    return getTrylockCallExpr(FE->getSubExpr(), C, Negate);
1441
1.21k
  else if (const auto *DRE = dyn_cast<DeclRefExpr>(Cond)) {
1442
172
    const Expr *E = LocalVarMap.lookupExpr(DRE->getDecl(), C);
1443
172
    return getTrylockCallExpr(E, C, Negate);
1444
172
  }
1445
1.04k
  else if (const auto *UOP = dyn_cast<UnaryOperator>(Cond)) {
1446
160
    if (UOP->getOpcode() == UO_LNot) {
1447
128
      Negate = !Negate;
1448
128
      return getTrylockCallExpr(UOP->getSubExpr(), C, Negate);
1449
128
    }
1450
32
    return nullptr;
1451
32
  }
1452
880
  else if (const auto *BOP = dyn_cast<BinaryOperator>(Cond)) {
1453
472
    if (BOP->getOpcode() == BO_EQ || 
BOP->getOpcode() == BO_NE152
) {
1454
344
      if (BOP->getOpcode() == BO_NE)
1455
24
        Negate = !Negate;
1456
1457
344
      bool TCond = false;
1458
344
      if (getStaticBooleanValue(BOP->getRHS(), TCond)) {
1459
320
        if (!TCond) 
Negate = !Negate208
;
1460
320
        return getTrylockCallExpr(BOP->getLHS(), C, Negate);
1461
320
      }
1462
24
      TCond = false;
1463
24
      if (getStaticBooleanValue(BOP->getLHS(), TCond)) {
1464
16
        if (!TCond) Negate = !Negate;
1465
16
        return getTrylockCallExpr(BOP->getRHS(), C, Negate);
1466
16
      }
1467
8
      return nullptr;
1468
8
    }
1469
128
    if (BOP->getOpcode() == BO_LAnd) {
1470
      // LHS must have been evaluated in a different block.
1471
72
      return getTrylockCallExpr(BOP->getRHS(), C, Negate);
1472
72
    }
1473
56
    if (BOP->getOpcode() == BO_LOr)
1474
24
      return getTrylockCallExpr(BOP->getRHS(), C, Negate);
1475
32
    return nullptr;
1476
408
  } else if (const auto *COP = dyn_cast<ConditionalOperator>(Cond)) {
1477
24
    bool TCond, FCond;
1478
24
    if (getStaticBooleanValue(COP->getTrueExpr(), TCond) &&
1479
24
        getStaticBooleanValue(COP->getFalseExpr(), FCond)) {
1480
24
      if (TCond && 
!FCond8
)
1481
8
        return getTrylockCallExpr(COP->getCond(), C, Negate);
1482
16
      if (!TCond && FCond) {
1483
16
        Negate = !Negate;
1484
16
        return getTrylockCallExpr(COP->getCond(), C, Negate);
1485
16
      }
1486
384
    }
1487
24
  }
1488
384
  return nullptr;
1489
384
}
1490
1491
/// Find the lockset that holds on the edge between PredBlock
1492
/// and CurrBlock.  The edge set is the exit set of PredBlock (passed
1493
/// as the ExitSet parameter) plus any trylocks, which are conditionally held.
1494
void ThreadSafetyAnalyzer::getEdgeLockset(FactSet& Result,
1495
                                          const FactSet &ExitSet,
1496
                                          const CFGBlock *PredBlock,
1497
5.90k
                                          const CFGBlock *CurrBlock) {
1498
5.90k
  Result = ExitSet;
1499
1500
5.90k
  const Stmt *Cond = PredBlock->getTerminatorCondition();
1501
  // We don't acquire try-locks on ?: branches, only when its result is used.
1502
5.90k
  if (!Cond || 
isa<ConditionalOperator>(PredBlock->getTerminatorStmt())1.35k
)
1503
4.61k
    return;
1504
1505
1.28k
  bool Negate = false;
1506
1.28k
  const CFGBlockInfo *PredBlockInfo = &BlockInfo[PredBlock->getBlockID()];
1507
1.28k
  const LocalVarContext &LVarCtx = PredBlockInfo->ExitContext;
1508
1.28k
  StringRef CapDiagKind = "mutex";
1509
1510
1.28k
  const auto *Exp = getTrylockCallExpr(Cond, LVarCtx, Negate);
1511
1.28k
  if (!Exp)
1512
516
    return;
1513
1514
766
  auto *FunDecl = dyn_cast_or_null<NamedDecl>(Exp->getCalleeDecl());
1515
766
  if(!FunDecl || !FunDecl->hasAttrs())
1516
446
    return;
1517
1518
320
  CapExprSet ExclusiveLocksToAdd;
1519
320
  CapExprSet SharedLocksToAdd;
1520
1521
  // If the condition is a call to a Trylock function, then grab the attributes
1522
336
  for (const auto *Attr : FunDecl->attrs()) {
1523
336
    switch (Attr->getKind()) {
1524
168
      case attr::TryAcquireCapability: {
1525
168
        auto *A = cast<TryAcquireCapabilityAttr>(Attr);
1526
156
        getMutexIDs(A->isShared() ? 
SharedLocksToAdd12
: ExclusiveLocksToAdd, A,
1527
168
                    Exp, FunDecl, PredBlock, CurrBlock, A->getSuccessValue(),
1528
168
                    Negate);
1529
168
        CapDiagKind = ClassifyDiagnostic(A);
1530
168
        break;
1531
0
      };
1532
156
      case attr::ExclusiveTrylockFunction: {
1533
156
        const auto *A = cast<ExclusiveTrylockFunctionAttr>(Attr);
1534
156
        getMutexIDs(ExclusiveLocksToAdd, A, Exp, FunDecl,
1535
156
                    PredBlock, CurrBlock, A->getSuccessValue(), Negate);
1536
156
        CapDiagKind = ClassifyDiagnostic(A);
1537
156
        break;
1538
0
      }
1539
12
      case attr::SharedTrylockFunction: {
1540
12
        const auto *A = cast<SharedTrylockFunctionAttr>(Attr);
1541
12
        getMutexIDs(SharedLocksToAdd, A, Exp, FunDecl,
1542
12
                    PredBlock, CurrBlock, A->getSuccessValue(), Negate);
1543
12
        CapDiagKind = ClassifyDiagnostic(A);
1544
12
        break;
1545
0
      }
1546
0
      default:
1547
0
        break;
1548
336
    }
1549
336
  }
1550
1551
  // Add and remove locks.
1552
320
  SourceLocation Loc = Exp->getExprLoc();
1553
320
  for (const auto &ExclusiveLockToAdd : ExclusiveLocksToAdd)
1554
156
    addLock(Result, std::make_unique<LockableFactEntry>(ExclusiveLockToAdd,
1555
156
                                                         LK_Exclusive, Loc),
1556
156
            CapDiagKind);
1557
320
  for (const auto &SharedLockToAdd : SharedLocksToAdd)
1558
12
    addLock(Result, std::make_unique<LockableFactEntry>(SharedLockToAdd,
1559
12
                                                         LK_Shared, Loc),
1560
12
            CapDiagKind);
1561
320
}
1562
1563
namespace {
1564
1565
/// We use this class to visit different types of expressions in
1566
/// CFGBlocks, and build up the lockset.
1567
/// An expression may cause us to add or remove locks from the lockset, or else
1568
/// output error messages related to missing locks.
1569
/// FIXME: In future, we may be able to not inherit from a visitor.
1570
class BuildLockset : public ConstStmtVisitor<BuildLockset> {
1571
  friend class ThreadSafetyAnalyzer;
1572
1573
  ThreadSafetyAnalyzer *Analyzer;
1574
  FactSet FSet;
1575
  LocalVariableMap::Context LVarCtx;
1576
  unsigned CtxIndex;
1577
1578
  // helper functions
1579
  void warnIfMutexNotHeld(const NamedDecl *D, const Expr *Exp, AccessKind AK,
1580
                          Expr *MutexExp, ProtectedOperationKind POK,
1581
                          StringRef DiagKind, SourceLocation Loc);
1582
  void warnIfMutexHeld(const NamedDecl *D, const Expr *Exp, Expr *MutexExp,
1583
                       StringRef DiagKind);
1584
1585
  void checkAccess(const Expr *Exp, AccessKind AK,
1586
                   ProtectedOperationKind POK = POK_VarAccess);
1587
  void checkPtAccess(const Expr *Exp, AccessKind AK,
1588
                     ProtectedOperationKind POK = POK_VarAccess);
1589
1590
  void handleCall(const Expr *Exp, const NamedDecl *D, VarDecl *VD = nullptr);
1591
  void examineArguments(const FunctionDecl *FD,
1592
                        CallExpr::const_arg_iterator ArgBegin,
1593
                        CallExpr::const_arg_iterator ArgEnd,
1594
                        bool SkipFirstParam = false);
1595
1596
public:
1597
  BuildLockset(ThreadSafetyAnalyzer *Anlzr, CFGBlockInfo &Info)
1598
      : ConstStmtVisitor<BuildLockset>(), Analyzer(Anlzr), FSet(Info.EntrySet),
1599
7.32k
        LVarCtx(Info.EntryContext), CtxIndex(Info.EntryIndex) {}
1600
1601
  void VisitUnaryOperator(const UnaryOperator *UO);
1602
  void VisitBinaryOperator(const BinaryOperator *BO);
1603
  void VisitCastExpr(const CastExpr *CE);
1604
  void VisitCallExpr(const CallExpr *Exp);
1605
  void VisitCXXConstructExpr(const CXXConstructExpr *Exp);
1606
  void VisitDeclStmt(const DeclStmt *S);
1607
};
1608
1609
} // namespace
1610
1611
/// Warn if the LSet does not contain a lock sufficient to protect access
1612
/// of at least the passed in AccessKind.
1613
void BuildLockset::warnIfMutexNotHeld(const NamedDecl *D, const Expr *Exp,
1614
                                      AccessKind AK, Expr *MutexExp,
1615
                                      ProtectedOperationKind POK,
1616
2.97k
                                      StringRef DiagKind, SourceLocation Loc) {
1617
2.97k
  LockKind LK = getLockKindFromAccessKind(AK);
1618
1619
2.97k
  CapabilityExpr Cp = Analyzer->SxBuilder.translateAttrExpr(MutexExp, D, Exp);
1620
2.97k
  if (Cp.isInvalid()) {
1621
0
    warnInvalidLock(Analyzer->Handler, MutexExp, D, Exp, DiagKind);
1622
0
    return;
1623
2.97k
  } else if (Cp.shouldIgnore()) {
1624
20
    return;
1625
20
  }
1626
1627
2.95k
  if (Cp.negative()) {
1628
    // Negative capabilities act like locks excluded
1629
34
    const FactEntry *LDat = FSet.findLock(Analyzer->FactMan, !Cp);
1630
34
    if (LDat) {
1631
10
      Analyzer->Handler.handleFunExcludesLock(
1632
10
          DiagKind, D->getNameAsString(), (!Cp).toString(), Loc);
1633
10
      return;
1634
10
    }
1635
1636
    // If this does not refer to a negative capability in the same class,
1637
    // then stop here.
1638
24
    if (!Analyzer->inCurrentScope(Cp))
1639
10
      return;
1640
1641
    // Otherwise the negative requirement must be propagated to the caller.
1642
14
    LDat = FSet.findLock(Analyzer->FactMan, Cp);
1643
14
    if (!LDat) {
1644
6
      Analyzer->Handler.handleNegativeNotHeld(D, Cp.toString(), Loc);
1645
6
    }
1646
14
    return;
1647
14
  }
1648
1649
2.91k
  const FactEntry *LDat = FSet.findLockUniv(Analyzer->FactMan, Cp);
1650
2.91k
  bool NoError = true;
1651
2.91k
  if (!LDat) {
1652
    // No exact match found.  Look for a partial match.
1653
1.14k
    LDat = FSet.findPartialMatch(Analyzer->FactMan, Cp);
1654
1.14k
    if (LDat) {
1655
      // Warn that there's no precise match.
1656
76
      std::string PartMatchStr = LDat->toString();
1657
76
      StringRef   PartMatchName(PartMatchStr);
1658
76
      Analyzer->Handler.handleMutexNotHeld(DiagKind, D, POK, Cp.toString(),
1659
76
                                           LK, Loc, &PartMatchName);
1660
1.07k
    } else {
1661
      // Warn that there's no match at all.
1662
1.07k
      Analyzer->Handler.handleMutexNotHeld(DiagKind, D, POK, Cp.toString(),
1663
1.07k
                                           LK, Loc);
1664
1.07k
    }
1665
1.14k
    NoError = false;
1666
1.14k
  }
1667
  // Make sure the mutex we found is the right kind.
1668
2.91k
  if (NoError && 
LDat1.77k
&&
!LDat->isAtLeast(LK)1.77k
) {
1669
32
    Analyzer->Handler.handleMutexNotHeld(DiagKind, D, POK, Cp.toString(),
1670
32
                                         LK, Loc);
1671
32
  }
1672
2.91k
}
1673
1674
/// Warn if the LSet contains the given lock.
1675
void BuildLockset::warnIfMutexHeld(const NamedDecl *D, const Expr *Exp,
1676
134
                                   Expr *MutexExp, StringRef DiagKind) {
1677
134
  CapabilityExpr Cp = Analyzer->SxBuilder.translateAttrExpr(MutexExp, D, Exp);
1678
134
  if (Cp.isInvalid()) {
1679
0
    warnInvalidLock(Analyzer->Handler, MutexExp, D, Exp, DiagKind);
1680
0
    return;
1681
134
  } else if (Cp.shouldIgnore()) {
1682
0
    return;
1683
0
  }
1684
1685
134
  const FactEntry *LDat = FSet.findLock(Analyzer->FactMan, Cp);
1686
134
  if (LDat) {
1687
67
    Analyzer->Handler.handleFunExcludesLock(
1688
67
        DiagKind, D->getNameAsString(), Cp.toString(), Exp->getExprLoc());
1689
67
  }
1690
134
}
1691
1692
/// Checks guarded_by and pt_guarded_by attributes.
1693
/// Whenever we identify an access (read or write) to a DeclRefExpr that is
1694
/// marked with guarded_by, we must ensure the appropriate mutexes are held.
1695
/// Similarly, we check if the access is to an expression that dereferences
1696
/// a pointer marked with pt_guarded_by.
1697
void BuildLockset::checkAccess(const Expr *Exp, AccessKind AK,
1698
8.62k
                               ProtectedOperationKind POK) {
1699
8.62k
  Exp = Exp->IgnoreImplicit()->IgnoreParenCasts();
1700
1701
8.62k
  SourceLocation Loc = Exp->getExprLoc();
1702
1703
  // Local variables of reference type cannot be re-assigned;
1704
  // map them to their initializer.
1705
8.67k
  while (const auto *DRE = dyn_cast<DeclRefExpr>(Exp)) {
1706
3.63k
    const auto *VD = dyn_cast<VarDecl>(DRE->getDecl()->getCanonicalDecl());
1707
3.63k
    if (VD && VD->isLocalVarDecl() && 
VD->getType()->isReferenceType()1.73k
) {
1708
44
      if (const auto *E = VD->getInit()) {
1709
        // Guard against self-initialization. e.g., int &i = i;
1710
44
        if (E == Exp)
1711
0
          break;
1712
44
        Exp = E;
1713
44
        continue;
1714
44
      }
1715
44
    }
1716
3.59k
    break;
1717
3.59k
  }
1718
1719
8.62k
  if (const auto *UO = dyn_cast<UnaryOperator>(Exp)) {
1720
    // For dereferences
1721
250
    if (UO->getOpcode() == UO_Deref)
1722
250
      checkPtAccess(UO->getSubExpr(), AK, POK);
1723
250
    return;
1724
250
  }
1725
1726
8.37k
  if (const auto *AE = dyn_cast<ArraySubscriptExpr>(Exp)) {
1727
68
    checkPtAccess(AE->getLHS(), AK, POK);
1728
68
    return;
1729
68
  }
1730
1731
8.31k
  if (const auto *ME = dyn_cast<MemberExpr>(Exp)) {
1732
4.22k
    if (ME->isArrow())
1733
3.42k
      checkPtAccess(ME->getBase(), AK, POK);
1734
799
    else
1735
799
      checkAccess(ME->getBase(), AK, POK);
1736
4.22k
  }
1737
1738
8.31k
  const ValueDecl *D = getValueDecl(Exp);
1739
8.31k
  if (!D || 
!D->hasAttrs()7.81k
)
1740
5.82k
    return;
1741
1742
2.48k
  if (D->hasAttr<GuardedVarAttr>() && 
FSet.isEmpty(Analyzer->FactMan)48
) {
1743
25
    Analyzer->Handler.handleNoMutexHeld("mutex", D, POK, AK, Loc);
1744
25
  }
1745
1746
2.48k
  for (const auto *I : D->specific_attrs<GuardedByAttr>())
1747
1.93k
    warnIfMutexNotHeld(D, Exp, AK, I->getArg(), POK,
1748
1.93k
                       ClassifyDiagnostic(I), Loc);
1749
2.48k
}
1750
1751
/// Checks pt_guarded_by and pt_guarded_var attributes.
1752
/// POK is the same  operationKind that was passed to checkAccess.
1753
void BuildLockset::checkPtAccess(const Expr *Exp, AccessKind AK,
1754
4.86k
                                 ProtectedOperationKind POK) {
1755
6.06k
  while (true) {
1756
6.06k
    if (const auto *PE = dyn_cast<ParenExpr>(Exp)) {
1757
4
      Exp = PE->getSubExpr();
1758
4
      continue;
1759
4
    }
1760
6.05k
    if (const auto *CE = dyn_cast<CastExpr>(Exp)) {
1761
1.25k
      if (CE->getCastKind() == CK_ArrayToPointerDecay) {
1762
        // If it's an actual array, and not a pointer, then it's elements
1763
        // are protected by GUARDED_BY, not PT_GUARDED_BY;
1764
60
        checkAccess(CE->getSubExpr(), AK, POK);
1765
60
        return;
1766
60
      }
1767
1.19k
      Exp = CE->getSubExpr();
1768
1.19k
      continue;
1769
1.19k
    }
1770
4.80k
    break;
1771
4.80k
  }
1772
1773
  // Pass by reference warnings are under a different flag.
1774
4.80k
  ProtectedOperationKind PtPOK = POK_VarDereference;
1775
4.80k
  if (POK == POK_PassByRef) 
PtPOK = POK_PtPassByRef130
;
1776
1777
4.80k
  const ValueDecl *D = getValueDecl(Exp);
1778
4.80k
  if (!D || 
!D->hasAttrs()1.16k
)
1779
4.36k
    return;
1780
1781
442
  if (D->hasAttr<PtGuardedVarAttr>() && 
FSet.isEmpty(Analyzer->FactMan)10
)
1782
9
    Analyzer->Handler.handleNoMutexHeld("mutex", D, PtPOK, AK,
1783
9
                                        Exp->getExprLoc());
1784
1785
442
  for (auto const *I : D->specific_attrs<PtGuardedByAttr>())
1786
388
    warnIfMutexNotHeld(D, Exp, AK, I->getArg(), PtPOK,
1787
388
                       ClassifyDiagnostic(I), Exp->getExprLoc());
1788
442
}
1789
1790
/// Process a function call, method call, constructor call,
1791
/// or destructor call.  This involves looking at the attributes on the
1792
/// corresponding function/method/constructor/destructor, issuing warnings,
1793
/// and updating the locksets accordingly.
1794
///
1795
/// FIXME: For classes annotated with one of the guarded annotations, we need
1796
/// to treat const method calls as reads and non-const method calls as writes,
1797
/// and check that the appropriate locks are held. Non-const method calls with
1798
/// the same signature as const method calls can be also treated as reads.
1799
///
1800
void BuildLockset::handleCall(const Expr *Exp, const NamedDecl *D,
1801
4.37k
                              VarDecl *VD) {
1802
4.37k
  SourceLocation Loc = Exp->getExprLoc();
1803
4.37k
  CapExprSet ExclusiveLocksToAdd, SharedLocksToAdd;
1804
4.37k
  CapExprSet ExclusiveLocksToRemove, SharedLocksToRemove, GenericLocksToRemove;
1805
4.37k
  CapExprSet ScopedReqsAndExcludes;
1806
4.37k
  StringRef CapDiagKind = "mutex";
1807
1808
  // Figure out if we're constructing an object of scoped lockable class
1809
4.37k
  bool isScopedVar = false;
1810
4.37k
  if (VD) {
1811
266
    if (const auto *CD = dyn_cast<const CXXConstructorDecl>(D)) {
1812
266
      const CXXRecordDecl* PD = CD->getParent();
1813
266
      if (PD && PD->hasAttr<ScopedLockableAttr>())
1814
246
        isScopedVar = true;
1815
266
    }
1816
266
  }
1817
1818
4.72k
  for(const Attr *At : D->attrs()) {
1819
4.72k
    switch (At->getKind()) {
1820
      // When we encounter a lock function, we need to add the lock to our
1821
      // lockset.
1822
1.73k
      case attr::AcquireCapability: {
1823
1.73k
        const auto *A = cast<AcquireCapabilityAttr>(At);
1824
213
        Analyzer->getMutexIDs(A->isShared() ? SharedLocksToAdd
1825
1.52k
                                            : ExclusiveLocksToAdd,
1826
1.73k
                              A, Exp, D, VD);
1827
1828
1.73k
        CapDiagKind = ClassifyDiagnostic(A);
1829
1.73k
        break;
1830
0
      }
1831
1832
      // An assert will add a lock to the lockset, but will not generate
1833
      // a warning if it is already there, and will not generate a warning
1834
      // if it is not removed.
1835
32
      case attr::AssertExclusiveLock: {
1836
32
        const auto *A = cast<AssertExclusiveLockAttr>(At);
1837
1838
32
        CapExprSet AssertLocks;
1839
32
        Analyzer->getMutexIDs(AssertLocks, A, Exp, D, VD);
1840
32
        for (const auto &AssertLock : AssertLocks)
1841
34
          Analyzer->addLock(FSet,
1842
34
                            std::make_unique<LockableFactEntry>(
1843
34
                                AssertLock, LK_Exclusive, Loc, false, true),
1844
34
                            ClassifyDiagnostic(A));
1845
32
        break;
1846
0
      }
1847
8
      case attr::AssertSharedLock: {
1848
8
        const auto *A = cast<AssertSharedLockAttr>(At);
1849
1850
8
        CapExprSet AssertLocks;
1851
8
        Analyzer->getMutexIDs(AssertLocks, A, Exp, D, VD);
1852
8
        for (const auto &AssertLock : AssertLocks)
1853
10
          Analyzer->addLock(FSet,
1854
10
                            std::make_unique<LockableFactEntry>(
1855
10
                                AssertLock, LK_Shared, Loc, false, true),
1856
10
                            ClassifyDiagnostic(A));
1857
8
        break;
1858
0
      }
1859
1860
40
      case attr::AssertCapability: {
1861
40
        const auto *A = cast<AssertCapabilityAttr>(At);
1862
40
        CapExprSet AssertLocks;
1863
40
        Analyzer->getMutexIDs(AssertLocks, A, Exp, D, VD);
1864
40
        for (const auto &AssertLock : AssertLocks)
1865
44
          Analyzer->addLock(FSet,
1866
44
                            std::make_unique<LockableFactEntry>(
1867
44
                                AssertLock,
1868
34
                                A->isShared() ? 
LK_Shared10
: LK_Exclusive, Loc,
1869
44
                                false, true),
1870
44
                            ClassifyDiagnostic(A));
1871
40
        break;
1872
0
      }
1873
1874
      // When we encounter an unlock function, we need to remove unlocked
1875
      // mutexes from the lockset, and flag a warning if they are not there.
1876
1.91k
      case attr::ReleaseCapability: {
1877
1.91k
        const auto *A = cast<ReleaseCapabilityAttr>(At);
1878
1.91k
        if (A->isGeneric())
1879
1.72k
          Analyzer->getMutexIDs(GenericLocksToRemove, A, Exp, D, VD);
1880
192
        else if (A->isShared())
1881
38
          Analyzer->getMutexIDs(SharedLocksToRemove, A, Exp, D, VD);
1882
154
        else
1883
154
          Analyzer->getMutexIDs(ExclusiveLocksToRemove, A, Exp, D, VD);
1884
1885
1.91k
        CapDiagKind = ClassifyDiagnostic(A);
1886
1.91k
        break;
1887
0
      }
1888
1889
588
      case attr::RequiresCapability: {
1890
588
        const auto *A = cast<RequiresCapabilityAttr>(At);
1891
652
        for (auto *Arg : A->args()) {
1892
525
          warnIfMutexNotHeld(D, Exp, A->isShared() ? 
AK_Read127
: AK_Written, Arg,
1893
652
                             POK_FunctionCall, ClassifyDiagnostic(A),
1894
652
                             Exp->getExprLoc());
1895
          // use for adopting a lock
1896
652
          if (isScopedVar)
1897
16
            Analyzer->getMutexIDs(ScopedReqsAndExcludes, A, Exp, D, VD);
1898
652
        }
1899
588
        break;
1900
0
      }
1901
1902
124
      case attr::LocksExcluded: {
1903
124
        const auto *A = cast<LocksExcludedAttr>(At);
1904
134
        for (auto *Arg : A->args()) {
1905
134
          warnIfMutexHeld(D, Exp, Arg, ClassifyDiagnostic(A));
1906
          // use for deferring a lock
1907
134
          if (isScopedVar)
1908
8
            Analyzer->getMutexIDs(ScopedReqsAndExcludes, A, Exp, D, VD);
1909
134
        }
1910
124
        break;
1911
0
      }
1912
1913
      // Ignore attributes unrelated to thread-safety
1914
281
      default:
1915
281
        break;
1916
4.72k
    }
1917
4.72k
  }
1918
1919
  // Remove locks first to allow lock upgrading/downgrading.
1920
  // FIXME -- should only fully remove if the attribute refers to 'this'.
1921
4.37k
  bool Dtor = isa<CXXDestructorDecl>(D);
1922
4.37k
  for (const auto &M : ExclusiveLocksToRemove)
1923
154
    Analyzer->removeLock(FSet, M, Loc, Dtor, LK_Exclusive, CapDiagKind);
1924
4.37k
  for (const auto &M : SharedLocksToRemove)
1925
38
    Analyzer->removeLock(FSet, M, Loc, Dtor, LK_Shared, CapDiagKind);
1926
4.37k
  for (const auto &M : GenericLocksToRemove)
1927
1.67k
    Analyzer->removeLock(FSet, M, Loc, Dtor, LK_Generic, CapDiagKind);
1928
1929
  // Add locks.
1930
4.37k
  for (const auto &M : ExclusiveLocksToAdd)
1931
1.48k
    Analyzer->addLock(FSet, std::make_unique<LockableFactEntry>(
1932
1.48k
                                M, LK_Exclusive, Loc, isScopedVar),
1933
1.48k
                      CapDiagKind);
1934
4.37k
  for (const auto &M : SharedLocksToAdd)
1935
201
    Analyzer->addLock(FSet, std::make_unique<LockableFactEntry>(
1936
201
                                M, LK_Shared, Loc, isScopedVar),
1937
201
                      CapDiagKind);
1938
1939
4.37k
  if (isScopedVar) {
1940
    // Add the managing object as a dummy mutex, mapped to the underlying mutex.
1941
246
    SourceLocation MLoc = VD->getLocation();
1942
246
    DeclRefExpr DRE(VD->getASTContext(), VD, false, VD->getType(), VK_LValue,
1943
246
                    VD->getLocation());
1944
    // FIXME: does this store a pointer to DRE?
1945
246
    CapabilityExpr Scp = Analyzer->SxBuilder.translateAttrExpr(&DRE, nullptr);
1946
1947
246
    auto ScopedEntry = std::make_unique<ScopedLockableFactEntry>(Scp, MLoc);
1948
246
    for (const auto &M : ExclusiveLocksToAdd)
1949
154
      ScopedEntry->addLock(M);
1950
246
    for (const auto &M : SharedLocksToAdd)
1951
36
      ScopedEntry->addLock(M);
1952
246
    for (const auto &M : ScopedReqsAndExcludes)
1953
24
      ScopedEntry->addLock(M);
1954
246
    for (const auto &M : ExclusiveLocksToRemove)
1955
28
      ScopedEntry->addExclusiveUnlock(M);
1956
246
    for (const auto &M : SharedLocksToRemove)
1957
8
      ScopedEntry->addSharedUnlock(M);
1958
246
    Analyzer->addLock(FSet, std::move(ScopedEntry), CapDiagKind);
1959
246
  }
1960
4.37k
}
1961
1962
/// For unary operations which read and write a variable, we need to
1963
/// check whether we hold any required mutexes. Reads are checked in
1964
/// VisitCastExpr.
1965
738
void BuildLockset::VisitUnaryOperator(const UnaryOperator *UO) {
1966
738
  switch (UO->getOpcode()) {
1967
28
    case UO_PostDec:
1968
28
    case UO_PostInc:
1969
28
    case UO_PreDec:
1970
28
    case UO_PreInc:
1971
28
      checkAccess(UO->getSubExpr(), AK_Written);
1972
28
      break;
1973
710
    default:
1974
710
      break;
1975
738
  }
1976
738
}
1977
1978
/// For binary operations which assign to a variable (writes), we need to check
1979
/// whether we hold any required mutexes.
1980
/// FIXME: Deal with non-primitive types.
1981
1.89k
void BuildLockset::VisitBinaryOperator(const BinaryOperator *BO) {
1982
1.89k
  if (!BO->isAssignmentOp())
1983
389
    return;
1984
1985
  // adjust the context
1986
1.50k
  LVarCtx = Analyzer->LocalVarMap.getNextContext(CtxIndex, BO, LVarCtx);
1987
1988
1.50k
  checkAccess(BO->getLHS(), AK_Written);
1989
1.50k
}
1990
1991
/// Whenever we do an LValue to Rvalue cast, we are reading a variable and
1992
/// need to ensure we hold any required mutexes.
1993
/// FIXME: Deal with non-primitive types.
1994
4.81k
void BuildLockset::VisitCastExpr(const CastExpr *CE) {
1995
4.81k
  if (CE->getCastKind() != CK_LValueToRValue)
1996
2.52k
    return;
1997
2.28k
  checkAccess(CE->getSubExpr(), AK_Read);
1998
2.28k
}
1999
2000
void BuildLockset::examineArguments(const FunctionDecl *FD,
2001
                                    CallExpr::const_arg_iterator ArgBegin,
2002
                                    CallExpr::const_arg_iterator ArgEnd,
2003
5.85k
                                    bool SkipFirstParam) {
2004
  // Currently we can't do anything if we don't know the function declaration.
2005
5.85k
  if (!FD)
2006
12
    return;
2007
2008
  // NO_THREAD_SAFETY_ANALYSIS does double duty here.  Normally it
2009
  // only turns off checking within the body of a function, but we also
2010
  // use it to turn off checking in arguments to the function.  This
2011
  // could result in some false negatives, but the alternative is to
2012
  // create yet another attribute.
2013
5.84k
  if (FD->hasAttr<NoThreadSafetyAnalysisAttr>())
2014
40
    return;
2015
2016
5.80k
  const ArrayRef<ParmVarDecl *> Params = FD->parameters();
2017
5.80k
  auto Param = Params.begin();
2018
5.80k
  if (SkipFirstParam)
2019
12
    ++Param;
2020
2021
  // There can be default arguments, so we stop when one iterator is at end().
2022
7.10k
  for (auto Arg = ArgBegin; Param != Params.end() && 
Arg != ArgEnd1.30k
;
2023
1.30k
       ++Param, ++Arg) {
2024
1.30k
    QualType Qt = (*Param)->getType();
2025
1.30k
    if (Qt->isReferenceType())
2026
263
      checkAccess(*Arg, AK_Read, POK_PassByRef);
2027
1.30k
  }
2028
5.80k
}
2029
2030
5.30k
void BuildLockset::VisitCallExpr(const CallExpr *Exp) {
2031
5.30k
  if (const auto *CE = dyn_cast<CXXMemberCallExpr>(Exp)) {
2032
3.95k
    const auto *ME = dyn_cast<MemberExpr>(CE->getCallee());
2033
    // ME can be null when calling a method pointer
2034
3.95k
    const CXXMethodDecl *MD = CE->getMethodDecl();
2035
2036
3.95k
    if (ME && 
MD3.94k
) {
2037
3.94k
      if (ME->isArrow()) {
2038
768
        if (MD->isConst())
2039
16
          checkPtAccess(CE->getImplicitObjectArgument(), AK_Read);
2040
752
        else // FIXME -- should be AK_Written
2041
752
          checkPtAccess(CE->getImplicitObjectArgument(), AK_Read);
2042
3.18k
      } else {
2043
3.18k
        if (MD->isConst())
2044
136
          checkAccess(CE->getImplicitObjectArgument(), AK_Read);
2045
3.04k
        else     // FIXME -- should be AK_Written
2046
3.04k
          checkAccess(CE->getImplicitObjectArgument(), AK_Read);
2047
3.18k
      }
2048
3.94k
    }
2049
2050
3.95k
    examineArguments(CE->getDirectCallee(), CE->arg_begin(), CE->arg_end());
2051
1.35k
  } else if (const auto *OE = dyn_cast<CXXOperatorCallExpr>(Exp)) {
2052
448
    auto OEop = OE->getOperator();
2053
448
    switch (OEop) {
2054
32
      case OO_Equal: {
2055
32
        const Expr *Target = OE->getArg(0);
2056
32
        const Expr *Source = OE->getArg(1);
2057
32
        checkAccess(Target, AK_Written);
2058
32
        checkAccess(Source, AK_Read);
2059
32
        break;
2060
0
      }
2061
360
      case OO_Star:
2062
360
      case OO_Arrow:
2063
360
      case OO_Subscript:
2064
360
        if (!(OEop == OO_Star && 
OE->getNumArgs() > 1116
)) {
2065
          // Grrr.  operator* can be multiplication...
2066
356
          checkPtAccess(OE->getArg(0), AK_Read);
2067
356
        }
2068
360
        LLVM_FALLTHROUGH;
2069
416
      default: {
2070
        // TODO: get rid of this, and rely on pass-by-ref instead.
2071
416
        const Expr *Obj = OE->getArg(0);
2072
416
        checkAccess(Obj, AK_Read);
2073
        // Check the remaining arguments. For method operators, the first
2074
        // argument is the implicit self argument, and doesn't appear in the
2075
        // FunctionDecl, but for non-methods it does.
2076
416
        const FunctionDecl *FD = OE->getDirectCallee();
2077
416
        examineArguments(FD, std::next(OE->arg_begin()), OE->arg_end(),
2078
416
                         /*SkipFirstParam*/ !isa<CXXMethodDecl>(FD));
2079
416
        break;
2080
904
      }
2081
904
    }
2082
904
  } else {
2083
904
    examineArguments(Exp->getDirectCallee(), Exp->arg_begin(), Exp->arg_end());
2084
904
  }
2085
2086
5.30k
  auto *D = dyn_cast_or_null<NamedDecl>(Exp->getCalleeDecl());
2087
5.30k
  if(!D || !D->hasAttrs())
2088
1.43k
    return;
2089
3.86k
  handleCall(Exp, D);
2090
3.86k
}
2091
2092
613
void BuildLockset::VisitCXXConstructExpr(const CXXConstructExpr *Exp) {
2093
613
  const CXXConstructorDecl *D = Exp->getConstructor();
2094
613
  if (D && D->isCopyConstructor()) {
2095
31
    const Expr* Source = Exp->getArg(0);
2096
31
    checkAccess(Source, AK_Read);
2097
582
  } else {
2098
582
    examineArguments(D, Exp->arg_begin(), Exp->arg_end());
2099
582
  }
2100
613
}
2101
2102
static CXXConstructorDecl *
2103
4
findConstructorForByValueReturn(const CXXRecordDecl *RD) {
2104
  // Prefer a move constructor over a copy constructor. If there's more than
2105
  // one copy constructor or more than one move constructor, we arbitrarily
2106
  // pick the first declared such constructor rather than trying to guess which
2107
  // one is more appropriate.
2108
4
  CXXConstructorDecl *CopyCtor = nullptr;
2109
8
  for (auto *Ctor : RD->ctors()) {
2110
8
    if (Ctor->isDeleted())
2111
0
      continue;
2112
8
    if (Ctor->isMoveConstructor())
2113
4
      return Ctor;
2114
4
    if (!CopyCtor && Ctor->isCopyConstructor())
2115
0
      CopyCtor = Ctor;
2116
4
  }
2117
0
  return CopyCtor;
2118
4
}
2119
2120
static Expr *buildFakeCtorCall(CXXConstructorDecl *CD, ArrayRef<Expr *> Args,
2121
4
                               SourceLocation Loc) {
2122
4
  ASTContext &Ctx = CD->getASTContext();
2123
4
  return CXXConstructExpr::Create(Ctx, Ctx.getRecordType(CD->getParent()), Loc,
2124
4
                                  CD, true, Args, false, false, false, false,
2125
4
                                  CXXConstructExpr::CK_Complete,
2126
4
                                  SourceRange(Loc, Loc));
2127
4
}
2128
2129
920
void BuildLockset::VisitDeclStmt(const DeclStmt *S) {
2130
  // adjust the context
2131
920
  LVarCtx = Analyzer->LocalVarMap.getNextContext(CtxIndex, S, LVarCtx);
2132
2133
920
  for (auto *D : S->getDeclGroup()) {
2134
920
    if (auto *VD = dyn_cast_or_null<VarDecl>(D)) {
2135
920
      Expr *E = VD->getInit();
2136
920
      if (!E)
2137
97
        continue;
2138
823
      E = E->IgnoreParens();
2139
2140
      // handle constructors that involve temporaries
2141
823
      if (auto *EWC = dyn_cast<ExprWithCleanups>(E))
2142
51
        E = EWC->getSubExpr()->IgnoreParens();
2143
823
      if (auto *CE = dyn_cast<CastExpr>(E))
2144
154
        if (CE->getCastKind() == CK_NoOp ||
2145
148
            CE->getCastKind() == CK_ConstructorConversion ||
2146
146
            CE->getCastKind() == CK_UserDefinedConversion)
2147
10
          E = CE->getSubExpr()->IgnoreParens();
2148
823
      if (auto *BTE = dyn_cast<CXXBindTemporaryExpr>(E))
2149
12
        E = BTE->getSubExpr()->IgnoreParens();
2150
2151
823
      if (const auto *CE = dyn_cast<CXXConstructExpr>(E)) {
2152
483
        const auto *CtorD = dyn_cast_or_null<NamedDecl>(CE->getConstructor());
2153
483
        if (!CtorD || !CtorD->hasAttrs())
2154
221
          continue;
2155
262
        handleCall(E, CtorD, VD);
2156
340
      } else if (isa<CallExpr>(E) && 
E->isRValue()72
) {
2157
        // If the object is initialized by a function call that returns a
2158
        // scoped lockable by value, use the attributes on the copy or move
2159
        // constructor to figure out what effect that should have on the
2160
        // lockset.
2161
        // FIXME: Is this really the best way to handle this situation?
2162
72
        auto *RD = E->getType()->getAsCXXRecordDecl();
2163
72
        if (!RD || 
!RD->hasAttr<ScopedLockableAttr>()4
)
2164
68
          continue;
2165
4
        CXXConstructorDecl *CtorD = findConstructorForByValueReturn(RD);
2166
4
        if (!CtorD || !CtorD->hasAttrs())
2167
0
          continue;
2168
4
        handleCall(buildFakeCtorCall(CtorD, {E}, E->getBeginLoc()), CtorD, VD);
2169
4
      }
2170
823
    }
2171
920
  }
2172
920
}
2173
2174
/// Compute the intersection of two locksets and issue warnings for any
2175
/// locks in the symmetric difference.
2176
///
2177
/// This function is used at a merge point in the CFG when comparing the lockset
2178
/// of each branch being merged. For example, given the following sequence:
2179
/// A; if () then B; else C; D; we need to check that the lockset after B and C
2180
/// are the same. In the event of a difference, we use the intersection of these
2181
/// two locksets at the start of D.
2182
///
2183
/// \param FSet1 The first lockset.
2184
/// \param FSet2 The second lockset.
2185
/// \param JoinLoc The location of the join point for error reporting
2186
/// \param LEK1 The error message to report if a mutex is missing from LSet1
2187
/// \param LEK2 The error message to report if a mutex is missing from Lset2
2188
void ThreadSafetyAnalyzer::intersectAndWarn(FactSet &FSet1,
2189
                                            const FactSet &FSet2,
2190
                                            SourceLocation JoinLoc,
2191
                                            LockErrorKind LEK1,
2192
                                            LockErrorKind LEK2,
2193
2.65k
                                            bool Modify) {
2194
2.65k
  FactSet FSet1Orig = FSet1;
2195
2196
  // Find locks in FSet2 that conflict or are not in FSet1, and warn.
2197
2.34k
  for (const auto &Fact : FSet2) {
2198
2.34k
    const FactEntry *LDat1 = nullptr;
2199
2.34k
    const FactEntry *LDat2 = &FactMan[Fact];
2200
2.34k
    FactSet::iterator Iter1  = FSet1.findLockIter(FactMan, *LDat2);
2201
2.34k
    if (Iter1 != FSet1.end()) 
LDat1 = &FactMan[*Iter1]979
;
2202
2203
2.34k
    if (LDat1) {
2204
979
      if (LDat1->kind() != LDat2->kind()) {
2205
20
        Handler.handleExclusiveAndShared("mutex", LDat2->toString(),
2206
20
                                         LDat2->loc(), LDat1->loc());
2207
20
        if (Modify && 
LDat1->kind() != LK_Exclusive12
) {
2208
          // Take the exclusive lock, which is the one in FSet2.
2209
8
          *Iter1 = Fact;
2210
8
        }
2211
20
      }
2212
959
      else if (Modify && 
LDat1->asserted()457
&&
!LDat2->asserted()12
) {
2213
        // The non-asserted lock in FSet2 is the one we want to track.
2214
8
        *Iter1 = Fact;
2215
8
      }
2216
1.36k
    } else {
2217
1.36k
      LDat2->handleRemovalFromIntersection(FSet2, FactMan, JoinLoc, LEK1,
2218
1.36k
                                           Handler);
2219
1.36k
    }
2220
2.34k
  }
2221
2222
  // Find locks in FSet1 that are not in FSet2, and remove them.
2223
1.22k
  for (const auto &Fact : FSet1Orig) {
2224
1.22k
    const FactEntry *LDat1 = &FactMan[Fact];
2225
1.22k
    const FactEntry *LDat2 = FSet2.findLock(FactMan, *LDat1);
2226
2227
1.22k
    if (!LDat2) {
2228
244
      LDat1->handleRemovalFromIntersection(FSet1Orig, FactMan, JoinLoc, LEK2,
2229
244
                                           Handler);
2230
244
      if (Modify)
2231
156
        FSet1.removeLock(FactMan, *LDat1);
2232
244
    }
2233
1.22k
  }
2234
2.65k
}
2235
2236
// Return true if block B never continues to its successors.
2237
5.92k
static bool neverReturns(const CFGBlock *B) {
2238
5.92k
  if (B->hasNoReturnElement())
2239
24
    return true;
2240
5.90k
  if (B->empty())
2241
2.02k
    return false;
2242
2243
3.88k
  CFGElement Last = B->back();
2244
3.88k
  if (Optional<CFGStmt> S = Last.getAs<CFGStmt>()) {
2245
3.62k
    if (isa<CXXThrowExpr>(S->getStmt()))
2246
4
      return true;
2247
3.87k
  }
2248
3.87k
  return false;
2249
3.87k
}
2250
2251
/// Check a function's CFG for thread-safety violations.
2252
///
2253
/// We traverse the blocks in the CFG, compute the set of mutexes that are held
2254
/// at the end of each block, and issue warnings for thread safety violations.
2255
/// Each block in the CFG is traversed exactly once.
2256
2.16k
void ThreadSafetyAnalyzer::runAnalysis(AnalysisDeclContext &AC) {
2257
  // TODO: this whole function needs be rewritten as a visitor for CFGWalker.
2258
  // For now, we just use the walker to set things up.
2259
2.16k
  threadSafety::CFGWalker walker;
2260
2.16k
  if (!walker.init(AC))
2261
3
    return;
2262
2263
  // AC.dumpCFG(true);
2264
  // threadSafety::printSCFG(walker);
2265
2266
2.15k
  CFG *CFGraph = walker.getGraph();
2267
2.15k
  const NamedDecl *D = walker.getDecl();
2268
2.15k
  const auto *CurrentFunction = dyn_cast<FunctionDecl>(D);
2269
2.15k
  CurrentMethod = dyn_cast<CXXMethodDecl>(D);
2270
2271
2.15k
  if (D->hasAttr<NoThreadSafetyAnalysisAttr>())
2272
36
    return;
2273
2274
  // FIXME: Do something a bit more intelligent inside constructor and
2275
  // destructor code.  Constructors and destructors must assume unique access
2276
  // to 'this', so checks on member variable access is disabled, but we should
2277
  // still enable checks on other objects.
2278
2.12k
  if (isa<CXXConstructorDecl>(D))
2279
51
    return;  // Don't check inside constructors.
2280
2.07k
  if (isa<CXXDestructorDecl>(D))
2281
26
    return;  // Don't check inside destructors.
2282
2283
2.04k
  Handler.enterFunction(CurrentFunction);
2284
2285
2.04k
  BlockInfo.resize(CFGraph->getNumBlockIDs(),
2286
2.04k
    CFGBlockInfo::getEmptyBlockInfo(LocalVarMap));
2287
2288
  // We need to explore the CFG via a "topological" ordering.
2289
  // That way, we will be guaranteed to have information about required
2290
  // predecessor locksets when exploring a new block.
2291
2.04k
  const PostOrderCFGView *SortedGraph = walker.getSortedGraph();
2292
2.04k
  PostOrderCFGView::CFGBlockSet VisitedBlocks(CFGraph);
2293
2294
  // Mark entry block as reachable
2295
2.04k
  BlockInfo[CFGraph->getEntry().getBlockID()].Reachable = true;
2296
2297
  // Compute SSA names for local variables
2298
2.04k
  LocalVarMap.traverseCFG(CFGraph, SortedGraph, BlockInfo);
2299
2300
  // Fill in source locations for all CFGBlocks.
2301
2.04k
  findBlockLocations(CFGraph, SortedGraph, BlockInfo);
2302
2303
2.04k
  CapExprSet ExclusiveLocksAcquired;
2304
2.04k
  CapExprSet SharedLocksAcquired;
2305
2.04k
  CapExprSet LocksReleased;
2306
2307
  // Add locks from exclusive_locks_required and shared_locks_required
2308
  // to initial lockset. Also turn off checking for lock and unlock functions.
2309
  // FIXME: is there a more intelligent way to check lock/unlock functions?
2310
2.04k
  if (!SortedGraph->empty() && D->hasAttrs()) {
2311
542
    const CFGBlock *FirstBlock = *SortedGraph->begin();
2312
542
    FactSet &InitialLockset = BlockInfo[FirstBlock->getBlockID()].EntrySet;
2313
2314
542
    CapExprSet ExclusiveLocksToAdd;
2315
542
    CapExprSet SharedLocksToAdd;
2316
542
    StringRef CapDiagKind = "mutex";
2317
2318
542
    SourceLocation Loc = D->getLocation();
2319
672
    for (const auto *Attr : D->attrs()) {
2320
672
      Loc = Attr->getLocation();
2321
672
      if (const auto *A = dyn_cast<RequiresCapabilityAttr>(Attr)) {
2322
339
        getMutexIDs(A->isShared() ? 
SharedLocksToAdd59
: ExclusiveLocksToAdd, A,
2323
398
                    nullptr, D);
2324
398
        CapDiagKind = ClassifyDiagnostic(A);
2325
274
      } else if (const auto *A = dyn_cast<ReleaseCapabilityAttr>(Attr)) {
2326
        // UNLOCK_FUNCTION() is used to hide the underlying lock implementation.
2327
        // We must ignore such methods.
2328
91
        if (A->args_size() == 0)
2329
14
          return;
2330
77
        getMutexIDs(A->isShared() ? 
SharedLocksToAdd8
:
ExclusiveLocksToAdd69
, A,
2331
77
                    nullptr, D);
2332
77
        getMutexIDs(LocksReleased, A, nullptr, D);
2333
77
        CapDiagKind = ClassifyDiagnostic(A);
2334
183
      } else if (const auto *A = dyn_cast<AcquireCapabilityAttr>(Attr)) {
2335
106
        if (A->args_size() == 0)
2336
18
          return;
2337
88
        getMutexIDs(A->isShared() ? 
SharedLocksAcquired28
2338
60
                                  : ExclusiveLocksAcquired,
2339
88
                    A, nullptr, D);
2340
88
        CapDiagKind = ClassifyDiagnostic(A);
2341
77
      } else if (isa<ExclusiveTrylockFunctionAttr>(Attr)) {
2342
        // Don't try to check trylock functions for now.
2343
4
        return;
2344
73
      } else if (isa<SharedTrylockFunctionAttr>(Attr)) {
2345
        // Don't try to check trylock functions for now.
2346
2
        return;
2347
71
      } else if (isa<TryAcquireCapabilityAttr>(Attr)) {
2348
        // Don't try to check trylock functions for now.
2349
6
        return;
2350
6
      }
2351
672
    }
2352
2353
    // FIXME -- Loc can be wrong here.
2354
498
    for (const auto &Mu : ExclusiveLocksToAdd) {
2355
420
      auto Entry = std::make_unique<LockableFactEntry>(Mu, LK_Exclusive, Loc);
2356
420
      Entry->setDeclared(true);
2357
420
      addLock(InitialLockset, std::move(Entry), CapDiagKind, true);
2358
420
    }
2359
83
    for (const auto &Mu : SharedLocksToAdd) {
2360
83
      auto Entry = std::make_unique<LockableFactEntry>(Mu, LK_Shared, Loc);
2361
83
      Entry->setDeclared(true);
2362
83
      addLock(InitialLockset, std::move(Entry), CapDiagKind, true);
2363
83
    }
2364
498
  }
2365
2366
7.34k
  
for (const auto *CurrBlock : *SortedGraph)2.00k
{
2367
7.34k
    unsigned CurrBlockID = CurrBlock->getBlockID();
2368
7.34k
    CFGBlockInfo *CurrBlockInfo = &BlockInfo[CurrBlockID];
2369
2370
    // Use the default initial lockset in case there are no predecessors.
2371
7.34k
    VisitedBlocks.insert(CurrBlock);
2372
2373
    // Iterate through the predecessor blocks and warn if the lockset for all
2374
    // predecessors is not the same. We take the entry lockset of the current
2375
    // block to be the intersection of all previous locksets.
2376
    // FIXME: By keeping the intersection, we may output more errors in future
2377
    // for a lock which is not in the intersection, but was in the union. We
2378
    // may want to also keep the union in future. As an example, let's say
2379
    // the intersection contains Mutex L, and the union contains L and M.
2380
    // Later we unlock M. At this point, we would output an error because we
2381
    // never locked M; although the real error is probably that we forgot to
2382
    // lock M on all code paths. Conversely, let's say that later we lock M.
2383
    // In this case, we should compare against the intersection instead of the
2384
    // union because the real error is probably that we forgot to unlock M on
2385
    // all code paths.
2386
7.34k
    bool LocksetInitialized = false;
2387
7.34k
    SmallVector<CFGBlock *, 8> SpecialBlocks;
2388
7.34k
    for (CFGBlock::const_pred_iterator PI = CurrBlock->pred_begin(),
2389
13.3k
         PE  = CurrBlock->pred_end(); PI != PE; 
++PI6.03k
) {
2390
      // if *PI -> CurrBlock is a back edge
2391
6.03k
      if (*PI == nullptr || !VisitedBlocks.alreadySet(*PI))
2392
106
        continue;
2393
2394
5.92k
      unsigned PrevBlockID = (*PI)->getBlockID();
2395
5.92k
      CFGBlockInfo *PrevBlockInfo = &BlockInfo[PrevBlockID];
2396
2397
      // Ignore edges from blocks that can't return.
2398
5.92k
      if (neverReturns(*PI) || 
!PrevBlockInfo->Reachable5.90k
)
2399
28
        continue;
2400
2401
      // Okay, we can reach this block from the entry.
2402
5.90k
      CurrBlockInfo->Reachable = true;
2403
2404
      // If the previous block ended in a 'continue' or 'break' statement, then
2405
      // a difference in locksets is probably due to a bug in that block, rather
2406
      // than in some other predecessor. In that case, keep the other
2407
      // predecessor's lockset.
2408
5.90k
      if (const Stmt *Terminator = (*PI)->getTerminatorStmt()) {
2409
1.38k
        if (isa<ContinueStmt>(Terminator) || 
isa<BreakStmt>(Terminator)1.37k
) {
2410
26
          SpecialBlocks.push_back(*PI);
2411
26
          continue;
2412
26
        }
2413
5.87k
      }
2414
2415
5.87k
      FactSet PrevLockset;
2416
5.87k
      getEdgeLockset(PrevLockset, PrevBlockInfo->ExitSet, *PI, CurrBlock);
2417
2418
5.87k
      if (!LocksetInitialized) {
2419
5.32k
        CurrBlockInfo->EntrySet = PrevLockset;
2420
5.32k
        LocksetInitialized = true;
2421
546
      } else {
2422
546
        intersectAndWarn(CurrBlockInfo->EntrySet, PrevLockset,
2423
546
                         CurrBlockInfo->EntryLoc,
2424
546
                         LEK_LockedSomePredecessors);
2425
546
      }
2426
5.87k
    }
2427
2428
    // Skip rest of block if it's not reachable.
2429
7.34k
    if (!CurrBlockInfo->Reachable)
2430
16
      continue;
2431
2432
    // Process continue and break blocks. Assume that the lockset for the
2433
    // resulting block is unaffected by any discrepancies in them.
2434
7.32k
    for (const auto *PrevBlock : SpecialBlocks) {
2435
26
      unsigned PrevBlockID = PrevBlock->getBlockID();
2436
26
      CFGBlockInfo *PrevBlockInfo = &BlockInfo[PrevBlockID];
2437
2438
26
      if (!LocksetInitialized) {
2439
0
        CurrBlockInfo->EntrySet = PrevBlockInfo->ExitSet;
2440
0
        LocksetInitialized = true;
2441
26
      } else {
2442
        // Determine whether this edge is a loop terminator for diagnostic
2443
        // purposes. FIXME: A 'break' statement might be a loop terminator, but
2444
        // it might also be part of a switch. Also, a subsequent destructor
2445
        // might add to the lockset, in which case the real issue might be a
2446
        // double lock on the other path.
2447
26
        const Stmt *Terminator = PrevBlock->getTerminatorStmt();
2448
26
        bool IsLoop = Terminator && isa<ContinueStmt>(Terminator);
2449
2450
26
        FactSet PrevLockset;
2451
26
        getEdgeLockset(PrevLockset, PrevBlockInfo->ExitSet,
2452
26
                       PrevBlock, CurrBlock);
2453
2454
        // Do not update EntrySet.
2455
26
        intersectAndWarn(CurrBlockInfo->EntrySet, PrevLockset,
2456
26
                         PrevBlockInfo->ExitLoc,
2457
16
                         IsLoop ? LEK_LockedSomeLoopIterations
2458
10
                                : LEK_LockedSomePredecessors,
2459
26
                         false);
2460
26
      }
2461
26
    }
2462
2463
7.32k
    BuildLockset LocksetBuilder(this, *CurrBlockInfo);
2464
2465
    // Visit all the statements in the basic block.
2466
34.2k
    for (const auto &BI : *CurrBlock) {
2467
34.2k
      switch (BI.getKind()) {
2468
33.9k
        case CFGElement::Statement: {
2469
33.9k
          CFGStmt CS = BI.castAs<CFGStmt>();
2470
33.9k
          LocksetBuilder.Visit(CS.getStmt());
2471
33.9k
          break;
2472
0
        }
2473
        // Ignore BaseDtor, MemberDtor, and TemporaryDtor for now.
2474
280
        case CFGElement::AutomaticObjectDtor: {
2475
280
          CFGAutomaticObjDtor AD = BI.castAs<CFGAutomaticObjDtor>();
2476
280
          const auto *DD = AD.getDestructorDecl(AC.getASTContext());
2477
280
          if (!DD->hasAttrs())
2478
37
            break;
2479
2480
          // Create a dummy expression,
2481
243
          auto *VD = const_cast<VarDecl *>(AD.getVarDecl());
2482
243
          DeclRefExpr DRE(VD->getASTContext(), VD, false,
2483
243
                          VD->getType().getNonReferenceType(), VK_LValue,
2484
243
                          AD.getTriggerStmt()->getEndLoc());
2485
243
          LocksetBuilder.handleCall(&DRE, DD);
2486
243
          break;
2487
243
        }
2488
34
        default:
2489
34
          break;
2490
34.2k
      }
2491
34.2k
    }
2492
7.32k
    CurrBlockInfo->ExitSet = LocksetBuilder.FSet;
2493
2494
    // For every back edge from CurrBlock (the end of the loop) to another block
2495
    // (FirstLoopBlock) we need to check that the Lockset of Block is equal to
2496
    // the one held at the beginning of FirstLoopBlock. We can look up the
2497
    // Lockset held at the beginning of FirstLoopBlock in the EntryLockSets map.
2498
7.32k
    for (CFGBlock::const_succ_iterator SI = CurrBlock->succ_begin(),
2499
13.3k
         SE  = CurrBlock->succ_end(); SI != SE; 
++SI6.03k
) {
2500
      // if CurrBlock -> *SI is *not* a back edge
2501
6.03k
      if (*SI == nullptr || 
!VisitedBlocks.alreadySet(*SI)6.02k
)
2502
5.93k
        continue;
2503
2504
98
      CFGBlock *FirstLoopBlock = *SI;
2505
98
      CFGBlockInfo *PreLoop = &BlockInfo[FirstLoopBlock->getBlockID()];
2506
98
      CFGBlockInfo *LoopEnd = &BlockInfo[CurrBlockID];
2507
98
      intersectAndWarn(LoopEnd->ExitSet, PreLoop->EntrySet,
2508
98
                       PreLoop->EntryLoc,
2509
98
                       LEK_LockedSomeLoopIterations,
2510
98
                       false);
2511
98
    }
2512
7.32k
  }
2513
2514
2.00k
  CFGBlockInfo *Initial = &BlockInfo[CFGraph->getEntry().getBlockID()];
2515
2.00k
  CFGBlockInfo *Final   = &BlockInfo[CFGraph->getExit().getBlockID()];
2516
2517
  // Skip the final check if the exit block is unreachable.
2518
2.00k
  if (!Final->Reachable)
2519
20
    return;
2520
2521
  // By default, we expect all locks held on entry to be held on exit.
2522
1.98k
  FactSet ExpectedExitSet = Initial->EntrySet;
2523
2524
  // Adjust the expected exit set by adding or removing locks, as declared
2525
  // by *-LOCK_FUNCTION and UNLOCK_FUNCTION.  The intersect below will then
2526
  // issue the appropriate warning.
2527
  // FIXME: the location here is not quite right.
2528
1.98k
  for (const auto &Lock : ExclusiveLocksAcquired)
2529
52
    ExpectedExitSet.addLock(FactMan, std::make_unique<LockableFactEntry>(
2530
52
                                         Lock, LK_Exclusive, D->getLocation()));
2531
1.98k
  for (const auto &Lock : SharedLocksAcquired)
2532
24
    ExpectedExitSet.addLock(FactMan, std::make_unique<LockableFactEntry>(
2533
24
                                         Lock, LK_Shared, D->getLocation()));
2534
1.98k
  for (const auto &Lock : LocksReleased)
2535
69
    ExpectedExitSet.removeLock(FactMan, Lock);
2536
2537
  // FIXME: Should we call this function for all blocks which exit the function?
2538
1.98k
  intersectAndWarn(ExpectedExitSet, Final->ExitSet,
2539
1.98k
                   Final->ExitLoc,
2540
1.98k
                   LEK_LockedAtEndOfFunction,
2541
1.98k
                   LEK_NotLockedAtEndOfFunction,
2542
1.98k
                   false);
2543
2544
1.98k
  Handler.leaveFunction(CurrentFunction);
2545
1.98k
}
2546
2547
/// Check a function's CFG for thread-safety violations.
2548
///
2549
/// We traverse the blocks in the CFG, compute the set of mutexes that are held
2550
/// at the end of each block, and issue warnings for thread safety violations.
2551
/// Each block in the CFG is traversed exactly once.
2552
void threadSafety::runThreadSafetyAnalysis(AnalysisDeclContext &AC,
2553
                                           ThreadSafetyHandler &Handler,
2554
2.16k
                                           BeforeSet **BSet) {
2555
2.16k
  if (!*BSet)
2556
34
    *BSet = new BeforeSet;
2557
2.16k
  ThreadSafetyAnalyzer Analyzer(Handler, *BSet);
2558
2.16k
  Analyzer.runAnalysis(AC);
2559
2.16k
}
2560
2561
71.7k
void threadSafety::threadSafetyCleanup(BeforeSet *Cache) { delete Cache; }
2562
2563
/// Helper function that returns a LockKind required for the given level
2564
/// of access.
2565
3.00k
LockKind threadSafety::getLockKindFromAccessKind(AccessKind AK) {
2566
3.00k
  switch (AK) {
2567
1.23k
    case AK_Read :
2568
1.23k
      return LK_Shared;
2569
1.77k
    case AK_Written :
2570
1.77k
      return LK_Exclusive;
2571
0
  }
2572
0
  llvm_unreachable("Unknown AccessKind");
2573
0
}