ghidra-master/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/DebugCodeViewSymbolTable.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.pe.debug;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

import ghidra.app.util.bin.BinaryReader;
import ghidra.app.util.bin.StructConverter;
import ghidra.program.model.data.DataType;
import ghidra.util.exception.DuplicateNameException;

/**
 * A class to represent the Object Module Format (OMF)
 * code view symbol table.
 */
public class DebugCodeViewSymbolTable implements StructConverter {
	public final static int MAGIC_NB_09 = 
		DebugCodeViewConstants.SIGNATURE_NB << 16 |
		DebugCodeViewConstants.VERSION_09;
	public final static int MAGIC_NB_11 = 
		DebugCodeViewConstants.SIGNATURE_NB << 16 |
		DebugCodeViewConstants.VERSION_11;
	public final static int MAGIC_N1_12 = 
		DebugCodeViewConstants.SIGNATURE_N1 << 16 |
		DebugCodeViewConstants.VERSION_12;
	public final static int MAGIC_N1_13 = 
		DebugCodeViewConstants.SIGNATURE_N1 << 16 |
		DebugCodeViewConstants.VERSION_13;

	public static boolean isMatch(BinaryReader reader, int ptr) throws IOException {
		//read value out as big endian
		int value = reader.readByte(ptr  ) << 24 |
					reader.readByte(ptr+1) << 16 |
					reader.readByte(ptr+2) << 8 |
					reader.readByte(ptr+3);
		return (MAGIC_NB_09 == value) || (MAGIC_NB_11 == value) || 
			   (MAGIC_N1_12 == value) || (MAGIC_N1_13 == value);
	}

    private byte [] magic;
    private int lfoDirectoryPos;
    private int omfDirHeaderPos;
    private OMFDirHeader header;
    private int omfDirEntryPos;

    private ArrayList<OMFDirEntry>    entriesList = new ArrayList<OMFDirEntry>();
    private ArrayList<OMFModule>      modulesList = new ArrayList<OMFModule>();
    private ArrayList<OMFGlobal>      globalsList = new ArrayList<OMFGlobal>();
    private ArrayList<OMFSegMap>      segMapsList = new ArrayList<OMFSegMap>();
    private ArrayList<OMFSrcModule> srcModuleList = new ArrayList<OMFSrcModule>();
    private ArrayList<OMFFileIndex> fileIndexList = new ArrayList<OMFFileIndex>();
    private ArrayList<OMFAlignSym>  alignSymsList = new ArrayList<OMFAlignSym>();

	private OMFLibrary library;

	DebugCodeViewSymbolTable(BinaryReader reader, int size, int base, int ptr) throws IOException {
		magic = reader.readByteArray(ptr, 4);
		ptr += 4;
        lfoDirectoryPos = reader.readInt(ptr);
        omfDirHeaderPos = base + lfoDirectoryPos;
		header = new OMFDirHeader(reader, omfDirHeaderPos);
        omfDirEntryPos = omfDirHeaderPos + OMFDirHeader.IMAGE_SIZEOF_OMF_DIR_HEADER;

        for (int i = 0 ; i < header.getNumberOfEntries() ; ++i) {
			OMFDirEntry entry = new OMFDirEntry(reader, omfDirEntryPos);
            entriesList.add(entry);
            switch (entry.getSubSectionType()) {
                case DebugCodeViewConstants.sstModule:
					modulesList.add(new OMFModule(reader, entry.getLargeFileOffset() + base,
						entry.getNumberOfBytes()));
                    break;
                case DebugCodeViewConstants.sstSegMap:
					segMapsList.add(new OMFSegMap(reader, entry.getLargeFileOffset() + base));
                    break;
                case DebugCodeViewConstants.sstGlobalPub:
				case DebugCodeViewConstants.sstGlobalSym:
				case DebugCodeViewConstants.sstStaticSym:
					globalsList.add(new OMFGlobal(reader, entry.getLargeFileOffset() + base));
                    break;
				case DebugCodeViewConstants.sstSrcModule:
					srcModuleList.add(new OMFSrcModule(reader, entry.getLargeFileOffset() + base));
					break;
				case DebugCodeViewConstants.sstFileIndex:
					fileIndexList.add(new OMFFileIndex(reader, entry.getLargeFileOffset() + base));
					break;
				case DebugCodeViewConstants.sstAlignSym:
					alignSymsList.add(new OMFAlignSym(reader, entry.getLargeFileOffset() + base));
					break;
				case DebugCodeViewConstants.sstLibraries:
					library = new OMFLibrary(reader, entry.getLargeFileOffset() + base,
						entry.getNumberOfBytes());
					break;
				case DebugCodeViewConstants.sstGlobalTypes:
					//int type = entry.getLargeFileOffset()+base;
					break;
                default:
					//TODO handle rest of possible types
                    break;
            }
            omfDirEntryPos += OMFDirEntry.IMAGE_SIZEOF_OMF_DIR_ENTRY;
        }
    }

    public byte[] getMagic() {
		return magic;
	}

	public OMFLibrary getOMFLibrary() {
		return library;
	}

	/**
	 * Returns the OMF directory entries.
	 * @return the OMF directory entries
	 */
    public List<OMFDirEntry> getOMFDirectoryEntries() {
        return entriesList;
    }

    /**
     * Returns the OMF modules.
     * @return the OMF modules
     */
    public List<OMFModule> getOMFModules() {
        return modulesList;

    }
    /**
     * Returns the OMF segment maps.
     * @return the OMF segment maps
     */
    public List<OMFSegMap> getOMFSegMaps() {
        return segMapsList;
    }

    /**
     * Returns the OMF globals.
     * @return the OMF globals
     */
    public List<OMFGlobal> getOMFGlobals() {
        return globalsList;
    }

	/**
	 * Returns the OMF Source Modules.
	 * @return the OMF Source Modules
	 */
	public List<OMFSrcModule> getOMFSrcModules() {
		return srcModuleList;
	}

	/**
	 * Returns the OMF Source Files.
	 * @return the OMF Source Files
	 */
	public List<OMFFileIndex> getOMFFiles() {
		return fileIndexList;
	}

	/**
	 * Returns the OMF Align Symbols.
	 * @return the OMF Align Symbols
	 */
	public List<OMFAlignSym> getOMFAlignSym() {
		return alignSymsList;
	}
    /**
     * @see ghidra.app.util.bin.StructConverter#toDataType()
     */
    public DataType toDataType() throws DuplicateNameException {
        return null;
    }
}
