blob: b3a897c76bfdbf9f0cff899ede39c76be023b7cc [file] [log] [blame]
/*
* Copyright (C) 2015 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef ART_RUNTIME_GC_SCOPED_GC_CRITICAL_SECTION_H_
#define ART_RUNTIME_GC_SCOPED_GC_CRITICAL_SECTION_H_
#include "base/locks.h"
#include "collector_type.h"
#include "gc_cause.h"
namespace art {
class Thread;
namespace gc {
// The use of ScopedGCCriticalSection should be preferred whenever possible.
class GCCriticalSection {
public:
GCCriticalSection(Thread* self, const char* name)
: self_(self), section_name_(name) {}
~GCCriticalSection() {}
// Starts a GCCriticalSection. Returns the previous no-suspension reason.
const char* Enter(GcCause cause, CollectorType type) ACQUIRE(Roles::uninterruptible_);
// Ends a GCCriticalSection. Takes the old no-suspension reason.
void Exit(const char* old_reason) RELEASE(Roles::uninterruptible_);
private:
Thread* const self_;
const char* section_name_;
};
// Wait until the GC is finished and then prevent the GC from starting until the destructor. Used
// to prevent deadlocks in places where we call ClassLinker::VisitClass with all the threads
// suspended.
class ScopedGCCriticalSection {
public:
ScopedGCCriticalSection(Thread* self, GcCause cause, CollectorType collector_type)
ACQUIRE(Roles::uninterruptible_);
~ScopedGCCriticalSection() RELEASE(Roles::uninterruptible_);
private:
GCCriticalSection critical_section_;
const char* old_no_suspend_reason_;
};
// The use of ScopedGCCriticalSection should be preferred whenever possible.
// This class allows thread suspension but should never be used with allocations because of the
// deadlock risk. TODO: Add a new thread role for "no allocations" that still allows suspension.
class ScopedInterruptibleGCCriticalSection {
public:
ScopedInterruptibleGCCriticalSection(Thread* self, GcCause cause, CollectorType type);
~ScopedInterruptibleGCCriticalSection();
private:
Thread* const self_;
};
} // namespace gc
} // namespace art
#endif // ART_RUNTIME_GC_SCOPED_GC_CRITICAL_SECTION_H_