blob: 7eaf406e8b545f0235b1103904b9244dffb9fa59 [file] [log] [blame]
Chris Lattnere2259872018-06-21 15:22:42 -07001//===- Function.h - MLIR Function Class -------------------------*- C++ -*-===//
Chris Lattnerc0c5e0f2018-06-21 09:49:33 -07002//
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 Lattnere2259872018-06-21 15:22:42 -070018// 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 Lattnerc0c5e0f2018-06-21 09:49:33 -070021//
22//===----------------------------------------------------------------------===//
23
24#ifndef MLIR_IR_FUNCTION_H
25#define MLIR_IR_FUNCTION_H
26
Chris Lattnere2259872018-06-21 15:22:42 -070027#include "mlir/Support/LLVM.h"
Chris Lattnerc0c5e0f2018-06-21 09:49:33 -070028
Chris Lattnere2259872018-06-21 15:22:42 -070029namespace mlir {
Chris Lattnerf7e22732018-06-22 22:03:48 -070030 class FunctionType;
31
Chris Lattnere2259872018-06-21 15:22:42 -070032 /// This is the base class for all of the MLIR function types
33 class Function {
34 std::string name;
Chris Lattnerf7e22732018-06-22 22:03:48 -070035 FunctionType *const type;
Chris Lattnere2259872018-06-21 15:22:42 -070036 public:
Chris Lattnerf7e22732018-06-22 22:03:48 -070037 explicit Function(StringRef name, FunctionType *type);
Chris Lattnere2259872018-06-21 15:22:42 -070038
39 void print(raw_ostream &os);
40 void dump();
Chris Lattnerc0c5e0f2018-06-21 09:49:33 -070041 };
42} // end namespace mlir
43
44#endif // MLIR_IR_FUNCTION_H