Chris Lattner | ed7ac42 | 2002-08-08 20:10:38 +0000 | [diff] [blame] | 1 | //===- Hello.cpp - Example code from "Writing an LLVM Pass" ---------------===// |
Misha Brukman | b1c9317 | 2005-04-21 23:48:37 +0000 | [diff] [blame] | 2 | // |
Chandler Carruth | 2946cd7 | 2019-01-19 08:50:56 +0000 | [diff] [blame] | 3 | // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. |
| 4 | // See https://llvm.org/LICENSE.txt for license information. |
| 5 | // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
Misha Brukman | b1c9317 | 2005-04-21 23:48:37 +0000 | [diff] [blame] | 6 | // |
John Criswell | 482202a | 2003-10-20 19:43:21 +0000 | [diff] [blame] | 7 | //===----------------------------------------------------------------------===// |
Chris Lattner | ed7ac42 | 2002-08-08 20:10:38 +0000 | [diff] [blame] | 8 | // |
| 9 | // This file implements two versions of the LLVM "Hello World" pass described |
| 10 | // in docs/WritingAnLLVMPass.html |
| 11 | // |
| 12 | //===----------------------------------------------------------------------===// |
| 13 | |
Reid Spencer | 2b6d18a | 2006-08-07 23:17:24 +0000 | [diff] [blame] | 14 | #include "llvm/ADT/Statistic.h" |
Chandler Carruth | 9fb823b | 2013-01-02 11:36:10 +0000 | [diff] [blame] | 15 | #include "llvm/IR/Function.h" |
Chandler Carruth | ed0881b | 2012-12-03 16:50:05 +0000 | [diff] [blame] | 16 | #include "llvm/Pass.h" |
| 17 | #include "llvm/Support/raw_ostream.h" |
Chris Lattner | df3c342 | 2004-01-09 06:12:26 +0000 | [diff] [blame] | 18 | using namespace llvm; |
Brian Gaeke | 960707c | 2003-11-11 22:41:34 +0000 | [diff] [blame] | 19 | |
Chandler Carruth | 964daaa | 2014-04-22 02:55:47 +0000 | [diff] [blame] | 20 | #define DEBUG_TYPE "hello" |
| 21 | |
Chris Lattner | 1fa216f | 2006-12-19 22:24:09 +0000 | [diff] [blame] | 22 | STATISTIC(HelloCounter, "Counts number of functions greeted"); |
| 23 | |
Chris Lattner | ed7ac42 | 2002-08-08 20:10:38 +0000 | [diff] [blame] | 24 | namespace { |
| 25 | // Hello - The first implementation, without getAnalysisUsage. |
| 26 | struct Hello : public FunctionPass { |
Nick Lewycky | e7da2d6 | 2007-05-06 13:37:16 +0000 | [diff] [blame] | 27 | static char ID; // Pass identification, replacement for typeid |
Owen Anderson | a7aed18 | 2010-08-06 18:33:48 +0000 | [diff] [blame] | 28 | Hello() : FunctionPass(ID) {} |
Devang Patel | 09f162c | 2007-05-01 21:15:47 +0000 | [diff] [blame] | 29 | |
Craig Topper | 3e4c697 | 2014-03-05 09:10:37 +0000 | [diff] [blame] | 30 | bool runOnFunction(Function &F) override { |
Dan Gohman | d2d1ae1 | 2010-06-22 15:08:57 +0000 | [diff] [blame] | 31 | ++HelloCounter; |
Daniel Dunbar | 8eff29d | 2009-10-17 20:43:19 +0000 | [diff] [blame] | 32 | errs() << "Hello: "; |
| 33 | errs().write_escaped(F.getName()) << '\n'; |
Chris Lattner | ed7ac42 | 2002-08-08 20:10:38 +0000 | [diff] [blame] | 34 | return false; |
| 35 | } |
Misha Brukman | b1c9317 | 2005-04-21 23:48:37 +0000 | [diff] [blame] | 36 | }; |
Alexander Kornienko | f00654e | 2015-06-23 09:49:53 +0000 | [diff] [blame] | 37 | } |
Devang Patel | 09f162c | 2007-05-01 21:15:47 +0000 | [diff] [blame] | 38 | |
Dan Gohman | d78c400 | 2008-05-13 00:00:25 +0000 | [diff] [blame] | 39 | char Hello::ID = 0; |
Owen Anderson | 6da4d82 | 2010-10-07 00:31:16 +0000 | [diff] [blame] | 40 | static RegisterPass<Hello> X("hello", "Hello World Pass"); |
Chris Lattner | ed7ac42 | 2002-08-08 20:10:38 +0000 | [diff] [blame] | 41 | |
Dan Gohman | d78c400 | 2008-05-13 00:00:25 +0000 | [diff] [blame] | 42 | namespace { |
Chris Lattner | ed7ac42 | 2002-08-08 20:10:38 +0000 | [diff] [blame] | 43 | // Hello2 - The second implementation with getAnalysisUsage implemented. |
| 44 | struct Hello2 : public FunctionPass { |
Nick Lewycky | e7da2d6 | 2007-05-06 13:37:16 +0000 | [diff] [blame] | 45 | static char ID; // Pass identification, replacement for typeid |
Owen Anderson | a7aed18 | 2010-08-06 18:33:48 +0000 | [diff] [blame] | 46 | Hello2() : FunctionPass(ID) {} |
Devang Patel | 09f162c | 2007-05-01 21:15:47 +0000 | [diff] [blame] | 47 | |
Craig Topper | 3e4c697 | 2014-03-05 09:10:37 +0000 | [diff] [blame] | 48 | bool runOnFunction(Function &F) override { |
Dan Gohman | d2d1ae1 | 2010-06-22 15:08:57 +0000 | [diff] [blame] | 49 | ++HelloCounter; |
Daniel Dunbar | 8eff29d | 2009-10-17 20:43:19 +0000 | [diff] [blame] | 50 | errs() << "Hello: "; |
| 51 | errs().write_escaped(F.getName()) << '\n'; |
Chris Lattner | ed7ac42 | 2002-08-08 20:10:38 +0000 | [diff] [blame] | 52 | return false; |
| 53 | } |
| 54 | |
Puyan Lotfi | 74e38de | 2013-09-27 07:36:10 +0000 | [diff] [blame] | 55 | // We don't modify the program, so we preserve all analyses. |
Craig Topper | 3e4c697 | 2014-03-05 09:10:37 +0000 | [diff] [blame] | 56 | void getAnalysisUsage(AnalysisUsage &AU) const override { |
Chris Lattner | ed7ac42 | 2002-08-08 20:10:38 +0000 | [diff] [blame] | 57 | AU.setPreservesAll(); |
Douglas Gregor | 740ab38 | 2009-12-19 07:05:23 +0000 | [diff] [blame] | 58 | } |
Misha Brukman | b1c9317 | 2005-04-21 23:48:37 +0000 | [diff] [blame] | 59 | }; |
Alexander Kornienko | f00654e | 2015-06-23 09:49:53 +0000 | [diff] [blame] | 60 | } |
Dan Gohman | d78c400 | 2008-05-13 00:00:25 +0000 | [diff] [blame] | 61 | |
| 62 | char Hello2::ID = 0; |
Owen Anderson | 6da4d82 | 2010-10-07 00:31:16 +0000 | [diff] [blame] | 63 | static RegisterPass<Hello2> |
| 64 | Y("hello2", "Hello World Pass (with getAnalysisUsage implemented)"); |