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 type conversions.
31 *
32 * @author Jose Fonseca <jfonseca@vmware.com>
33 */
34
35
36#ifndef LP_BLD_STRUCT_H
37#define LP_BLD_STRUCT_H
38
39
40#include "gallivm/lp_bld.h"
41#include "gallivm/lp_bld_init.h"
42
43#include "util/u_debug.h"
44#include "util/u_memory.h"
45
46
47#define LP_CHECK_STRUCT_SIZE(_ctype, _ltarget, _ltype) \
48      assert(LLVMABISizeOfType(_ltarget, _ltype) == \
49             sizeof(_ctype))
50
51#define LP_CHECK_MEMBER_OFFSET(_ctype, _cmember, _ltarget, _ltype, _lindex) \
52      assert(LLVMOffsetOfElement(_ltarget, _ltype, _lindex) == \
53             offsetof(_ctype, _cmember))
54
55
56/**
57 * Get value pointer to a structure member.
58 */
59LLVMValueRef
60lp_build_struct_get_ptr(struct gallivm_state *gallivm,
61                        LLVMValueRef ptr,
62                        unsigned member,
63                        const char *name);
64
65/**
66 * Get the value of a structure member.
67 */
68LLVMValueRef
69lp_build_struct_get(struct gallivm_state *gallivm,
70                    LLVMValueRef ptr,
71                    unsigned member,
72                    const char *name);
73
74/**
75 * Get value pointer to a structure member.
76 * This takes the explicit LLVM type of ptr, as required by LLVM-15 opaque-pointers.
77 */
78LLVMValueRef
79lp_build_struct_get_ptr2(struct gallivm_state *gallivm,
80                        LLVMTypeRef ptr_type,
81                        LLVMValueRef ptr,
82                        unsigned member,
83                        const char *name);
84
85/**
86 * Get the value of a structure member.
87 * This takes the explicit LLVM type of ptr, as required by LLVM-15 opaque-pointers.
88 */
89LLVMValueRef
90lp_build_struct_get2(struct gallivm_state *gallivm,
91                    LLVMTypeRef ptr_type,
92                    LLVMValueRef ptr,
93                    unsigned member,
94                    const char *name);
95
96/**
97 * Get value pointer to an array element.
98 */
99LLVMValueRef
100lp_build_array_get_ptr(struct gallivm_state *gallivm,
101                       LLVMValueRef ptr,
102                       LLVMValueRef index);
103
104/**
105 * Get the value of an array element.
106 */
107LLVMValueRef
108lp_build_array_get(struct gallivm_state *gallivm,
109                   LLVMValueRef ptr,
110                   LLVMValueRef index);
111
112/**
113 * Set the value of an array element.
114 */
115void
116lp_build_array_set(struct gallivm_state *gallivm,
117                   LLVMValueRef ptr,
118                   LLVMValueRef index,
119                   LLVMValueRef value);
120
121/**
122 * Get the value of an array element.
123 */
124LLVMValueRef
125lp_build_pointer_get(LLVMBuilderRef builder,
126                   LLVMValueRef ptr,
127                   LLVMValueRef index);
128
129/**
130 * Get the value of an array element, with explicit alignment.
131 *
132 * If the element size is different from the alignment this will
133 * cause llvm to emit an unaligned load
134 */
135LLVMValueRef
136lp_build_pointer_get_unaligned(LLVMBuilderRef builder,
137                               LLVMValueRef ptr,
138                               LLVMValueRef index,
139                               unsigned alignment);
140
141/**
142 * Set the value of an array element.
143 */
144void
145lp_build_pointer_set(LLVMBuilderRef builder,
146                     LLVMValueRef ptr,
147                     LLVMValueRef index,
148                     LLVMValueRef value);
149
150/**
151 * Set the value of an array element, with explicit alignment.
152 *
153 * If the element size is different from the alignment this will
154 * cause llvm to emit an unaligned store
155 */
156void
157lp_build_pointer_set_unaligned(LLVMBuilderRef builder,
158                               LLVMValueRef ptr,
159                               LLVMValueRef index,
160                               LLVMValueRef value,
161                               unsigned alignment);
162
163#endif /* !LP_BLD_STRUCT_H */
164