// RUN: %clang_cc1 -fsyntax-only -verify -std=c++11 -Wthread-safety -Wthread-safety-beta -fcxx-exceptions %s // FIXME: should also run %clang_cc1 -fsyntax-only -verify -Wthread-safety -std=c++11 -Wc++98-compat %s // FIXME: should also run %clang_cc1 -fsyntax-only -verify -Wthread-safety %s #define LOCKABLE __attribute__ ((lockable)) #define SCOPED_LOCKABLE __attribute__ ((scoped_lockable)) #define GUARDED_BY(x) __attribute__ ((guarded_by(x))) #define GUARDED_VAR __attribute__ ((guarded_var)) #define PT_GUARDED_BY(x) __attribute__ ((pt_guarded_by(x))) #define PT_GUARDED_VAR __attribute__ ((pt_guarded_var)) #define ACQUIRED_AFTER(...) __attribute__ ((acquired_after(__VA_ARGS__))) #define ACQUIRED_BEFORE(...) __attribute__ ((acquired_before(__VA_ARGS__))) #define EXCLUSIVE_LOCK_FUNCTION(...) __attribute__ ((exclusive_lock_function(__VA_ARGS__))) #define SHARED_LOCK_FUNCTION(...) __attribute__ ((shared_lock_function(__VA_ARGS__))) #define EXCLUSIVE_TRYLOCK_FUNCTION(...) __attribute__ ((exclusive_trylock_function(__VA_ARGS__))) #define SHARED_TRYLOCK_FUNCTION(...) __attribute__ ((shared_trylock_function(__VA_ARGS__))) #define UNLOCK_FUNCTION(...) __attribute__ ((unlock_function(__VA_ARGS__))) #define LOCK_RETURNED(x) __attribute__ ((lock_returned(x))) #define LOCKS_EXCLUDED(...) __attribute__ ((locks_excluded(__VA_ARGS__))) #define EXCLUSIVE_LOCKS_REQUIRED(...) \ __attribute__ ((exclusive_locks_required(__VA_ARGS__))) #define SHARED_LOCKS_REQUIRED(...) \ __attribute__ ((shared_locks_required(__VA_ARGS__))) #define NO_THREAD_SAFETY_ANALYSIS __attribute__ ((no_thread_safety_analysis)) class __attribute__((lockable)) Mutex { public: void Lock() __attribute__((exclusive_lock_function)); void ReaderLock() __attribute__((shared_lock_function)); void Unlock() __attribute__((unlock_function)); bool TryLock() __attribute__((exclusive_trylock_function(true))); bool ReaderTryLock() __attribute__((shared_trylock_function(true))); void LockWhen(const int &cond) __attribute__((exclusive_lock_function)); }; class __attribute__((scoped_lockable)) MutexLock { public: MutexLock(Mutex *mu) __attribute__((exclusive_lock_function(mu))); ~MutexLock() __attribute__((unlock_function)); }; class __attribute__((scoped_lockable)) ReaderMutexLock { public: ReaderMutexLock(Mutex *mu) __attribute__((exclusive_lock_function(mu))); ~ReaderMutexLock() __attribute__((unlock_function)); }; class SCOPED_LOCKABLE ReleasableMutexLock { public: ReleasableMutexLock(Mutex *mu) EXCLUSIVE_LOCK_FUNCTION(mu); ~ReleasableMutexLock() UNLOCK_FUNCTION(); void Release() UNLOCK_FUNCTION(); }; // The universal lock, written "*", allows checking to be selectively turned // off for a particular piece of code. void beginNoWarnOnReads() SHARED_LOCK_FUNCTION("*"); void endNoWarnOnReads() UNLOCK_FUNCTION("*"); void beginNoWarnOnWrites() EXCLUSIVE_LOCK_FUNCTION("*"); void endNoWarnOnWrites() UNLOCK_FUNCTION("*"); // For testing handling of smart pointers. template class SmartPtr { public: SmartPtr(T* p) : ptr_(p) { } SmartPtr(const SmartPtr& p) : ptr_(p.ptr_) { } ~SmartPtr(); T* get() const { return ptr_; } T* operator->() const { return ptr_; } T& operator*() const { return *ptr_; } private: T* ptr_; }; // For testing destructor calls and cleanup. class MyString { public: MyString(const char* s); ~MyString(); }; Mutex sls_mu; Mutex sls_mu2 __attribute__((acquired_after(sls_mu))); int sls_guard_var __attribute__((guarded_var)) = 0; int sls_guardby_var __attribute__((guarded_by(sls_mu))) = 0; bool getBool(); class MutexWrapper { public: Mutex mu; int x __attribute__((guarded_by(mu))); void MyLock() __attribute__((exclusive_lock_function(mu))); }; MutexWrapper sls_mw; void sls_fun_0() { sls_mw.mu.Lock(); sls_mw.x = 5; sls_mw.mu.Unlock(); } void sls_fun_2() { sls_mu.Lock(); int x = sls_guard_var; sls_mu.Unlock(); } void sls_fun_3() { sls_mu.Lock(); sls_guard_var = 2; sls_mu.Unlock(); } void sls_fun_4() { sls_mu2.Lock(); sls_guard_var = 2; sls_mu2.Unlock(); } void sls_fun_5() { sls_mu.Lock(); int x = sls_guardby_var; sls_mu.Unlock(); } void sls_fun_6() { sls_mu.Lock(); sls_guardby_var = 2; sls_mu.Unlock(); } void sls_fun_7() { sls_mu.Lock(); sls_mu2.Lock(); sls_mu2.Unlock(); sls_mu.Unlock(); } void sls_fun_8() { sls_mu.Lock(); if (getBool()) sls_mu.Unlock(); else sls_mu.Unlock(); } void sls_fun_9() { if (getBool()) sls_mu.Lock(); else sls_mu.Lock(); sls_mu.Unlock(); } void sls_fun_good_6() { if (getBool()) { sls_mu.Lock(); } else { if (getBool()) { getBool(); // EMPTY } else { getBool(); // EMPTY } sls_mu.Lock(); } sls_mu.Unlock(); } void sls_fun_good_7() { sls_mu.Lock(); while (getBool()) { sls_mu.Unlock(); if (getBool()) { if (getBool()) { sls_mu.Lock(); continue; } } sls_mu.Lock(); } sls_mu.Unlock(); } void sls_fun_good_8() { sls_mw.MyLock(); sls_mw.mu.Unlock(); } void sls_fun_bad_1() { sls_mu.Unlock(); // \ // expected-warning{{unlocking 'sls_mu' that was not locked}} } void sls_fun_bad_2() { sls_mu.Lock(); sls_mu.Lock(); // \ // expected-warning{{locking 'sls_mu' that is already locked}} sls_mu.Unlock(); } void sls_fun_bad_3() { sls_mu.Lock(); // expected-note {{mutex acquired here}} } // expected-warning{{mutex 'sls_mu' is still locked at the end of function}} void sls_fun_bad_4() { if (getBool()) sls_mu.Lock(); // expected-note{{mutex acquired here}} else sls_mu2.Lock(); // expected-note{{mutex acquired here}} } // expected-warning{{mutex 'sls_mu' is not locked on every path through here}} \ // expected-warning{{mutex 'sls_mu2' is not locked on every path through here}} void sls_fun_bad_5() { sls_mu.Lock(); // expected-note {{mutex acquired here}} if (getBool()) sls_mu.Unlock(); } // expected-warning{{mutex 'sls_mu' is not locked on every path through here}} void sls_fun_bad_6() { if (getBool()) { sls_mu.Lock(); // expected-note {{mutex acquired here}} } else { if (getBool()) { getBool(); // EMPTY } else { getBool(); // EMPTY } } sls_mu.Unlock(); // \ expected-warning{{mutex 'sls_mu' is not locked on every path through here}}\ expected-warning{{unlocking 'sls_mu' that was not locked}} } void sls_fun_bad_7() { sls_mu.Lock(); while (getBool()) { sls_mu.Unlock(); if (getBool()) { if (getBool()) { continue; // \ expected-warning{{expecting mutex 'sls_mu' to be locked at start of each loop}} } } sls_mu.Lock(); // expected-note {{mutex acquired here}} } sls_mu.Unlock(); } void sls_fun_bad_8() { sls_mu.Lock(); // expected-note{{mutex acquired here}} do { sls_mu.Unlock(); // expected-warning{{expecting mutex 'sls_mu' to be locked at start of each loop}} } while (getBool()); } void sls_fun_bad_9() { do { sls_mu.Lock(); // \ // expected-warning{{expecting mutex 'sls_mu' to be locked at start of each loop}} \ // expected-note{{mutex acquired here}} } while (getBool()); sls_mu.Unlock(); } void sls_fun_bad_10() { sls_mu.Lock(); // expected-note 2{{mutex acquired here}} while(getBool()) { // expected-warning{{expecting mutex 'sls_mu' to be locked at start of each loop}} sls_mu.Unlock(); } } // expected-warning{{mutex 'sls_mu' is still locked at the end of function}} void sls_fun_bad_11() { while (getBool()) { // \ expected-warning{{expecting mutex 'sls_mu' to be locked at start of each loop}} sls_mu.Lock(); // expected-note {{mutex acquired here}} } sls_mu.Unlock(); // \ // expected-warning{{unlocking 'sls_mu' that was not locked}} } void sls_fun_bad_12() { sls_mu.Lock(); // expected-note {{mutex acquired here}} while (getBool()) { sls_mu.Unlock(); if (getBool()) { if (getBool()) { break; // expected-warning{{mutex 'sls_mu' is not locked on every path through here}} } } sls_mu.Lock(); } sls_mu.Unlock(); } //-----------------------------------------// // Handling lock expressions in attribute args // -------------------------------------------// Mutex aa_mu; class GlobalLocker { public: void globalLock() __attribute__((exclusive_lock_function(aa_mu))); void globalUnlock() __attribute__((unlock_function(aa_mu))); }; GlobalLocker glock; void aa_fun_1() { glock.globalLock(); glock.globalUnlock(); } void aa_fun_bad_1() { glock.globalUnlock(); // \ // expected-warning{{unlocking 'aa_mu' that was not locked}} } void aa_fun_bad_2() { glock.globalLock(); glock.globalLock(); // \ // expected-warning{{locking 'aa_mu' that is already locked}} glock.globalUnlock(); } void aa_fun_bad_3() { glock.globalLock(); // expected-note{{mutex acquired here}} } // expected-warning{{mutex 'aa_mu' is still locked at the end of function}} //--------------------------------------------------// // Regression tests for unusual method names //--------------------------------------------------// Mutex wmu; // Test diagnostics for other method names. class WeirdMethods { // FIXME: can't currently check inside constructors and destructors. WeirdMethods() { wmu.Lock(); // EXPECTED-NOTE {{mutex acquired here}} } // EXPECTED-WARNING {{mutex 'wmu' is still locked at the end of function}} ~WeirdMethods() { wmu.Lock(); // EXPECTED-NOTE {{mutex acquired here}} } // EXPECTED-WARNING {{mutex 'wmu' is still locked at the end of function}} void operator++() { wmu.Lock(); // expected-note {{mutex acquired here}} } // expected-warning {{mutex 'wmu' is still locked at the end of function}} operator int*() { wmu.Lock(); // expected-note {{mutex acquired here}} return 0; } // expected-warning {{mutex 'wmu' is still locked at the end of function}} }; //-----------------------------------------------// // Errors for guarded by or guarded var variables // ----------------------------------------------// int *pgb_gvar __attribute__((pt_guarded_var)); int *pgb_var __attribute__((pt_guarded_by(sls_mu))); class PGBFoo { public: int x; int *pgb_field __attribute__((guarded_by(sls_mu2))) __attribute__((pt_guarded_by(sls_mu))); void testFoo() { pgb_field = &x; // \ // expected-warning {{writing variable 'pgb_field' requires locking 'sls_mu2' exclusively}} *pgb_field = x; // expected-warning {{reading variable 'pgb_field' requires locking 'sls_mu2'}} \ // expected-warning {{writing the value pointed to by 'pgb_field' requires locking 'sls_mu' exclusively}} x = *pgb_field; // expected-warning {{reading variable 'pgb_field' requires locking 'sls_mu2'}} \ // expected-warning {{reading the value pointed to by 'pgb_field' requires locking 'sls_mu'}} (*pgb_field)++; // expected-warning {{reading variable 'pgb_field' requires locking 'sls_mu2'}} \ // expected-warning {{writing the value pointed to by 'pgb_field' requires locking 'sls_mu' exclusively}} } }; class GBFoo { public: int gb_field __attribute__((guarded_by(sls_mu))); void testFoo() { gb_field = 0; // \ // expected-warning {{writing variable 'gb_field' requires locking 'sls_mu' exclusively}} } void testNoAnal() __attribute__((no_thread_safety_analysis)) { gb_field = 0; } }; GBFoo GlobalGBFoo __attribute__((guarded_by(sls_mu))); void gb_fun_0() { sls_mu.Lock(); int x = *pgb_var; sls_mu.Unlock(); } void gb_fun_1() { sls_mu.Lock(); *pgb_var = 2; sls_mu.Unlock(); } void gb_fun_2() { int x; pgb_var = &x; } void gb_fun_3() { int *x = pgb_var; } void gb_bad_0() { sls_guard_var = 1; // \ // expected-warning{{writing variable 'sls_guard_var' requires locking any mutex exclusively}} } void gb_bad_1() { int x = sls_guard_var; // \ // expected-warning{{reading variable 'sls_guard_var' requires locking any mutex}} } void gb_bad_2() { sls_guardby_var = 1; // \ // expected-warning {{writing variable 'sls_guardby_var' requires locking 'sls_mu' exclusively}} } void gb_bad_3() { int x = sls_guardby_var; // \ // expected-warning {{reading variable 'sls_guardby_var' requires locking 'sls_mu'}} } void gb_bad_4() { *pgb_gvar = 1; // \ // expected-warning {{writing the value pointed to by 'pgb_gvar' requires locking any mutex exclusively}} } void gb_bad_5() { int x = *pgb_gvar; // \ // expected-warning {{reading the value pointed to by 'pgb_gvar' requires locking any mutex}} } void gb_bad_6() { *pgb_var = 1; // \ // expected-warning {{writing the value pointed to by 'pgb_var' requires locking 'sls_mu' exclusively}} } void gb_bad_7() { int x = *pgb_var; // \ // expected-warning {{reading the value pointed to by 'pgb_var' requires locking 'sls_mu'}} } void gb_bad_8() { GBFoo G; G.gb_field = 0; // \ // expected-warning {{writing variable 'gb_field' requires locking 'sls_mu'}} } void gb_bad_9() { sls_guard_var++; // \ // expected-warning{{writing variable 'sls_guard_var' requires locking any mutex exclusively}} sls_guard_var--; // \ // expected-warning{{writing variable 'sls_guard_var' requires locking any mutex exclusively}} ++sls_guard_var; // \ // expected-warning{{writing variable 'sls_guard_var' requires locking any mutex exclusively}} --sls_guard_var;// \ // expected-warning{{writing variable 'sls_guard_var' requires locking any mutex exclusively}} } //-----------------------------------------------// // Warnings on variables with late parsed attributes // ----------------------------------------------// class LateFoo { public: int a __attribute__((guarded_by(mu))); int b; void foo() __attribute__((exclusive_locks_required(mu))) { } void test() { a = 0; // \ // expected-warning{{writing variable 'a' requires locking 'mu' exclusively}} b = a; // \ // expected-warning {{reading variable 'a' requires locking 'mu'}} c = 0; // \ // expected-warning {{writing variable 'c' requires locking 'mu' exclusively}} } int c __attribute__((guarded_by(mu))); Mutex mu; }; class LateBar { public: int a_ __attribute__((guarded_by(mu1_))); int b_; int *q __attribute__((pt_guarded_by(mu))); Mutex mu1_; Mutex mu; LateFoo Foo; LateFoo Foo2; LateFoo *FooPointer; }; LateBar b1, *b3; void late_0() { LateFoo FooA; LateFoo FooB; FooA.mu.Lock(); FooA.a = 5; FooA.mu.Unlock(); } void late_1() { LateBar BarA; BarA.FooPointer->mu.Lock(); BarA.FooPointer->a = 2; BarA.FooPointer->mu.Unlock(); } void late_bad_0() { LateFoo fooA; LateFoo fooB; fooA.mu.Lock(); fooB.a = 5; // \ // expected-warning{{writing variable 'a' requires locking 'fooB.mu' exclusively}} \ // expected-note{{found near match 'fooA.mu'}} fooA.mu.Unlock(); } void late_bad_1() { Mutex mu; mu.Lock(); b1.mu1_.Lock(); int res = b1.a_ + b3->b_; b3->b_ = *b1.q; // \ // expected-warning{{reading the value pointed to by 'q' requires locking 'b1.mu'}} b1.mu1_.Unlock(); b1.b_ = res; mu.Unlock(); } void late_bad_2() { LateBar BarA; BarA.FooPointer->mu.Lock(); BarA.Foo.a = 2; // \ // expected-warning{{writing variable 'a' requires locking 'BarA.Foo.mu' exclusively}} \ // expected-note{{found near match 'BarA.FooPointer->mu'}} BarA.FooPointer->mu.Unlock(); } void late_bad_3() { LateBar BarA; BarA.Foo.mu.Lock(); BarA.FooPointer->a = 2; // \ // expected-warning{{writing variable 'a' requires locking 'BarA.FooPointer->mu' exclusively}} \ // expected-note{{found near match 'BarA.Foo.mu'}} BarA.Foo.mu.Unlock(); } void late_bad_4() { LateBar BarA; BarA.Foo.mu.Lock(); BarA.Foo2.a = 2; // \ // expected-warning{{writing variable 'a' requires locking 'BarA.Foo2.mu' exclusively}} \ // expected-note{{found near match 'BarA.Foo.mu'}} BarA.Foo.mu.Unlock(); } //-----------------------------------------------// // Extra warnings for shared vs. exclusive locks // ----------------------------------------------// void shared_fun_0() { sls_mu.Lock(); do { sls_mu.Unlock(); sls_mu.Lock(); } while (getBool()); sls_mu.Unlock(); } void shared_fun_1() { sls_mu.ReaderLock(); // \ // expected-warning {{mutex 'sls_mu' is locked exclusively and shared in the same scope}} do { sls_mu.Unlock(); sls_mu.Lock(); // \ // expected-note {{the other lock of mutex 'sls_mu' is here}} } while (getBool()); sls_mu.Unlock(); } void shared_fun_3() { if (getBool()) sls_mu.Lock(); else sls_mu.Lock(); *pgb_var = 1; sls_mu.Unlock(); } void shared_fun_4() { if (getBool()) sls_mu.ReaderLock(); else sls_mu.ReaderLock(); int x = sls_guardby_var; sls_mu.Unlock(); } void shared_fun_8() { if (getBool()) sls_mu.Lock(); // \ // expected-warning {{mutex 'sls_mu' is locked exclusively and shared in the same scope}} else sls_mu.ReaderLock(); // \ // expected-note {{the other lock of mutex 'sls_mu' is here}} sls_mu.Unlock(); } void shared_bad_0() { sls_mu.Lock(); // \ // expected-warning {{mutex 'sls_mu' is locked exclusively and shared in the same scope}} do { sls_mu.Unlock(); sls_mu.ReaderLock(); // \ // expected-note {{the other lock of mutex 'sls_mu' is here}} } while (getBool()); sls_mu.Unlock(); } void shared_bad_1() { if (getBool()) sls_mu.Lock(); // \ // expected-warning {{mutex 'sls_mu' is locked exclusively and shared in the same scope}} else sls_mu.ReaderLock(); // \ // expected-note {{the other lock of mutex 'sls_mu' is here}} *pgb_var = 1; sls_mu.Unlock(); } void shared_bad_2() { if (getBool()) sls_mu.ReaderLock(); // \ // expected-warning {{mutex 'sls_mu' is locked exclusively and shared in the same scope}} else sls_mu.Lock(); // \ // expected-note {{the other lock of mutex 'sls_mu' is here}} *pgb_var = 1; sls_mu.Unlock(); } // FIXME: Add support for functions (not only methods) class LRBar { public: void aa_elr_fun() __attribute__((exclusive_locks_required(aa_mu))); void aa_elr_fun_s() __attribute__((shared_locks_required(aa_mu))); void le_fun() __attribute__((locks_excluded(sls_mu))); }; class LRFoo { public: void test() __attribute__((exclusive_locks_required(sls_mu))); void testShared() __attribute__((shared_locks_required(sls_mu2))); }; void elr_fun() __attribute__((exclusive_locks_required(sls_mu))); void elr_fun() {} LRFoo MyLRFoo; LRBar Bar; void es_fun_0() { aa_mu.Lock(); Bar.aa_elr_fun(); aa_mu.Unlock(); } void es_fun_1() { aa_mu.Lock(); Bar.aa_elr_fun_s(); aa_mu.Unlock(); } void es_fun_2() { aa_mu.ReaderLock(); Bar.aa_elr_fun_s(); aa_mu.Unlock(); } void es_fun_3() { sls_mu.Lock(); MyLRFoo.test(); sls_mu.Unlock(); } void es_fun_4() { sls_mu2.Lock(); MyLRFoo.testShared(); sls_mu2.Unlock(); } void es_fun_5() { sls_mu2.ReaderLock(); MyLRFoo.testShared(); sls_mu2.Unlock(); } void es_fun_6() { Bar.le_fun(); } void es_fun_7() { sls_mu.Lock(); elr_fun(); sls_mu.Unlock(); } void es_fun_8() __attribute__((no_thread_safety_analysis)); void es_fun_8() { Bar.aa_elr_fun_s(); } void es_fun_9() __attribute__((shared_locks_required(aa_mu))); void es_fun_9() { Bar.aa_elr_fun_s(); } void es_fun_10() __attribute__((exclusive_locks_required(aa_mu))); void es_fun_10() { Bar.aa_elr_fun_s(); } void es_bad_0() { Bar.aa_elr_fun(); // \ // expected-warning {{calling function 'aa_elr_fun' requires exclusive lock on 'aa_mu'}} } void es_bad_1() { aa_mu.ReaderLock(); Bar.aa_elr_fun(); // \ // expected-warning {{calling function 'aa_elr_fun' requires exclusive lock on 'aa_mu'}} aa_mu.Unlock(); } void es_bad_2() { Bar.aa_elr_fun_s(); // \ // expected-warning {{calling function 'aa_elr_fun_s' requires shared lock on 'aa_mu'}} } void es_bad_3() { MyLRFoo.test(); // \ // expected-warning {{calling function 'test' requires exclusive lock on 'sls_mu'}} } void es_bad_4() { MyLRFoo.testShared(); // \ // expected-warning {{calling function 'testShared' requires shared lock on 'sls_mu2'}} } void es_bad_5() { sls_mu.ReaderLock(); MyLRFoo.test(); // \ // expected-warning {{calling function 'test' requires exclusive lock on 'sls_mu'}} sls_mu.Unlock(); } void es_bad_6() { sls_mu.Lock(); Bar.le_fun(); // \ // expected-warning {{cannot call function 'le_fun' while mutex 'sls_mu' is locked}} sls_mu.Unlock(); } void es_bad_7() { sls_mu.ReaderLock(); Bar.le_fun(); // \ // expected-warning {{cannot call function 'le_fun' while mutex 'sls_mu' is locked}} sls_mu.Unlock(); } //-----------------------------------------------// // Unparseable lock expressions // ----------------------------------------------// // FIXME -- derive new tests for unhandled expressions //----------------------------------------------------------------------------// // The following test cases are ported from the gcc thread safety implementation // They are each wrapped inside a namespace with the test number of the gcc test // // FIXME: add all the gcc tests, once this analysis passes them. //----------------------------------------------------------------------------// //-----------------------------------------// // Good testcases (no errors) //-----------------------------------------// namespace thread_annot_lock_20 { class Bar { public: static int func1() EXCLUSIVE_LOCKS_REQUIRED(mu1_); static int b_ GUARDED_BY(mu1_); static Mutex mu1_; static int a_ GUARDED_BY(mu1_); }; Bar b1; int Bar::func1() { int res = 5; if (a_ == 4) res = b_; return res; } } // end namespace thread_annot_lock_20 namespace thread_annot_lock_22 { // Test various usage of GUARDED_BY and PT_GUARDED_BY annotations, especially // uses in class definitions. Mutex mu; class Bar { public: int a_ GUARDED_BY(mu1_); int b_; int *q PT_GUARDED_BY(mu); Mutex mu1_ ACQUIRED_AFTER(mu); }; Bar b1, *b3; int *p GUARDED_BY(mu) PT_GUARDED_BY(mu); int res GUARDED_BY(mu) = 5; int func(int i) { int x; mu.Lock(); b1.mu1_.Lock(); res = b1.a_ + b3->b_; *p = i; b1.a_ = res + b3->b_; b3->b_ = *b1.q; b1.mu1_.Unlock(); b1.b_ = res; x = res; mu.Unlock(); return x; } } // end namespace thread_annot_lock_22 namespace thread_annot_lock_27_modified { // test lock annotations applied to function definitions // Modified: applied annotations only to function declarations Mutex mu1; Mutex mu2 ACQUIRED_AFTER(mu1); class Foo { public: int method1(int i) SHARED_LOCKS_REQUIRED(mu2) EXCLUSIVE_LOCKS_REQUIRED(mu1); }; int Foo::method1(int i) { return i; } int foo(int i) EXCLUSIVE_LOCKS_REQUIRED(mu2) SHARED_LOCKS_REQUIRED(mu1); int foo(int i) { return i; } static int bar(int i) EXCLUSIVE_LOCKS_REQUIRED(mu1); static int bar(int i) { return i; } void main() { Foo a; mu1.Lock(); mu2.Lock(); a.method1(1); foo(2); mu2.Unlock(); bar(3); mu1.Unlock(); } } // end namespace thread_annot_lock_27_modified namespace thread_annot_lock_38 { // Test the case where a template member function is annotated with lock // attributes in a non-template class. class Foo { public: void func1(int y) LOCKS_EXCLUDED(mu_); template void func2(T x) LOCKS_EXCLUDED(mu_); private: Mutex mu_; }; Foo *foo; void main() { foo->func1(5); foo->func2(5); } } // end namespace thread_annot_lock_38 namespace thread_annot_lock_43 { // Tests lock canonicalization class Foo { public: Mutex *mu_; }; class FooBar { public: Foo *foo_; int GetA() EXCLUSIVE_LOCKS_REQUIRED(foo_->mu_) { return a_; } int a_ GUARDED_BY(foo_->mu_); }; FooBar *fb; void main() { int x; fb->foo_->mu_->Lock(); x = fb->GetA(); fb->foo_->mu_->Unlock(); } } // end namespace thread_annot_lock_43 namespace thread_annot_lock_49 { // Test the support for use of lock expression in the annotations class Foo { public: Mutex foo_mu_; }; class Bar { private: Foo *foo; Mutex bar_mu_ ACQUIRED_AFTER(foo->foo_mu_); public: void Test1() { foo->foo_mu_.Lock(); bar_mu_.Lock(); bar_mu_.Unlock(); foo->foo_mu_.Unlock(); } }; void main() { Bar bar; bar.Test1(); } } // end namespace thread_annot_lock_49 namespace thread_annot_lock_61_modified { // Modified to fix the compiler errors // Test the fix for a bug introduced by the support of pass-by-reference // paramters. struct Foo { Foo &operator<< (bool) {return *this;} }; Foo &getFoo(); struct Bar { Foo &func () {return getFoo();} }; struct Bas { void operator& (Foo &) {} }; void mumble() { Bas() & Bar().func() << "" << ""; Bas() & Bar().func() << ""; } } // end namespace thread_annot_lock_61_modified namespace thread_annot_lock_65 { // Test the fix for a bug in the support of allowing reader locks for // non-const, non-modifying overload functions. (We didn't handle the builtin // properly.) enum MyFlags { Zero, One, Two, Three, Four, Five, Six, Seven, Eight, Nine }; inline MyFlags operator|(MyFlags a, MyFlags b) { return MyFlags(static_cast(a) | static_cast(b)); } inline MyFlags& operator|=(MyFlags& a, MyFlags b) { return a = a | b; } } // end namespace thread_annot_lock_65 namespace thread_annot_lock_66_modified { // Modified: Moved annotation to function defn // Test annotations on out-of-line definitions of member functions where the // annotations refer to locks that are also data members in the class. Mutex mu; class Foo { public: int method1(int i) SHARED_LOCKS_REQUIRED(mu1, mu, mu2); int data GUARDED_BY(mu1); Mutex *mu1; Mutex *mu2; }; int Foo::method1(int i) { return data + i; } void main() { Foo a; a.mu2->Lock(); a.mu1->Lock(); mu.Lock(); a.method1(1); mu.Unlock(); a.mu1->Unlock(); a.mu2->Unlock(); } } // end namespace thread_annot_lock_66_modified namespace thread_annot_lock_68_modified { // Test a fix to a bug in the delayed name binding with nested template // instantiation. We use a stack to make sure a name is not resolved to an // inner context. template class Bar { Mutex mu_; }; template class Foo { public: void func(T x) { mu_.Lock(); count_ = x; mu_.Unlock(); } private: T count_ GUARDED_BY(mu_); Bar bar_; Mutex mu_; }; void main() { Foo *foo; foo->func(5); } } // end namespace thread_annot_lock_68_modified namespace thread_annot_lock_30_modified { // Test delay parsing of lock attribute arguments with nested classes. // Modified: trylocks replaced with exclusive_lock_fun int a = 0; class Bar { struct Foo; public: void MyLock() EXCLUSIVE_LOCK_FUNCTION(mu); int func() { MyLock(); // if (foo == 0) { // return 0; // } a = 5; mu.Unlock(); return 1; } class FooBar { int x; int y; }; private: Mutex mu; }; Bar *bar; void main() { bar->func(); } } // end namespace thread_annot_lock_30_modified namespace thread_annot_lock_47 { // Test the support for annotations on virtual functions. // This is a good test case. (i.e. There should be no warning emitted by the // compiler.) class Base { public: virtual void func1() EXCLUSIVE_LOCKS_REQUIRED(mu_); virtual void func2() LOCKS_EXCLUDED(mu_); Mutex mu_; }; class Child : public Base { public: virtual void func1() EXCLUSIVE_LOCKS_REQUIRED(mu_); virtual void func2() LOCKS_EXCLUDED(mu_); }; void main() { Child *c; Base *b = c; b->mu_.Lock(); b->func1(); b->mu_.Unlock(); b->func2(); c->mu_.Lock(); c->func1(); c->mu_.Unlock(); c->func2(); } } // end namespace thread_annot_lock_47 //-----------------------------------------// // Tests which produce errors //-----------------------------------------// namespace thread_annot_lock_13 { Mutex mu1; Mutex mu2; int g GUARDED_BY(mu1); int w GUARDED_BY(mu2); class Foo { public: void bar() LOCKS_EXCLUDED(mu_, mu1); int foo() SHARED_LOCKS_REQUIRED(mu_) EXCLUSIVE_LOCKS_REQUIRED(mu2); private: int a_ GUARDED_BY(mu_); public: Mutex mu_ ACQUIRED_AFTER(mu1); }; int Foo::foo() { int res; w = 5; res = a_ + 5; return res; } void Foo::bar() { int x; mu_.Lock(); x = foo(); // expected-warning {{calling function 'foo' requires exclusive lock on 'mu2'}} a_ = x + 1; mu_.Unlock(); if (x > 5) { mu1.Lock(); g = 2; mu1.Unlock(); } } void main() { Foo f1, *f2; f1.mu_.Lock(); f1.bar(); // expected-warning {{cannot call function 'bar' while mutex 'f1.mu_' is locked}} mu2.Lock(); f1.foo(); mu2.Unlock(); f1.mu_.Unlock(); f2->mu_.Lock(); f2->bar(); // expected-warning {{cannot call function 'bar' while mutex 'f2->mu_' is locked}} f2->mu_.Unlock(); mu2.Lock(); w = 2; mu2.Unlock(); } } // end namespace thread_annot_lock_13 namespace thread_annot_lock_18_modified { // Modified: Trylocks removed // Test the ability to distnguish between the same lock field of // different objects of a class. class Bar { public: bool MyLock() EXCLUSIVE_LOCK_FUNCTION(mu1_); void MyUnlock() UNLOCK_FUNCTION(mu1_); int a_ GUARDED_BY(mu1_); private: Mutex mu1_; }; Bar *b1, *b2; void func() { b1->MyLock(); b1->a_ = 5; b2->a_ = 3; // \ // expected-warning {{writing variable 'a_' requires locking 'b2->mu1_' exclusively}} \ // expected-note {{found near match 'b1->mu1_'}} b2->MyLock(); b2->MyUnlock(); b1->MyUnlock(); } } // end namespace thread_annot_lock_18_modified namespace thread_annot_lock_21 { // Test various usage of GUARDED_BY and PT_GUARDED_BY annotations, especially // uses in class definitions. Mutex mu; class Bar { public: int a_ GUARDED_BY(mu1_); int b_; int *q PT_GUARDED_BY(mu); Mutex mu1_ ACQUIRED_AFTER(mu); }; Bar b1, *b3; int *p GUARDED_BY(mu) PT_GUARDED_BY(mu); int res GUARDED_BY(mu) = 5; int func(int i) { int x; b3->mu1_.Lock(); res = b1.a_ + b3->b_; // expected-warning {{reading variable 'a_' requires locking 'b1.mu1_'}} \ // expected-warning {{writing variable 'res' requires locking 'mu' exclusively}} \ // expected-note {{found near match 'b3->mu1_'}} *p = i; // expected-warning {{reading variable 'p' requires locking 'mu'}} \ // expected-warning {{writing the value pointed to by 'p' requires locking 'mu' exclusively}} b1.a_ = res + b3->b_; // expected-warning {{reading variable 'res' requires locking 'mu'}} \ // expected-warning {{writing variable 'a_' requires locking 'b1.mu1_' exclusively}} \ // expected-note {{found near match 'b3->mu1_'}} b3->b_ = *b1.q; // expected-warning {{reading the value pointed to by 'q' requires locking 'mu'}} b3->mu1_.Unlock(); b1.b_ = res; // expected-warning {{reading variable 'res' requires locking 'mu'}} x = res; // expected-warning {{reading variable 'res' requires locking 'mu'}} return x; } } // end namespace thread_annot_lock_21 namespace thread_annot_lock_35_modified { // Test the analyzer's ability to distinguish the lock field of different // objects. class Foo { private: Mutex lock_; int a_ GUARDED_BY(lock_); public: void Func(Foo* child) LOCKS_EXCLUDED(lock_) { Foo *new_foo = new Foo; lock_.Lock(); child->Func(new_foo); // There shouldn't be any warning here as the // acquired lock is not in child. child->bar(7); // \ // expected-warning {{calling function 'bar' requires exclusive lock on 'child->lock_'}} \ // expected-note {{found near match 'lock_'}} child->a_ = 5; // \ // expected-warning {{writing variable 'a_' requires locking 'child->lock_' exclusively}} \ // expected-note {{found near match 'lock_'}} lock_.Unlock(); } void bar(int y) EXCLUSIVE_LOCKS_REQUIRED(lock_) { a_ = y; } }; Foo *x; void main() { Foo *child = new Foo; x->Func(child); } } // end namespace thread_annot_lock_35_modified namespace thread_annot_lock_36_modified { // Modified to move the annotations to function defns. // Test the analyzer's ability to distinguish the lock field of different // objects class Foo { private: Mutex lock_; int a_ GUARDED_BY(lock_); public: void Func(Foo* child) LOCKS_EXCLUDED(lock_); void bar(int y) EXCLUSIVE_LOCKS_REQUIRED(lock_); }; void Foo::Func(Foo* child) { Foo *new_foo = new Foo; lock_.Lock(); child->lock_.Lock(); child->Func(new_foo); // expected-warning {{cannot call function 'Func' while mutex 'child->lock_' is locked}} child->bar(7); child->a_ = 5; child->lock_.Unlock(); lock_.Unlock(); } void Foo::bar(int y) { a_ = y; } Foo *x; void main() { Foo *child = new Foo; x->Func(child); } } // end namespace thread_annot_lock_36_modified namespace thread_annot_lock_42 { // Test support of multiple lock attributes of the same kind on a decl. class Foo { private: Mutex mu1, mu2, mu3; int x GUARDED_BY(mu1) GUARDED_BY(mu2); int y GUARDED_BY(mu2); void f2() LOCKS_EXCLUDED(mu1) LOCKS_EXCLUDED(mu2) LOCKS_EXCLUDED(mu3) { mu2.Lock(); y = 2; mu2.Unlock(); } public: void f1() EXCLUSIVE_LOCKS_REQUIRED(mu2) EXCLUSIVE_LOCKS_REQUIRED(mu1) { x = 5; f2(); // expected-warning {{cannot call function 'f2' while mutex 'mu1' is locked}} \ // expected-warning {{cannot call function 'f2' while mutex 'mu2' is locked}} } }; Foo *foo; void func() { foo->f1(); // expected-warning {{calling function 'f1' requires exclusive lock on 'foo->mu2'}} \ // expected-warning {{calling function 'f1' requires exclusive lock on 'foo->mu1'}} } } // end namespace thread_annot_lock_42 namespace thread_annot_lock_46 { // Test the support for annotations on virtual functions. class Base { public: virtual void func1() EXCLUSIVE_LOCKS_REQUIRED(mu_); virtual void func2() LOCKS_EXCLUDED(mu_); Mutex mu_; }; class Child : public Base { public: virtual void func1() EXCLUSIVE_LOCKS_REQUIRED(mu_); virtual void func2() LOCKS_EXCLUDED(mu_); }; void main() { Child *c; Base *b = c; b->func1(); // expected-warning {{calling function 'func1' requires exclusive lock on 'b->mu_'}} b->mu_.Lock(); b->func2(); // expected-warning {{cannot call function 'func2' while mutex 'b->mu_' is locked}} b->mu_.Unlock(); c->func1(); // expected-warning {{calling function 'func1' requires exclusive lock on 'c->mu_'}} c->mu_.Lock(); c->func2(); // expected-warning {{cannot call function 'func2' while mutex 'c->mu_' is locked}} c->mu_.Unlock(); } } // end namespace thread_annot_lock_46 namespace thread_annot_lock_67_modified { // Modified: attributes on definitions moved to declarations // Test annotations on out-of-line definitions of member functions where the // annotations refer to locks that are also data members in the class. Mutex mu; Mutex mu3; class Foo { public: int method1(int i) SHARED_LOCKS_REQUIRED(mu1, mu, mu2, mu3); int data GUARDED_BY(mu1); Mutex *mu1; Mutex *mu2; }; int Foo::method1(int i) { return data + i; } void main() { Foo a; a.method1(1); // expected-warning {{calling function 'method1' requires shared lock on 'a.mu1'}} \ // expected-warning {{calling function 'method1' requires shared lock on 'mu'}} \ // expected-warning {{calling function 'method1' requires shared lock on 'a.mu2'}} \ // expected-warning {{calling function 'method1' requires shared lock on 'mu3'}} } } // end namespace thread_annot_lock_67_modified namespace substitution_test { class MyData { public: Mutex mu; void lockData() __attribute__((exclusive_lock_function(mu))); void unlockData() __attribute__((unlock_function(mu))); void doSomething() __attribute__((exclusive_locks_required(mu))) { } }; class DataLocker { public: void lockData (MyData *d) __attribute__((exclusive_lock_function(d->mu))); void unlockData(MyData *d) __attribute__((unlock_function(d->mu))); }; class Foo { public: void foo(MyData* d) __attribute__((exclusive_locks_required(d->mu))) { } void bar1(MyData* d) { d->lockData(); foo(d); d->unlockData(); } void bar2(MyData* d) { DataLocker dlr; dlr.lockData(d); foo(d); dlr.unlockData(d); } void bar3(MyData* d1, MyData* d2) { DataLocker dlr; dlr.lockData(d1); // expected-note {{mutex acquired here}} dlr.unlockData(d2); // \ // expected-warning {{unlocking 'd2->mu' that was not locked}} } // expected-warning {{mutex 'd1->mu' is still locked at the end of function}} void bar4(MyData* d1, MyData* d2) { DataLocker dlr; dlr.lockData(d1); foo(d2); // \ // expected-warning {{calling function 'foo' requires exclusive lock on 'd2->mu'}} \ // expected-note {{found near match 'd1->mu'}} dlr.unlockData(d1); } }; } // end namespace substituation_test namespace constructor_destructor_tests { Mutex fooMu; int myVar GUARDED_BY(fooMu); class Foo { public: Foo() __attribute__((exclusive_lock_function(fooMu))) { } ~Foo() __attribute__((unlock_function(fooMu))) { } }; void fooTest() { Foo foo; myVar = 0; } } namespace template_member_test { struct S { int n; }; struct T { Mutex m; S *s GUARDED_BY(this->m); }; Mutex m; struct U { union { int n; }; } *u GUARDED_BY(m); template struct IndirectLock { int DoNaughtyThings(T *t) { u->n = 0; // expected-warning {{reading variable 'u' requires locking 'm'}} return t->s->n; // expected-warning {{reading variable 's' requires locking 't->m'}} } }; template struct IndirectLock; // expected-note {{here}} struct V { void f(int); void f(double); Mutex m; V *p GUARDED_BY(this->m); }; template struct W { V v; void f(U u) { v.p->f(u); // expected-warning {{reading variable 'p' requires locking 'v.m'}} } }; template struct W; // expected-note {{here}} } namespace test_scoped_lockable { struct TestScopedLockable { Mutex mu1; Mutex mu2; int a __attribute__((guarded_by(mu1))); int b __attribute__((guarded_by(mu2))); bool getBool(); void foo1() { MutexLock mulock(&mu1); a = 5; } void foo2() { ReaderMutexLock mulock1(&mu1); if (getBool()) { MutexLock mulock2a(&mu2); b = a + 1; } else { MutexLock mulock2b(&mu2); b = a + 2; } } void foo3() { MutexLock mulock_a(&mu1); MutexLock mulock_b(&mu1); // \ // expected-warning {{locking 'mu1' that is already locked}} } void foo4() { MutexLock mulock1(&mu1), mulock2(&mu2); a = b+1; b = a+1; } }; } // end namespace test_scoped_lockable namespace FunctionAttrTest { class Foo { public: Mutex mu_; int a GUARDED_BY(mu_); }; Foo fooObj; void foo() EXCLUSIVE_LOCKS_REQUIRED(fooObj.mu_); void bar() { foo(); // expected-warning {{calling function 'foo' requires exclusive lock on 'fooObj.mu_'}} fooObj.mu_.Lock(); foo(); fooObj.mu_.Unlock(); } }; // end namespace FunctionAttrTest namespace TryLockTest { struct TestTryLock { Mutex mu; int a GUARDED_BY(mu); bool cond; void foo1() { if (mu.TryLock()) { a = 1; mu.Unlock(); } } void foo2() { if (!mu.TryLock()) return; a = 2; mu.Unlock(); } void foo3() { bool b = mu.TryLock(); if (b) { a = 3; mu.Unlock(); } } void foo4() { bool b = mu.TryLock(); if (!b) return; a = 4; mu.Unlock(); } void foo5() { while (mu.TryLock()) { a = a + 1; mu.Unlock(); } } void foo6() { bool b = mu.TryLock(); b = !b; if (b) return; a = 6; mu.Unlock(); } void foo7() { bool b1 = mu.TryLock(); bool b2 = !b1; bool b3 = !b2; if (b3) { a = 7; mu.Unlock(); } } // Test use-def chains: join points void foo8() { bool b = mu.TryLock(); bool b2 = b; if (cond) b = true; if (b) { // b should be unknown at this point, because of the join point a = 8; // expected-warning {{writing variable 'a' requires locking 'mu' exclusively}} } if (b2) { // b2 should be known at this point. a = 8; mu.Unlock(); } } // Test use-def-chains: back edges void foo9() { bool b = mu.TryLock(); for (int i = 0; i < 10; ++i); if (b) { // b is still known, because the loop doesn't alter it a = 9; mu.Unlock(); } } // Test use-def chains: back edges void foo10() { bool b = mu.TryLock(); while (cond) { if (b) { // b should be uknown at this point b/c of the loop a = 10; // expected-warning {{writing variable 'a' requires locking 'mu' exclusively}} } b = !b; } } // Test merge of exclusive trylock void foo11() { if (cond) { if (!mu.TryLock()) return; } else { mu.Lock(); } a = 10; mu.Unlock(); } // Test merge of shared trylock void foo12() { if (cond) { if (!mu.ReaderTryLock()) return; } else { mu.ReaderLock(); } int i = a; mu.Unlock(); } }; // end TestTrylock } // end namespace TrylockTest namespace TestTemplateAttributeInstantiation { class Foo1 { public: Mutex mu_; int a GUARDED_BY(mu_); }; class Foo2 { public: int a GUARDED_BY(mu_); Mutex mu_; }; class Bar { public: // Test non-dependent expressions in attributes on template functions template void barND(Foo1 *foo, T *fooT) EXCLUSIVE_LOCKS_REQUIRED(foo->mu_) { foo->a = 0; } // Test dependent expressions in attributes on template functions template void barD(Foo1 *foo, T *fooT) EXCLUSIVE_LOCKS_REQUIRED(fooT->mu_) { fooT->a = 0; } }; template class BarT { public: Foo1 fooBase; T fooBaseT; // Test non-dependent expression in ordinary method on template class void barND() EXCLUSIVE_LOCKS_REQUIRED(fooBase.mu_) { fooBase.a = 0; } // Test dependent expressions in ordinary methods on template class void barD() EXCLUSIVE_LOCKS_REQUIRED(fooBaseT.mu_) { fooBaseT.a = 0; } // Test dependent expressions in template method in template class template void barTD(T2 *fooT) EXCLUSIVE_LOCKS_REQUIRED(fooBaseT.mu_, fooT->mu_) { fooBaseT.a = 0; fooT->a = 0; } }; template class Cell { public: Mutex mu_; // Test dependent guarded_by T data GUARDED_BY(mu_); void fooEx() EXCLUSIVE_LOCKS_REQUIRED(mu_) { data = 0; } void foo() { mu_.Lock(); data = 0; mu_.Unlock(); } }; void test() { Bar b; BarT bt; Foo1 f1; Foo2 f2; f1.mu_.Lock(); f2.mu_.Lock(); bt.fooBase.mu_.Lock(); bt.fooBaseT.mu_.Lock(); b.barND(&f1, &f2); b.barD(&f1, &f2); bt.barND(); bt.barD(); bt.barTD(&f2); f1.mu_.Unlock(); bt.barTD(&f1); // \ // expected-warning {{calling function 'barTD' requires exclusive lock on 'f1.mu_'}} \ // expected-note {{found near match 'bt.fooBase.mu_'}} bt.fooBase.mu_.Unlock(); bt.fooBaseT.mu_.Unlock(); f2.mu_.Unlock(); Cell cell; cell.data = 0; // \ // expected-warning {{writing variable 'data' requires locking 'cell.mu_' exclusively}} cell.foo(); cell.mu_.Lock(); cell.fooEx(); cell.mu_.Unlock(); } template class CellDelayed { public: // Test dependent guarded_by T data GUARDED_BY(mu_); static T static_data GUARDED_BY(static_mu_); void fooEx(CellDelayed *other) EXCLUSIVE_LOCKS_REQUIRED(mu_, other->mu_) { this->data = other->data; } template void fooExT(CellDelayed *otherT) EXCLUSIVE_LOCKS_REQUIRED(mu_, otherT->mu_) { this->data = otherT->data; } void foo() { mu_.Lock(); data = 0; mu_.Unlock(); } Mutex mu_; static Mutex static_mu_; }; void testDelayed() { CellDelayed celld; CellDelayed celld2; celld.foo(); celld.mu_.Lock(); celld2.mu_.Lock(); celld.fooEx(&celld2); celld.fooExT(&celld2); celld2.mu_.Unlock(); celld.mu_.Unlock(); } }; // end namespace TestTemplateAttributeInstantiation namespace FunctionDeclDefTest { class Foo { public: Mutex mu_; int a GUARDED_BY(mu_); virtual void foo1(Foo *f_declared) EXCLUSIVE_LOCKS_REQUIRED(f_declared->mu_); }; // EXCLUSIVE_LOCKS_REQUIRED should be applied, and rewritten to f_defined->mu_ void Foo::foo1(Foo *f_defined) { f_defined->a = 0; }; void test() { Foo myfoo; myfoo.foo1(&myfoo); // \ // expected-warning {{calling function 'foo1' requires exclusive lock on 'myfoo.mu_'}} myfoo.mu_.Lock(); myfoo.foo1(&myfoo); myfoo.mu_.Unlock(); } }; namespace GoingNative { struct __attribute__((lockable)) mutex { void lock() __attribute__((exclusive_lock_function)); void unlock() __attribute__((unlock_function)); // ... }; bool foo(); bool bar(); mutex m; void test() { m.lock(); while (foo()) { m.unlock(); // ... if (bar()) { // ... if (foo()) continue; // expected-warning {{expecting mutex 'm' to be locked at start of each loop}} //... } // ... m.lock(); // expected-note {{mutex acquired here}} } m.unlock(); } } namespace FunctionDefinitionTest { class Foo { public: void foo1(); void foo2(); void foo3(Foo *other); template void fooT1(const T& dummy1); template void fooT2(const T& dummy2) EXCLUSIVE_LOCKS_REQUIRED(mu_); Mutex mu_; int a GUARDED_BY(mu_); }; template class FooT { public: void foo(); Mutex mu_; T a GUARDED_BY(mu_); }; void Foo::foo1() NO_THREAD_SAFETY_ANALYSIS { a = 1; } void Foo::foo2() EXCLUSIVE_LOCKS_REQUIRED(mu_) { a = 2; } void Foo::foo3(Foo *other) EXCLUSIVE_LOCKS_REQUIRED(other->mu_) { other->a = 3; } template void Foo::fooT1(const T& dummy1) EXCLUSIVE_LOCKS_REQUIRED(mu_) { a = dummy1; } /* TODO -- uncomment with template instantiation of attributes. template void Foo::fooT2(const T& dummy2) { a = dummy2; } */ void fooF1(Foo *f) EXCLUSIVE_LOCKS_REQUIRED(f->mu_) { f->a = 1; } void fooF2(Foo *f); void fooF2(Foo *f) EXCLUSIVE_LOCKS_REQUIRED(f->mu_) { f->a = 2; } void fooF3(Foo *f) EXCLUSIVE_LOCKS_REQUIRED(f->mu_); void fooF3(Foo *f) { f->a = 3; } template void FooT::foo() EXCLUSIVE_LOCKS_REQUIRED(mu_) { a = 0; } void test() { int dummy = 0; Foo myFoo; myFoo.foo2(); // \ // expected-warning {{calling function 'foo2' requires exclusive lock on 'myFoo.mu_'}} myFoo.foo3(&myFoo); // \ // expected-warning {{calling function 'foo3' requires exclusive lock on 'myFoo.mu_'}} myFoo.fooT1(dummy); // \ // expected-warning {{calling function 'fooT1' requires exclusive lock on 'myFoo.mu_'}} myFoo.fooT2(dummy); // \ // expected-warning {{calling function 'fooT2' requires exclusive lock on 'myFoo.mu_'}} fooF1(&myFoo); // \ // expected-warning {{calling function 'fooF1' requires exclusive lock on 'myFoo.mu_'}} fooF2(&myFoo); // \ // expected-warning {{calling function 'fooF2' requires exclusive lock on 'myFoo.mu_'}} fooF3(&myFoo); // \ // expected-warning {{calling function 'fooF3' requires exclusive lock on 'myFoo.mu_'}} myFoo.mu_.Lock(); myFoo.foo2(); myFoo.foo3(&myFoo); myFoo.fooT1(dummy); myFoo.fooT2(dummy); fooF1(&myFoo); fooF2(&myFoo); fooF3(&myFoo); myFoo.mu_.Unlock(); FooT myFooT; myFooT.foo(); // \ // expected-warning {{calling function 'foo' requires exclusive lock on 'myFooT.mu_'}} } } // end namespace FunctionDefinitionTest namespace SelfLockingTest { class LOCKABLE MyLock { public: int foo GUARDED_BY(this); void lock() EXCLUSIVE_LOCK_FUNCTION(); void unlock() UNLOCK_FUNCTION(); void doSomething() { this->lock(); // allow 'this' as a lock expression foo = 0; doSomethingElse(); this->unlock(); } void doSomethingElse() EXCLUSIVE_LOCKS_REQUIRED(this) { foo = 1; }; void test() { foo = 2; // \ // expected-warning {{writing variable 'foo' requires locking 'this' exclusively}} } }; class LOCKABLE MyLock2 { public: Mutex mu_; int foo GUARDED_BY(this); // don't check inside lock and unlock functions void lock() EXCLUSIVE_LOCK_FUNCTION() { mu_.Lock(); } void unlock() UNLOCK_FUNCTION() { mu_.Unlock(); } // don't check inside constructors and destructors MyLock2() { foo = 1; } ~MyLock2() { foo = 0; } }; } // end namespace SelfLockingTest namespace InvalidNonstatic { // Forward decl here causes bogus "invalid use of non-static data member" // on reference to mutex_ in guarded_by attribute. class Foo; class Foo { Mutex* mutex_; int foo __attribute__((guarded_by(mutex_))); }; } // end namespace InvalidNonStatic namespace NoReturnTest { bool condition(); void fatal() __attribute__((noreturn)); Mutex mu_; void test1() { MutexLock lock(&mu_); if (condition()) { fatal(); return; } } } // end namespace NoReturnTest namespace TestMultiDecl { class Foo { public: int GUARDED_BY(mu_) a; int GUARDED_BY(mu_) b, c; void foo() { a = 0; // \ // expected-warning {{writing variable 'a' requires locking 'mu_' exclusively}} b = 0; // \ // expected-warning {{writing variable 'b' requires locking 'mu_' exclusively}} c = 0; // \ // expected-warning {{writing variable 'c' requires locking 'mu_' exclusively}} } private: Mutex mu_; }; } // end namespace TestMultiDecl namespace WarnNoDecl { class Foo { void foo(int a); __attribute__(( // \ // expected-warning {{declaration does not declare anything}} exclusive_locks_required(a))); // \ // expected-warning {{attribute exclusive_locks_required ignored}} }; } // end namespace WarnNoDecl namespace MoreLockExpressions { class Foo { public: Mutex mu_; int a GUARDED_BY(mu_); }; class Bar { public: int b; Foo* f; Foo& getFoo() { return *f; } Foo& getFoo2(int c) { return *f; } Foo& getFoo3(int c, int d) { return *f; } Foo& getFooey() { return *f; } }; Foo& getBarFoo(Bar &bar, int c) { return bar.getFoo2(c); } void test() { Foo foo; Foo *fooArray; Bar bar; int a; int b; int c; bar.getFoo().mu_.Lock(); bar.getFoo().a = 0; bar.getFoo().mu_.Unlock(); (bar.getFoo().mu_).Lock(); // test parenthesis bar.getFoo().a = 0; (bar.getFoo().mu_).Unlock(); bar.getFoo2(a).mu_.Lock(); bar.getFoo2(a).a = 0; bar.getFoo2(a).mu_.Unlock(); bar.getFoo3(a, b).mu_.Lock(); bar.getFoo3(a, b).a = 0; bar.getFoo3(a, b).mu_.Unlock(); getBarFoo(bar, a).mu_.Lock(); getBarFoo(bar, a).a = 0; getBarFoo(bar, a).mu_.Unlock(); bar.getFoo2(10).mu_.Lock(); bar.getFoo2(10).a = 0; bar.getFoo2(10).mu_.Unlock(); bar.getFoo2(a + 1).mu_.Lock(); bar.getFoo2(a + 1).a = 0; bar.getFoo2(a + 1).mu_.Unlock(); (a > 0 ? fooArray[1] : fooArray[b]).mu_.Lock(); (a > 0 ? fooArray[1] : fooArray[b]).a = 0; (a > 0 ? fooArray[1] : fooArray[b]).mu_.Unlock(); bar.getFoo().mu_.Lock(); bar.getFooey().a = 0; // \ // expected-warning {{writing variable 'a' requires locking 'bar.getFooey().mu_' exclusively}} \ // expected-note {{found near match 'bar.getFoo().mu_'}} bar.getFoo().mu_.Unlock(); bar.getFoo2(a).mu_.Lock(); bar.getFoo2(b).a = 0; // \ // expected-warning {{writing variable 'a' requires locking 'bar.getFoo2(b).mu_' exclusively}} \ // expected-note {{found near match 'bar.getFoo2(a).mu_'}} bar.getFoo2(a).mu_.Unlock(); bar.getFoo3(a, b).mu_.Lock(); bar.getFoo3(a, c).a = 0; // \ // expected-warning {{writing variable 'a' requires locking 'bar.getFoo3(a,c).mu_' exclusively}} \ // expected-note {{'bar.getFoo3(a,b).mu_'}} bar.getFoo3(a, b).mu_.Unlock(); getBarFoo(bar, a).mu_.Lock(); getBarFoo(bar, b).a = 0; // \ // expected-warning {{writing variable 'a' requires locking 'getBarFoo(bar,b).mu_' exclusively}} \ // expected-note {{'getBarFoo(bar,a).mu_'}} getBarFoo(bar, a).mu_.Unlock(); (a > 0 ? fooArray[1] : fooArray[b]).mu_.Lock(); (a > 0 ? fooArray[b] : fooArray[c]).a = 0; // \ // expected-warning {{writing variable 'a' requires locking '((a#_)#_#fooArray[b]).mu_' exclusively}} \ // expected-note {{'((a#_)#_#fooArray[_]).mu_'}} (a > 0 ? fooArray[1] : fooArray[b]).mu_.Unlock(); } } // end namespace MoreLockExpressions namespace TrylockJoinPoint { class Foo { Mutex mu; bool c; void foo() { if (c) { if (!mu.TryLock()) return; } else { mu.Lock(); } mu.Unlock(); } }; } // end namespace TrylockJoinPoint namespace LockReturned { class Foo { public: int a GUARDED_BY(mu_); void foo() EXCLUSIVE_LOCKS_REQUIRED(mu_); void foo2(Foo* f) EXCLUSIVE_LOCKS_REQUIRED(mu_, f->mu_); static void sfoo(Foo* f) EXCLUSIVE_LOCKS_REQUIRED(f->mu_); Mutex* getMu() LOCK_RETURNED(mu_); Mutex mu_; static Mutex* getMu(Foo* f) LOCK_RETURNED(f->mu_); }; // Calls getMu() directly to lock and unlock void test1(Foo* f1, Foo* f2) { f1->a = 0; // expected-warning {{writing variable 'a' requires locking 'f1->mu_' exclusively}} f1->foo(); // expected-warning {{calling function 'foo' requires exclusive lock on 'f1->mu_'}} f1->foo2(f2); // expected-warning {{calling function 'foo2' requires exclusive lock on 'f1->mu_'}} \ // expected-warning {{calling function 'foo2' requires exclusive lock on 'f2->mu_'}} Foo::sfoo(f1); // expected-warning {{calling function 'sfoo' requires exclusive lock on 'f1->mu_'}} f1->getMu()->Lock(); f1->a = 0; f1->foo(); f1->foo2(f2); // \ // expected-warning {{calling function 'foo2' requires exclusive lock on 'f2->mu_'}} \ // expected-note {{found near match 'f1->mu_'}} Foo::getMu(f2)->Lock(); f1->foo2(f2); Foo::getMu(f2)->Unlock(); Foo::sfoo(f1); f1->getMu()->Unlock(); } Mutex* getFooMu(Foo* f) LOCK_RETURNED(Foo::getMu(f)); class Bar : public Foo { public: int b GUARDED_BY(getMu()); void bar() EXCLUSIVE_LOCKS_REQUIRED(getMu()); void bar2(Bar* g) EXCLUSIVE_LOCKS_REQUIRED(getMu(this), g->getMu()); static void sbar(Bar* g) EXCLUSIVE_LOCKS_REQUIRED(g->getMu()); static void sbar2(Bar* g) EXCLUSIVE_LOCKS_REQUIRED(getFooMu(g)); }; // Use getMu() within other attributes. // This requires at lest levels of substitution, more in the case of void test2(Bar* b1, Bar* b2) { b1->b = 0; // expected-warning {{writing variable 'b' requires locking 'b1->mu_' exclusively}} b1->bar(); // expected-warning {{calling function 'bar' requires exclusive lock on 'b1->mu_'}} b1->bar2(b2); // expected-warning {{calling function 'bar2' requires exclusive lock on 'b1->mu_'}} \ // expected-warning {{calling function 'bar2' requires exclusive lock on 'b2->mu_'}} Bar::sbar(b1); // expected-warning {{calling function 'sbar' requires exclusive lock on 'b1->mu_'}} Bar::sbar2(b1); // expected-warning {{calling function 'sbar2' requires exclusive lock on 'b1->mu_'}} b1->getMu()->Lock(); b1->b = 0; b1->bar(); b1->bar2(b2); // \ // expected-warning {{calling function 'bar2' requires exclusive lock on 'b2->mu_'}} \ // // expected-note {{found near match 'b1->mu_'}} b2->getMu()->Lock(); b1->bar2(b2); b2->getMu()->Unlock(); Bar::sbar(b1); Bar::sbar2(b1); b1->getMu()->Unlock(); } // Sanity check -- lock the mutex directly, but use attributes that call getMu() // Also lock the mutex using getFooMu, which calls a lock_returned function. void test3(Bar* b1, Bar* b2) { b1->mu_.Lock(); b1->b = 0; b1->bar(); getFooMu(b2)->Lock(); b1->bar2(b2); getFooMu(b2)->Unlock(); Bar::sbar(b1); Bar::sbar2(b1); b1->mu_.Unlock(); } } // end namespace LockReturned namespace ReleasableScopedLock { class Foo { Mutex mu_; bool c; int a GUARDED_BY(mu_); void test1(); void test2(); void test3(); void test4(); void test5(); }; void Foo::test1() { ReleasableMutexLock rlock(&mu_); rlock.Release(); } void Foo::test2() { ReleasableMutexLock rlock(&mu_); if (c) { // test join point -- held/not held during release rlock.Release(); } } void Foo::test3() { ReleasableMutexLock rlock(&mu_); a = 0; rlock.Release(); a = 1; // expected-warning {{writing variable 'a' requires locking 'mu_' exclusively}} } void Foo::test4() { ReleasableMutexLock rlock(&mu_); rlock.Release(); rlock.Release(); // expected-warning {{unlocking 'mu_' that was not locked}} } void Foo::test5() { ReleasableMutexLock rlock(&mu_); if (c) { rlock.Release(); } // no warning on join point for managed lock. rlock.Release(); // expected-warning {{unlocking 'mu_' that was not locked}} } } // end namespace ReleasableScopedLock namespace TrylockFunctionTest { class Foo { public: Mutex mu1_; Mutex mu2_; bool c; bool lockBoth() EXCLUSIVE_TRYLOCK_FUNCTION(true, mu1_, mu2_); }; bool Foo::lockBoth() { if (!mu1_.TryLock()) return false; mu2_.Lock(); if (!c) { mu1_.Unlock(); mu2_.Unlock(); return false; } return true; } } // end namespace TrylockFunctionTest namespace DoubleLockBug { class Foo { public: Mutex mu_; int a GUARDED_BY(mu_); void foo1() EXCLUSIVE_LOCKS_REQUIRED(mu_); int foo2() SHARED_LOCKS_REQUIRED(mu_); }; void Foo::foo1() EXCLUSIVE_LOCKS_REQUIRED(mu_) { a = 0; } int Foo::foo2() SHARED_LOCKS_REQUIRED(mu_) { return a; } } namespace UnlockBug { class Foo { public: Mutex mutex_; void foo1() EXCLUSIVE_LOCKS_REQUIRED(mutex_) { // expected-note {{mutex acquired here}} mutex_.Unlock(); } // expected-warning {{expecting mutex 'mutex_' to be locked at the end of function}} void foo2() SHARED_LOCKS_REQUIRED(mutex_) { // expected-note {{mutex acquired here}} mutex_.Unlock(); } // expected-warning {{expecting mutex 'mutex_' to be locked at the end of function}} }; } // end namespace UnlockBug namespace FoolishScopedLockableBug { class SCOPED_LOCKABLE WTF_ScopedLockable { public: WTF_ScopedLockable(Mutex* mu) EXCLUSIVE_LOCK_FUNCTION(mu); // have to call release() manually; ~WTF_ScopedLockable(); void release() UNLOCK_FUNCTION(); }; class Foo { Mutex mu_; int a GUARDED_BY(mu_); bool c; void doSomething(); void test1() { WTF_ScopedLockable wtf(&mu_); wtf.release(); } void test2() { WTF_ScopedLockable wtf(&mu_); // expected-note {{mutex acquired here}} } // expected-warning {{mutex 'mu_' is still locked at the end of function}} void test3() { if (c) { WTF_ScopedLockable wtf(&mu_); wtf.release(); } } void test4() { if (c) { doSomething(); } else { WTF_ScopedLockable wtf(&mu_); wtf.release(); } } void test5() { if (c) { WTF_ScopedLockable wtf(&mu_); // expected-note {{mutex acquired here}} } } // expected-warning {{mutex 'mu_' is not locked on every path through here}} void test6() { if (c) { doSomething(); } else { WTF_ScopedLockable wtf(&mu_); // expected-note {{mutex acquired here}} } } // expected-warning {{mutex 'mu_' is not locked on every path through here}} }; } // end namespace FoolishScopedLockableBug namespace TemporaryCleanupExpr { class Foo { int a GUARDED_BY(getMutexPtr().get()); SmartPtr getMutexPtr(); void test(); }; void Foo::test() { { ReaderMutexLock lock(getMutexPtr().get()); int b = a; } int b = a; // expected-warning {{reading variable 'a' requires locking 'getMutexPtr()'}} } } // end namespace TemporaryCleanupExpr namespace SmartPointerTests { class Foo { public: SmartPtr mu_; int a GUARDED_BY(mu_); int b GUARDED_BY(mu_.get()); int c GUARDED_BY(*mu_); void Lock() EXCLUSIVE_LOCK_FUNCTION(mu_); void Unlock() UNLOCK_FUNCTION(mu_); void test0(); void test1(); void test2(); void test3(); void test4(); void test5(); void test6(); void test7(); void test8(); }; void Foo::test0() { a = 0; // expected-warning {{writing variable 'a' requires locking 'mu_' exclusively}} b = 0; // expected-warning {{writing variable 'b' requires locking 'mu_' exclusively}} c = 0; // expected-warning {{writing variable 'c' requires locking 'mu_' exclusively}} } void Foo::test1() { mu_->Lock(); a = 0; b = 0; c = 0; mu_->Unlock(); } void Foo::test2() { (*mu_).Lock(); a = 0; b = 0; c = 0; (*mu_).Unlock(); } void Foo::test3() { mu_.get()->Lock(); a = 0; b = 0; c = 0; mu_.get()->Unlock(); } void Foo::test4() { MutexLock lock(mu_.get()); a = 0; b = 0; c = 0; } void Foo::test5() { MutexLock lock(&(*mu_)); a = 0; b = 0; c = 0; } void Foo::test6() { Lock(); a = 0; b = 0; c = 0; Unlock(); } void Foo::test7() { { Lock(); mu_->Unlock(); } { mu_->Lock(); Unlock(); } { mu_.get()->Lock(); mu_->Unlock(); } { mu_->Lock(); mu_.get()->Unlock(); } { mu_.get()->Lock(); (*mu_).Unlock(); } { (*mu_).Lock(); mu_->Unlock(); } } void Foo::test8() { mu_->Lock(); mu_.get()->Lock(); // expected-warning {{locking 'mu_' that is already locked}} (*mu_).Lock(); // expected-warning {{locking 'mu_' that is already locked}} mu_.get()->Unlock(); Unlock(); // expected-warning {{unlocking 'mu_' that was not locked}} } class Bar { SmartPtr foo; void test0(); void test1(); void test2(); void test3(); }; void Bar::test0() { foo->a = 0; // expected-warning {{writing variable 'a' requires locking 'foo->mu_' exclusively}} (*foo).b = 0; // expected-warning {{writing variable 'b' requires locking 'foo->mu_' exclusively}} foo.get()->c = 0; // expected-warning {{writing variable 'c' requires locking 'foo->mu_' exclusively}} } void Bar::test1() { foo->mu_->Lock(); foo->a = 0; (*foo).b = 0; foo.get()->c = 0; foo->mu_->Unlock(); } void Bar::test2() { (*foo).mu_->Lock(); foo->a = 0; (*foo).b = 0; foo.get()->c = 0; foo.get()->mu_->Unlock(); } void Bar::test3() { MutexLock lock(foo->mu_.get()); foo->a = 0; (*foo).b = 0; foo.get()->c = 0; } } // end namespace SmartPointerTests namespace DuplicateAttributeTest { class LOCKABLE Foo { public: Mutex mu1_; Mutex mu2_; Mutex mu3_; int a GUARDED_BY(mu1_); int b GUARDED_BY(mu2_); int c GUARDED_BY(mu3_); void lock() EXCLUSIVE_LOCK_FUNCTION(); void unlock() UNLOCK_FUNCTION(); void lock1() EXCLUSIVE_LOCK_FUNCTION(mu1_); void slock1() SHARED_LOCK_FUNCTION(mu1_); void lock3() EXCLUSIVE_LOCK_FUNCTION(mu1_, mu2_, mu3_); void locklots() EXCLUSIVE_LOCK_FUNCTION(mu1_) EXCLUSIVE_LOCK_FUNCTION(mu2_) EXCLUSIVE_LOCK_FUNCTION(mu1_, mu2_, mu3_); void unlock1() UNLOCK_FUNCTION(mu1_); void unlock3() UNLOCK_FUNCTION(mu1_, mu2_, mu3_); void unlocklots() UNLOCK_FUNCTION(mu1_) UNLOCK_FUNCTION(mu2_) UNLOCK_FUNCTION(mu1_, mu2_, mu3_); }; void Foo::lock() EXCLUSIVE_LOCK_FUNCTION() { } void Foo::unlock() UNLOCK_FUNCTION() { } void Foo::lock1() EXCLUSIVE_LOCK_FUNCTION(mu1_) { mu1_.Lock(); } void Foo::slock1() SHARED_LOCK_FUNCTION(mu1_) { mu1_.ReaderLock(); } void Foo::lock3() EXCLUSIVE_LOCK_FUNCTION(mu1_, mu2_, mu3_) { mu1_.Lock(); mu2_.Lock(); mu3_.Lock(); } void Foo::locklots() EXCLUSIVE_LOCK_FUNCTION(mu1_, mu2_) EXCLUSIVE_LOCK_FUNCTION(mu2_, mu3_) { mu1_.Lock(); mu2_.Lock(); mu3_.Lock(); } void Foo::unlock1() UNLOCK_FUNCTION(mu1_) { mu1_.Unlock(); } void Foo::unlock3() UNLOCK_FUNCTION(mu1_, mu2_, mu3_) { mu1_.Unlock(); mu2_.Unlock(); mu3_.Unlock(); } void Foo::unlocklots() UNLOCK_FUNCTION(mu1_, mu2_) UNLOCK_FUNCTION(mu2_, mu3_) { mu1_.Unlock(); mu2_.Unlock(); mu3_.Unlock(); } void test0() { Foo foo; foo.lock(); foo.unlock(); foo.lock(); foo.lock(); // expected-warning {{locking 'foo' that is already locked}} foo.unlock(); foo.unlock(); // expected-warning {{unlocking 'foo' that was not locked}} } void test1() { Foo foo; foo.lock1(); foo.a = 0; foo.unlock1(); foo.lock1(); foo.lock1(); // expected-warning {{locking 'foo.mu1_' that is already locked}} foo.a = 0; foo.unlock1(); foo.unlock1(); // expected-warning {{unlocking 'foo.mu1_' that was not locked}} } int test2() { Foo foo; foo.slock1(); int d1 = foo.a; foo.unlock1(); foo.slock1(); foo.slock1(); // expected-warning {{locking 'foo.mu1_' that is already locked}} int d2 = foo.a; foo.unlock1(); foo.unlock1(); // expected-warning {{unlocking 'foo.mu1_' that was not locked}} return d1 + d2; } void test3() { Foo foo; foo.lock3(); foo.a = 0; foo.b = 0; foo.c = 0; foo.unlock3(); foo.lock3(); foo.lock3(); // \ // expected-warning {{locking 'foo.mu1_' that is already locked}} \ // expected-warning {{locking 'foo.mu2_' that is already locked}} \ // expected-warning {{locking 'foo.mu3_' that is already locked}} foo.a = 0; foo.b = 0; foo.c = 0; foo.unlock3(); foo.unlock3(); // \ // expected-warning {{unlocking 'foo.mu1_' that was not locked}} \ // expected-warning {{unlocking 'foo.mu2_' that was not locked}} \ // expected-warning {{unlocking 'foo.mu3_' that was not locked}} } void testlots() { Foo foo; foo.locklots(); foo.a = 0; foo.b = 0; foo.c = 0; foo.unlocklots(); foo.locklots(); foo.locklots(); // \ // expected-warning {{locking 'foo.mu1_' that is already locked}} \ // expected-warning {{locking 'foo.mu2_' that is already locked}} \ // expected-warning {{locking 'foo.mu3_' that is already locked}} foo.a = 0; foo.b = 0; foo.c = 0; foo.unlocklots(); foo.unlocklots(); // \ // expected-warning {{unlocking 'foo.mu1_' that was not locked}} \ // expected-warning {{unlocking 'foo.mu2_' that was not locked}} \ // expected-warning {{unlocking 'foo.mu3_' that was not locked}} } } // end namespace DuplicateAttributeTest namespace TryLockEqTest { class Foo { Mutex mu_; int a GUARDED_BY(mu_); bool c; int tryLockMutexI() EXCLUSIVE_TRYLOCK_FUNCTION(1, mu_); Mutex* tryLockMutexP() EXCLUSIVE_TRYLOCK_FUNCTION(1, mu_); void unlock() UNLOCK_FUNCTION(mu_); void test1(); void test2(); }; void Foo::test1() { if (tryLockMutexP() == 0) { a = 0; // expected-warning {{writing variable 'a' requires locking 'mu_' exclusively}} return; } a = 0; unlock(); if (tryLockMutexP() != 0) { a = 0; unlock(); } if (0 != tryLockMutexP()) { a = 0; unlock(); } if (!(tryLockMutexP() == 0)) { a = 0; unlock(); } if (tryLockMutexI() == 0) { a = 0; // expected-warning {{writing variable 'a' requires locking 'mu_' exclusively}} return; } a = 0; unlock(); if (0 == tryLockMutexI()) { a = 0; // expected-warning {{writing variable 'a' requires locking 'mu_' exclusively}} return; } a = 0; unlock(); if (tryLockMutexI() == 1) { a = 0; unlock(); } if (mu_.TryLock() == false) { a = 0; // expected-warning {{writing variable 'a' requires locking 'mu_' exclusively}} return; } a = 0; unlock(); if (mu_.TryLock() == true) { a = 0; unlock(); } else { a = 0; // expected-warning {{writing variable 'a' requires locking 'mu_' exclusively}} } #if __has_feature(cxx_nullptr) if (tryLockMutexP() == nullptr) { a = 0; // expected-warning {{writing variable 'a' requires locking 'mu_' exclusively}} return; } a = 0; unlock(); #endif } void Foo::test2() { /* FIXME: these tests depend on changes to the CFG. * if (mu_.TryLock() && c) { a = 0; unlock(); } else return; if (c && mu_.TryLock()) { a = 0; unlock(); } else return; if (!(mu_.TryLock() && c)) return; a = 0; unlock(); if (!(c && mu_.TryLock())) return; a = 0; unlock(); if (!(mu_.TryLock() == 0) && c) { a = 0; unlock(); } if (!mu_.TryLock() || c) return; a = 0; unlock(); */ } } // end namespace TryLockEqTest namespace ExistentialPatternMatching { class Graph { public: Mutex mu_; }; void LockAllGraphs() EXCLUSIVE_LOCK_FUNCTION(&Graph::mu_); void UnlockAllGraphs() UNLOCK_FUNCTION(&Graph::mu_); class Node { public: int a GUARDED_BY(&Graph::mu_); void foo() EXCLUSIVE_LOCKS_REQUIRED(&Graph::mu_) { a = 0; } void foo2() LOCKS_EXCLUDED(&Graph::mu_); }; void test() { Graph g1; Graph g2; Node n1; n1.a = 0; // expected-warning {{writing variable 'a' requires locking '&ExistentialPatternMatching::Graph::mu_' exclusively}} n1.foo(); // expected-warning {{calling function 'foo' requires exclusive lock on '&ExistentialPatternMatching::Graph::mu_'}} n1.foo2(); g1.mu_.Lock(); n1.a = 0; n1.foo(); n1.foo2(); // expected-warning {{cannot call function 'foo2' while mutex '&ExistentialPatternMatching::Graph::mu_' is locked}} g1.mu_.Unlock(); g2.mu_.Lock(); n1.a = 0; n1.foo(); n1.foo2(); // expected-warning {{cannot call function 'foo2' while mutex '&ExistentialPatternMatching::Graph::mu_' is locked}} g2.mu_.Unlock(); LockAllGraphs(); n1.a = 0; n1.foo(); n1.foo2(); // expected-warning {{cannot call function 'foo2' while mutex '&ExistentialPatternMatching::Graph::mu_' is locked}} UnlockAllGraphs(); LockAllGraphs(); g1.mu_.Unlock(); LockAllGraphs(); g2.mu_.Unlock(); LockAllGraphs(); g1.mu_.Lock(); // expected-warning {{locking 'g1.mu_' that is already locked}} g1.mu_.Unlock(); } } // end namespace ExistentialPatternMatching namespace StringIgnoreTest { class Foo { public: Mutex mu_; void lock() EXCLUSIVE_LOCK_FUNCTION(""); void unlock() UNLOCK_FUNCTION(""); void goober() EXCLUSIVE_LOCKS_REQUIRED(""); void roober() SHARED_LOCKS_REQUIRED(""); }; class Bar : public Foo { public: void bar(Foo* f) { f->unlock(); f->goober(); f->roober(); f->lock(); }; }; } // end namespace StringIgnoreTest namespace LockReturnedScopeFix { class Base { protected: struct Inner; bool c; const Mutex& getLock(const Inner* i); void lockInner (Inner* i) EXCLUSIVE_LOCK_FUNCTION(getLock(i)); void unlockInner(Inner* i) UNLOCK_FUNCTION(getLock(i)); void foo(Inner* i) EXCLUSIVE_LOCKS_REQUIRED(getLock(i)); void bar(Inner* i); }; struct Base::Inner { Mutex lock_; void doSomething() EXCLUSIVE_LOCKS_REQUIRED(lock_); }; const Mutex& Base::getLock(const Inner* i) LOCK_RETURNED(i->lock_) { return i->lock_; } void Base::foo(Inner* i) { i->doSomething(); } void Base::bar(Inner* i) { if (c) { i->lock_.Lock(); unlockInner(i); } else { lockInner(i); i->lock_.Unlock(); } } } // end namespace LockReturnedScopeFix namespace TrylockWithCleanups { struct Foo { Mutex mu_; int a GUARDED_BY(mu_); }; Foo* GetAndLockFoo(const MyString& s) EXCLUSIVE_TRYLOCK_FUNCTION(true, &Foo::mu_); static void test() { Foo* lt = GetAndLockFoo("foo"); if (!lt) return; int a = lt->a; lt->mu_.Unlock(); } } // end namespace TrylockWithCleanups namespace UniversalLock { class Foo { Mutex mu_; bool c; int a GUARDED_BY(mu_); void r_foo() SHARED_LOCKS_REQUIRED(mu_); void w_foo() EXCLUSIVE_LOCKS_REQUIRED(mu_); void test1() { int b; beginNoWarnOnReads(); b = a; r_foo(); endNoWarnOnReads(); beginNoWarnOnWrites(); a = 0; w_foo(); endNoWarnOnWrites(); } // don't warn on joins with universal lock void test2() { if (c) { beginNoWarnOnWrites(); } a = 0; // \ // expected-warning {{writing variable 'a' requires locking 'mu_' exclusively}} endNoWarnOnWrites(); // \ // expected-warning {{unlocking '*' that was not locked}} } // make sure the universal lock joins properly void test3() { if (c) { mu_.Lock(); beginNoWarnOnWrites(); } else { beginNoWarnOnWrites(); mu_.Lock(); } a = 0; endNoWarnOnWrites(); mu_.Unlock(); } // combine universal lock with other locks void test4() { beginNoWarnOnWrites(); mu_.Lock(); mu_.Unlock(); endNoWarnOnWrites(); mu_.Lock(); beginNoWarnOnWrites(); endNoWarnOnWrites(); mu_.Unlock(); mu_.Lock(); beginNoWarnOnWrites(); mu_.Unlock(); endNoWarnOnWrites(); } }; } // end namespace UniversalLock namespace TemplateLockReturned { template class BaseT { public: virtual void baseMethod() = 0; Mutex* get_mutex() LOCK_RETURNED(mutex_) { return &mutex_; } Mutex mutex_; int a GUARDED_BY(mutex_); }; class Derived : public BaseT { public: void baseMethod() EXCLUSIVE_LOCKS_REQUIRED(get_mutex()) { a = 0; } }; } // end namespace TemplateLockReturned namespace ExprMatchingBugFix { class Foo { public: Mutex mu_; }; class Bar { public: bool c; Foo* foo; Bar(Foo* f) : foo(f) { } struct Nested { Foo* foo; Nested(Foo* f) : foo(f) { } void unlockFoo() UNLOCK_FUNCTION(&Foo::mu_); }; void test(); }; void Bar::test() { foo->mu_.Lock(); if (c) { Nested *n = new Nested(foo); n->unlockFoo(); } else { foo->mu_.Unlock(); } } }; // end namespace ExprMatchingBugfix namespace ComplexNameTest { class Foo { public: static Mutex mu_; Foo() EXCLUSIVE_LOCKS_REQUIRED(mu_) { } ~Foo() EXCLUSIVE_LOCKS_REQUIRED(mu_) { } int operator[](int i) EXCLUSIVE_LOCKS_REQUIRED(mu_) { return 0; } }; class Bar { public: static Mutex mu_; Bar() LOCKS_EXCLUDED(mu_) { } ~Bar() LOCKS_EXCLUDED(mu_) { } int operator[](int i) LOCKS_EXCLUDED(mu_) { return 0; } }; void test1() { Foo f; // expected-warning {{calling function 'Foo' requires exclusive lock on 'mu_'}} int a = f[0]; // expected-warning {{calling function 'operator[]' requires exclusive lock on 'mu_'}} } // expected-warning {{calling function '~Foo' requires exclusive lock on 'mu_'}} void test2() { Bar::mu_.Lock(); { Bar b; // expected-warning {{cannot call function 'Bar' while mutex 'mu_' is locked}} int a = b[0]; // expected-warning {{cannot call function 'operator[]' while mutex 'mu_' is locked}} } // expected-warning {{cannot call function '~Bar' while mutex 'mu_' is locked}} Bar::mu_.Unlock(); } }; // end namespace ComplexNameTest namespace UnreachableExitTest { class FemmeFatale { public: FemmeFatale(); ~FemmeFatale() __attribute__((noreturn)); }; void exitNow() __attribute__((noreturn)); void exitDestruct(const MyString& ms) __attribute__((noreturn)); Mutex fatalmu_; void test1() EXCLUSIVE_LOCKS_REQUIRED(fatalmu_) { exitNow(); } void test2() EXCLUSIVE_LOCKS_REQUIRED(fatalmu_) { FemmeFatale femme; } bool c; void test3() EXCLUSIVE_LOCKS_REQUIRED(fatalmu_) { if (c) { exitNow(); } else { FemmeFatale femme; } } void test4() EXCLUSIVE_LOCKS_REQUIRED(fatalmu_) { exitDestruct("foo"); } } // end namespace UnreachableExitTest namespace VirtualMethodCanonicalizationTest { class Base { public: virtual Mutex* getMutex() = 0; }; class Base2 : public Base { public: Mutex* getMutex(); }; class Base3 : public Base2 { public: Mutex* getMutex(); }; class Derived : public Base3 { public: Mutex* getMutex(); // overrides Base::getMutex() }; void baseFun(Base *b) EXCLUSIVE_LOCKS_REQUIRED(b->getMutex()) { } void derivedFun(Derived *d) EXCLUSIVE_LOCKS_REQUIRED(d->getMutex()) { baseFun(d); } } // end namespace VirtualMethodCanonicalizationTest namespace TemplateFunctionParamRemapTest { template struct Cell { T dummy_; Mutex* mu_; }; class Foo { public: template void elr(Cell* c) __attribute__((exclusive_locks_required(c->mu_))); void test(); }; template void Foo::elr(Cell* c1) { } void Foo::test() { Cell cell; elr(&cell); // \ // expected-warning {{calling function 'elr' requires exclusive lock on 'cell.mu_'}} } template void globalELR(Cell* c) __attribute__((exclusive_locks_required(c->mu_))); template void globalELR(Cell* c1) { } void globalTest() { Cell cell; globalELR(&cell); // \ // expected-warning {{calling function 'globalELR' requires exclusive lock on 'cell.mu_'}} } template void globalELR2(Cell* c) __attribute__((exclusive_locks_required(c->mu_))); // second declaration template void globalELR2(Cell* c2); template void globalELR2(Cell* c3) { } // re-declaration after definition template void globalELR2(Cell* c4); void globalTest2() { Cell cell; globalELR2(&cell); // \ // expected-warning {{calling function 'globalELR2' requires exclusive lock on 'cell.mu_'}} } template class FooT { public: void elr(Cell* c) __attribute__((exclusive_locks_required(c->mu_))); }; template void FooT::elr(Cell* c1) { } void testFooT() { Cell cell; FooT foo; foo.elr(&cell); // \ // expected-warning {{calling function 'elr' requires exclusive lock on 'cell.mu_'}} } } // end namespace TemplateFunctionParamRemapTest namespace SelfConstructorTest { class SelfLock { public: SelfLock() EXCLUSIVE_LOCK_FUNCTION(mu_); ~SelfLock() UNLOCK_FUNCTION(mu_); void foo() EXCLUSIVE_LOCKS_REQUIRED(mu_); Mutex mu_; }; class LOCKABLE SelfLock2 { public: SelfLock2() EXCLUSIVE_LOCK_FUNCTION(); ~SelfLock2() UNLOCK_FUNCTION(); void foo() EXCLUSIVE_LOCKS_REQUIRED(this); }; void test() { SelfLock s; s.foo(); } void test2() { SelfLock2 s2; s2.foo(); } } // end namespace SelfConstructorTest namespace MultipleAttributeTest { class Foo { Mutex mu1_; Mutex mu2_; int a GUARDED_BY(mu1_); int b GUARDED_BY(mu2_); int c GUARDED_BY(mu1_) GUARDED_BY(mu2_); int* d PT_GUARDED_BY(mu1_) PT_GUARDED_BY(mu2_); void foo1() EXCLUSIVE_LOCKS_REQUIRED(mu1_) EXCLUSIVE_LOCKS_REQUIRED(mu2_); void foo2() SHARED_LOCKS_REQUIRED(mu1_) SHARED_LOCKS_REQUIRED(mu2_); void foo3() LOCKS_EXCLUDED(mu1_) LOCKS_EXCLUDED(mu2_); void lock() EXCLUSIVE_LOCK_FUNCTION(mu1_) EXCLUSIVE_LOCK_FUNCTION(mu2_); void readerlock() SHARED_LOCK_FUNCTION(mu1_) SHARED_LOCK_FUNCTION(mu2_); void unlock() UNLOCK_FUNCTION(mu1_) UNLOCK_FUNCTION(mu2_); bool trylock() EXCLUSIVE_TRYLOCK_FUNCTION(true, mu1_) EXCLUSIVE_TRYLOCK_FUNCTION(true, mu2_); bool readertrylock() SHARED_TRYLOCK_FUNCTION(true, mu1_) SHARED_TRYLOCK_FUNCTION(true, mu2_); void test(); }; void Foo::foo1() { a = 1; b = 2; } void Foo::foo2() { int result = a + b; } void Foo::foo3() { } void Foo::lock() { mu1_.Lock(); mu2_.Lock(); } void Foo::readerlock() { mu1_.ReaderLock(); mu2_.ReaderLock(); } void Foo::unlock() { mu1_.Unlock(); mu2_.Unlock(); } bool Foo::trylock() { return true; } bool Foo::readertrylock() { return true; } void Foo::test() { mu1_.Lock(); foo1(); // expected-warning {{}} c = 0; // expected-warning {{}} *d = 0; // expected-warning {{}} mu1_.Unlock(); mu1_.ReaderLock(); foo2(); // expected-warning {{}} int x = c; // expected-warning {{}} int y = *d; // expected-warning {{}} mu1_.Unlock(); mu2_.Lock(); foo3(); // expected-warning {{}} mu2_.Unlock(); lock(); a = 0; b = 0; unlock(); readerlock(); int z = a + b; unlock(); if (trylock()) { a = 0; b = 0; unlock(); } if (readertrylock()) { int zz = a + b; unlock(); } } } // end namespace MultipleAttributeTest namespace GuardedNonPrimitiveTypeTest { class Data { public: Data(int i) : dat(i) { } int getValue() const { return dat; } void setValue(int i) { dat = i; } int operator[](int i) const { return dat; } int& operator[](int i) { return dat; } void operator()() { } private: int dat; }; class DataCell { public: DataCell(const Data& d) : dat(d) { } private: Data dat; }; void showDataCell(const DataCell& dc); class Foo { public: // method call tests void test() { data_.setValue(0); // FIXME -- should be writing \ // expected-warning {{reading variable 'data_' requires locking 'mu_'}} int a = data_.getValue(); // \ // expected-warning {{reading variable 'data_' requires locking 'mu_'}} datap1_->setValue(0); // FIXME -- should be writing \ // expected-warning {{reading variable 'datap1_' requires locking 'mu_'}} a = datap1_->getValue(); // \ // expected-warning {{reading variable 'datap1_' requires locking 'mu_'}} datap2_->setValue(0); // FIXME -- should be writing \ // expected-warning {{reading the value pointed to by 'datap2_' requires locking 'mu_'}} a = datap2_->getValue(); // \ // expected-warning {{reading the value pointed to by 'datap2_' requires locking 'mu_'}} (*datap2_).setValue(0); // FIXME -- should be writing \ // expected-warning {{reading the value pointed to by 'datap2_' requires locking 'mu_'}} a = (*datap2_).getValue(); // \ // expected-warning {{reading the value pointed to by 'datap2_' requires locking 'mu_'}} mu_.Lock(); data_.setValue(1); datap1_->setValue(1); datap2_->setValue(1); mu_.Unlock(); mu_.ReaderLock(); a = data_.getValue(); datap1_->setValue(0); // reads datap1_, writes *datap1_ a = datap1_->getValue(); a = datap2_->getValue(); mu_.Unlock(); } // operator tests void test2() { data_ = Data(1); // expected-warning {{writing variable 'data_' requires locking 'mu_' exclusively}} *datap1_ = data_; // expected-warning {{reading variable 'datap1_' requires locking 'mu_'}} \ // expected-warning {{reading variable 'data_' requires locking 'mu_'}} *datap2_ = data_; // expected-warning {{writing the value pointed to by 'datap2_' requires locking 'mu_' exclusively}} \ // expected-warning {{reading variable 'data_' requires locking 'mu_'}} data_ = *datap1_; // expected-warning {{writing variable 'data_' requires locking 'mu_' exclusively}} \ // expected-warning {{reading variable 'datap1_' requires locking 'mu_'}} data_ = *datap2_; // expected-warning {{writing variable 'data_' requires locking 'mu_' exclusively}} \ // expected-warning {{reading the value pointed to by 'datap2_' requires locking 'mu_'}} data_[0] = 0; // expected-warning {{reading variable 'data_' requires locking 'mu_'}} (*datap2_)[0] = 0; // expected-warning {{reading the value pointed to by 'datap2_' requires locking 'mu_'}} data_(); // expected-warning {{reading variable 'data_' requires locking 'mu_'}} } // const operator tests void test3() const { Data mydat(data_); // expected-warning {{reading variable 'data_' requires locking 'mu_'}} //FIXME //showDataCell(data_); // xpected-warning {{reading variable 'data_' requires locking 'mu_'}} //showDataCell(*datap2_); // xpected-warning {{reading the value pointed to by 'datap2_' requires locking 'mu_'}} int a = data_[0]; // expected-warning {{reading variable 'data_' requires locking 'mu_'}} } private: Mutex mu_; Data data_ GUARDED_BY(mu_); Data* datap1_ GUARDED_BY(mu_); Data* datap2_ PT_GUARDED_BY(mu_); }; } // end namespace GuardedNonPrimitiveTypeTest namespace GuardedNonPrimitive_MemberAccess { class Cell { public: Cell(int i); void cellMethod(); int a; }; class Foo { public: int a; Cell c GUARDED_BY(cell_mu_); Cell* cp PT_GUARDED_BY(cell_mu_); void myMethod(); Mutex cell_mu_; }; class Bar { private: Mutex mu_; Foo foo GUARDED_BY(mu_); Foo* foop PT_GUARDED_BY(mu_); void test() { foo.myMethod(); // expected-warning {{reading variable 'foo' requires locking 'mu_'}} int fa = foo.a; // expected-warning {{reading variable 'foo' requires locking 'mu_'}} foo.a = fa; // expected-warning {{writing variable 'foo' requires locking 'mu_' exclusively}} fa = foop->a; // expected-warning {{reading the value pointed to by 'foop' requires locking 'mu_'}} foop->a = fa; // expected-warning {{writing the value pointed to by 'foop' requires locking 'mu_' exclusively}} fa = (*foop).a; // expected-warning {{reading the value pointed to by 'foop' requires locking 'mu_'}} (*foop).a = fa; // expected-warning {{writing the value pointed to by 'foop' requires locking 'mu_' exclusively}} foo.c = Cell(0); // expected-warning {{writing variable 'foo' requires locking 'mu_'}} \ // expected-warning {{writing variable 'c' requires locking 'foo.cell_mu_' exclusively}} foo.c.cellMethod(); // expected-warning {{reading variable 'foo' requires locking 'mu_'}} \ // expected-warning {{reading variable 'c' requires locking 'foo.cell_mu_'}} foop->c = Cell(0); // expected-warning {{writing the value pointed to by 'foop' requires locking 'mu_'}} \ // expected-warning {{writing variable 'c' requires locking 'foop->cell_mu_' exclusively}} foop->c.cellMethod(); // expected-warning {{reading the value pointed to by 'foop' requires locking 'mu_'}} \ // expected-warning {{reading variable 'c' requires locking 'foop->cell_mu_'}} (*foop).c = Cell(0); // expected-warning {{writing the value pointed to by 'foop' requires locking 'mu_'}} \ // expected-warning {{writing variable 'c' requires locking 'foop->cell_mu_' exclusively}} (*foop).c.cellMethod(); // expected-warning {{reading the value pointed to by 'foop' requires locking 'mu_'}} \ // expected-warning {{reading variable 'c' requires locking 'foop->cell_mu_'}} }; }; } // namespace GuardedNonPrimitive_MemberAccess namespace TestThrowExpr { class Foo { Mutex mu_; bool hasError(); void test() { mu_.Lock(); if (hasError()) { throw "ugly"; } mu_.Unlock(); } }; } // end namespace TestThrowExpr namespace UnevaluatedContextTest { // parse attribute expressions in an unevaluated context. static inline Mutex* getMutex1(); static inline Mutex* getMutex2(); void bar() EXCLUSIVE_LOCKS_REQUIRED(getMutex1()); void bar2() EXCLUSIVE_LOCKS_REQUIRED(getMutex1(), getMutex2()); } // end namespace UnevaluatedContextTest namespace LockUnlockFunctionTest { // Check built-in lock functions class LOCKABLE MyLockable { public: void lock() EXCLUSIVE_LOCK_FUNCTION() { mu_.Lock(); } void readerLock() SHARED_LOCK_FUNCTION() { mu_.ReaderLock(); } void unlock() UNLOCK_FUNCTION() { mu_.Unlock(); } private: Mutex mu_; }; class Foo { public: // Correct lock/unlock functions void lock() EXCLUSIVE_LOCK_FUNCTION(mu_) { mu_.Lock(); } void readerLock() SHARED_LOCK_FUNCTION(mu_) { mu_.ReaderLock(); } void unlock() UNLOCK_FUNCTION(mu_) { mu_.Unlock(); } // Check failure to lock. void lockBad() EXCLUSIVE_LOCK_FUNCTION(mu_) { // expected-note {{mutex acquired here}} mu2_.Lock(); mu2_.Unlock(); } // expected-warning {{expecting mutex 'mu_' to be locked at the end of function}} void readerLockBad() SHARED_LOCK_FUNCTION(mu_) { // expected-note {{mutex acquired here}} mu2_.Lock(); mu2_.Unlock(); } // expected-warning {{expecting mutex 'mu_' to be locked at the end of function}} void unlockBad() UNLOCK_FUNCTION(mu_) { // expected-note {{mutex acquired here}} mu2_.Lock(); mu2_.Unlock(); } // expected-warning {{mutex 'mu_' is still locked at the end of function}} // Check locking the wrong thing. void lockBad2() EXCLUSIVE_LOCK_FUNCTION(mu_) { // expected-note {{mutex acquired here}} mu2_.Lock(); // expected-note {{mutex acquired here}} } // expected-warning {{expecting mutex 'mu_' to be locked at the end of function}} \ // expected-warning {{mutex 'mu2_' is still locked at the end of function}} void readerLockBad2() SHARED_LOCK_FUNCTION(mu_) { // expected-note {{mutex acquired here}} mu2_.ReaderLock(); // expected-note {{mutex acquired here}} } // expected-warning {{expecting mutex 'mu_' to be locked at the end of function}} \ // expected-warning {{mutex 'mu2_' is still locked at the end of function}} void unlockBad2() UNLOCK_FUNCTION(mu_) { // expected-note {{mutex acquired here}} mu2_.Unlock(); // expected-warning {{unlocking 'mu2_' that was not locked}} } // expected-warning {{mutex 'mu_' is still locked at the end of function}} private: Mutex mu_; Mutex mu2_; }; } // end namespace LockUnlockFunctionTest