mirror of
https://github.com/gbdev/rgbds.git
synced 2025-11-20 10:12:06 +00:00
0e24adcafd
The goal was to improve readability, but along the way a few things were gained. - Sorted sym and map files - Infrastructure for supporting multiple .o versions - Valgrind-proof, as far as my testing goes anyways - Improved verbosity messages - Added error checking - Performance improvements, see end of commit message The readability improvement was spurred while trying to make sense of the old code while trying to implement features such as sorted sym and map files. I also did my best to remove hardcoded logic, such that modifications should be doable; for example, "RAM loading" sections, which are linked against a different location than the one they're stored at. Some work remains to be done, see the "TODO:" and "FIXME:" comments. Further, while regression tests pass, this new linker should be tested on different codebases (ideally while instrumented with `make develop` and under valgrind). The few errors spotted in the man pages (alignment) need to be corrected. Finally, documentation comments need to be written, I have written a lot of them but not all. This also provides a significant performance boost (benchmarked with a 51994-symbol project): Current master RGBLINK: 2.02user 0.03system 0:02.06elapsed 99%CPU (0avgtext+0avgdata 84336maxresident)k 0inputs+11584outputs (0major+20729minor)pagefaults 0swaps Rewritten RGBLINK: 0.19user 0.06system 0:00.63elapsed 40%CPU (0avgtext+0avgdata 32460maxresident)k 23784inputs+11576outputs (0major+7672minor)pagefaults 0swaps
60 lines
1.5 KiB
C
60 lines
1.5 KiB
C
/*
|
|
* This file is part of RGBDS.
|
|
*
|
|
* Copyright (c) 1997-2019, Carsten Sorensen and RGBDS contributors.
|
|
*
|
|
* SPDX-License-Identifier: MIT
|
|
*/
|
|
|
|
/* Declarations manipulating symbols */
|
|
#ifndef RGBDS_LINK_SYMBOL_H
|
|
#define RGBDS_LINK_SYMBOL_H
|
|
|
|
/* GUIDELINE: external code MUST NOT BE AWARE of the data structure used!! */
|
|
|
|
#include <stdint.h>
|
|
|
|
#include "linkdefs.h"
|
|
|
|
struct Symbol {
|
|
/* Info contained in the object files */
|
|
char *name;
|
|
enum SymbolType type;
|
|
char const *objFileName;
|
|
char *fileName;
|
|
int32_t lineNo;
|
|
int32_t sectionID;
|
|
union {
|
|
int32_t offset;
|
|
int32_t value;
|
|
};
|
|
/* Extra info computed during linking */
|
|
struct Section *section;
|
|
};
|
|
|
|
/*
|
|
* Execute a callback for each symbol currently registered.
|
|
* This is done to avoid exposing the data structure in which symbol are stored.
|
|
* @param callback The function to call for each symbol;
|
|
* the first argument will be a pointer to the symbol,
|
|
* the second argument will be the pointer `arg`.
|
|
* @param arg A pointer which will be passed to all calls to `callback`.
|
|
*/
|
|
void sym_ForEach(void (*callback)(struct Symbol *, void *), void *arg);
|
|
|
|
void sym_AddSymbol(struct Symbol *symbol);
|
|
|
|
/**
|
|
* Finds a symbol in all the defined symbols.
|
|
* @param name The name of the symbol to look for
|
|
* @return A pointer to the symbol, or NULL if not found.
|
|
*/
|
|
struct Symbol *sym_GetSymbol(char const *name);
|
|
|
|
/**
|
|
* `free`s all symbol memory that was allocated.
|
|
*/
|
|
void sym_CleanupSymbols(void);
|
|
|
|
#endif /* RGBDS_LINK_SYMBOL_H */
|