Please use GitHub pull requests for new patches. Avoid migrating existing patches. Phabricator shutdown timeline

Differential D144812 Diff 504472 mlir/lib/Debug/ExecutionContext.cpp

Changeset View

Standalone View

mlir/lib/Debug/ExecutionContext.cpp

This file was added.

				//===- ExecutionContext.cpp - Debug Execution Context Support -------------===//
				//
				// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
				// See https://llvm.org/LICENSE.txt for license information.
				// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
				//
				//===----------------------------------------------------------------------===//

				#include "mlir/Debug/ExecutionContext.h"

				#include "llvm/ADT/ScopeExit.h"

				#include <cstddef>

				using namespace mlir;
				using namespace mlir::tracing;

				//===----------------------------------------------------------------------===//
				// ExecutionContext
				//===----------------------------------------------------------------------===//

				static const thread_local ActionActiveStack *actionStack = nullptr;

				void ExecutionContext::setCallback(CallbackTy callback) {
				onBreakpointControlExecutionCallback = callback;
				}

				void ExecutionContext::registerObserver(Observer *observer) {
				observers.push_back(observer);
				}

				void ExecutionContext::operator()(llvm::function_ref<void()> transform,
				const Action &action) {
				// Update the top of the stack with the current action.
				int depth = 0;
				if (actionStack)
				depth = actionStack->getDepth() + 1;
				ActionActiveStack info{actionStack, action, depth};
				actionStack = &info;
				auto raii = llvm::make_scope_exit([&]() { actionStack = info.getParent(); });
				Breakpoint *breakpoint = nullptr;
				TykerUnsubmitted Not Done Reply Inline Actions shouldn't the logic above be part `ActionActiveStack`'s ctor/dtor ? `ActionActiveStack::ActionActiveStack` would only take an action. the rest would automatically handled. Tyker: shouldn't the logic above be part `ActionActiveStack`'s ctor/dtor ? `ActionActiveStack…
				mehdi_aminiAuthorUnsubmitted Done Reply Inline Actions Are you talking about `actionStack`? It's not clear to me how to handle this in the `ActionActiveStack`'s ctor actually, unless I'd add an extra member. I'd rather not make the class aware of the global variable just now. mehdi_amini: Are you talking about `actionStack`? It's not clear to me how to handle this in the…

				// Invoke the callback here and handles control requests here.
				auto handleUserInput = [&]() -> bool {
				if (!onBreakpointControlExecutionCallback)
				return true;
				auto todoNext = onBreakpointControlExecutionCallback(actionStack);
				switch (todoNext) {
				case ExecutionContext::Apply:
				depthToBreak = std::nullopt;
				return true;
				case ExecutionContext::Skip:
				depthToBreak = std::nullopt;
				return false;
				case ExecutionContext::Step:
				depthToBreak = depth + 1;
				return true;
				case ExecutionContext::Next:
				depthToBreak = depth;
				return true;
				case ExecutionContext::Finish:
				depthToBreak = depth - 1;
				return true;
				}
				llvm::report_fatal_error("Unknown control request");
				};

				// Try to find a breakpoint that would hit on this action.
				// Right now there is no way to collect them all, we stop at the first one.
				for (auto *breakpointManager : breakpoints) {
				breakpoint = breakpointManager->match(action);
				if (breakpoint)
				break;
				}

				bool shouldExecuteAction = true;
				// If we have a breakpoint, or if `depthToBreak` was previously set and the
				// current depth matches, we invoke the user-provided callback.
				if (breakpoint \|\| (depthToBreak && depth <= depthToBreak))
				shouldExecuteAction = handleUserInput();

				// Notify the observers about the current action.
				for (auto *observer : observers)
				observer->beforeExecute(actionStack, breakpoint, shouldExecuteAction);

				rriddleUnsubmitted Done Reply Inline Actions Can you remind me what manages the thread safety of all of this? rriddle: Can you remind me what manages the thread safety of all of this?
				mehdi_aminiAuthorUnsubmitted Done Reply Inline Actions Good point, I added documentation in the header about thread safety aspects of these APIs. mehdi_amini: Good point, I added documentation in the header about thread safety aspects of these APIs.
				if (shouldExecuteAction) {
				// Execute the action here.
				transform();
				rriddleUnsubmitted Done Reply Inline Actions Can you drop this newline? rriddle: Can you drop this newline?

				// Notify the observers about completion of the action.
				for (auto *observer : observers)
				observer->afterExecute(actionStack);
				}

				if (depthToBreak && depth <= depthToBreak)
				handleUserInput();
				}
				rriddleUnsubmitted Done Reply Inline Actions Missing newline here. rriddle: Missing newline here.