1 //===------ SPIRVWriterPass.h - SPIRV writing pass --------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 /// \file
10 ///
11 /// This file provides a SPIRV writing pass.
12 ///
13 //===----------------------------------------------------------------------===//
14 
15 #ifndef LLVM_SPIRVWRITERPASS_H
16 #define LLVM_SPIRVWRITERPASS_H
17 
18 #include "llvm/ADT/StringRef.h"
19 
20 namespace llvm {
21 class Module;
22 class ModulePass;
23 class raw_ostream;
24 class PreservedAnalyses;
25 
26 /// \brief Create and return a pass that writes the module to the specified
27 /// ostream. Note that this pass is designed for use with the legacy pass
28 /// manager.
29 ModulePass *createSPIRVWriterPass(raw_ostream &Str);
30 
31 /// \brief Pass for writing a module of IR out to a SPIRV file.
32 ///
33 /// Note that this is intended for use with the new pass manager. To construct
34 /// a pass for the legacy pass manager, use the function above.
35 class SPIRVWriterPass {
36   raw_ostream &OS;
37 
38 public:
39   /// \brief Construct a SPIRV writer pass around a particular output stream.
SPIRVWriterPass(raw_ostream & OS)40   explicit SPIRVWriterPass(raw_ostream &OS) : OS(OS) {}
41 
42   /// \brief Run the SPIRV writer pass, and output the module to the selected
43   /// output stream.
44   PreservedAnalyses run(Module &M);
45 
name()46   static StringRef name() { return "SPIRVWriterPass"; }
47 };
48 
49 }
50 
51 #endif
52