ghidra-master/Ghidra/Features/Base/src/test.slow/java/ghidra/program/model/symbol/SymbolUtilities1Test.java
/* ###
 * IP: GHIDRA
 *
 * 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.
 */
package ghidra.program.model.symbol;

import static org.junit.Assert.*;

import org.junit.*;

import ghidra.program.database.ProgramDB;
import ghidra.program.model.address.Address;
import ghidra.program.model.address.AddressSpace;
import ghidra.program.model.data.*;
import ghidra.program.model.lang.*;
import ghidra.program.model.listing.Listing;
import ghidra.program.model.mem.*;
import ghidra.program.util.DefaultLanguageService;
import ghidra.test.*;
import ghidra.util.exception.DuplicateNameException;
import ghidra.util.exception.InvalidInputException;
import ghidra.util.task.TaskMonitor;

public class SymbolUtilities1Test extends AbstractGhidraHeadedIntegrationTest {
	private ProgramDB program;
	private AddressSpace space;
	private int transactionID;
	private SymbolTable symbolTable;
	private ReferenceManager refMgr;
	private Listing listing;

	public SymbolUtilities1Test() {
		super();
	}

	@Before
	public void setUp() throws Exception {
		TestEnv env = new TestEnv();
		LanguageService ls = DefaultLanguageService.getLanguageService();
		Language x86 = ls.getDefaultLanguage(TestProcessorConstants.PROCESSOR_X86);
		CompilerSpec windows = x86.getCompilerSpecByID(new CompilerSpecID("windows"));
		program = new ProgramDB("Test", x86, windows, this);
		env.dispose();
		space = program.getAddressFactory().getDefaultAddressSpace();
		Memory memory = program.getMemory();
		transactionID = program.startTransaction("Test");
		memory.createInitializedBlock("test", addr(0), 5000, (byte) 0,
			TaskMonitor.DUMMY, false);
		symbolTable = program.getSymbolTable();
		refMgr = program.getReferenceManager();
		listing = program.getListing();
	}

	@After
	public void tearDown() throws Exception {
		if (program != null) {
			program.endTransaction(transactionID, true);
			program.release(this);
		}
	}

	private Address addr(long l) {
		return space.getAddress(l);
	}

	@Test
	public void testDynamicLabelFlowToUndefined() {
		refMgr.addMemoryReference(addr(0x100), addr(0x200), RefType.FLOW, SourceType.USER_DEFINED,
			-1);
		Symbol symbol = symbolTable.getPrimarySymbol(addr(0x200));
		assertEquals("LAB_00000200", symbol.getName());
	}

	@Test
	public void testDynamicLabelReadToUndefined() {
		refMgr.addMemoryReference(addr(0x100), addr(0x200), RefType.READ, SourceType.USER_DEFINED,
			-1);
		Symbol symbol = symbolTable.getPrimarySymbol(addr(0x200));
		assertEquals("DAT_00000200", symbol.getName());

	}

	@Test
	public void testDynamicLabelReadToCode() throws Exception {
		refMgr.addMemoryReference(addr(0x100), addr(0x200), RefType.READ, SourceType.USER_DEFINED,
			-1);
		ProcessorContext context =
			new ProgramProcessorContext(program.getProgramContext(), addr(0x200));
		DumbMemBufferImpl membuf = new DumbMemBufferImpl(program.getMemory(), addr(0x200));
		InstructionPrototype proto = program.getLanguage().parse(membuf, context, false);
		listing.createInstruction(addr(0x200), proto, membuf, context);
		Symbol symbol = symbolTable.getPrimarySymbol(addr(0x200));
		assertEquals("LAB_00000200", symbol.getName());

	}

	@Test
	public void testDynamicLabelFlowToByte() throws Exception {
		refMgr.addMemoryReference(addr(0x100), addr(0x200), RefType.FLOW, SourceType.USER_DEFINED,
			-1);
		listing.createData(addr(0x200), new ByteDataType());
		Symbol symbol = symbolTable.getPrimarySymbol(addr(0x200));
		assertEquals("BYTE_00000200", symbol.getName());
	}

	@Test
	public void testDynamicLabelFlowToWord() throws Exception {
		refMgr.addMemoryReference(addr(0x100), addr(0x200), RefType.FLOW, SourceType.USER_DEFINED,
			-1);
		listing.createData(addr(0x200), new WordDataType());
		Symbol symbol = symbolTable.getPrimarySymbol(addr(0x200));
		assertEquals("WORD_00000200", symbol.getName());
	}

