runtime/fault_handler.cc - LeafOS-Project/android_art - Gitiles

 /*
  * Copyright (C) 2008 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.
  */

 #include "fault_handler.h"

 #include <setjmp.h>
 #include <sys/mman.h>
 #include <sys/ucontext.h>

 #include "art_method-inl.h"
 #include "base/stl_util.h"
 #include "mirror/class.h"
 #include "oat_quick_method_header.h"
 #include "sigchain.h"
 #include "thread-inl.h"
 #include "verify_object-inl.h"

 namespace art {
 // Static fault manger object accessed by signal handler.
 FaultManager fault_manager;

 extern "C" __attribute__((visibility("default"))) void art_sigsegv_fault() {
   // Set a breakpoint here to be informed when a SIGSEGV is unhandled by ART.
   VLOG(signals)<< "Caught unknown SIGSEGV in ART fault handler - chaining to next handler.";
 }

 // Signal handler called on SIGSEGV.
 static void art_fault_handler(int sig, siginfo_t* info, void* context) {
   fault_manager.HandleFault(sig, info, context);
 }

 FaultManager::FaultManager() : initialized_(false) {
   sigaction(SIGSEGV, nullptr, &oldaction_);
 }

 FaultManager::~FaultManager() {
 }

 static void SetUpArtAction(struct sigaction* action) {
   action->sa_sigaction = art_fault_handler;
   sigemptyset(&action->sa_mask);
   action->sa_flags = SA_SIGINFO | SA_ONSTACK;
 #if !defined(__APPLE__) && !defined(__mips__)
   action->sa_restorer = nullptr;
 #endif
 }

 void FaultManager::EnsureArtActionInFrontOfSignalChain() {
   if (initialized_) {
     struct sigaction action;
     SetUpArtAction(&action);
     EnsureFrontOfChain(SIGSEGV, &action);
   } else {
     LOG(WARNING) << "Can't call " << __FUNCTION__ << " due to unitialized fault manager";
   }
 }

 void FaultManager::Init() {
   CHECK(!initialized_);
   struct sigaction action;
   SetUpArtAction(&action);

   // Set our signal handler now.
   int e = sigaction(SIGSEGV, &action, &oldaction_);
   if (e != 0) {
     VLOG(signals) << "Failed to claim SEGV: " << strerror(errno);
   }
   // Make sure our signal handler is called before any user handlers.
   ClaimSignalChain(SIGSEGV, &oldaction_);
   initialized_ = true;
 }

 void FaultManager::Release() {
   if (initialized_) {
     UnclaimSignalChain(SIGSEGV);
     initialized_ = false;
   }
 }

 void FaultManager::Shutdown() {
   if (initialized_) {
     Release();

     // Free all handlers.
     STLDeleteElements(&generated_code_handlers_);
     STLDeleteElements(&other_handlers_);
   }
 }

 bool FaultManager::HandleFaultByOtherHandlers(int sig, siginfo_t* info, void* context) {
   if (other_handlers_.empty()) {
     return false;
   }

   Thread* self = Thread::Current();

   DCHECK(self != nullptr);
   DCHECK(Runtime::Current() != nullptr);
   DCHECK(Runtime::Current()->IsStarted());
   for (const auto& handler : other_handlers_) {
     if (handler->Action(sig, info, context)) {
       return true;
     }
   }
   return false;
 }

 class ScopedSignalUnblocker {
  public:
   explicit ScopedSignalUnblocker(const std::initializer_list<int>& signals) {
     sigset_t new_mask;
     sigemptyset(&new_mask);
     for (int signal : signals) {
       sigaddset(&new_mask, signal);
     }
     if (sigprocmask(SIG_UNBLOCK, &new_mask, &previous_mask_) != 0) {
       PLOG(FATAL) << "failed to unblock signals";
     }
   }

   ~ScopedSignalUnblocker() {
     if (sigprocmask(SIG_SETMASK, &previous_mask_, nullptr) != 0) {
       PLOG(FATAL) << "failed to unblock signals";
     }
   }

  private:
   sigset_t previous_mask_;
 };

 class ScopedHandlingSignalSetter {
  public:
   explicit ScopedHandlingSignalSetter(Thread* thread) : thread_(thread) {
     CHECK(!thread->HandlingSignal());
     thread_->SetHandlingSignal(true);
   }

   ~ScopedHandlingSignalSetter() {
     CHECK(thread_->HandlingSignal());
     thread_->SetHandlingSignal(false);
   }

  private:
   Thread* thread_;
 };

 void FaultManager::HandleFault(int sig, siginfo_t* info, void* context) {
   // BE CAREFUL ALLOCATING HERE INCLUDING USING LOG(...)
   //
   // If malloc calls abort, it will be holding its lock.
   // If the handler tries to call malloc, it will deadlock.

   // Use a thread local field to track whether we're recursing, and fall back.
   // (e.g.. if one of our handlers crashed)
   Thread* thread = Thread::Current();

   if (thread != nullptr && !thread->HandlingSignal()) {
     // Unblock some signals and set thread->handling_signal_ to true,
     // so that we can catch crashes in our signal handler.
     ScopedHandlingSignalSetter setter(thread);
     ScopedSignalUnblocker unblocker { SIGABRT, SIGBUS, SIGSEGV }; // NOLINT

     VLOG(signals) << "Handling fault";

 #ifdef TEST_NESTED_SIGNAL
     // Simulate a crash in a handler.
     raise(SIGSEGV);
 #endif

     if (IsInGeneratedCode(info, context, true)) {
       VLOG(signals) << "in generated code, looking for handler";
       for (const auto& handler : generated_code_handlers_) {
         VLOG(signals) << "invoking Action on handler " << handler;
         if (handler->Action(sig, info, context)) {
           // We have handled a signal so it's time to return from the
           // signal handler to the appropriate place.
           return;
         }
       }

       // We hit a signal we didn't handle.  This might be something for which
       // we can give more information about so call all registered handlers to
       // see if it is.
       if (HandleFaultByOtherHandlers(sig, info, context)) {
         return;
       }
     }
   }

   // Set a breakpoint in this function to catch unhandled signals.
   art_sigsegv_fault();

   // Pass this on to the next handler in the chain, or the default if none.
   InvokeUserSignalHandler(sig, info, context);
 }

 void FaultManager::AddHandler(FaultHandler* handler, bool generated_code) {
   DCHECK(initialized_);
   if (generated_code) {
     generated_code_handlers_.push_back(handler);
   } else {
     other_handlers_.push_back(handler);
   }
 }

 void FaultManager::RemoveHandler(FaultHandler* handler) {
   auto it = std::find(generated_code_handlers_.begin(), generated_code_handlers_.end(), handler);
   if (it != generated_code_handlers_.end()) {
     generated_code_handlers_.erase(it);
     return;
   }
   auto it2 = std::find(other_handlers_.begin(), other_handlers_.end(), handler);
   if (it2 != other_handlers_.end()) {
     other_handlers_.erase(it);
     return;
   }
   LOG(FATAL) << "Attempted to remove non existent handler " << handler;
 }

 // This function is called within the signal handler.  It checks that
 // the mutator_lock is held (shared).  No annotalysis is done.
 bool FaultManager::IsInGeneratedCode(siginfo_t* siginfo, void* context, bool check_dex_pc) {
   // We can only be running Java code in the current thread if it
   // is in Runnable state.
   VLOG(signals) << "Checking for generated code";
   Thread* thread = Thread::Current();
   if (thread == nullptr) {
     VLOG(signals) << "no current thread";
     return false;
   }

   ThreadState state = thread->GetState();
   if (state != kRunnable) {
     VLOG(signals) << "not runnable";
     return false;
   }

   // Current thread is runnable.
   // Make sure it has the mutator lock.
   if (!Locks::mutator_lock_->IsSharedHeld(thread)) {
     VLOG(signals) << "no lock";
     return false;
   }

   ArtMethod* method_obj = nullptr;
   uintptr_t return_pc = 0;
   uintptr_t sp = 0;

   // Get the architecture specific method address and return address.  These
   // are in architecture specific files in arch/<arch>/fault_handler_<arch>.
   GetMethodAndReturnPcAndSp(siginfo, context, &method_obj, &return_pc, &sp);

   // If we don't have a potential method, we're outta here.
   VLOG(signals) << "potential method: " << method_obj;
   // TODO: Check linear alloc and image.
   DCHECK_ALIGNED(ArtMethod::Size(kRuntimePointerSize), sizeof(void*))
       << "ArtMethod is not pointer aligned";
   if (method_obj == nullptr || !IsAligned<sizeof(void*)>(method_obj)) {
     VLOG(signals) << "no method";
     return false;
   }

   // Verify that the potential method is indeed a method.
   // TODO: check the GC maps to make sure it's an object.
   // Check that the class pointer inside the object is not null and is aligned.
   // TODO: Method might be not a heap address, and GetClass could fault.
   // No read barrier because method_obj may not be a real object.
   mirror::Class* cls = method_obj->GetDeclaringClassUnchecked<kWithoutReadBarrier>();
   if (cls == nullptr) {
     VLOG(signals) << "not a class";
     return false;
   }
   if (!IsAligned<kObjectAlignment>(cls)) {
     VLOG(signals) << "not aligned";
     return false;
   }


   if (!VerifyClassClass(cls)) {
     VLOG(signals) << "not a class class";
     return false;
   }

   const OatQuickMethodHeader* method_header = method_obj->GetOatQuickMethodHeader(return_pc);

   // We can be certain that this is a method now.  Check if we have a GC map
   // at the return PC address.
   if (true || kIsDebugBuild) {
     VLOG(signals) << "looking for dex pc for return pc " << std::hex << return_pc;
     uint32_t sought_offset = return_pc -
         reinterpret_cast<uintptr_t>(method_header->GetEntryPoint());
     VLOG(signals) << "pc offset: " << std::hex << sought_offset;
   }
   uint32_t dexpc = method_header->ToDexPc(method_obj, return_pc, false);
   VLOG(signals) << "dexpc: " << dexpc;
   return !check_dex_pc || dexpc != DexFile::kDexNoIndex;
 }

 FaultHandler::FaultHandler(FaultManager* manager) : manager_(manager) {
 }

 //
 // Null pointer fault handler
 //
 NullPointerHandler::NullPointerHandler(FaultManager* manager) : FaultHandler(manager) {
   manager_->AddHandler(this, true);
 }

 //
 // Suspension fault handler
 //
 SuspensionHandler::SuspensionHandler(FaultManager* manager) : FaultHandler(manager) {
   manager_->AddHandler(this, true);
 }

 //
 // Stack overflow fault handler
 //
 StackOverflowHandler::StackOverflowHandler(FaultManager* manager) : FaultHandler(manager) {
   manager_->AddHandler(this, true);
 }

 //
 // Stack trace handler, used to help get a stack trace from SIGSEGV inside of compiled code.
 //
 JavaStackTraceHandler::JavaStackTraceHandler(FaultManager* manager) : FaultHandler(manager) {
   manager_->AddHandler(this, false);
 }

 bool JavaStackTraceHandler::Action(int sig ATTRIBUTE_UNUSED, siginfo_t* siginfo, void* context) {
   // Make sure that we are in the generated code, but we may not have a dex pc.
   bool in_generated_code = manager_->IsInGeneratedCode(siginfo, context, false);
   if (in_generated_code) {
     LOG(ERROR) << "Dumping java stack trace for crash in generated code";
     ArtMethod* method = nullptr;
     uintptr_t return_pc = 0;
     uintptr_t sp = 0;
     Thread* self = Thread::Current();

     manager_->GetMethodAndReturnPcAndSp(siginfo, context, &method, &return_pc, &sp);
     // Inside of generated code, sp[0] is the method, so sp is the frame.
     self->SetTopOfStack(reinterpret_cast<ArtMethod**>(sp));
     self->DumpJavaStack(LOG_STREAM(ERROR));
   }

   return false;  // Return false since we want to propagate the fault to the main signal handler.
 }

 }   // namespace art
	/*
	* Copyright (C) 2008 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.
	*/

	#include "fault_handler.h"

	#include <setjmp.h>
	#include <sys/mman.h>
	#include <sys/ucontext.h>

	#include "art_method-inl.h"
	#include "base/stl_util.h"
	#include "mirror/class.h"
	#include "oat_quick_method_header.h"
	#include "sigchain.h"
	#include "thread-inl.h"
	#include "verify_object-inl.h"

	namespace art {
	// Static fault manger object accessed by signal handler.
	FaultManager fault_manager;

	extern "C" __attribute__((visibility("default"))) void art_sigsegv_fault() {
	// Set a breakpoint here to be informed when a SIGSEGV is unhandled by ART.
	VLOG(signals)<< "Caught unknown SIGSEGV in ART fault handler - chaining to next handler.";
	}

	// Signal handler called on SIGSEGV.
	static void art_fault_handler(int sig, siginfo_t* info, void* context) {
	fault_manager.HandleFault(sig, info, context);
	}

	FaultManager::FaultManager() : initialized_(false) {
	sigaction(SIGSEGV, nullptr, &oldaction_);
	}

	FaultManager::~FaultManager() {
	}

	static void SetUpArtAction(struct sigaction* action) {
	action->sa_sigaction = art_fault_handler;
	sigemptyset(&action->sa_mask);
	action->sa_flags = SA_SIGINFO \| SA_ONSTACK;
	#if !defined(__APPLE__) && !defined(__mips__)
	action->sa_restorer = nullptr;
	#endif
	}

	void FaultManager::EnsureArtActionInFrontOfSignalChain() {
	if (initialized_) {
	struct sigaction action;
	SetUpArtAction(&action);
	EnsureFrontOfChain(SIGSEGV, &action);
	} else {
	LOG(WARNING) << "Can't call " << __FUNCTION__ << " due to unitialized fault manager";
	}
	}

	void FaultManager::Init() {
	CHECK(!initialized_);
	struct sigaction action;
	SetUpArtAction(&action);

	// Set our signal handler now.
	int e = sigaction(SIGSEGV, &action, &oldaction_);
	if (e != 0) {
	VLOG(signals) << "Failed to claim SEGV: " << strerror(errno);
	}
	// Make sure our signal handler is called before any user handlers.
	ClaimSignalChain(SIGSEGV, &oldaction_);
	initialized_ = true;
	}

	void FaultManager::Release() {
	if (initialized_) {
	UnclaimSignalChain(SIGSEGV);
	initialized_ = false;
	}
	}

	void FaultManager::Shutdown() {
	if (initialized_) {
	Release();

	// Free all handlers.
	STLDeleteElements(&generated_code_handlers_);
	STLDeleteElements(&other_handlers_);
	}
	}

	bool FaultManager::HandleFaultByOtherHandlers(int sig, siginfo_t* info, void* context) {
	if (other_handlers_.empty()) {
	return false;
	}

	Thread* self = Thread::Current();

	DCHECK(self != nullptr);
	DCHECK(Runtime::Current() != nullptr);
	DCHECK(Runtime::Current()->IsStarted());
	for (const auto& handler : other_handlers_) {
	if (handler->Action(sig, info, context)) {
	return true;
	}
	}
	return false;
	}

	class ScopedSignalUnblocker {
	public:
	explicit ScopedSignalUnblocker(const std::initializer_list<int>& signals) {
	sigset_t new_mask;
	sigemptyset(&new_mask);
	for (int signal : signals) {
	sigaddset(&new_mask, signal);
	}
	if (sigprocmask(SIG_UNBLOCK, &new_mask, &previous_mask_) != 0) {
	PLOG(FATAL) << "failed to unblock signals";
	}
	}

	~ScopedSignalUnblocker() {
	if (sigprocmask(SIG_SETMASK, &previous_mask_, nullptr) != 0) {
	PLOG(FATAL) << "failed to unblock signals";
	}
	}

	private:
	sigset_t previous_mask_;
	};

	class ScopedHandlingSignalSetter {
	public:
	explicit ScopedHandlingSignalSetter(Thread* thread) : thread_(thread) {
	CHECK(!thread->HandlingSignal());
	thread_->SetHandlingSignal(true);
	}

	~ScopedHandlingSignalSetter() {
	CHECK(thread_->HandlingSignal());
	thread_->SetHandlingSignal(false);
	}

	private:
	Thread* thread_;
	};

	void FaultManager::HandleFault(int sig, siginfo_t* info, void* context) {
	// BE CAREFUL ALLOCATING HERE INCLUDING USING LOG(...)
	//
	// If malloc calls abort, it will be holding its lock.
	// If the handler tries to call malloc, it will deadlock.

	// Use a thread local field to track whether we're recursing, and fall back.
	// (e.g.. if one of our handlers crashed)
	Thread* thread = Thread::Current();

	if (thread != nullptr && !thread->HandlingSignal()) {
	// Unblock some signals and set thread->handling_signal_ to true,
	// so that we can catch crashes in our signal handler.
	ScopedHandlingSignalSetter setter(thread);
	ScopedSignalUnblocker unblocker { SIGABRT, SIGBUS, SIGSEGV }; // NOLINT

	VLOG(signals) << "Handling fault";

	#ifdef TEST_NESTED_SIGNAL
	// Simulate a crash in a handler.
	raise(SIGSEGV);
	#endif

	if (IsInGeneratedCode(info, context, true)) {
	VLOG(signals) << "in generated code, looking for handler";
	for (const auto& handler : generated_code_handlers_) {
	VLOG(signals) << "invoking Action on handler " << handler;
	if (handler->Action(sig, info, context)) {
	// We have handled a signal so it's time to return from the
	// signal handler to the appropriate place.
	return;
	}
	}

	// We hit a signal we didn't handle. This might be something for which
	// we can give more information about so call all registered handlers to
	// see if it is.
	if (HandleFaultByOtherHandlers(sig, info, context)) {
	return;
	}
	}
	}

	// Set a breakpoint in this function to catch unhandled signals.
	art_sigsegv_fault();

	// Pass this on to the next handler in the chain, or the default if none.
	InvokeUserSignalHandler(sig, info, context);
	}

	void FaultManager::AddHandler(FaultHandler* handler, bool generated_code) {
	DCHECK(initialized_);
	if (generated_code) {
	generated_code_handlers_.push_back(handler);
	} else {
	other_handlers_.push_back(handler);
	}
	}

	void FaultManager::RemoveHandler(FaultHandler* handler) {
	auto it = std::find(generated_code_handlers_.begin(), generated_code_handlers_.end(), handler);
	if (it != generated_code_handlers_.end()) {
	generated_code_handlers_.erase(it);
	return;
	}
	auto it2 = std::find(other_handlers_.begin(), other_handlers_.end(), handler);
	if (it2 != other_handlers_.end()) {
	other_handlers_.erase(it);
	return;
	}
	LOG(FATAL) << "Attempted to remove non existent handler " << handler;
	}

	// This function is called within the signal handler. It checks that
	// the mutator_lock is held (shared). No annotalysis is done.
	bool FaultManager::IsInGeneratedCode(siginfo_t* siginfo, void* context, bool check_dex_pc) {
	// We can only be running Java code in the current thread if it
	// is in Runnable state.
	VLOG(signals) << "Checking for generated code";
	Thread* thread = Thread::Current();
	if (thread == nullptr) {
	VLOG(signals) << "no current thread";
	return false;
	}

	ThreadState state = thread->GetState();
	if (state != kRunnable) {
	VLOG(signals) << "not runnable";
	return false;
	}

	// Current thread is runnable.
	// Make sure it has the mutator lock.
	if (!Locks::mutator_lock_->IsSharedHeld(thread)) {
	VLOG(signals) << "no lock";
	return false;
	}

	ArtMethod* method_obj = nullptr;
	uintptr_t return_pc = 0;
	uintptr_t sp = 0;

	// Get the architecture specific method address and return address. These
	// are in architecture specific files in arch/<arch>/fault_handler_<arch>.
	GetMethodAndReturnPcAndSp(siginfo, context, &method_obj, &return_pc, &sp);

	// If we don't have a potential method, we're outta here.
	VLOG(signals) << "potential method: " << method_obj;
	// TODO: Check linear alloc and image.
	DCHECK_ALIGNED(ArtMethod::Size(kRuntimePointerSize), sizeof(void*))
	<< "ArtMethod is not pointer aligned";
	if (method_obj == nullptr \|\| !IsAligned<sizeof(void*)>(method_obj)) {
	VLOG(signals) << "no method";
	return false;
	}

	// Verify that the potential method is indeed a method.
	// TODO: check the GC maps to make sure it's an object.
	// Check that the class pointer inside the object is not null and is aligned.
	// TODO: Method might be not a heap address, and GetClass could fault.
	// No read barrier because method_obj may not be a real object.
	mirror::Class* cls = method_obj->GetDeclaringClassUnchecked<kWithoutReadBarrier>();
	if (cls == nullptr) {
	VLOG(signals) << "not a class";
	return false;
	}
	if (!IsAligned<kObjectAlignment>(cls)) {
	VLOG(signals) << "not aligned";
	return false;
	}


	if (!VerifyClassClass(cls)) {
	VLOG(signals) << "not a class class";
	return false;
	}

	const OatQuickMethodHeader* method_header = method_obj->GetOatQuickMethodHeader(return_pc);

	// We can be certain that this is a method now. Check if we have a GC map
	// at the return PC address.
	if (true \|\| kIsDebugBuild) {
	VLOG(signals) << "looking for dex pc for return pc " << std::hex << return_pc;
	uint32_t sought_offset = return_pc -
	reinterpret_cast<uintptr_t>(method_header->GetEntryPoint());
	VLOG(signals) << "pc offset: " << std::hex << sought_offset;
	}
	uint32_t dexpc = method_header->ToDexPc(method_obj, return_pc, false);
	VLOG(signals) << "dexpc: " << dexpc;
	return !check_dex_pc \|\| dexpc != DexFile::kDexNoIndex;
	}

	FaultHandler::FaultHandler(FaultManager* manager) : manager_(manager) {
	}

	//
	// Null pointer fault handler
	//
	NullPointerHandler::NullPointerHandler(FaultManager* manager) : FaultHandler(manager) {
	manager_->AddHandler(this, true);
	}

	//
	// Suspension fault handler
	//
	SuspensionHandler::SuspensionHandler(FaultManager* manager) : FaultHandler(manager) {
	manager_->AddHandler(this, true);
	}

	//
	// Stack overflow fault handler
	//
	StackOverflowHandler::StackOverflowHandler(FaultManager* manager) : FaultHandler(manager) {
	manager_->AddHandler(this, true);
	}

	//
	// Stack trace handler, used to help get a stack trace from SIGSEGV inside of compiled code.
	//
	JavaStackTraceHandler::JavaStackTraceHandler(FaultManager* manager) : FaultHandler(manager) {
	manager_->AddHandler(this, false);
	}

	bool JavaStackTraceHandler::Action(int sig ATTRIBUTE_UNUSED, siginfo_t* siginfo, void* context) {
	// Make sure that we are in the generated code, but we may not have a dex pc.
	bool in_generated_code = manager_->IsInGeneratedCode(siginfo, context, false);
	if (in_generated_code) {
	LOG(ERROR) << "Dumping java stack trace for crash in generated code";
	ArtMethod* method = nullptr;
	uintptr_t return_pc = 0;
	uintptr_t sp = 0;
	Thread* self = Thread::Current();

	manager_->GetMethodAndReturnPcAndSp(siginfo, context, &method, &return_pc, &sp);
	// Inside of generated code, sp[0] is the method, so sp is the frame.
	self->SetTopOfStack(reinterpret_cast<ArtMethod**>(sp));
	self->DumpJavaStack(LOG_STREAM(ERROR));
	}

	return false; // Return false since we want to propagate the fault to the main signal handler.
	}

	} // namespace art