mirror/ghidra
1
0
Fork 0
mirror of https://github.com/NationalSecurityAgency/ghidra.git synced 2026-07-30 07:18:37 -09:00
Code Issues Packages Projects Releases Wiki Activity

Merge remote-tracking branch

Browse Source 
'origin/GP-7091_Dan_fixDocumentation--SQUASHED' (Closes #9366)
This commit is contained in:
Ryan Kurtz
2026-07-28 05:11:36 -04:00
parent e07115416e 67a974b70c
commit 74aa934e3b
9 changed files with 50 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Ghidra/Features/Decompiler/src/main/doc/pcoderef.xml
View File

@@ -3501,7 +3501,7 @@ still have normal data-flow and can be manipulated symbolically.
</tr>
<tr>
<td/>
<td colspan="2"><code>output = cpool(input0,intput1);</code></td>
<td colspan="2"><code>output = cpool(input0,input1);</code></td>
</tr>
</tfoot>
</table>

2
Ghidra/Features/Decompiler/src/main/doc/sleigh.xml
View File

@@ -3416,7 +3416,7 @@ scope. The macro can refer to these and any global specific symbol.
<programlisting>
macro resultflags(op) {
zeroflag = (op == 0);
signflag = (op1 s&lt; 0);
signflag = (op s&lt; 0);
}
:add r1,r2 is opcode=0xba &amp; r1 &amp; r2 { r1 = r1 + r2; resultflags(r1); }

67
GhidraDocs/GhidraClass/Debugger/B3-Scripting.html
View File

@@ -467,42 +467,35 @@ check the program counter:</p>
class="sourceCode numberSource java numberLines"><code class="sourceCode java"><span id="cb10-1"><a href="#cb10-1"></a><span class="cf">while</span> <span class="op">(</span><span class="kw">true</span><span class="op">)</span> <span class="op">{</span></span>
<span id="cb10-2"><a href="#cb10-2"></a> monitor<span class="op">.</span><span class="fu">checkCancelled</span><span class="op">();</span></span>
<span id="cb10-3"><a href="#cb10-3"></a></span>
<span id="cb10-4"><a href="#cb10-4"></a> TargetExecutionState execState <span class="op">=</span> <span class="fu">getExecutionState</span><span class="op">(</span>trace<span class="op">);</span></span>
<span id="cb10-4"><a href="#cb10-4"></a> TraceExecutionState execState <span class="op">=</span> <span class="fu">getExecutionState</span><span class="op">(</span>trace<span class="op">);</span></span>
<span id="cb10-5"><a href="#cb10-5"></a> <span class="cf">switch</span> <span class="op">(</span>execState<span class="op">)</span> <span class="op">{</span></span>
<span id="cb10-6"><a href="#cb10-6"></a> <span class="cf">case</span> STOPPED<span class="op">:</span></span>
<span id="cb10-7"><a href="#cb10-7"></a> <span class="fu">resume</span><span class="op">();</span></span>
<span id="cb10-8"><a href="#cb10-8"></a> <span class="cf">break</span><span class="op">;</span></span>
<span id="cb10-9"><a href="#cb10-9"></a> <span class="cf">case</span> TERMINATED<span class="op">:</span></span>
<span id="cb10-10"><a href="#cb10-10"></a> <span class="cf">case</span> <span class="bu">INACTIVE</span><span class="op">:</span></span>
<span id="cb10-11"><a href="#cb10-11"></a> <span class="cf">throw</span> <span class="kw">new</span> <span class="bu">AssertionError</span><span class="op">(</span><span class="st">&quot;Target terminated&quot;</span><span class="op">);</span></span>
<span id="cb10-12"><a href="#cb10-12"></a> <span class="cf">case</span> ALIVE<span class="op">:</span></span>
<span id="cb10-13"><a href="#cb10-13"></a> <span class="fu">println</span><span class="op">(</span></span>
<span id="cb10-14"><a href="#cb10-14"></a> <span class="st">&quot;I don&#39;t know whether or not the target is running. Please make it RUNNING.&quot;</span><span class="op">);</span></span>
<span id="cb10-15"><a href="#cb10-15"></a> <span class="cf">break</span><span class="op">;</span></span>
<span id="cb10-16"><a href="#cb10-16"></a> <span class="cf">case</span> RUNNING<span class="op">:</span></span>
<span id="cb10-17"><a href="#cb10-17"></a> <span class="co">/**</span></span>
<span id="cb10-18"><a href="#cb10-18"></a> <span class="co">*</span> Probably timed out waiting for break<span class="co">. </span>That<span class="co">&#39;</span>s fine<span class="co">.</span> Give the player time to</span>
<span id="cb10-19"><a href="#cb10-19"></a> <span class="co">*</span> win<span class="co">.</span></span>
<span id="cb10-20"><a href="#cb10-20"></a> <span class="co">*/</span></span>
<span id="cb10-21"><a href="#cb10-21"></a> <span class="cf">break</span><span class="op">;</span></span>
<span id="cb10-22"><a href="#cb10-22"></a> <span class="kw">default</span><span class="op">:</span></span>
<span id="cb10-23"><a href="#cb10-23"></a> <span class="cf">throw</span> <span class="kw">new</span> <span class="bu">AssertionError</span><span class="op">(</span><span class="st">&quot;Unrecognized state: &quot;</span> <span class="op">+</span> execState<span class="op">);</span></span>
<span id="cb10-24"><a href="#cb10-24"></a> <span class="op">}</span></span>
<span id="cb10-25"><a href="#cb10-25"></a> <span class="cf">try</span> <span class="op">{</span></span>
<span id="cb10-26"><a href="#cb10-26"></a> monitor<span class="op">.</span><span class="fu">setMessage</span><span class="op">(</span><span class="st">&quot;Waiting for player to win&quot;</span><span class="op">);</span></span>
<span id="cb10-27"><a href="#cb10-27"></a> <span class="fu">waitForBreak</span><span class="op">(</span><span class="dv">1</span><span class="op">,</span> <span class="bu">TimeUnit</span><span class="op">.</span><span class="fu">SECONDS</span><span class="op">);</span></span>
<span id="cb10-28"><a href="#cb10-28"></a> <span class="op">}</span></span>
<span id="cb10-29"><a href="#cb10-29"></a> <span class="cf">catch</span> <span class="op">(</span><span class="bu">TimeoutException</span> e<span class="op">)</span> <span class="op">{</span></span>
<span id="cb10-30"><a href="#cb10-30"></a> <span class="co">// Give the player time to win.</span></span>
<span id="cb10-31"><a href="#cb10-31"></a> <span class="cf">continue</span><span class="op">;</span></span>
<span id="cb10-32"><a href="#cb10-32"></a> <span class="op">}</span></span>
<span id="cb10-33"><a href="#cb10-33"></a> <span class="fu">flushAsyncPipelines</span><span class="op">(</span>trace<span class="op">);</span></span>
<span id="cb10-34"><a href="#cb10-34"></a> Address pc <span class="op">=</span> <span class="fu">getProgramCounter</span><span class="op">();</span></span>
<span id="cb10-35"><a href="#cb10-35"></a> <span class="fu">println</span><span class="op">(</span><span class="st">&quot;STOPPED at pc = &quot;</span> <span class="op">+</span> pc<span class="op">);</span></span>
<span id="cb10-36"><a href="#cb10-36"></a> <span class="cf">if</span> <span class="op">(</span>resetDyn<span class="op">.</span><span class="fu">equals</span><span class="op">(</span>pc<span class="op">))</span> <span class="op">{</span></span>
<span id="cb10-37"><a href="#cb10-37"></a> <span class="cf">break</span><span class="op">;</span></span>
<span id="cb10-38"><a href="#cb10-38"></a> <span class="op">}</span></span>
<span id="cb10-39"><a href="#cb10-39"></a><span class="op">}</span></span></code></pre></div>
<span id="cb10-6"><a href="#cb10-6"></a> <span class="cf">case</span> STOPPED <span class="op">-&gt;</span> <span class="fu">resume</span><span class="op">();</span></span>
<span id="cb10-7"><a href="#cb10-7"></a> <span class="cf">case</span> TERMINATED<span class="op">,</span> <span class="bu">INACTIVE</span> <span class="op">-&gt;</span> <span class="cf">throw</span> <span class="kw">new</span> <span class="bu">AssertionError</span><span class="op">(</span><span class="st">&quot;Target terminated&quot;</span><span class="op">);</span></span>
<span id="cb10-8"><a href="#cb10-8"></a> <span class="cf">case</span> ALIVE <span class="op">-&gt;</span> <span class="fu">println</span><span class="op">(</span></span>
<span id="cb10-9"><a href="#cb10-9"></a> <span class="st">&quot;I don&#39;t know whether or not the target is running. Please make it RUNNING.&quot;</span><span class="op">);</span></span>
<span id="cb10-10"><a href="#cb10-10"></a> <span class="cf">case</span> RUNNING <span class="op">-&gt;</span> <span class="op">{</span></span>
<span id="cb10-11"><a href="#cb10-11"></a> <span class="co">/**</span></span>
<span id="cb10-12"><a href="#cb10-12"></a> <span class="co">*</span> Probably timed out waiting for break<span class="co">. </span>That<span class="co">&#39;</span>s fine<span class="co">.</span> Give the player time to</span>
<span id="cb10-13"><a href="#cb10-13"></a> <span class="co">*</span> win<span class="co">.</span></span>
<span id="cb10-14"><a href="#cb10-14"></a> <span class="co">*/</span></span>
<span id="cb10-15"><a href="#cb10-15"></a> <span class="op">}</span></span>
<span id="cb10-16"><a href="#cb10-16"></a> <span class="kw">default</span> <span class="op">-&gt;</span> <span class="cf">throw</span> <span class="kw">new</span> <span class="bu">AssertionError</span><span class="op">(</span><span class="st">&quot;Unrecognized state: &quot;</span> <span class="op">+</span> execState<span class="op">);</span></span>
<span id="cb10-17"><a href="#cb10-17"></a> <span class="op">}</span></span>
<span id="cb10-18"><a href="#cb10-18"></a> <span class="cf">try</span> <span class="op">{</span></span>
<span id="cb10-19"><a href="#cb10-19"></a> monitor<span class="op">.</span><span class="fu">setMessage</span><span class="op">(</span><span class="st">&quot;Waiting for player to win&quot;</span><span class="op">);</span></span>
<span id="cb10-20"><a href="#cb10-20"></a> <span class="fu">waitForBreak</span><span class="op">(</span><span class="dv">1</span><span class="op">,</span> <span class="bu">TimeUnit</span><span class="op">.</span><span class="fu">SECONDS</span><span class="op">);</span></span>
<span id="cb10-21"><a href="#cb10-21"></a> <span class="op">}</span></span>
<span id="cb10-22"><a href="#cb10-22"></a> <span class="cf">catch</span> <span class="op">(</span><span class="bu">TimeoutException</span> e<span class="op">)</span> <span class="op">{</span></span>
<span id="cb10-23"><a href="#cb10-23"></a> <span class="co">// Give the player time to win.</span></span>
<span id="cb10-24"><a href="#cb10-24"></a> <span class="cf">continue</span><span class="op">;</span></span>
<span id="cb10-25"><a href="#cb10-25"></a> <span class="op">}</span></span>
<span id="cb10-26"><a href="#cb10-26"></a> <span class="fu">flushAsyncPipelines</span><span class="op">(</span>trace<span class="op">);</span></span>
<span id="cb10-27"><a href="#cb10-27"></a> Address pc <span class="op">=</span> <span class="fu">getProgramCounter</span><span class="op">();</span></span>
<span id="cb10-28"><a href="#cb10-28"></a> <span class="fu">println</span><span class="op">(</span><span class="st">&quot;STOPPED at pc = &quot;</span> <span class="op">+</span> pc<span class="op">);</span></span>
<span id="cb10-29"><a href="#cb10-29"></a> <span class="cf">if</span> <span class="op">(</span>resetDyn<span class="op">.</span><span class="fu">equals</span><span class="op">(</span>pc<span class="op">))</span> <span class="op">{</span></span>
<span id="cb10-30"><a href="#cb10-30"></a> <span class="cf">break</span><span class="op">;</span></span>
<span id="cb10-31"><a href="#cb10-31"></a> <span class="op">}</span></span>
<span id="cb10-32"><a href="#cb10-32"></a><span class="op">}</span></span></code></pre></div>
<p>The “center” of this loop is a call to <code>waitForBreak()</code> on
line 27. This is the simplest primitive for waiting on the target to
meet any condition. Because we expect the user to take more than a
@@ -511,9 +504,7 @@ keep waiting. Using a timeout of 1 second ensures we can terminate
promptly should the user cancel the script.</p>
<p>Before waiting, we need to make sure the target is running. Because
we could repeat the loop while the target is already running, we should
only call <code>resume()</code> if the target is stopped. There are
utility methods on <code>TargetExecutionState</code> like
<code>isRunning()</code>, which you might prefer to use. Here, we
only call <code>resume()</code> if the target is stopped. Here, we
exhaustively handle every kind of state using a switch statement, which
does make the code a bit verbose.</p>
<p>When the target does break, we first allow the UI to finish

24
GhidraDocs/GhidraClass/Debugger/B3-Scripting.md
View File

@@ -293,26 +293,19 @@ We do not need to be precise in this check; it suffices to check the program cou
while (true) {
monitor.checkCancelled();
TargetExecutionState execState = getExecutionState(trace);
TraceExecutionState execState = getExecutionState(trace);
switch (execState) {
case STOPPED:
resume();
break;
case TERMINATED:
case INACTIVE:
throw new AssertionError("Target terminated");
case ALIVE:
println(
"I don't know whether or not the target is running. Please make it RUNNING.");
break;
case RUNNING:
case STOPPED -> resume();
case TERMINATED, INACTIVE -> throw new AssertionError("Target terminated");
case ALIVE -> println(
"I don't know whether or not the target is running. Please make it RUNNING.");
case RUNNING -> {
/**
* Probably timed out waiting for break. That's fine. Give the player time to
* win.
*/
break;
default:
throw new AssertionError("Unrecognized state: " + execState);
}
default -> throw new AssertionError("Unrecognized state: " + execState);
}
try {
monitor.setMessage("Waiting for player to win");
@@ -338,7 +331,6 @@ Using a timeout of 1 second ensures we can terminate promptly should the user ca
Before waiting, we need to make sure the target is running.
Because we could repeat the loop while the target is already running, we should only call `resume()` if the target is stopped.
There are utility methods on `TargetExecutionState` like `isRunning()`, which you might prefer to use.
Here, we exhaustively handle every kind of state using a switch statement, which does make the code a bit verbose.
When the target does break, we first allow the UI to finish interrogating the target.

2
GhidraDocs/GhidraClass/Debugger/B4-Modeling.html
View File

@@ -585,7 +585,7 @@ class="sourceCode numberSource java numberLines"><code class="sourceCode java"><
to complete the model. There is some odd nuance in the naming of p-code
operations, so do read the documentation carefully. If you are not
entirely certain what an operation does, take a look at <a
href="../../../Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/pcode/opbehavior/OpBehaviorFactory.java">OpBehaviorFactory</a>.
href="../../../Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/opbehavior/OpBehaviorFactory.java">OpBehaviorFactory</a>.
You can also examine the concrete implementation on byte arrays <a
href="../../../Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/exec/BytesPcodeArithmetic.java">BytesPcodeArithmetic</a>.</p>
</section>

2
GhidraDocs/GhidraClass/Debugger/B4-Modeling.md
View File

@@ -387,7 +387,7 @@ public class ModelingScript extends GhidraScript {
It should be fairly apparent how you could add more expression types to complete the model.
There is some odd nuance in the naming of p-code operations, so do read the documentation carefully.
If you are not entirely certain what an operation does, take a look at [OpBehaviorFactory](../../../Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/pcode/opbehavior/OpBehaviorFactory.java).
If you are not entirely certain what an operation does, take a look at [OpBehaviorFactory](../../../Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/opbehavior/OpBehaviorFactory.java).
You can also examine the concrete implementation on byte arrays [BytesPcodeArithmetic](../../../Ghidra/Framework/Emulation/src/main/java/ghidra/pcode/exec/BytesPcodeArithmetic.java).
### Mapping the Model

21
GhidraDocs/GhidraClass/Debugger/ghidra_scripts/ZeroTimerScript.java
View File

@@ -91,24 +91,17 @@ public class ZeroTimerScript extends GhidraScript implements FlatDebuggerAPI {
TraceExecutionState execState = getExecutionState(trace);
switch (execState) {
case STOPPED:
resume();
break;
case TERMINATED:
case INACTIVE:
throw new AssertionError("Target terminated");
case ALIVE:
println(
"I don't know whether or not the target is running. Please make it RUNNING.");
break;
case RUNNING:
case STOPPED -> resume();
case TERMINATED, INACTIVE -> throw new AssertionError("Target terminated");
case ALIVE -> println(
"I don't know whether or not the target is running. Please make it RUNNING.");
case RUNNING -> {
/**
* Probably timed out waiting for break. That's fine. Give the player time to
* win.
*/
break;
default:
throw new AssertionError("Unrecognized state: " + execState);
}
default -> throw new AssertionError("Unrecognized state: " + execState);
}
try {
monitor.setMessage("Waiting for player to win");

2
GhidraDocs/languages/html/pseudo-ops.html
View File

@@ -149,7 +149,7 @@ still have normal data-flow and can be manipulated symbolically.
</tr>
<tr>
<td></td>
<td colspan="2"><code class="code">output = cpool(input0,intput1);</code></td>
<td colspan="2"><code class="code">output = cpool(input0,input1);</code></td>
</tr>
</tfoot>
</table>

2
GhidraDocs/languages/html/sleigh_constructors.html
View File

@@ -2138,7 +2138,7 @@ scope. The macro can refer to these and any global specific symbol.
<div class="informalexample"><pre class="programlisting">
macro resultflags(op) {
zeroflag = (op == 0);
signflag = (op1 s&lt; 0);
signflag = (op s&lt; 0);
}
:add r1,r2 is opcode=0xba &amp; r1 &amp; r2 { r1 = r1 + r2; resultflags(r1); }