	@Test
	public void testDynamicLabelFlowToString() throws Exception {
		refMgr.addMemoryReference(addr(0x100), addr(0x200), RefType.FLOW, SourceType.USER_DEFINED,
			-1);
		listing.createData(addr(0x200), new StringDataType(), 1);
		Symbol symbol = symbolTable.getPrimarySymbol(addr(0x200));
		assertEquals("s__00000200", symbol.getName());
	}

	@Test
	public void testDynamicLabelNameChange() throws Exception {
		refMgr.addMemoryReference(addr(0x100), addr(0x200), RefType.FLOW, SourceType.USER_DEFINED,
			-1);
		Symbol symbol = symbolTable.getPrimarySymbol(addr(0x200));
		assertEquals("LAB_00000200", symbol.getName());
		listing.createData(addr(0x200), new ByteDataType());
		assertEquals("BYTE_00000200", symbol.getName());
		listing.clearCodeUnits(addr(0x200), addr(0x300), false);
		assertEquals("LAB_00000200", symbol.getName());
	}

	@Test
	public void testParseDynamicName() {
		assertEquals(addr(0x100),
			SymbolUtilities.parseDynamicName(program.getAddressFactory(), "LAB_00000100"));
		assertEquals(addr(0x100),
			SymbolUtilities.parseDynamicName(program.getAddressFactory(), "s_foo_00000100"));
		assertEquals(addr(0x100),
			SymbolUtilities.parseDynamicName(program.getAddressFactory(), "BYTE_05h_00000100"));
	}

	@Test
	public void testParseDynamicNameOnOverlay() throws Exception {
		MemoryBlock block =
			program.getMemory().createUninitializedBlock("ov_10", addr(500), 100, true);
		Address ovAddress = block.getStart().getAddress("0x100");
		assertEquals(ovAddress,
			SymbolUtilities.parseDynamicName(program.getAddressFactory(), "LAB_ov_10_00000100"));
	}

	@Test
	public void testPromoteGlobalSymbolToNamespacedSymbol()
			throws InvalidInputException, DuplicateNameException {
		symbolTable.createLabel(addr(0x100), "ABC", SourceType.IMPORTED);
		Namespace xyzNamespace =
			symbolTable.createNameSpace(null, "xyzNamespace", SourceType.USER_DEFINED);
		SymbolUtilities.createPreferredLabelOrFunctionSymbol(program, addr(0x100), xyzNamespace,
			"ABC", SourceType.IMPORTED);

		Symbol[] symbols = symbolTable.getSymbols(addr(0x100));
		assertEquals(1, symbols.length);
		assertEquals(xyzNamespace, symbols[0].getParentNamespace());

	}

	@Test
	public void testDontCreateGlobalSymbolIfNamespacedSymbolExists()
			throws InvalidInputException, DuplicateNameException {
		Namespace xyzNamespace =
			symbolTable.createNameSpace(null, "xyzNamespace", SourceType.USER_DEFINED);

		Symbol s1 =
			SymbolUtilities.createPreferredLabelOrFunctionSymbol(program, addr(0x100), xyzNamespace,
				"ABC", SourceType.IMPORTED);
		Symbol s2 =
			SymbolUtilities.createPreferredLabelOrFunctionSymbol(program, addr(0x100), xyzNamespace,
				"ABC", SourceType.IMPORTED);

		assertEquals(s1, s2);
	}

	@Test
	public void testCreatingSameSymbolTwice()
			throws InvalidInputException, DuplicateNameException {
		Namespace xyzNamespace =
			symbolTable.createNameSpace(null, "xyzNamespace", SourceType.USER_DEFINED);
		symbolTable.createLabel(addr(0x100), "ABC", xyzNamespace, SourceType.IMPORTED);

		Symbol s = SymbolUtilities.createPreferredLabelOrFunctionSymbol(program, addr(0x100),
			null, "ABC", SourceType.IMPORTED);
		assertEquals(null, s);

		Symbol[] symbols = symbolTable.getSymbols(addr(0x100));
		assertEquals(1, symbols.length);
		assertEquals(xyzNamespace, symbols[0].getParentNamespace());

	}
}
