1 /*
2  * Copyright (C) 2016 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef ART_RUNTIME_BASE_MUTATOR_LOCKED_DUMPABLE_H_
18 #define ART_RUNTIME_BASE_MUTATOR_LOCKED_DUMPABLE_H_
19 
20 #include "base/locks.h"
21 #include "thread-current-inl.h"
22 
23 namespace art {
24 
25 template<typename T>
26 class MutatorLockedDumpable {
27  public:
MutatorLockedDumpable(T & value)28   explicit MutatorLockedDumpable(T& value) REQUIRES_SHARED(Locks::mutator_lock_) : value_(value) {}
29 
Dump(std::ostream & os)30   void Dump(std::ostream& os) const REQUIRES_SHARED(Locks::mutator_lock_) {
31     value_.Dump(os);
32   }
33 
34  private:
35   const T& value_;
36 
37   DISALLOW_COPY_AND_ASSIGN(MutatorLockedDumpable);
38 };
39 
40 // template<typename T>
41 // std::ostream& operator<<(std::ostream& os, const MutatorLockedDumpable<T>& rhs)
42 //   // TODO: should be REQUIRES_SHARED(Locks::mutator_lock_) however annotalysis
43 //   //       currently fails for this.
44 //     NO_THREAD_SAFETY_ANALYSIS;
45 
46 template<typename T>
47 inline std::ostream& operator<<(std::ostream& os, const MutatorLockedDumpable<T>& rhs)
48     NO_THREAD_SAFETY_ANALYSIS {
49   Locks::mutator_lock_->AssertSharedHeld(Thread::Current());
50   rhs.Dump(os);
51   return os;
52 }
53 
54 }  // namespace art
55 
56 #endif  // ART_RUNTIME_BASE_MUTATOR_LOCKED_DUMPABLE_H_
57