ghidra-master/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/elf/info/GnuDebugLink.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.elf.info;

import static ghidra.app.util.bin.StructConverter.DWORD;

import java.io.IOException;

import ghidra.app.util.bin.BinaryReader;
import ghidra.program.model.address.Address;
import ghidra.program.model.data.*;
import ghidra.program.model.data.DataUtilities.ClearDataMode;
import ghidra.program.model.listing.Program;
import ghidra.program.model.util.CodeUnitInsertionException;
import ghidra.util.Msg;

/**
 * An ELF section (almost like a {@link ElfNote}) that contains information about an external
 * DWARF debug file.
 * <p>
 * External DWARF debug files can also be specified with a {@link NoteGnuBuildId}.
 */
public class GnuDebugLink implements ElfInfoItem {
	public static final String SECTION_NAME = ".gnu_debuglink";

	/**
	 * Reads a GnuDebugLink from the standard ".gnu_debuglink" section in the specified Program.
	 * 
	 * @param program Program to read from
	 * @return new instance, or null if not found or data error
	 */
	public static GnuDebugLink fromProgram(Program program) {
		ItemWithAddress<GnuDebugLink> wrappedItem = ElfInfoItem.readItemFromSection(program,
			SECTION_NAME, GnuDebugLink::read);
		return wrappedItem != null ? wrappedItem.item() : null;
	}

	/**
	 * Reads a GnuDebugLink from the specified BinaryReader.
	 * 
	 * @param br BinaryReader to read from
	 * @param program unused, present to match the signature of {@link ElfInfoItem.ReaderFunc}
	 * @return new instance, or null if data error
	 */
	public static GnuDebugLink read(BinaryReader br, Program program) {
		try {
			long filenameStart = br.getPointerIndex();
			String filename = br.readNextAsciiString();
			br.align(4);
			int filenameLen = (int) (br.getPointerIndex() - filenameStart);
			int crc = br.readNextInt();
			return new GnuDebugLink(filenameLen, filename, crc);
		}
		catch (IOException e) {
			// fall thru and return null
		}
		return null;
	}

	private final int filenameLen;
	private final String filename;
	private final int crc;

	public GnuDebugLink(int filenameLen, String filename, int crc) {
		this.filenameLen = filenameLen;
		this.filename = filename;
		this.crc = crc;
	}

	public String getFilename() {
		return filename;
	}

	public int getFilenameLen() {
		return filenameLen;
	}

	public int getCrc() {
		return crc;
	}

	@Override
	public void markupProgram(Program program, Address address) {
		program.getOptions(Program.PROGRAM_INFO).setString("GNU DebugLink", getFilename());

		try {
			StructureDataType struct = toStructure(program.getDataTypeManager());
			if (struct != null) {
				DataUtilities.createData(program, address, struct, -1, false,
					ClearDataMode.CLEAR_ALL_UNDEFINED_CONFLICT_DATA);
			}
		}
		catch (CodeUnitInsertionException e) {
			Msg.error(this, "Failed to markup GnuDebugLink at %s: %s".formatted(address, this));
		}

	}

	private StructureDataType toStructure(DataTypeManager dtm) {
		if (filenameLen <= 0) {
			return null;
		}

		StructureDataType result =
			new StructureDataType(StandardElfInfoProducer.ELF_CATEGORYPATH,
				"GnuDebugLink_%d".formatted(filenameLen), 0, dtm);
		result.add(StringDataType.dataType, filenameLen, "filename", null);
		result.add(DWORD, "crc", null);

		return result;
	}

	@Override
	public String toString() {
		return String.format("GnuDebugLink [filename=%s, crc=%s]", filename, crc);
	}

}
