Shih-wei Liao | 22add6f | 2012-12-15 17:21:00 -0800 | [diff] [blame] | 1 | //===- Linker.h -----------------------------------------------------------===// |
| 2 | // |
| 3 | // The MCLinker Project |
| 4 | // |
| 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
| 7 | // |
| 8 | //===----------------------------------------------------------------------===// |
Stephen Hines | 37b74a3 | 2014-11-26 18:48:20 -0800 | [diff] [blame] | 9 | #ifndef MCLD_LINKER_H_ |
| 10 | #define MCLD_LINKER_H_ |
Shih-wei Liao | 22add6f | 2012-12-15 17:21:00 -0800 | [diff] [blame] | 11 | |
| 12 | #include <string> |
| 13 | |
| 14 | namespace mcld { |
| 15 | |
Shih-wei Liao | 22add6f | 2012-12-15 17:21:00 -0800 | [diff] [blame] | 16 | class FileHandle; |
Stephen Hines | 87f3465 | 2014-02-14 18:00:16 -0800 | [diff] [blame] | 17 | class FileOutputBuffer; |
Stephen Hines | 37b74a3 | 2014-11-26 18:48:20 -0800 | [diff] [blame] | 18 | class IRBuilder; |
| 19 | class LinkerConfig; |
| 20 | class LinkerScript; |
| 21 | class Module; |
| 22 | class ObjectLinker; |
| 23 | class Target; |
| 24 | class TargetLDBackend; |
Shih-wei Liao | 22add6f | 2012-12-15 17:21:00 -0800 | [diff] [blame] | 25 | |
| 26 | /** \class Linker |
| 27 | * \brief Linker is a modular linker. |
| 28 | */ |
Stephen Hines | 37b74a3 | 2014-11-26 18:48:20 -0800 | [diff] [blame] | 29 | class Linker { |
| 30 | public: |
Shih-wei Liao | 22add6f | 2012-12-15 17:21:00 -0800 | [diff] [blame] | 31 | Linker(); |
| 32 | |
| 33 | ~Linker(); |
| 34 | |
Stephen Hines | f7ac0f1 | 2013-05-03 19:09:24 -0700 | [diff] [blame] | 35 | /// emulate - To set up target-dependent options and default linker script. |
| 36 | bool emulate(LinkerScript& pScript, LinkerConfig& pConfig); |
Shih-wei Liao | 22add6f | 2012-12-15 17:21:00 -0800 | [diff] [blame] | 37 | |
Stephen Hines | f7ac0f1 | 2013-05-03 19:09:24 -0700 | [diff] [blame] | 38 | /// normalize - To normalize the command line language into mcld::Module. |
| 39 | bool normalize(Module& pModule, IRBuilder& pBuilder); |
Stephen Hines | 6f75755 | 2013-03-04 19:51:03 -0800 | [diff] [blame] | 40 | |
Stephen Hines | f7ac0f1 | 2013-05-03 19:09:24 -0700 | [diff] [blame] | 41 | /// resolve - To build up the topology of mcld::Module. |
Stephen Hines | 87f3465 | 2014-02-14 18:00:16 -0800 | [diff] [blame] | 42 | bool resolve(Module& pModule); |
Stephen Hines | f7ac0f1 | 2013-05-03 19:09:24 -0700 | [diff] [blame] | 43 | |
| 44 | /// layout - To serialize the final result of the output mcld::Module. |
Stephen Hines | 6f75755 | 2013-03-04 19:51:03 -0800 | [diff] [blame] | 45 | bool layout(); |
| 46 | |
| 47 | /// link - A convenient way to resolve and to layout the output mcld::Module. |
Shih-wei Liao | 22add6f | 2012-12-15 17:21:00 -0800 | [diff] [blame] | 48 | bool link(Module& pModule, IRBuilder& pBuilder); |
| 49 | |
Stephen Hines | 87f3465 | 2014-02-14 18:00:16 -0800 | [diff] [blame] | 50 | /// emit - To emit output mcld::Module to a FileOutputBuffer. |
| 51 | bool emit(FileOutputBuffer& pOutput); |
Shih-wei Liao | 22add6f | 2012-12-15 17:21:00 -0800 | [diff] [blame] | 52 | |
Stephen Hines | 6f75755 | 2013-03-04 19:51:03 -0800 | [diff] [blame] | 53 | /// emit - To open a file for output in pPath and to emit output mcld::Module |
| 54 | /// to the file. |
Stephen Hines | 87f3465 | 2014-02-14 18:00:16 -0800 | [diff] [blame] | 55 | bool emit(const Module& pModule, const std::string& pPath); |
Shih-wei Liao | 22add6f | 2012-12-15 17:21:00 -0800 | [diff] [blame] | 56 | |
Stephen Hines | 6f75755 | 2013-03-04 19:51:03 -0800 | [diff] [blame] | 57 | /// emit - To emit output mcld::Module in the pFileDescriptor. |
Stephen Hines | 87f3465 | 2014-02-14 18:00:16 -0800 | [diff] [blame] | 58 | bool emit(const Module& pModule, int pFileDescriptor); |
Shih-wei Liao | 22add6f | 2012-12-15 17:21:00 -0800 | [diff] [blame] | 59 | |
| 60 | bool reset(); |
| 61 | |
Stephen Hines | 37b74a3 | 2014-11-26 18:48:20 -0800 | [diff] [blame] | 62 | private: |
Shih-wei Liao | 22add6f | 2012-12-15 17:21:00 -0800 | [diff] [blame] | 63 | bool initTarget(); |
| 64 | |
| 65 | bool initBackend(); |
| 66 | |
Shih-wei Liao | 22add6f | 2012-12-15 17:21:00 -0800 | [diff] [blame] | 67 | bool initOStream(); |
| 68 | |
Stephen Hines | f7ac0f1 | 2013-05-03 19:09:24 -0700 | [diff] [blame] | 69 | bool initEmulator(LinkerScript& pScript); |
| 70 | |
Stephen Hines | 37b74a3 | 2014-11-26 18:48:20 -0800 | [diff] [blame] | 71 | private: |
Shih-wei Liao | 22add6f | 2012-12-15 17:21:00 -0800 | [diff] [blame] | 72 | LinkerConfig* m_pConfig; |
Shih-wei Liao | 22add6f | 2012-12-15 17:21:00 -0800 | [diff] [blame] | 73 | IRBuilder* m_pIRBuilder; |
| 74 | |
| 75 | const Target* m_pTarget; |
| 76 | TargetLDBackend* m_pBackend; |
| 77 | ObjectLinker* m_pObjLinker; |
| 78 | }; |
| 79 | |
Stephen Hines | 37b74a3 | 2014-11-26 18:48:20 -0800 | [diff] [blame] | 80 | } // namespace mcld |
Shih-wei Liao | 22add6f | 2012-12-15 17:21:00 -0800 | [diff] [blame] | 81 | |
Stephen Hines | 37b74a3 | 2014-11-26 18:48:20 -0800 | [diff] [blame] | 82 | #endif // MCLD_LINKER_H_ |