This is an archive of the discontinued LLVM Phabricator instance.

Differential D96452

[docs] Make clearer in WritingAnLLVMPass that the legacy PM isn't the default
ClosedPublic

Authored by aeubanks on Feb 10 2021, 2:21 PM.

Details

Reviewers
ychen
asbirlea
Commits
rG1cd1573f11b8: [docs] Make clearer in WritingAnLLVMPass that the legacy PM isn't the default

Diff Detail

Unit TestsFailed

TimeTest
420 msx64 debian > AddressSanitizer-x86_64-linux-dynamic.TestCases/Linux::odr-violation.cpp
710 msx64 debian > AddressSanitizer-x86_64-linux.TestCases/Linux::odr-violation.cpp
260 msx64 debian > MemProfiler-x86_64-linux-dynamic.TestCases::test_malloc_load_store.c
50 msx64 debian > Polly.ScopInfo::user_provided_assumptions.ll

Event Timeline

aeubanks created this revision.Feb 10 2021, 2:21 PM
Herald added a subscriber: awarzynski. · View Herald TranscriptFeb 10 2021, 2:21 PM
aeubanks requested review of this revision.Feb 10 2021, 2:21 PM
Herald added a project: Restricted Project. · View Herald TranscriptFeb 10 2021, 2:21 PM
Herald added a subscriber: llvm-commits. · View Herald Transcript
ychen accepted this revision.Feb 10 2021, 3:07 PM

LGTM

This revision is now accepted and ready to land.Feb 10 2021, 3:07 PM
This revision was landed with ongoing or failed builds.Feb 10 2021, 3:26 PM
Closed by commit rG1cd1573f11b8: [docs] Make clearer in WritingAnLLVMPass that the legacy PM isn't the default (authored by aeubanks). · Explain Why
This revision was automatically updated to reflect the committed changes.
aeubanks added a commit: rG1cd1573f11b8: [docs] Make clearer in WritingAnLLVMPass that the legacy PM isn't the default.
Harbormaster completed remote builds in B88718: Diff 322824.Feb 10 2021, 4:12 PM

Revision Contents

PathSize
llvm/
docs/
9 lines

Diff 322824

llvm/docs/WritingAnLLVMPass.rst

Show All 28 Lines
passes. One of the main features of the LLVM Pass Framework is that it passes. One of the main features of the LLVM Pass Framework is that it
schedules passes to run in an efficient way based on the constraints that your schedules passes to run in an efficient way based on the constraints that your
pass meets (which are indicated by which class they derive from). pass meets (which are indicated by which class they derive from).
We start by showing you how to construct a pass, everything from setting up the We start by showing you how to construct a pass, everything from setting up the
code, to compiling, loading, and executing it. After the basics are down, more code, to compiling, loading, and executing it. After the basics are down, more
advanced features are discussed. advanced features are discussed.
This document deals with the legacy pass manager. LLVM is transitioning to .. warning::
the new pass manager, which has its own way of defining passes. For more This document deals with the legacy pass manager. LLVM now uses the new
details, see :doc:`WritingAnLLVMNewPMPass`. pass manager by default, which has its own way of defining passes. For more
details, see :doc:`WritingAnLLVMNewPMPass`. To use the legacy pass manager
with ``opt``, pass the ``-enable-new-pm=0`` flag to all ``opt``
invocations.
Quick Start --- Writing hello world Quick Start --- Writing hello world
=================================== ===================================
Here we describe how to write the "hello world" of passes. The "Hello" pass is Here we describe how to write the "hello world" of passes. The "Hello" pass is
designed to simply print out the name of non-external functions that exist in designed to simply print out the name of non-external functions that exist in
the program being compiled. It does not modify the program at all, it just the program being compiled. It does not modify the program at all, it just
inspects it. The source code and files for this pass are available in the LLVM inspects it. The source code and files for this pass are available in the LLVM
▲ Show 20 Lines • Show All 1,392 Lines • Show Last 20 Lines