From 021fb21871cca01bf4b27bd9d9731c5b8836b651 Mon Sep 17 00:00:00 2001
From: TSR Berry <20988865+TSRBerry@users.noreply.github.com>
Date: Sun, 21 May 2023 22:22:49 +0200
Subject: [PATCH] Upgrade to Ghidra 10.3

---
 build.gradle                                  |  1 +
 gradlew                                       |  0
 .../adubbz/nx/analyzer/ipc/IPCEmulator.java   | 20 +++----
 .../java/adubbz/nx/loader/SwitchLoader.java   | 21 ++++----
 .../nx/loader/common/NXProgramBuilder.java    | 54 +++++++++----------
 5 files changed, 43 insertions(+), 53 deletions(-)
 mode change 100644 => 100755 gradlew

diff --git a/build.gradle b/build.gradle
index 155ab0f..bb3b2f7 100644
--- a/build.gradle
+++ b/build.gradle
@@ -60,6 +60,7 @@ configurations {
 
 dependencies {
     api fileTree(dir: ghidraInstallDir + '/Ghidra/Processors', include: "**/*.jar")
+    implementation 'commons-primitives:commons-primitives:1.0'
     localDeps group: 'org.lz4', name: 'lz4-java', version: '1.5.1'
     api configurations.localDeps
 }
diff --git a/gradlew b/gradlew
old mode 100644
new mode 100755
diff --git a/src/main/java/adubbz/nx/analyzer/ipc/IPCEmulator.java b/src/main/java/adubbz/nx/analyzer/ipc/IPCEmulator.java
index b9b1bc4..251a6e1 100644
--- a/src/main/java/adubbz/nx/analyzer/ipc/IPCEmulator.java
+++ b/src/main/java/adubbz/nx/analyzer/ipc/IPCEmulator.java
@@ -6,13 +6,6 @@
  */
 package adubbz.nx.analyzer.ipc;
 
-import java.nio.ByteBuffer;
-import java.util.List;
-import java.util.function.Consumer;
-import java.util.function.Supplier;
-
-import org.apache.commons.compress.utils.Lists;
-
 import adubbz.nx.util.ByteUtil;
 import ghidra.app.plugin.processors.sleigh.SleighLanguage;
 import ghidra.app.util.bin.BinaryReader;
@@ -21,10 +14,7 @@
 import ghidra.pcode.emulate.BreakTableCallBack;
 import ghidra.pcode.emulate.Emulate;
 import ghidra.pcode.error.LowlevelError;
-import ghidra.pcode.memstate.MemoryBank;
-import ghidra.pcode.memstate.MemoryFaultHandler;
-import ghidra.pcode.memstate.MemoryPageBank;
-import ghidra.pcode.memstate.MemoryState;
+import ghidra.pcode.memstate.*;
 import ghidra.pcode.utils.Utils;
 import ghidra.program.database.ProgramDB;
 import ghidra.program.database.code.CodeManager;
@@ -42,6 +32,12 @@
 import ghidra.util.exception.CancelledException;
 import ghidra.util.task.TaskMonitor;
 import ghidra.util.task.TaskMonitorAdapter;
+import org.apache.commons.compress.utils.Lists;
+
+import java.nio.ByteBuffer;
+import java.util.List;
+import java.util.function.Consumer;
+import java.util.function.Supplier;
 
 public class IPCEmulator 
 {
@@ -121,7 +117,7 @@ public boolean unknownAddress(Address address, boolean write)
         };
         
         this.sLang = (SleighLanguage)this.program.getLanguage();
-        this.state = new MemoryState(this.sLang);
+        this.state = new DefaultMemoryState(this.sLang);
         
         // Create banks for ram and registers and add them to our state
         this.ramBank = new MemoryPageBank(this.sLang.getAddressFactory().getDefaultAddressSpace(), false, 4096, faultHandler);
diff --git a/src/main/java/adubbz/nx/loader/SwitchLoader.java b/src/main/java/adubbz/nx/loader/SwitchLoader.java
index a11ffbc..36870be 100644
--- a/src/main/java/adubbz/nx/loader/SwitchLoader.java
+++ b/src/main/java/adubbz/nx/loader/SwitchLoader.java
@@ -27,7 +27,7 @@
 import ghidra.app.util.opinion.BinaryLoader;
 import ghidra.app.util.opinion.LoadSpec;
 import ghidra.app.util.opinion.LoaderTier;
-import ghidra.framework.model.DomainFolder;
+import ghidra.framework.model.Project;
 import ghidra.framework.store.LockException;
 import ghidra.program.model.address.Address;
 import ghidra.program.model.address.AddressOutOfBoundsException;
@@ -38,6 +38,7 @@
 import ghidra.program.model.lang.LanguageCompilerSpecPair;
 import ghidra.program.model.lang.LanguageID;
 import ghidra.program.model.listing.Program;
+import ghidra.app.util.opinion.Loaded;
 import ghidra.util.Msg;
 import ghidra.util.exception.CancelledException;
 import ghidra.util.task.TaskMonitor;
@@ -99,10 +100,7 @@ else if (magic_0x10.equals("KIP1"))
     }
 
     @Override
