Chris Lattner | e225987 | 2018-06-21 15:22:42 -0700 | [diff] [blame] | 1 | //===- Function.h - MLIR Function Class -------------------------*- C++ -*-===// |
Chris Lattner | c0c5e0f | 2018-06-21 09:49:33 -0700 | [diff] [blame] | 2 | // |
| 3 | // Copyright 2019 The MLIR Authors. |
| 4 | // |
| 5 | // Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | // you may not use this file except in compliance with the License. |
| 7 | // You may obtain a copy of the License at |
| 8 | // |
| 9 | // http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | // |
| 11 | // Unless required by applicable law or agreed to in writing, software |
| 12 | // distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | // See the License for the specific language governing permissions and |
| 15 | // limitations under the License. |
| 16 | // ============================================================================= |
| 17 | // |
Chris Lattner | e225987 | 2018-06-21 15:22:42 -0700 | [diff] [blame] | 18 | // Functions are the basic unit of composition in MLIR. There are three |
| 19 | // different kinds of functions: external functions, CFG functions, and ML |
| 20 | // functions. |
Chris Lattner | c0c5e0f | 2018-06-21 09:49:33 -0700 | [diff] [blame] | 21 | // |
| 22 | //===----------------------------------------------------------------------===// |
| 23 | |
| 24 | #ifndef MLIR_IR_FUNCTION_H |
| 25 | #define MLIR_IR_FUNCTION_H |
| 26 | |
Chris Lattner | e225987 | 2018-06-21 15:22:42 -0700 | [diff] [blame] | 27 | #include "mlir/Support/LLVM.h" |
Chris Lattner | c0c5e0f | 2018-06-21 09:49:33 -0700 | [diff] [blame] | 28 | |
Chris Lattner | e225987 | 2018-06-21 15:22:42 -0700 | [diff] [blame] | 29 | namespace mlir { |
Chris Lattner | ff0d590 | 2018-07-05 09:12:11 -0700 | [diff] [blame] | 30 | class FunctionType; |
| 31 | class MLIRContext; |
Chris Lattner | f7e2273 | 2018-06-22 22:03:48 -0700 | [diff] [blame] | 32 | |
Chris Lattner | 4c95a50 | 2018-06-23 16:03:42 -0700 | [diff] [blame] | 33 | /// This is the base class for all of the MLIR function types. |
| 34 | class Function { |
| 35 | public: |
Chris Lattner | ff0d590 | 2018-07-05 09:12:11 -0700 | [diff] [blame] | 36 | enum class Kind { ExtFunc, CFGFunc, MLFunc }; |
Chris Lattner | 4c95a50 | 2018-06-23 16:03:42 -0700 | [diff] [blame] | 37 | |
| 38 | Kind getKind() const { return kind; } |
| 39 | |
| 40 | /// Return the name of this function, without the @. |
| 41 | const std::string &getName() const { return name; } |
| 42 | |
| 43 | /// Return the type of this function. |
Chris Lattner | ff0d590 | 2018-07-05 09:12:11 -0700 | [diff] [blame] | 44 | FunctionType *getType() const { return type; } |
| 45 | |
| 46 | MLIRContext *getContext() const; |
Chris Lattner | 4c95a50 | 2018-06-23 16:03:42 -0700 | [diff] [blame] | 47 | |
Chris Lattner | 21e67f6 | 2018-07-06 10:46:19 -0700 | [diff] [blame] | 48 | /// Perform (potentially expensive) checks of invariants, used to detect |
| 49 | /// compiler bugs. This aborts on failure. |
| 50 | void verify() const; |
| 51 | |
Chris Lattner | 4c95a50 | 2018-06-23 16:03:42 -0700 | [diff] [blame] | 52 | void print(raw_ostream &os) const; |
| 53 | void dump() const; |
| 54 | |
| 55 | protected: |
| 56 | Function(StringRef name, FunctionType *type, Kind kind); |
| 57 | ~Function() {} |
Chris Lattner | ff0d590 | 2018-07-05 09:12:11 -0700 | [diff] [blame] | 58 | |
Chris Lattner | 4c95a50 | 2018-06-23 16:03:42 -0700 | [diff] [blame] | 59 | private: |
| 60 | Kind kind; |
| 61 | std::string name; |
| 62 | FunctionType *const type; |
| 63 | |
Chris Lattner | ff0d590 | 2018-07-05 09:12:11 -0700 | [diff] [blame] | 64 | void operator=(const Function &) = delete; |
Chris Lattner | 4c95a50 | 2018-06-23 16:03:42 -0700 | [diff] [blame] | 65 | }; |
| 66 | |
| 67 | /// An extfunc declaration is a declaration of a function signature that is |
| 68 | /// defined in some other module. |
| 69 | class ExtFunction : public Function { |
| 70 | public: |
| 71 | ExtFunction(StringRef name, FunctionType *type); |
| 72 | |
| 73 | /// Methods for support type inquiry through isa, cast, and dyn_cast. |
| 74 | static bool classof(const Function *func) { |
| 75 | return func->getKind() == Kind::ExtFunc; |
| 76 | } |
Chris Lattner | 4c95a50 | 2018-06-23 16:03:42 -0700 | [diff] [blame] | 77 | }; |
| 78 | |
| 79 | |
Chris Lattner | c0c5e0f | 2018-06-21 09:49:33 -0700 | [diff] [blame] | 80 | } // end namespace mlir |
| 81 | |
| 82 | #endif // MLIR_IR_FUNCTION_H |