1 //===- BuildLibCalls.h - Utility builder for libcalls -----------*- 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 //
10 // This file exposes an interface to build some C language libcalls for
11 // optimization passes that need to call the various functions.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #ifndef LLVM_TRANSFORMS_UTILS_BUILDLIBCALLS_H
16 #define LLVM_TRANSFORMS_UTILS_BUILDLIBCALLS_H
17 
18 #include "llvm/IR/IRBuilder.h"
19 
20 namespace llvm {
21   class Value;
22   class DataLayout;
23   class TargetLibraryInfo;
24 
25   /// CastToCStr - Return V if it is an i8*, otherwise cast it to i8*.
26   Value *CastToCStr(Value *V, IRBuilder<> &B);
27 
28   /// EmitStrLen - Emit a call to the strlen function to the builder, for the
29   /// specified pointer.  Ptr is required to be some pointer type, and the
30   /// return value has 'intptr_t' type.
31   Value *EmitStrLen(Value *Ptr, IRBuilder<> &B, const DataLayout &DL,
32                     const TargetLibraryInfo *TLI);
33 
34   /// EmitStrNLen - Emit a call to the strnlen function to the builder, for the
35   /// specified pointer.  Ptr is required to be some pointer type, MaxLen must
36   /// be of size_t type, and the return value has 'intptr_t' type.
37   Value *EmitStrNLen(Value *Ptr, Value *MaxLen, IRBuilder<> &B,
38                      const DataLayout &DL, const TargetLibraryInfo *TLI);
39 
40   /// EmitStrChr - Emit a call to the strchr function to the builder, for the
41   /// specified pointer and character.  Ptr is required to be some pointer type,
42   /// and the return value has 'i8*' type.
43   Value *EmitStrChr(Value *Ptr, char C, IRBuilder<> &B,
44                     const TargetLibraryInfo *TLI);
45 
46   /// EmitStrNCmp - Emit a call to the strncmp function to the builder.
47   Value *EmitStrNCmp(Value *Ptr1, Value *Ptr2, Value *Len, IRBuilder<> &B,
48                      const DataLayout &DL, const TargetLibraryInfo *TLI);
49 
50   /// EmitStrCpy - Emit a call to the strcpy function to the builder, for the
51   /// specified pointer arguments.
52   Value *EmitStrCpy(Value *Dst, Value *Src, IRBuilder<> &B,
53                     const TargetLibraryInfo *TLI, StringRef Name = "strcpy");
54 
55   /// EmitStrNCpy - Emit a call to the strncpy function to the builder, for the
56   /// specified pointer arguments and length.
57   Value *EmitStrNCpy(Value *Dst, Value *Src, Value *Len, IRBuilder<> &B,
58                      const TargetLibraryInfo *TLI, StringRef Name = "strncpy");
59 
60   /// EmitMemCpyChk - Emit a call to the __memcpy_chk function to the builder.
61   /// This expects that the Len and ObjSize have type 'intptr_t' and Dst/Src
62   /// are pointers.
63   Value *EmitMemCpyChk(Value *Dst, Value *Src, Value *Len, Value *ObjSize,
64                        IRBuilder<> &B, const DataLayout &DL,
65                        const TargetLibraryInfo *TLI);
66 
67   /// EmitMemChr - Emit a call to the memchr function.  This assumes that Ptr is
68   /// a pointer, Val is an i32 value, and Len is an 'intptr_t' value.
69   Value *EmitMemChr(Value *Ptr, Value *Val, Value *Len, IRBuilder<> &B,
70                     const DataLayout &DL, const TargetLibraryInfo *TLI);
71 
72   /// EmitMemCmp - Emit a call to the memcmp function.
73   Value *EmitMemCmp(Value *Ptr1, Value *Ptr2, Value *Len, IRBuilder<> &B,
74                     const DataLayout &DL, const TargetLibraryInfo *TLI);
75 
76   /// EmitUnaryFloatFnCall - Emit a call to the unary function named 'Name'
77   /// (e.g.  'floor').  This function is known to take a single of type matching
78   /// 'Op' and returns one value with the same type.  If 'Op' is a long double,
79   /// 'l' is added as the suffix of name, if 'Op' is a float, we add a 'f'
80   /// suffix.
81   Value *EmitUnaryFloatFnCall(Value *Op, StringRef Name, IRBuilder<> &B,
82                               const AttributeSet &Attrs);
83 
84   /// EmitUnaryFloatFnCall - Emit a call to the binary function named 'Name'
85   /// (e.g. 'fmin').  This function is known to take type matching 'Op1' and
86   /// 'Op2' and return one value with the same type.  If 'Op1/Op2' are long
87   /// double, 'l' is added as the suffix of name, if 'Op1/Op2' are float, we
88   /// add a 'f' suffix.
89   Value *EmitBinaryFloatFnCall(Value *Op1, Value *Op2, StringRef Name,
90                                   IRBuilder<> &B, const AttributeSet &Attrs);
91 
92   /// EmitPutChar - Emit a call to the putchar function.  This assumes that Char
93   /// is an integer.
94   Value *EmitPutChar(Value *Char, IRBuilder<> &B, const TargetLibraryInfo *TLI);
95 
96   /// EmitPutS - Emit a call to the puts function.  This assumes that Str is
97   /// some pointer.
98   Value *EmitPutS(Value *Str, IRBuilder<> &B, const TargetLibraryInfo *TLI);
99 
100   /// EmitFPutC - Emit a call to the fputc function.  This assumes that Char is
101   /// an i32, and File is a pointer to FILE.
102   Value *EmitFPutC(Value *Char, Value *File, IRBuilder<> &B,
103                    const TargetLibraryInfo *TLI);
104 
105   /// EmitFPutS - Emit a call to the puts function.  Str is required to be a
106   /// pointer and File is a pointer to FILE.
107   Value *EmitFPutS(Value *Str, Value *File, IRBuilder<> &B,
108                    const TargetLibraryInfo *TLI);
109 
110   /// EmitFWrite - Emit a call to the fwrite function.  This assumes that Ptr is
111   /// a pointer, Size is an 'intptr_t', and File is a pointer to FILE.
112   Value *EmitFWrite(Value *Ptr, Value *Size, Value *File, IRBuilder<> &B,
113                     const DataLayout &DL, const TargetLibraryInfo *TLI);
114 }
115 
116 #endif
117