src/gallium/auxiliary/gallivm/lp_bld_flow.h

   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  * LLVM control flow build helpers.
  30  *
  31  * @author Jose Fonseca <jfonseca@vmware.com>
  32  */
  33
  34 #ifndef LP_BLD_FLOW_H
  35 #define LP_BLD_FLOW_H
  36
  37
  38 #include "gallivm/lp_bld.h"
  39
  40
  41 struct lp_type;
  42
  43
  44 /**
  45  * Early exit. Useful to skip to the end of a function or block when
  46  * the execution mask becomes zero or when there is an error condition.
  47  */
  48 struct lp_build_skip_context
  49 {
  50    struct gallivm_state *gallivm;
  51
  52    /** Block to skip to */
  53    LLVMBasicBlockRef block;
  54 };
  55
  56 void
  57 lp_build_flow_skip_begin(struct lp_build_skip_context *ctx,
  58                          struct gallivm_state *gallivm);
  59
  60 void
  61 lp_build_flow_skip_cond_break(struct lp_build_skip_context *ctx,
  62                               LLVMValueRef cond);
  63
  64 void
  65 lp_build_flow_skip_end(struct lp_build_skip_context *ctx);
  66
  67
  68 struct lp_build_mask_context
  69 {
  70    struct lp_build_skip_context skip;
  71
  72    LLVMTypeRef reg_type;
  73
  74    LLVMValueRef var;
  75 };
  76
  77
  78 void
  79 lp_build_mask_begin(struct lp_build_mask_context *mask,
  80                     struct gallivm_state *gallivm,
  81                     struct lp_type type,
  82                     LLVMValueRef value);
  83
  84 LLVMValueRef
  85 lp_build_mask_value(struct lp_build_mask_context *mask);
  86
  87 /**
  88  * Bitwise AND the mask with the given value, if a previous mask was set.
  89  */
  90 void
  91 lp_build_mask_update(struct lp_build_mask_context *mask,
  92                      LLVMValueRef value);
  93
  94 void
  95 lp_build_mask_check(struct lp_build_mask_context *mask);
  96
  97 LLVMValueRef
  98 lp_build_mask_end(struct lp_build_mask_context *mask);
  99
 100
 101 /**
 102  * LLVM's IR doesn't represent for-loops directly. Furthermore it
 103  * it requires creating code blocks, branches, phi variables, so it
 104  * requires a fair amount of code.
 105  *
 106  * @sa http://www.llvm.org/docs/tutorial/LangImpl5.html#for
 107  */
 108 struct lp_build_loop_state
 109 {
 110    LLVMBasicBlockRef block;
 111    LLVMValueRef counter_var;
 112    LLVMValueRef counter;
 113    struct gallivm_state *gallivm;
 114 };
 115
 116
 117 void
 118 lp_build_loop_begin(struct lp_build_loop_state *state,
 119                     struct gallivm_state *gallivm,
 120                     LLVMValueRef start);
 121
 122 void
 123 lp_build_loop_end(struct lp_build_loop_state *state,
 124                   LLVMValueRef end,
 125                   LLVMValueRef step);
 126
 127 void
 128 lp_build_loop_end_cond(struct lp_build_loop_state *state,
 129                        LLVMValueRef end,
 130                        LLVMValueRef step,
 131                        LLVMIntPredicate cond);
 132
 133
 134
 135 /**
 136  * if/else/endif.
 137  */
 138 struct lp_build_if_state
 139 {
 140    struct gallivm_state *gallivm;
 141    LLVMValueRef condition;
 142    LLVMBasicBlockRef entry_block;
 143    LLVMBasicBlockRef true_block;
 144    LLVMBasicBlockRef false_block;
 145    LLVMBasicBlockRef merge_block;
 146 };
 147
 148
 149 void
 150 lp_build_if(struct lp_build_if_state *ctx,
 151             struct gallivm_state *gallivm,
 152             LLVMValueRef condition);
 153
 154 void
 155 lp_build_else(struct lp_build_if_state *ctx);
 156
 157 void
 158 lp_build_endif(struct lp_build_if_state *ctx);
 159
 160 LLVMBasicBlockRef
 161 lp_build_insert_new_block(struct gallivm_state *gallivm, const char *name);
 162
 163 LLVMValueRef
 164 lp_build_alloca(struct gallivm_state *gallivm,
 165                 LLVMTypeRef type,
 166                 const char *name);
 167
 168 LLVMValueRef
 169 lp_build_array_alloca(struct gallivm_state *gallivm,
 170                       LLVMTypeRef type,
 171                       LLVMValueRef count,
 172                       const char *name);
 173
 174 #endif /* !LP_BLD_FLOW_H */