Added conditional breakpoints to the debugger GUI (breakpoints widget + context menu additions)

Co-authored-by: AdamR05 <215697996+AdamR05@users.noreply.github.com>

Author: 3rdit

api/debuggercontroller.cpp

@@ -731,6 +731,7 @@ std::vector<DebugBreakpoint> DebuggerController::GetBreakpoints()
 		bp.offset = breakpoints[i].offset;
 		bp.address = breakpoints[i].address;
 		bp.enabled = breakpoints[i].enabled;
+		bp.condition = breakpoints[i].condition ? breakpoints[i].condition : "";
 		result[i] = bp;
 	}
 

ui/breakpointswidget.cpp

@@ -23,6 +23,7 @@ limitations under the License.
 #include <QStringList>
 #include <algorithm>
 #include <QMouseEvent>
+#include <QInputDialog>
 #include "breakpointswidget.h"
 #include "ui.h"
 #include "menus.h"
@@ -32,13 +33,14 @@ using namespace BinaryNinjaDebuggerAPI;
 using namespace BinaryNinja;
 using namespace std;
 
-BreakpointItem::BreakpointItem(bool enabled, const ModuleNameAndOffset location, uint64_t address) :
-	m_enabled(enabled), m_location(location), m_address(address)
+BreakpointItem::BreakpointItem(bool enabled, const ModuleNameAndOffset location, uint64_t address, const std::string& condition) :
+	m_enabled(enabled), m_location(location), m_address(address), m_condition(condition)
 {}
 
 
 bool BreakpointItem::operator==(const BreakpointItem& other) const
 {
+	// Condition is not part of identity - same location = same breakpoint
 	return (m_enabled == other.enabled()) && (m_location == other.location()) && (m_address == other.address());
 }
 
@@ -100,7 +102,7 @@ QVariant DebugBreakpointsListModel::data(const QModelIndex& index, int role) con
 	if (!item)
 		return QVariant();
 
-	if ((role != Qt::DisplayRole) && (role != Qt::SizeHintRole))
+	if ((role != Qt::DisplayRole) && (role != Qt::SizeHintRole) && (role != Qt::ToolTipRole))
 		return QVariant();
 
 	switch (index.column())
@@ -138,6 +140,18 @@ QVariant DebugBreakpointsListModel::data(const QModelIndex& index, int role) con
 
 		return QVariant(text);
 	}
+	case DebugBreakpointsListModel::ConditionColumn:
+	{
+		QString condition = QString::fromStdString(item->condition());
+
+		if (role == Qt::ToolTipRole && !condition.isEmpty())
+			return QVariant(condition);
+
+		if (role == Qt::SizeHintRole)
+			return QVariant((qulonglong)condition.size());
+
+		return QVariant(condition);
+	}
 	}
 	return QVariant();
 }
@@ -159,6 +173,8 @@ QVariant DebugBreakpointsListModel::headerData(int column, Qt::Orientation orien
 		return "Location";
 	case DebugBreakpointsListModel::AddressColumn:
 		return "Remote Address";
+	case DebugBreakpointsListModel::ConditionColumn:
+		return "Condition";
 	}
 	return QVariant();
 }
@@ -207,6 +223,17 @@ void DebugBreakpointsItemDelegate::paint(
 		painter->drawText(textRect, data.toString());
 		break;
 	}
+	case DebugBreakpointsListModel::ConditionColumn:
+	{
+		painter->setFont(m_font);
+		painter->setPen(option.palette.color(QPalette::WindowText).rgba());
+
+		QString text = data.toString();
+		QFontMetrics metrics(m_font);
+		QString elidedText = metrics.elidedText(text, Qt::ElideRight, textRect.width());
+		painter->drawText(textRect, elidedText);
+		break;
+	}
 	default:
 		break;
 	}
