This is an archive of the discontinued LLVM Phabricator instance.

Differential D88049

[docs] Update ExtendingLLVM.rst
ClosedPublic

Authored by antonio-cortes-perez on Sep 21 2020, 2:54 PM.

Details

Reviewers
ncv
dblaikie
Commits
rGc82c0f99a5c1: [docs] Update ExtendingLLVM.rst
Summary

Updated file paths and function signatures in section
"Adding a new type".

Diff Detail

Event Timeline

antonio-cortes-perez created this revision.Sep 21 2020, 2:54 PM
Herald added a project: Restricted Project. · View Herald TranscriptSep 21 2020, 2:54 PM
Herald added a subscriber: llvm-commits. · View Herald Transcript
antonio-cortes-perez requested review of this revision.Sep 21 2020, 2:54 PM
Harbormaster completed remote builds in B72430: Diff 293260.Sep 21 2020, 3:34 PM
antonio-cortes-perez added a reviewer: ncv.Sep 21 2020, 3:38 PM
ncv added a reviewer: dblaikie.Sep 21 2020, 3:44 PM
dblaikie accepted this revision.Sep 21 2020, 4:39 PM

Looks good - thanks!

This revision is now accepted and ready to land.Sep 21 2020, 4:39 PM
Closed by commit rGc82c0f99a5c1: [docs] Update ExtendingLLVM.rst (authored by antonio-cortes-perez, committed by ncv). · Explain WhySep 21 2020, 4:50 PM
This revision was automatically updated to reflect the committed changes.
ncv added a commit: rGc82c0f99a5c1: [docs] Update ExtendingLLVM.rst.

Revision Contents

PathSize
llvm/
docs/
18 lines

Diff 293292

llvm/docs/ExtendingLLVM.rst

Show First 20 Lines • Show All 240 Lines • ▼ Show 20 Lines
Adding a fundamental type Adding a fundamental type
------------------------- -------------------------
#. ``llvm/include/llvm/IR/Type.h``: #. ``llvm/include/llvm/IR/Type.h``:
add enum for the new type; add static ``Type*`` for this type add enum for the new type; add static ``Type*`` for this type
#. ``llvm/lib/IR/Type.cpp`` and ``llvm/lib/IR/ValueTypes.cpp``: #. ``llvm/lib/IR/Type.cpp`` and ``llvm/lib/CodeGen/ValueTypes.cpp``:
add mapping from ``TypeID`` => ``Type*``; initialize the static ``Type*`` add mapping from ``TypeID`` => ``Type*``; initialize the static ``Type*``
#. ``llvm/llvm/llvm-c/Core.cpp``: #. ``llvm/include/llvm-c/Core.h`` and ``llvm/lib/IR/Core.cpp``:
add enum ``LLVMTypeKind`` and modify add enum ``LLVMTypeKind`` and modify
``LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty)`` for the new type ``LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty)`` for the new type
#. ``llvm/lib/AsmParser/LLLexer.cpp``: #. ``llvm/lib/AsmParser/LLLexer.cpp``:
add ability to parse in the type from text assembly add ability to parse in the type from text assembly
#. ``llvm/lib/AsmParser/LLParser.cpp``: #. ``llvm/lib/AsmParser/LLParser.cpp``:
add a token for that type add a token for that type
#. ``llvm/lib/Bitcode/Writer/BitcodeWriter.cpp``: #. ``llvm/lib/Bitcode/Writer/BitcodeWriter.cpp``:
modify ``static void WriteTypeTable(const ValueEnumerator &VE, modify ``void ModuleBitcodeWriter::writeTypeTable()`` to serialize your type
BitstreamWriter &Stream)`` to serialize your type
#. ``llvm/lib/Bitcode/Reader/BitcodeReader.cpp``: #. ``llvm/lib/Bitcode/Reader/BitcodeReader.cpp``:
modify ``bool BitcodeReader::ParseTypeType()`` to read your data type modify ``Error BitcodeReader::parseTypeTableBody()`` to read your data type
#. ``include/llvm/Bitcode/LLVMBitCodes.h``: #. ``include/llvm/Bitcode/LLVMBitCodes.h``:
add enum ``TypeCodes`` for the new type add enum ``TypeCodes`` for the new type
Adding a derived type Adding a derived type
--------------------- ---------------------
#. ``llvm/include/llvm/IR/Type.h``: #. ``llvm/include/llvm/IR/Type.h``:
add enum for the new type; add a forward declaration of the type also add enum for the new type; add a forward declaration of the type also
#. ``llvm/include/llvm/IR/DerivedTypes.h``: #. ``llvm/include/llvm/IR/DerivedTypes.h``:
add new class to represent new class in the hierarchy; add forward add new class to represent new class in the hierarchy; add forward
declaration to the TypeMap value type declaration to the TypeMap value type
#. ``llvm/lib/IR/Type.cpp`` and ``llvm/lib/IR/ValueTypes.cpp``: #. ``llvm/lib/IR/Type.cpp`` and ``llvm/lib/CodeGen/ValueTypes.cpp``:
add support for derived type, notably `enum TypeID` and `is`, `get` methods. add support for derived type, notably `enum TypeID` and `is`, `get` methods.
#. ``llvm/llvm/llvm-c/Core.cpp``: #. ``llvm/include/llvm-c/Core.h`` and ``llvm/lib/IR/Core.cpp``:
add enum ``LLVMTypeKind`` and modify add enum ``LLVMTypeKind`` and modify
`LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty)` for the new type `LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty)` for the new type
#. ``llvm/lib/AsmParser/LLLexer.cpp``: #. ``llvm/lib/AsmParser/LLLexer.cpp``:
modify ``lltok::Kind LLLexer::LexIdentifier()`` to add ability to modify ``lltok::Kind LLLexer::LexIdentifier()`` to add ability to
parse in the type from text assembly parse in the type from text assembly
#. ``llvm/lib/Bitcode/Writer/BitcodeWriter.cpp``: #. ``llvm/lib/Bitcode/Writer/BitcodeWriter.cpp``:
modify ``static void WriteTypeTable(const ValueEnumerator &VE, modify ``void ModuleBitcodeWriter::writeTypeTable()`` to serialize your type
BitstreamWriter &Stream)`` to serialize your type
#. ``llvm/lib/Bitcode/Reader/BitcodeReader.cpp``: #. ``llvm/lib/Bitcode/Reader/BitcodeReader.cpp``:
modify ``bool BitcodeReader::ParseTypeType()`` to read your data type modify ``Error BitcodeReader::parseTypeTableBody()`` to read your data type
#. ``include/llvm/Bitcode/LLVMBitCodes.h``: #. ``include/llvm/Bitcode/LLVMBitCodes.h``:
add enum ``TypeCodes`` for the new type add enum ``TypeCodes`` for the new type
#. ``llvm/lib/IR/AsmWriter.cpp``: #. ``llvm/lib/IR/AsmWriter.cpp``:
modify ``void TypePrinting::print(Type *Ty, raw_ostream &OS)`` modify ``void TypePrinting::print(Type *Ty, raw_ostream &OS)``
to output the new derived type to output the new derived type