src/gallium/drivers/llvmpipe/lp_bld_type.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  * @file
  30  * Convenient representation of SIMD types.
  31  *
  32  * @author Jose Fonseca <jfonseca@vmware.com>
  33  */
  34
  35
  36 #ifndef LP_BLD_TYPE_H
  37 #define LP_BLD_TYPE_H
  38
  39
  40 #include <llvm-c/Core.h>
  41
  42 #include <pipe/p_compiler.h>
  43
  44
  45 /**
  46  * Several functions can only cope with vectors of length up to this value.
  47  * You may need to increase that value if you want to represent bigger vectors.
  48  */
  49 #define LP_MAX_VECTOR_LENGTH 16
  50
  51 #define LP_MAX_TYPE_WIDTH 64
  52
  53
  54 /**
  55  * The LLVM type system can't conveniently express all the things we care about
  56  * on the types used for intermediate computations, such as signed vs unsigned,
  57  * normalized values, or fixed point.
  58  */
  59 struct lp_type {
  60    /**
  61     * Floating-point. Cannot be used with fixed. Integer numbers are
  62     * represented by this zero.
  63     */
  64    unsigned floating:1;
  65
  66    /**
  67     * Fixed-point. Cannot be used with floating. Integer numbers are
  68     * represented by this zero.
  69     */
  70    unsigned fixed:1;
  71
  72    /**
  73     * Whether it can represent negative values or not.
  74     *
  75     * If this is not set for floating point, it means that all values are
  76     * assumed to be positive.
  77     */
  78    unsigned sign:1;
  79
  80    /**
  81     * Whether values are normalized to fit [0, 1] interval, or [-1, 1]
  82     * interval for signed types.
  83     *
  84     * For integer types it means the representable integer range should be
  85     * interpreted as the interval above.
  86     *
  87     * For floating and fixed point formats it means the values should be
  88     * clamped to the interval above.
  89     */
  90    unsigned norm:1;
  91
  92    /**
  93     * Element width.
  94     *
  95     * For fixed point values, the fixed point is assumed to be at half the
  96     * width.
  97     */
  98    unsigned width:14;
  99
 100    /**
 101     * Vector length.
 102     *
 103     * width*length should be a power of two greater or equal to eight.
 104     *
 105     * @sa LP_MAX_VECTOR_LENGTH
 106     */
 107    unsigned length:14;
 108 };
 109
 110
 111 /**
 112  * We need most of the information here in order to correctly and efficiently
 113  * translate an arithmetic operation into LLVM IR. Putting it here avoids the
 114  * trouble of passing it as parameters.
 115  */
 116 struct lp_build_context
 117 {
 118    LLVMBuilderRef builder;
 119
 120    /**
 121     * This not only describes the input/output LLVM types, but also whether
 122     * to normalize/clamp the results.
 123     */
 124    struct lp_type type;
 125
 126    /** Same as lp_build_undef(type) */
 127    LLVMValueRef undef;
 128
 129    /** Same as lp_build_zero(type) */
 130    LLVMValueRef zero;
 131
 132    /** Same as lp_build_one(type) */
 133    LLVMValueRef one;
 134 };
 135
 136
 137 LLVMTypeRef
 138 lp_build_elem_type(struct lp_type type);
 139
 140
 141 LLVMTypeRef
 142 lp_build_vec_type(struct lp_type type);
 143
 144
 145 boolean
 146 lp_check_elem_type(struct lp_type type, LLVMTypeRef elem_type);
 147
 148
 149 boolean
 150 lp_check_vec_type(struct lp_type type, LLVMTypeRef vec_type);
 151
 152
 153 boolean
 154 lp_check_value(struct lp_type type, LLVMValueRef val);
 155
 156
 157 LLVMTypeRef
 158 lp_build_int_elem_type(struct lp_type type);
 159
 160
 161 LLVMTypeRef
 162 lp_build_int_vec_type(struct lp_type type);
 163
 164
 165 struct lp_type
 166 lp_int_type(struct lp_type type);
 167
 168
 169 void
 170 lp_build_context_init(struct lp_build_context *bld,
 171                       LLVMBuilderRef builder,
 172                       struct lp_type type);
 173
 174
 175 #endif /* !LP_BLD_TYPE_H */