@@ -298,6 +325,15 @@ DebugBreakpointsWidget::DebugBreakpointsWidget(ViewFrame* view, BinaryViewRef da
 	m_actionHandler.bindAction(
 		toggleEnabledActionName, UIAction([&]() { toggleSelected(); }, [&]() { return selectionNotEmpty(); }));
 
+	QString editConditionActionName = QString::fromStdString("Edit Condition...");
+	UIAction::registerAction(editConditionActionName);
+	m_menu->addAction(editConditionActionName, "Options", MENU_ORDER_NORMAL);
+	m_actionHandler.bindAction(
+		editConditionActionName, UIAction([&]() { editCondition(); }, [&]() {
+			QModelIndexList sel = selectionModel()->selectedRows();
+			return sel.size() == 1;
+		}));
+
 	QString enableAllActionName = QString::fromStdString("Enable All Breakpoints");
 	UIAction::registerAction(enableAllActionName);
 	m_menu->addAction(enableAllActionName, "Options", MENU_ORDER_NORMAL);
@@ -510,7 +546,7 @@ void DebugBreakpointsWidget::soloSelected()
 
 	// Get the selected breakpoint location
 	BreakpointItem selectedBp = m_model->getRow(sel[0].row());
-	
+
 	// Disable all breakpoints first
 	std::vector<DebugBreakpoint> breakpoints = m_controller->GetBreakpoints();
 	for (const DebugBreakpoint& bp : breakpoints)
@@ -520,12 +556,34 @@ void DebugBreakpointsWidget::soloSelected()
 		info.offset = bp.offset;
 		m_controller->DisableBreakpoint(info);
 	}
-	
+
 	// Enable the selected breakpoint
 	m_controller->EnableBreakpoint(selectedBp.location());
 }
 
 
+void DebugBreakpointsWidget::editCondition()
+{
+	QModelIndexList sel = selectionModel()->selectedRows();
+	if (sel.size() != 1)
+		return;
+
+	BreakpointItem bp = m_model->getRow(sel[0].row());
+	std::string currentCondition = m_controller->GetBreakpointCondition(bp.location());
+
+	bool ok;
+	QString newCondition = QInputDialog::getText(
+		this, "Edit Condition", "Condition (e.g., $rax == 0x1234):",
+		QLineEdit::Normal, QString::fromStdString(currentCondition), &ok);
+
+	if (ok)
+	{
+		m_controller->SetBreakpointCondition(bp.location(), newCondition.trimmed().toStdString());
+		updateContent();
+	}
+}
+
+
 void DebugBreakpointsWidget::remove()
 {
 	QModelIndexList sel = selectionModel()->selectedRows();
@@ -554,12 +612,13 @@ void DebugBreakpointsWidget::updateContent()
 		ModuleNameAndOffset info;
 		info.module = bp.module;
 		info.offset = bp.offset;
-		bps.emplace_back(bp.enabled, info, bp.address);
+		bps.emplace_back(bp.enabled, info, bp.address, bp.condition);
 	}
 
 	m_model->updateRows(bps);
 
 	resizeColumnToContents(DebugBreakpointsListModel::EnabledColumn);
 	resizeColumnToContents(DebugBreakpointsListModel::LocationColumn);
 	resizeColumnToContents(DebugBreakpointsListModel::AddressColumn);
+	resizeColumnToContents(DebugBreakpointsListModel::ConditionColumn);
 }

ui/breakpointswidget.h

@@ -39,12 +39,14 @@ class BreakpointItem
 	bool m_enabled;
 	ModuleNameAndOffset m_location;
 	uint64_t m_address;
+	std::string m_condition;
 
 public:
-	BreakpointItem(bool enabled, const ModuleNameAndOffset location, uint64_t remoteAddress);
+	BreakpointItem(bool enabled, const ModuleNameAndOffset location, uint64_t remoteAddress, const std::string& condition = "");
 	bool enabled() const { return m_enabled; }
 	ModuleNameAndOffset location() const { return m_location; }
 	uint64_t address() const { return m_address; }
+	std::string condition() const { return m_condition; }
 	bool operator==(const BreakpointItem& other) const;
 	bool operator!=(const BreakpointItem& other) const;
 	bool operator<(const BreakpointItem& other) const;
@@ -68,6 +70,7 @@ class DebugBreakpointsListModel : public QAbstractTableModel
 		EnabledColumn,
 		LocationColumn,
 		AddressColumn,
