/**
 * $Id$
 * Copyright (C) 2008 - 2014 Nils Asmussen
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

#pragma once

#include <common.h>

class OStream;

class KSymbols {
	KSymbols() = delete;

public:
	/* Represents one symbol (address -> name) */
	struct Symbol {
		uintptr_t address;
		const char *funcName;
	};

	/**
	 * Prints all kernel-symbols
	 *
	 * @param os the output-stream
	 */
	static void print(OStream &os);

	/**
	 * Searches for the highest address lower than the given one in the symbol-table. In other
	 * words: The name of the function to which the given address belongs
	 *
	 * @param address the address
	 * @return the pointer to the symbol (no copy!)
	 */
	static Symbol *getSymbolAt(uintptr_t address);
};
