ghidra-master/Ghidra/Features/Base/src/test.slow/java/ghidra/app/util/bin/format/dwarf4/next/DWARFStaticVarImporterTest.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.app.util.bin.format.dwarf4.next;

import static ghidra.app.util.bin.format.dwarf4.encoding.DWARFAttribute.*;
import static org.junit.Assert.*;

import java.util.HashSet;
import java.util.Set;

import java.io.IOException;

import org.junit.Test;

import ghidra.app.util.bin.format.dwarf4.*;
import ghidra.app.util.bin.format.dwarf4.encoding.DWARFTag;
import ghidra.app.util.bin.format.dwarf4.expression.DWARFExpressionOpCodes;
import ghidra.program.model.data.*;
import ghidra.program.model.listing.CodeUnit;
import ghidra.program.model.listing.Data;
import ghidra.program.model.symbol.Symbol;
import ghidra.program.model.symbol.SymbolType;
import ghidra.util.exception.CancelledException;

public class DWARFStaticVarImporterTest extends DWARFTestBase {

	@Test
	public void testIntStaticVar() throws CancelledException, IOException, DWARFException {
		DebugInfoEntry intDIE = addInt(cu);
		new DIECreator(DWARFTag.DW_TAG_variable)
				.addString(DW_AT_name, "static_var1")
				.addRef(DW_AT_type, intDIE)
				.addBlock(DW_AT_location, DWARFExpressionOpCodes.DW_OP_addr, 0x10, 0x4, 0, 0, 0, 0,
					0, 0)
				.create(cu);

		importFunctions();

		CodeUnit cu = program.getListing().getCodeUnitAt(addr(0x410));
		assertNotNull(cu);
		assertEquals("static_var1", cu.getLabel());
		assertEquals(4, cu.getLength());
		assertTrue(((Data) cu).getDataType() instanceof IntegerDataType);
	}

	@Test
	public void testZeroLenGlobalVar() throws CancelledException, IOException, DWARFException {
		DebugInfoEntry emptyStructDIE = newStruct("emptystruct", 0).create(cu);
		new DIECreator(DWARFTag.DW_TAG_variable)
				.addString(DW_AT_name, "static_var1")
				.addRef(DW_AT_type, emptyStructDIE)
				.addBlock(DW_AT_location, DWARFExpressionOpCodes.DW_OP_addr, 0x10, 0x4, 0, 0, 0, 0,
					0, 0)
				.create(cu);

		importFunctions();

		CodeUnit cu = program.getListing().getCodeUnitAt(addr(0x410));
		assertNotNull(cu);
		assertEquals("static_var1", cu.getLabel());
		assertEquals(1, cu.getLength());
		DataType dataType = ((Data) cu).getDataType();
		assertTrue(dataType instanceof Undefined || dataType instanceof DefaultDataType);
	}

	@Test
	public void test2ZeroLenGlobalVar() throws CancelledException, IOException, DWARFException {
		DebugInfoEntry emptyStructDIE = newStruct("emptystruct", 0).create(cu);
		new DIECreator(DWARFTag.DW_TAG_variable)
				.addString(DW_AT_name, "static_var1")
				.addRef(DW_AT_type, emptyStructDIE)
				.addBlock(DW_AT_location, DWARFExpressionOpCodes.DW_OP_addr, 0x10, 0x4, 0, 0, 0, 0,
					0, 0)
				.create(cu);
		new DIECreator(DWARFTag.DW_TAG_variable)
				.addString(DW_AT_name, "static_var2")
				.addRef(DW_AT_type, emptyStructDIE)
				.addBlock(DW_AT_location, DWARFExpressionOpCodes.DW_OP_addr, 0x10, 0x4, 0, 0, 0, 0,
					0, 0)
				.create(cu);

		importFunctions();

		Set<String> labelNames = getLabelNames(program.getSymbolTable().getSymbols(addr(0x410)));
		assertTrue(labelNames.contains("static_var1"));
		assertTrue(labelNames.contains("static_var2"));
	}

	@Test
	public void testZeroLenGlobalVarOnTopOfNormalVar()
			throws CancelledException, IOException, DWARFException {
		DebugInfoEntry emptyStructDIE = newStruct("emptystruct", 0).create(cu);
		DebugInfoEntry intDIE = addInt(cu);
		new DIECreator(DWARFTag.DW_TAG_variable)
				.addString(DW_AT_name, "static_var1")
				.addRef(DW_AT_type, intDIE)
				.addBlock(DW_AT_location, DWARFExpressionOpCodes.DW_OP_addr, 0x10, 0x4, 0, 0, 0, 0,
					0, 0)
				.create(cu);
		new DIECreator(DWARFTag.DW_TAG_variable)
				.addString(DW_AT_name, "static_var2")
				.addRef(DW_AT_type, emptyStructDIE)
				.addBlock(DW_AT_location, DWARFExpressionOpCodes.DW_OP_addr, 0x10, 0x4, 0, 0, 0, 0,
					0, 0)
				.create(cu);

		importFunctions();

		Set<String> labelNames = getLabelNames(program.getSymbolTable().getSymbols(addr(0x410)));
		assertTrue(labelNames.contains("static_var1"));
		assertTrue(labelNames.contains("static_var2"));

		CodeUnit cu = program.getListing().getCodeUnitAt(addr(0x410));
		assertNotNull(cu);
		assertEquals("static_var1", cu.getLabel());
		assertEquals(4, cu.getLength());
		assertTrue(((Data) cu).getDataType() instanceof IntegerDataType);
	}

	private Set<String> getLabelNames(Symbol[] symbols) {
		Set<String> result = new HashSet<>();
		for (Symbol symbol : symbols) {
			if (symbol.getSymbolType() == SymbolType.LABEL) {
				result.add(symbol.getName());
			}
		}
		return result;
	}
}