+		ConditionColumn,
 	};
 
 	DebugBreakpointsListModel(QWidget* parent, ViewFrame* view);
@@ -83,7 +86,7 @@ class DebugBreakpointsListModel : public QAbstractTableModel
 	virtual int columnCount(const QModelIndex& parent = QModelIndex()) const override
 	{
 		(void)parent;
-		return 3;
+		return 4;
 	}
 	BreakpointItem getRow(int row) const;
 	virtual QVariant data(const QModelIndex& i, int role) const override;
@@ -153,6 +156,7 @@ private slots:
 	void enableAll();
 	void disableAll();
 	void soloSelected();
+	void editCondition();
 
 public slots:
 	void updateContent();

ui/ui.cpp

@@ -118,6 +118,36 @@ static void BreakpointToggleCallback(BinaryView* view, uint64_t addr)
 	}
 }
 
+static void BreakpointEditConditionCallback(BinaryView* view, uint64_t addr, UIContext* context)
+{
+	auto controller = DebuggerController::GetController(view);
+	if (!controller)
+		return;
+
+	const bool isAbsoluteAddress = controller->IsConnected();
+	const ModuleNameAndOffset relativeAddr = {
+		controller->GetInputFile(),
+		addr - controller->GetViewFileSegmentsStart()
+	};
+
+	const std::string currentCondition = isAbsoluteAddress
+		? controller->GetBreakpointCondition(addr)
+		: controller->GetBreakpointCondition(relativeAddr);
+
+	bool ok;
+	QString newCondition = QInputDialog::getText(
+		context->mainWindow(), "Edit Condition", "Condition (e.g., $rax == 0x1234):",
+		QLineEdit::Normal, QString::fromStdString(currentCondition), &ok);
+
+	if (ok)
+	{
+		if (isAbsoluteAddress)
+			controller->SetBreakpointCondition(addr, newCondition.trimmed().toStdString());
+		else
+			controller->SetBreakpointCondition(relativeAddr, newCondition.trimmed().toStdString());
+	}
+}
+
 static void JumpToIPCallback(BinaryView* view, UIContext* context)
 {
 	auto controller = DebuggerController::GetController(view);
@@ -927,6 +957,24 @@ void GlobalDebuggerUI::SetupMenu(UIContext* context)
 			}));
 	debuggerMenu->addAction("Solo Breakpoint", "Breakpoint");
 
+	UIAction::registerAction("Edit Condition...");
+	context->globalActions()->bindAction("Edit Condition...",
+		UIAction(
+			[=](const UIActionContext& ctxt) {
+				if (!ctxt.binaryView || !ctxt.context)
+					return;
+				auto controller = DebuggerController::GetController(ctxt.binaryView);
+				if (!controller)
+					return;
+
+				BreakpointEditConditionCallback(ctxt.binaryView, ctxt.address, ctxt.context);
+			},
+			[=](const UIActionContext& ctxt) {
+				auto [hasBreakpoint, isEnabled] = getBreakpointEnabledState(ctxt.binaryView, ctxt.address);
+				return ctxt.binaryView && hasBreakpoint;
+			}));
+	debuggerMenu->addAction("Edit Condition...", "Breakpoint");
+
 	UIAction::registerAction("Connect to Debug Server");
 	context->globalActions()->bindAction("Connect to Debug Server",
 		UIAction(

ui/uinotification.cpp

@@ -178,6 +178,7 @@ void NotificationListener::OnContextMenuCreated(UIContext *context, View* view,
 	menu.addAction("Debugger", "Toggle Breakpoint", "Breakpoint");
 	menu.addAction("Debugger", "Enable Breakpoint", "Breakpoint");
 	menu.addAction("Debugger", "Solo Breakpoint", "Breakpoint");
+	menu.addAction("Debugger", "Edit Condition...", "Breakpoint");
 	menu.addAction("Debugger", "Launch", "Control");
 	menu.addAction("Debugger", "Pause", "Control");
 	menu.addAction("Debugger", "Restart", "Control");