-    protected List<LoadedProgram> loadProgram(ByteProvider provider, String programName,
-                                              DomainFolder programFolder, LoadSpec loadSpec, List<Option> options, MessageLog log,
-                                              Object consumer, TaskMonitor monitor)
-                    throws IOException, CancelledException 
+    protected List<Loaded<Program>> loadProgram(ByteProvider provider, String programName, Project project, String programFolderPath, LoadSpec loadSpec, List<Option> options, MessageLog log, Object consumer, TaskMonitor monitor) throws IOException, CancelledException
     {
         LanguageCompilerSpecPair pair = loadSpec.getLanguageCompilerSpec();
         Language importerLanguage = getLanguageService().getLanguage(pair.languageID);
@@ -112,26 +110,27 @@ protected List<LoadedProgram> loadProgram(ByteProvider provider, String programN
         Program prog = createProgram(provider, programName, baseAddr, getName(), importerLanguage, importerCompilerSpec, consumer);
         boolean success = false;
 
+        List<Loaded<Program>> results;
+
         try 
         {
-            success = this.loadInto(provider, loadSpec, options, log, prog, monitor);
+            this.loadInto(provider, loadSpec, options, log, prog, monitor);
+            success = true;
+            results = List.of(new Loaded<>(prog, programName, programFolderPath));
         }
         finally 
         {
             if (!success) 
             {
                 prog.release(consumer);
-                prog = null;
             }
         }
 
-        List<LoadedProgram> results = new ArrayList<>();
-        if (prog != null) results.add(new LoadedProgram(prog, programFolder));
         return results;
     }
 
     @Override
-    protected boolean loadProgramInto(ByteProvider provider, LoadSpec loadSpec, List<Option> options,
+    protected void loadProgramInto(ByteProvider provider, LoadSpec loadSpec, List<Option> options,
             MessageLog messageLog, Program program, TaskMonitor monitor) 
                     throws IOException
     {
@@ -169,8 +168,6 @@ protected boolean loadProgramInto(ByteProvider provider, LoadSpec loadSpec, List
             // KIP1s always start with a branch instruction at the start of their text
             loader.createEntryFunction("entry", program.getImageBase().getOffset(), monitor);
         }
-        
-        return true;
     }
 
     @Override
diff --git a/src/main/java/adubbz/nx/loader/common/NXProgramBuilder.java b/src/main/java/adubbz/nx/loader/common/NXProgramBuilder.java
index 4f7d7dc..86c880c 100644
--- a/src/main/java/adubbz/nx/loader/common/NXProgramBuilder.java
+++ b/src/main/java/adubbz/nx/loader/common/NXProgramBuilder.java
@@ -6,21 +6,14 @@
  */
 package adubbz.nx.loader.common;
 
-import java.io.IOException;
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-
-import com.google.common.collect.ImmutableList;
-import com.google.common.primitives.Longs;
-
 import adubbz.nx.common.NXRelocation;
-import adubbz.nx.loader.nxo.NXOAdapter;
 import adubbz.nx.loader.nxo.NXO;
+import adubbz.nx.loader.nxo.NXOAdapter;
 import adubbz.nx.loader.nxo.NXOSection;
 import adubbz.nx.loader.nxo.NXOSectionType;
 import adubbz.nx.util.UIUtil;
+import com.google.common.collect.ImmutableList;
+import com.google.common.primitives.Longs;
 import ghidra.app.cmd.label.SetLabelPrimaryCmd;
 import ghidra.app.util.MemoryBlockUtils;
 import ghidra.app.util.bin.BinaryReader;
@@ -32,26 +25,14 @@
 import ghidra.app.util.bin.format.elf.relocation.AARCH64_ElfRelocationConstants;
 import ghidra.app.util.bin.format.elf.relocation.ARM_ElfRelocationConstants;
 import ghidra.app.util.importer.MessageLog;
-import ghidra.program.model.address.Address;
-import ghidra.program.model.address.AddressOutOfBoundsException;
-import ghidra.program.model.address.AddressOverflowException;
-import ghidra.program.model.address.AddressSet;
-import ghidra.program.model.address.AddressSpace;
+import ghidra.program.model.address.*;
 import ghidra.program.model.data.PointerDataType;
 import ghidra.program.model.data.TerminatedStringDataType;
-import ghidra.program.model.listing.Data;
-import ghidra.program.model.listing.Function;
-import ghidra.program.model.listing.FunctionManager;
-import ghidra.program.model.listing.Library;
-import ghidra.program.model.listing.Program;
+import ghidra.program.model.listing.*;
 import ghidra.program.model.mem.MemoryAccessException;
 import ghidra.program.model.mem.MemoryBlock;
-import ghidra.program.model.symbol.ExternalLocation;
-import ghidra.program.model.symbol.ExternalManager;
-import ghidra.program.model.symbol.Namespace;
-import ghidra.program.model.symbol.SourceType;
-import ghidra.program.model.symbol.Symbol;
-import ghidra.program.model.symbol.SymbolTable;
+import ghidra.program.model.reloc.Relocation;
+import ghidra.program.model.symbol.*;
 import ghidra.program.model.util.CodeUnitInsertionException;
 import ghidra.util.Msg;
 import ghidra.util.exception.DuplicateNameException;
@@ -59,6 +40,13 @@
 import ghidra.util.exception.NotFoundException;
 import ghidra.util.task.TaskMonitor;
 
+import java.io.IOException;
+import java.lang.reflect.Field;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
 public class NXProgramBuilder 
 {
     protected ByteProvider fileByteProvider;
@@ -366,8 +354,9 @@ else if (reloc.r_type == AARCH64_ElfRelocationConstants.R_AARCH64_RELATIVE)
                 {
                     symbolName = reloc.sym.getNameAsString();
                 }
-                
-                program.getRelocationTable().add(target, (int)reloc.r_type, new long[] { reloc.r_sym }, Longs.toByteArray(originalValue), symbolName);
+
+                // Status APPLIED: "Relocation was applied successfully and resulted in the modification of memory bytes."
+                program.getRelocationTable().add(target, Relocation.Status.APPLIED,(int)reloc.r_type, new long[] { reloc.r_sym }, Longs.toByteArray(originalValue), symbolName);
             }
         }
         
@@ -419,7 +408,14 @@ protected void setupImports(TaskMonitor monitor)
                 if (elfSymbol.getSectionHeaderIndex() == ElfSectionHeaderConstants.SHN_UNDEF && symName != null && !symName.isEmpty())
                 {
                     Address address = this.aSpace.getAddress(externalBlockAddrOffset);
-                    elfSymbol.setValue(externalBlockAddrOffset); // Fix the value to be non-zero, instead pointing to our fake EXTERNAL block
+                    try {
+                        Field elfSymbolValue = elfSymbol.getClass().getDeclaredField("st_value");
+                        elfSymbolValue.setAccessible(true);
+                        // Fix the value to be non-zero, instead pointing to our fake EXTERNAL block
+                        elfSymbolValue.set(elfSymbol, externalBlockAddrOffset);
+                    } catch (NoSuchFieldException | IllegalAccessException e) {
+                        Msg.error(this, "Couldn't find or set st_value field in ElfSymbol.", e);
+                    }
                     this.evaluateElfSymbol(elfSymbol, address, true);
                     externalBlockAddrOffset += undefEntrySize;
                 }