1 /**************************************************************************
2  *
3  * Copyright 2009 VMware, Inc.
4  * All Rights Reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the
8  * "Software"), to deal in the Software without restriction, including
9  * without limitation the rights to use, copy, modify, merge, publish,
10  * distribute, sub license, and/or sell copies of the Software, and to
11  * permit persons to whom the Software is furnished to do so, subject to
12  * the following conditions:
13  *
14  * The above copyright notice and this permission notice (including the
15  * next paragraph) shall be included in all copies or substantial portions
16  * of the Software.
17  *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
21  * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25  *
26  **************************************************************************/
27 
28 /**
29  * @file
30  * Helper functions for calling intrinsics.
31  *
32  * @author Jose Fonseca <jfonseca@vmware.com>
33  */
34 
35 
36 #ifndef LP_BLD_INTR_H
37 #define LP_BLD_INTR_H
38 
39 #include <llvm/Config/llvm-config.h>
40 
41 #include "gallivm/lp_bld.h"
42 #include "gallivm/lp_bld_init.h"
43 
44 
45 /**
46  * Max number of arguments in an intrinsic.
47  */
48 #define LP_MAX_FUNC_ARGS 32
49 
50 enum lp_func_attr {
51    LP_FUNC_ATTR_ALWAYSINLINE = (1 << 0),
52    LP_FUNC_ATTR_INREG        = (1 << 2),
53    LP_FUNC_ATTR_NOALIAS      = (1 << 3),
54    LP_FUNC_ATTR_NOUNWIND     = (1 << 4),
55    LP_FUNC_ATTR_READNONE     = (1 << 5),
56    LP_FUNC_ATTR_READONLY     = (1 << 6),
57    LP_FUNC_ATTR_WRITEONLY    = LLVM_VERSION_MAJOR >= 4 ? (1 << 7) : 0,
58    LP_FUNC_ATTR_INACCESSIBLE_MEM_ONLY = LLVM_VERSION_MAJOR >= 4 ? (1 << 8) : 0,
59    LP_FUNC_ATTR_CONVERGENT   = LLVM_VERSION_MAJOR >= 4 ? (1 << 9) : 0,
60 
61    /* Legacy intrinsic that needs attributes on function declarations
62     * and they must match the internal LLVM definition exactly, otherwise
63     * intrinsic selection fails.
64     */
65    LP_FUNC_ATTR_LEGACY       = (1u << 31),
66 };
67 
68 void
69 lp_format_intrinsic(char *name,
70                     size_t size,
71                     const char *name_root,
72                     LLVMTypeRef type);
73 
74 LLVMValueRef
75 lp_declare_intrinsic(LLVMModuleRef module,
76                      const char *name,
77                      LLVMTypeRef ret_type,
78                      LLVMTypeRef *arg_types,
79                      unsigned num_args);
80 
81 void
82 lp_add_function_attr(LLVMValueRef function_or_call,
83                      int attr_idx, enum lp_func_attr attr);
84 
85 LLVMValueRef
86 lp_build_intrinsic(LLVMBuilderRef builder,
87                    const char *name,
88                    LLVMTypeRef ret_type,
89                    LLVMValueRef *args,
90                    unsigned num_args,
91                    unsigned attr_mask);
92 
93 
94 LLVMValueRef
95 lp_build_intrinsic_unary(LLVMBuilderRef builder,
96                          const char *name,
97                          LLVMTypeRef ret_type,
98                          LLVMValueRef a);
99 
100 
101 LLVMValueRef
102 lp_build_intrinsic_binary(LLVMBuilderRef builder,
103                           const char *name,
104                           LLVMTypeRef ret_type,
105                           LLVMValueRef a,
106                           LLVMValueRef b);
107 
108 
109 LLVMValueRef
110 lp_build_intrinsic_binary_anylength(struct gallivm_state *gallivm,
111                                     const char *name,
112                                     struct lp_type src_type,
113                                     unsigned intr_size,
114                                     LLVMValueRef a,
115                                     LLVMValueRef b);
116 
117 
118 LLVMValueRef
119 lp_build_intrinsic_map(struct gallivm_state *gallivm,
120                        const char *name,
121                        LLVMTypeRef ret_type,
122                        LLVMValueRef *args,
123                        unsigned num_args);
124 
125 
126 LLVMValueRef
127 lp_build_intrinsic_map_unary(struct gallivm_state *gallivm,
128                              const char *name,
129                              LLVMTypeRef ret_type,
130                              LLVMValueRef a);
131 
132 
133 LLVMValueRef
134 lp_build_intrinsic_map_binary(struct gallivm_state *gallivm,
135                               const char *name,
136                               LLVMTypeRef ret_type,
137                               LLVMValueRef a,
138                               LLVMValueRef b);
139 
140 
141 #endif /* !LP_BLD_INTR_H */
142