ir.h revision 233b88eab9d8095523ebae3c4be1dbf2e2bd856a
15c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)/* -*- c++ -*- */ 25c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)/* 35c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Copyright © 2010 Intel Corporation 45c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 55c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Permission is hereby granted, free of charge, to any person obtaining a 65c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * copy of this software and associated documentation files (the "Software"), 75c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * to deal in the Software without restriction, including without limitation 85c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * the rights to use, copy, modify, merge, publish, distribute, sublicense, 95c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * and/or sell copies of the Software, and to permit persons to whom the 105c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Software is furnished to do so, subject to the following conditions: 115c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 125c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * The above copyright notice and this permission notice (including the next 135c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * paragraph) shall be included in all copies or substantial portions of the 145c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Software. 155c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 165c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 175c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 185c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 195c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 205c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 215c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 225c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * DEALINGS IN THE SOFTWARE. 235c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 245c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 255c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#pragma once 2653e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles)#ifndef IR_H 2753e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles)#define IR_H 285c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 29df95704c49daea886ddad70775bda23618d6274dBen Murdoch#include <stdio.h> 30df95704c49daea886ddad70775bda23618d6274dBen Murdoch#include <stdlib.h> 3153e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) 3253e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles)#include "ralloc.h" 3306f816c7c76bc45a15e452ade8a34e8af077693eTorne (Richard Coles)#include "glsl_types.h" 3406f816c7c76bc45a15e452ade8a34e8af077693eTorne (Richard Coles)#include "list.h" 3553e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles)#include "ir_visitor.h" 3653e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles)#include "ir_hierarchical_visitor.h" 379bbd2f5e390b01907d97ecffde80aa1b06113aacTorne (Richard Coles) 3853e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles)/** 3953e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) * \defgroup IR Intermediate representation nodes 4053e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) * 419bbd2f5e390b01907d97ecffde80aa1b06113aacTorne (Richard Coles) * @{ 4253e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) */ 4353e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) 44e1f1df5f01594c0e62e751e4b46e779b85c2faa5Torne (Richard Coles)/** 4553e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) * Class tags 46e69819bd8e388ea4ad1636a19aa6b2eed4952191Ben Murdoch * 475c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Each concrete class derived from \c ir_instruction has a value in this 485c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * enumerant. The value for the type is stored in \c ir_instruction::ir_type 495c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * by the constructor. While using type tags is not very C++, it is extremely 505c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * convenient. For example, during debugging you can simply inspect 515c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * \c ir_instruction::ir_type to find out the actual type of the object. 525c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 538abfc5808a4e34d6e03867af8bc440dee641886fTorne (Richard Coles) * In addition, it is possible to use a switch-statement based on \c 545c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * \c ir_instruction::ir_type to select different behavior for different object 555c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * types. For functions that have only slight differences for several object 565c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * types, this allows writing very straightforward, readable code. 575c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 585c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)enum ir_node_type { 595c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 605c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Zero is unused so that the IR validator can detect cases where 615c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * \c ir_instruction::ir_type has not been initialized. 625c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 635c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_type_unset, 645c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_type_variable, 655c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_type_assignment, 665c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_type_call, 675c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_type_constant, 6893ac45cfc74041c8ae536ce58a9534d46db2024eTorne (Richard Coles) ir_type_dereference_array, 695c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_type_dereference_record, 705c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_type_dereference_variable, 715c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_type_discard, 725c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_type_expression, 735c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_type_function, 745c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_type_function_signature, 755c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_type_if, 7602772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch ir_type_loop, 775c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_type_loop_jump, 785c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_type_return, 795c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_type_swizzle, 8002772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch ir_type_texture, 8102772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch ir_type_max /**< maximum ir_type enum number, for validation */ 825c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)}; 835c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 8402772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch/** 855c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Base class of all IR instructions 865c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 875c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)class ir_instruction : public exec_node { 885c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)public: 8902772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch enum ir_node_type ir_type; 905c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) const struct glsl_type *type; 915c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 925c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** ir_print_visitor helper for debugging. */ 935c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) void print(void) const; 945c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 955c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual void accept(ir_visitor *) = 0; 965c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual ir_visitor_status accept(ir_hierarchical_visitor *) = 0; 975c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual ir_instruction *clone(void *mem_ctx, 985c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) struct hash_table *ht) const = 0; 995c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1005c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 1015c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * \name IR instruction downcast functions 1025c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 1035c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * These functions either cast the object to a derived class or return 1045c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * \c NULL if the object's type does not match the specified derived class. 1055c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Additional downcast functions will be added as needed. 1065c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 1075c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /*@{*/ 1085c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual class ir_variable * as_variable() { return NULL; } 1095c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual class ir_function * as_function() { return NULL; } 1105c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual class ir_dereference * as_dereference() { return NULL; } 1115c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual class ir_dereference_array * as_dereference_array() { return NULL; } 1125c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual class ir_dereference_variable *as_dereference_variable() { return NULL; } 1135c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual class ir_expression * as_expression() { return NULL; } 114926b001d589ce2f10facb93dd4b87578ea35a855Torne (Richard Coles) virtual class ir_rvalue * as_rvalue() { return NULL; } 1155c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual class ir_loop * as_loop() { return NULL; } 1165c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual class ir_assignment * as_assignment() { return NULL; } 1175c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual class ir_call * as_call() { return NULL; } 1185c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual class ir_return * as_return() { return NULL; } 1195c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual class ir_if * as_if() { return NULL; } 1205c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual class ir_swizzle * as_swizzle() { return NULL; } 1215c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual class ir_constant * as_constant() { return NULL; } 1225c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual class ir_discard * as_discard() { return NULL; } 1235c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /*@}*/ 1245c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1255c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)protected: 1265c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_instruction() 1275c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 1285c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_type = ir_type_unset; 1295c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) type = NULL; 1305c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 1315c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)}; 1325c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1335c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 134926b001d589ce2f10facb93dd4b87578ea35a855Torne (Richard Coles)class ir_rvalue : public ir_instruction { 13506f816c7c76bc45a15e452ade8a34e8af077693eTorne (Richard Coles)public: 1365c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual ir_rvalue *clone(void *mem_ctx, struct hash_table *) const = 0; 1375c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1385c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual ir_constant *constant_expression_value() = 0; 1395c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1405c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual ir_rvalue * as_rvalue() 1415c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 1425c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return this; 1435c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 1448abfc5808a4e34d6e03867af8bc440dee641886fTorne (Richard Coles) 1455c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_rvalue *as_rvalue_to_saturate(); 1465c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1475c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual bool is_lvalue() 1489bbd2f5e390b01907d97ecffde80aa1b06113aacTorne (Richard Coles) { 1499bbd2f5e390b01907d97ecffde80aa1b06113aacTorne (Richard Coles) return false; 1509bbd2f5e390b01907d97ecffde80aa1b06113aacTorne (Richard Coles) } 1519bbd2f5e390b01907d97ecffde80aa1b06113aacTorne (Richard Coles) 1529bbd2f5e390b01907d97ecffde80aa1b06113aacTorne (Richard Coles) /** 1535c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Get the variable that is ultimately referenced by an r-value 1545c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 1555c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual ir_variable *variable_referenced() 1565c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 1575c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return NULL; 1585c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 1595c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1605c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1615c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 16283750176c3ee2cea66c8a9751271026a5901be3aBen Murdoch * If an r-value is a reference to a whole variable, get that variable 1635c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 1645c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * \return 1655c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Pointer to a variable that is completely dereferenced by the r-value. If 1665c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * the r-value is not a dereference or the dereference does not access the 1675c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * entire variable (i.e., it's just one array element, struct field), \c NULL 1685c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * is returned. 1695c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 1705c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual ir_variable *whole_variable_referenced() 1715c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 1725c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return NULL; 1735c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 1745c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1755c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 1765c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Determine if an r-value has the value zero 1775c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 1785c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * The base implementation of this function always returns \c false. The 1795c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * \c ir_constant class over-rides this function to return \c true \b only 1805c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * for vector and scalar types that have all elements set to the value 1815c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * zero (or \c false for booleans). 1825c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 1835c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * \sa ir_constant::has_value, ir_rvalue::is_one, ir_rvalue::is_negative_one 1845c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 1855c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual bool is_zero() const; 1865c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1875c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 1885c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Determine if an r-value has the value one 1895c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 1905c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * The base implementation of this function always returns \c false. The 1915c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * \c ir_constant class over-rides this function to return \c true \b only 1925c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * for vector and scalar types that have all elements set to the value 1935c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * one (or \c true for booleans). 1945c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 1955c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_negative_one 1965c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 1975c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual bool is_one() const; 1985c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1995c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 2005c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Determine if an r-value has the value negative one 201e1f1df5f01594c0e62e751e4b46e779b85c2faa5Torne (Richard Coles) * 2025c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * The base implementation of this function always returns \c false. The 203e1f1df5f01594c0e62e751e4b46e779b85c2faa5Torne (Richard Coles) * \c ir_constant class over-rides this function to return \c true \b only 204e1f1df5f01594c0e62e751e4b46e779b85c2faa5Torne (Richard Coles) * for vector and scalar types that have all elements set to the value 2055c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * negative one. For boolean times, the result is always \c false. 2065c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 2075c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_one 208df95704c49daea886ddad70775bda23618d6274dBen Murdoch */ 2095c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual bool is_negative_one() const; 210df95704c49daea886ddad70775bda23618d6274dBen Murdoch 2115c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)protected: 2125c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_rvalue(); 213df95704c49daea886ddad70775bda23618d6274dBen Murdoch}; 2145c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 2155c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 21606f816c7c76bc45a15e452ade8a34e8af077693eTorne (Richard Coles)/** 2175c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Variable storage classes 2185c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 2195c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)enum ir_variable_mode { 2205c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_var_auto = 0, /**< Function local variables and globals. */ 2215c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_var_uniform, /**< Variable declared as a uniform. */ 2225c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_var_in, 2235c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_var_out, 2245c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_var_inout, 2255c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_var_const_in, /**< "in" param that must be a constant expression */ 2265c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_var_system_value, /**< Ex: front-face, instance-id, etc. */ 2275c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_var_temporary /**< Temporary variable generated during compilation. */ 2285c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)}; 2295c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 2305c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)enum ir_variable_interpolation { 2315c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_var_smooth = 0, 2325c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_var_flat, 2335c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_var_noperspective 2345c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)}; 2355c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 2365c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)/** 2375c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * \brief Layout qualifiers for gl_FragDepth. 2385c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 2395c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * The AMD_conservative_depth extension allows gl_FragDepth to be redeclared 2405c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * with a layout qualifier. 2415c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 2425c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)enum ir_depth_layout { 2435c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_depth_layout_none, /**< No depth layout is specified. */ 2445c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_depth_layout_any, 2455c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_depth_layout_greater, 2465c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_depth_layout_less, 2475c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_depth_layout_unchanged 2485c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)}; 2495c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 2505c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)/** 2515c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * \brief Convert depth layout qualifier to string. 2525c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 2535c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)const char* 2545c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)depth_layout_string(ir_depth_layout layout); 2555c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 2565c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)class ir_variable : public ir_instruction { 2575c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)public: 2585c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_variable(const struct glsl_type *, const char *, ir_variable_mode); 2595c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 2605c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual ir_variable *clone(void *mem_ctx, struct hash_table *ht) const; 2615c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 2625c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual ir_variable *as_variable() 2635c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 2645c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return this; 2655c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 2665c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 2675c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual void accept(ir_visitor *v) 2685c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 2695c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) v->visit(this); 2705c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 2715c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 2725c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual ir_visitor_status accept(ir_hierarchical_visitor *); 2735c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 2745c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 2755c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 2765c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Get the string value for the interpolation qualifier 2775c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 2785c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * \return The string that would be used in a shader to specify \c 2795c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * mode will be returned. 2808abfc5808a4e34d6e03867af8bc440dee641886fTorne (Richard Coles) * 2815c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * This function should only be used on a shader input or output variable. 2825c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 2835c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) const char *interpolation_string() const; 2845c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 2855c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 2865c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Calculate the number of slots required to hold this variable 2875c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 288e1f1df5f01594c0e62e751e4b46e779b85c2faa5Torne (Richard Coles) * This is used to determine how many uniform or varying locations a variable 2895c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * occupies. The count is in units of floating point components. 2905c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 2915c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) unsigned component_slots() const; 29253e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) 2935c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 2945c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Delcared name of the variable 2955c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 2965c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) const char *name; 29753e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) 2985c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 2995c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Highest element accessed with a constant expression array index 3005c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 3015c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Not used for non-array variables. 302926b001d589ce2f10facb93dd4b87578ea35a855Torne (Richard Coles) */ 303926b001d589ce2f10facb93dd4b87578ea35a855Torne (Richard Coles) unsigned max_array_access; 3045c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 3055c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 3065c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Is the variable read-only? 3075c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 3085c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * This is set for variables declared as \c const, shader inputs, 3095c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * and uniforms. 3105c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 3115c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) unsigned read_only:1; 3128abfc5808a4e34d6e03867af8bc440dee641886fTorne (Richard Coles) unsigned centroid:1; 3138abfc5808a4e34d6e03867af8bc440dee641886fTorne (Richard Coles) unsigned invariant:1; 3145c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 3155c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 31653e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) * Has this variable been used for reading or writing? 31753e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) * 31853e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) * Several GLSL semantic checks require knowledge of whether or not a 31953e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) * variable has been used. For example, it is an error to redeclare a 32053e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) * variable as invariant after it has been used. 3211fad5ca6c42d689812b66fc493992aa6d747a6fbBen Murdoch */ 32253e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) unsigned used:1; 32353e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) 32453e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) /** 32553e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) * Storage class of the variable. 32653e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) * 3275c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * \sa ir_variable_mode 3285c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 3295c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) unsigned mode:3; 3305c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 3315c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 3328abfc5808a4e34d6e03867af8bc440dee641886fTorne (Richard Coles) * Interpolation mode for shader inputs / outputs 3338abfc5808a4e34d6e03867af8bc440dee641886fTorne (Richard Coles) * 3341fad5ca6c42d689812b66fc493992aa6d747a6fbBen Murdoch * \sa ir_variable_interpolation 3351fad5ca6c42d689812b66fc493992aa6d747a6fbBen Murdoch */ 3365c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) unsigned interpolation:2; 3375c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 3385c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 3395c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Flag that the whole array is assignable 3405c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 3415c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * In GLSL 1.20 and later whole arrays are assignable (and comparable for 3425c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * equality). This flag enables this behavior. 3438abfc5808a4e34d6e03867af8bc440dee641886fTorne (Richard Coles) */ 3445c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) unsigned array_lvalue:1; 3455c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 3465c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 3475c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * \name ARB_fragment_coord_conventions 3485c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * @{ 3495c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 3505c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) unsigned origin_upper_left:1; 3515c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) unsigned pixel_center_integer:1; 3528abfc5808a4e34d6e03867af8bc440dee641886fTorne (Richard Coles) /*@}*/ 3535c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 3545c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 3555c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * \brief Layout qualifier for gl_FragDepth. 3568abfc5808a4e34d6e03867af8bc440dee641886fTorne (Richard Coles) * 3575c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * This is not equal to \c ir_depth_layout_none if and only if this 3585c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * variable is \c gl_FragDepth and a layout qualifier is specified. 3595c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 3605c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_depth_layout depth_layout; 3615c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 3625c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 3638abfc5808a4e34d6e03867af8bc440dee641886fTorne (Richard Coles) * Was the location explicitly set in the shader? 3645c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 3655c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * If the location is explicitly set in the shader, it \b cannot be changed 3665c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * by the linker or by the API (e.g., calls to \c glBindAttribLocation have 3675c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * no effect). 3685c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 3695c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) unsigned explicit_location:1; 3705c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 3718abfc5808a4e34d6e03867af8bc440dee641886fTorne (Richard Coles) /** 3725c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Storage location of the base of this variable 3735c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 3745c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * The precise meaning of this field depends on the nature of the variable. 3758abfc5808a4e34d6e03867af8bc440dee641886fTorne (Richard Coles) * 3765c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * - Vertex shader input: one of the values from \c gl_vert_attrib. 3775c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * - Vertex shader output: one of the values from \c gl_vert_result. 3785c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * - Fragment shader input: one of the values from \c gl_frag_attrib. 3795c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * - Fragment shader output: one of the values from \c gl_frag_result. 3805c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * - Uniforms: Per-stage uniform slot number. 3815c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * - Other: This field is not currently used. 3825c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 3835c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * If the variable is a uniform, shader input, or shader output, and the 3845c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * slot has not been assigned, the value will be -1. 3855c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 3865c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) int location; 3875c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 3885c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 3895c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Emit a warning if this variable is accessed. 3905c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 3915c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) const char *warn_extension; 3925c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 3935c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 3945c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Value assigned in the initializer of a variable declared "const" 3955c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 3965c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_constant *constant_value; 3975c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)}; 3985c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 3995c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 4005c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)/*@{*/ 4018abfc5808a4e34d6e03867af8bc440dee641886fTorne (Richard Coles)/** 4025c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * The representation of a function instance; may be the full definition or 4035c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * simply a prototype. 4045c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 4055c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)class ir_function_signature : public ir_instruction { 4065c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /* An ir_function_signature will be part of the list of signatures in 4075c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * an ir_function. 4085c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 4095c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)public: 4108abfc5808a4e34d6e03867af8bc440dee641886fTorne (Richard Coles) ir_function_signature(const glsl_type *return_type); 4115c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 4125c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual ir_function_signature *clone(void *mem_ctx, 4135c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) struct hash_table *ht) const; 4148abfc5808a4e34d6e03867af8bc440dee641886fTorne (Richard Coles) ir_function_signature *clone_prototype(void *mem_ctx, 4155c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) struct hash_table *ht) const; 4165c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 4175c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual void accept(ir_visitor *v) 4185c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 4195c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) v->visit(this); 4205c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 4215c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 4225c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual ir_visitor_status accept(ir_hierarchical_visitor *); 4235c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 4245c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 4255c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Get the name of the function for which this is a signature 4265c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 4275c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) const char *function_name() const; 4285c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 4295c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 4305c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Get a handle to the function for which this is a signature 4315c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 4325c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * There is no setter function, this function returns a \c const pointer, 4335c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * and \c ir_function_signature::_function is private for a reason. The 4345c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * only way to make a connection between a function and function signature 4355c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * is via \c ir_function::add_signature. This helps ensure that certain 4365c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * invariants (i.e., a function signature is in the list of signatures for 4375c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * its \c _function) are met. 4385c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 4395c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * \sa ir_function::add_signature 4405c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 4415c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) inline const class ir_function *function() const 4425c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 4435c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return this->_function; 4445c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 4455c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 4465c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 4475c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Check whether the qualifiers match between this signature's parameters 448926b001d589ce2f10facb93dd4b87578ea35a855Torne (Richard Coles) * and the supplied parameter list. If not, returns the name of the first 4495c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * parameter with mismatched qualifiers (for use in error messages). 4505c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 4515c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) const char *qualifiers_match(exec_list *params); 4525c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 4535c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 4545c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Replace the current parameter list with the given one. This is useful 4555c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * if the current information came from a prototype, and either has invalid 4565c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * or missing parameter names. 4575c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 4585c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) void replace_parameters(exec_list *new_params); 4595c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 4605c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 4615c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Function return type. 4625c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 4635c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * \note This discards the optional precision qualifier. 4645c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 4655c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) const struct glsl_type *return_type; 4665c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 4675c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 4685c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * List of ir_variable of function parameters. 4695c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 4705c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * This represents the storage. The paramaters passed in a particular 4715c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * call will be in ir_call::actual_paramaters. 4725c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 4735c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) struct exec_list parameters; 4745c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 4755c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** Whether or not this function has a body (which may be empty). */ 4765c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) unsigned is_defined:1; 4775c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 4785c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** Whether or not this function signature is a built-in. */ 4795c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) unsigned is_builtin:1; 4805c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 4815c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** Body of instructions in the function. */ 4825c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) struct exec_list body; 4838abfc5808a4e34d6e03867af8bc440dee641886fTorne (Richard Coles) 4848abfc5808a4e34d6e03867af8bc440dee641886fTorne (Richard Coles)private: 485c0e19a689c8ac22cdc96b291a8d33a5d3b0b34a4Torne (Richard Coles) /** Function of which this signature is one overload. */ 4865c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) class ir_function *_function; 4875c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 4885c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) friend class ir_function; 489926b001d589ce2f10facb93dd4b87578ea35a855Torne (Richard Coles)}; 4905c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 491926b001d589ce2f10facb93dd4b87578ea35a855Torne (Richard Coles) 4925c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)/** 4938abfc5808a4e34d6e03867af8bc440dee641886fTorne (Richard Coles) * Header for tracking multiple overloaded functions with the same name. 49453e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles) * Contains a list of ir_function_signatures representing each of the 495926b001d589ce2f10facb93dd4b87578ea35a855Torne (Richard Coles) * actual functions. 4965c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 4975c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)class ir_function : public ir_instruction { 4985c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)public: 4995c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_function(const char *name); 5005c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 5015c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual ir_function *clone(void *mem_ctx, struct hash_table *ht) const; 5025c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 5035c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual ir_function *as_function() 5045c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 5055c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return this; 5065c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 5075c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 5085c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual void accept(ir_visitor *v) 5095c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 5105c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) v->visit(this); 5115c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 5128abfc5808a4e34d6e03867af8bc440dee641886fTorne (Richard Coles) 5138abfc5808a4e34d6e03867af8bc440dee641886fTorne (Richard Coles) virtual ir_visitor_status accept(ir_hierarchical_visitor *); 514926b001d589ce2f10facb93dd4b87578ea35a855Torne (Richard Coles) 5155c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) void add_signature(ir_function_signature *sig) 5161fad5ca6c42d689812b66fc493992aa6d747a6fbBen Murdoch { 517926b001d589ce2f10facb93dd4b87578ea35a855Torne (Richard Coles) sig->_function = this; 518926b001d589ce2f10facb93dd4b87578ea35a855Torne (Richard Coles) this->signatures.push_tail(sig); 519e1f1df5f01594c0e62e751e4b46e779b85c2faa5Torne (Richard Coles) } 5205c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 5215c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 5225c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Get an iterator for the set of function signatures 5235c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 5245c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) exec_list_iterator iterator() 5255c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 5265c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return signatures.iterator(); 5275c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 5285c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 5295c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 5305c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Find a signature that matches a set of actual parameters, taking implicit 5315c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * conversions into account. 5325c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 5335c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_function_signature *matching_signature(const exec_list *actual_param); 5345c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 5355c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 5365c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Find a signature that exactly matches a set of actual parameters without 5375c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * any implicit type conversions. 5385c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 5395c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_function_signature *exact_matching_signature(const exec_list *actual_ps); 5405c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 541926b001d589ce2f10facb93dd4b87578ea35a855Torne (Richard Coles) /** 5425c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Name of the function. 5435c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 5445c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) const char *name; 5455c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 5465c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** Whether or not this function has a signature that isn't a built-in. */ 5475c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) bool has_user_signature(); 5485c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 5495c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 5505c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * List of ir_function_signature for each overloaded function with this name. 5515c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 5525c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) struct exec_list signatures; 5535c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)}; 5545c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 5555c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)inline const char *ir_function_signature::function_name() const 5565c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles){ 5575c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return this->_function->name; 5585c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)} 5595c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)/*@}*/ 5605c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 5615c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 5625c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)/** 5635c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * IR instruction representing high-level if-statements 5645c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 5655c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)class ir_if : public ir_instruction { 5665c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)public: 5675c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_if(ir_rvalue *condition) 5685c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) : condition(condition) 5695c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 5705c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_type = ir_type_if; 5715c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 5725c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 5735c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual ir_if *clone(void *mem_ctx, struct hash_table *ht) const; 5745c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 5755c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual ir_if *as_if() 5765c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 5775c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return this; 5785c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 5795c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 5805c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual void accept(ir_visitor *v) 5815c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 5825c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) v->visit(this); 5835c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 5845c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 5855c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual ir_visitor_status accept(ir_hierarchical_visitor *); 5865c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 5875c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_rvalue *condition; 588926b001d589ce2f10facb93dd4b87578ea35a855Torne (Richard Coles) /** List of ir_instruction for the body of the then branch */ 5895c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) exec_list then_instructions; 5905c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** List of ir_instruction for the body of the else branch */ 5915c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) exec_list else_instructions; 5925c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)}; 5935c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 5945c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 5955c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)/** 5965c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * IR instruction representing a high-level loop structure. 597591b958dee2cf159d33a0b931e6231072eaf38d5Ben Murdoch */ 5985c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)class ir_loop : public ir_instruction { 5995c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)public: 6005c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_loop(); 6015c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 6025c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual ir_loop *clone(void *mem_ctx, struct hash_table *ht) const; 603591b958dee2cf159d33a0b931e6231072eaf38d5Ben Murdoch 6045c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual void accept(ir_visitor *v) 6055c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 6065c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) v->visit(this); 6075c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 6085c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 6095c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual ir_visitor_status accept(ir_hierarchical_visitor *); 6105c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 6115c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) virtual ir_loop *as_loop() 6125c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 6135c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return this; 614926b001d589ce2f10facb93dd4b87578ea35a855Torne (Richard Coles) } 615926b001d589ce2f10facb93dd4b87578ea35a855Torne (Richard Coles) 61602772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch /** 6175c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Get an iterator for the instructions of the loop body 6185c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 6195c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) exec_list_iterator iterator() 620926b001d589ce2f10facb93dd4b87578ea35a855Torne (Richard Coles) { 621926b001d589ce2f10facb93dd4b87578ea35a855Torne (Richard Coles) return body_instructions.iterator(); 6225c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 6235c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 6245c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** List of ir_instruction that make up the body of the loop. */ 6255c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) exec_list body_instructions; 6265c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 6275c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 6285c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * \name Loop counter and controls 6295c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 6305c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Represents a loop like a FORTRAN \c do-loop. 6315c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 6325c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * \note 6335c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * If \c from and \c to are the same value, the loop will execute once. 6345c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 6355c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /*@{*/ 6365c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_rvalue *from; /** Value of the loop counter on the first 6375c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * iteration of the loop. 6385c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 6395c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_rvalue *to; /** Value of the loop counter on the last 6405c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * iteration of the loop. 6415c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 6425c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_rvalue *increment; 6435c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ir_variable *counter; 6445c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 6455c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 6465c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Comparison operation in the loop terminator. 6475c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 6485c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * If any of the loop control fields are non-\c NULL, this field must be 6495c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * one of \c ir_binop_less, \c ir_binop_greater, \c ir_binop_lequal, 6505c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * \c ir_binop_gequal, \c ir_binop_equal, or \c ir_binop_nequal. 6515c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 6525c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) int cmp; 6535c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /*@}*/ 6545c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)}; 655 656 657class ir_assignment : public ir_instruction { 658public: 659 ir_assignment(ir_rvalue *lhs, ir_rvalue *rhs, ir_rvalue *condition); 660 661 /** 662 * Construct an assignment with an explicit write mask 663 * 664 * \note 665 * Since a write mask is supplied, the LHS must already be a bare 666 * \c ir_dereference. The cannot be any swizzles in the LHS. 667 */ 668 ir_assignment(ir_dereference *lhs, ir_rvalue *rhs, ir_rvalue *condition, 669 unsigned write_mask); 670 671 virtual ir_assignment *clone(void *mem_ctx, struct hash_table *ht) const; 672 673 virtual ir_constant *constant_expression_value(); 674 675 virtual void accept(ir_visitor *v) 676 { 677 v->visit(this); 678 } 679 680 virtual ir_visitor_status accept(ir_hierarchical_visitor *); 681 682 virtual ir_assignment * as_assignment() 683 { 684 return this; 685 } 686 687 /** 688 * Get a whole variable written by an assignment 689 * 690 * If the LHS of the assignment writes a whole variable, the variable is 691 * returned. Otherwise \c NULL is returned. Examples of whole-variable 692 * assignment are: 693 * 694 * - Assigning to a scalar 695 * - Assigning to all components of a vector 696 * - Whole array (or matrix) assignment 697 * - Whole structure assignment 698 */ 699 ir_variable *whole_variable_written(); 700 701 /** 702 * Set the LHS of an assignment 703 */ 704 void set_lhs(ir_rvalue *lhs); 705 706 /** 707 * Left-hand side of the assignment. 708 * 709 * This should be treated as read only. If you need to set the LHS of an 710 * assignment, use \c ir_assignment::set_lhs. 711 */ 712 ir_dereference *lhs; 713 714 /** 715 * Value being assigned 716 */ 717 ir_rvalue *rhs; 718 719 /** 720 * Optional condition for the assignment. 721 */ 722 ir_rvalue *condition; 723 724 725 /** 726 * Component mask written 727 * 728 * For non-vector types in the LHS, this field will be zero. For vector 729 * types, a bit will be set for each component that is written. Note that 730 * for \c vec2 and \c vec3 types only the lower bits will ever be set. 731 * 732 * A partially-set write mask means that each enabled channel gets 733 * the value from a consecutive channel of the rhs. For example, 734 * to write just .xyw of gl_FrontColor with color: 735 * 736 * (assign (constant bool (1)) (xyw) 737 * (var_ref gl_FragColor) 738 * (swiz xyw (var_ref color))) 739 */ 740 unsigned write_mask:4; 741}; 742 743/* Update ir_expression::num_operands() and operator_strs when 744 * updating this list. 745 */ 746enum ir_expression_operation { 747 ir_unop_bit_not, 748 ir_unop_logic_not, 749 ir_unop_neg, 750 ir_unop_abs, 751 ir_unop_sign, 752 ir_unop_rcp, 753 ir_unop_rsq, 754 ir_unop_sqrt, 755 ir_unop_exp, /**< Log base e on gentype */ 756 ir_unop_log, /**< Natural log on gentype */ 757 ir_unop_exp2, 758 ir_unop_log2, 759 ir_unop_f2i, /**< Float-to-integer conversion. */ 760 ir_unop_i2f, /**< Integer-to-float conversion. */ 761 ir_unop_f2b, /**< Float-to-boolean conversion */ 762 ir_unop_b2f, /**< Boolean-to-float conversion */ 763 ir_unop_i2b, /**< int-to-boolean conversion */ 764 ir_unop_b2i, /**< Boolean-to-int conversion */ 765 ir_unop_u2f, /**< Unsigned-to-float conversion. */ 766 ir_unop_any, 767 768 /** 769 * \name Unary floating-point rounding operations. 770 */ 771 /*@{*/ 772 ir_unop_trunc, 773 ir_unop_ceil, 774 ir_unop_floor, 775 ir_unop_fract, 776 ir_unop_round_even, 777 /*@}*/ 778 779 /** 780 * \name Trigonometric operations. 781 */ 782 /*@{*/ 783 ir_unop_sin, 784 ir_unop_cos, 785 ir_unop_sin_reduced, /**< Reduced range sin. [-pi, pi] */ 786 ir_unop_cos_reduced, /**< Reduced range cos. [-pi, pi] */ 787 /*@}*/ 788 789 /** 790 * \name Partial derivatives. 791 */ 792 /*@{*/ 793 ir_unop_dFdx, 794 ir_unop_dFdy, 795 /*@}*/ 796 797 ir_unop_noise, 798 799 /** 800 * A sentinel marking the last of the unary operations. 801 */ 802 ir_last_unop = ir_unop_noise, 803 804 ir_binop_add, 805 ir_binop_sub, 806 ir_binop_mul, 807 ir_binop_div, 808 809 /** 810 * Takes one of two combinations of arguments: 811 * 812 * - mod(vecN, vecN) 813 * - mod(vecN, float) 814 * 815 * Does not take integer types. 816 */ 817 ir_binop_mod, 818 819 /** 820 * \name Binary comparison operators which return a boolean vector. 821 * The type of both operands must be equal. 822 */ 823 /*@{*/ 824 ir_binop_less, 825 ir_binop_greater, 826 ir_binop_lequal, 827 ir_binop_gequal, 828 ir_binop_equal, 829 ir_binop_nequal, 830 /** 831 * Returns single boolean for whether all components of operands[0] 832 * equal the components of operands[1]. 833 */ 834 ir_binop_all_equal, 835 /** 836 * Returns single boolean for whether any component of operands[0] 837 * is not equal to the corresponding component of operands[1]. 838 */ 839 ir_binop_any_nequal, 840 /*@}*/ 841 842 /** 843 * \name Bit-wise binary operations. 844 */ 845 /*@{*/ 846 ir_binop_lshift, 847 ir_binop_rshift, 848 ir_binop_bit_and, 849 ir_binop_bit_xor, 850 ir_binop_bit_or, 851 /*@}*/ 852 853 ir_binop_logic_and, 854 ir_binop_logic_xor, 855 ir_binop_logic_or, 856 857 ir_binop_dot, 858 ir_binop_min, 859 ir_binop_max, 860 861 ir_binop_pow, 862 863 /** 864 * A sentinel marking the last of the binary operations. 865 */ 866 ir_last_binop = ir_binop_pow, 867 868 ir_quadop_vector, 869 870 /** 871 * A sentinel marking the last of all operations. 872 */ 873 ir_last_opcode = ir_last_binop 874}; 875 876class ir_expression : public ir_rvalue { 877public: 878 /** 879 * Constructor for unary operation expressions 880 */ 881 ir_expression(int op, const struct glsl_type *type, ir_rvalue *); 882 ir_expression(int op, ir_rvalue *); 883 884 /** 885 * Constructor for binary operation expressions 886 */ 887 ir_expression(int op, const struct glsl_type *type, 888 ir_rvalue *, ir_rvalue *); 889 ir_expression(int op, ir_rvalue *op0, ir_rvalue *op1); 890 891 /** 892 * Constructor for quad operator expressions 893 */ 894 ir_expression(int op, const struct glsl_type *type, 895 ir_rvalue *, ir_rvalue *, ir_rvalue *, ir_rvalue *); 896 897 virtual ir_expression *as_expression() 898 { 899 return this; 900 } 901 902 virtual ir_expression *clone(void *mem_ctx, struct hash_table *ht) const; 903 904 /** 905 * Attempt to constant-fold the expression 906 * 907 * If the expression cannot be constant folded, this method will return 908 * \c NULL. 909 */ 910 virtual ir_constant *constant_expression_value(); 911 912 /** 913 * Determine the number of operands used by an expression 914 */ 915 static unsigned int get_num_operands(ir_expression_operation); 916 917 /** 918 * Determine the number of operands used by an expression 919 */ 920 unsigned int get_num_operands() const 921 { 922 return (this->operation == ir_quadop_vector) 923 ? this->type->vector_elements : get_num_operands(operation); 924 } 925 926 /** 927 * Return a string representing this expression's operator. 928 */ 929 const char *operator_string(); 930 931 /** 932 * Return a string representing this expression's operator. 933 */ 934 static const char *operator_string(ir_expression_operation); 935 936 937 /** 938 * Do a reverse-lookup to translate the given string into an operator. 939 */ 940 static ir_expression_operation get_operator(const char *); 941 942 virtual void accept(ir_visitor *v) 943 { 944 v->visit(this); 945 } 946 947 virtual ir_visitor_status accept(ir_hierarchical_visitor *); 948 949 ir_expression_operation operation; 950 ir_rvalue *operands[4]; 951}; 952 953 954/** 955 * IR instruction representing a function call 956 */ 957class ir_call : public ir_rvalue { 958public: 959 ir_call(ir_function_signature *callee, exec_list *actual_parameters) 960 : callee(callee) 961 { 962 ir_type = ir_type_call; 963 assert(callee->return_type != NULL); 964 type = callee->return_type; 965 actual_parameters->move_nodes_to(& this->actual_parameters); 966 } 967 968 virtual ir_call *clone(void *mem_ctx, struct hash_table *ht) const; 969 970 virtual ir_constant *constant_expression_value(); 971 972 virtual ir_call *as_call() 973 { 974 return this; 975 } 976 977 virtual void accept(ir_visitor *v) 978 { 979 v->visit(this); 980 } 981 982 virtual ir_visitor_status accept(ir_hierarchical_visitor *); 983 984 /** 985 * Get a generic ir_call object when an error occurs 986 * 987 * Any allocation will be performed with 'ctx' as ralloc owner. 988 */ 989 static ir_call *get_error_instruction(void *ctx); 990 991 /** 992 * Get an iterator for the set of acutal parameters 993 */ 994 exec_list_iterator iterator() 995 { 996 return actual_parameters.iterator(); 997 } 998 999 /** 1000 * Get the name of the function being called. 1001 */ 1002 const char *callee_name() const 1003 { 1004 return callee->function_name(); 1005 } 1006 1007 /** 1008 * Get the function signature bound to this function call 1009 */ 1010 ir_function_signature *get_callee() 1011 { 1012 return callee; 1013 } 1014 1015 /** 1016 * Set the function call target 1017 */ 1018 void set_callee(ir_function_signature *sig); 1019 1020 /** 1021 * Generates an inline version of the function before @ir, 1022 * returning the return value of the function. 1023 */ 1024 ir_rvalue *generate_inline(ir_instruction *ir); 1025 1026 /* List of ir_rvalue of paramaters passed in this call. */ 1027 exec_list actual_parameters; 1028 1029private: 1030 ir_call() 1031 : callee(NULL) 1032 { 1033 this->ir_type = ir_type_call; 1034 } 1035 1036 ir_function_signature *callee; 1037}; 1038 1039 1040/** 1041 * \name Jump-like IR instructions. 1042 * 1043 * These include \c break, \c continue, \c return, and \c discard. 1044 */ 1045/*@{*/ 1046class ir_jump : public ir_instruction { 1047protected: 1048 ir_jump() 1049 { 1050 ir_type = ir_type_unset; 1051 } 1052}; 1053 1054class ir_return : public ir_jump { 1055public: 1056 ir_return() 1057 : value(NULL) 1058 { 1059 this->ir_type = ir_type_return; 1060 } 1061 1062 ir_return(ir_rvalue *value) 1063 : value(value) 1064 { 1065 this->ir_type = ir_type_return; 1066 } 1067 1068 virtual ir_return *clone(void *mem_ctx, struct hash_table *) const; 1069 1070 virtual ir_return *as_return() 1071 { 1072 return this; 1073 } 1074 1075 ir_rvalue *get_value() const 1076 { 1077 return value; 1078 } 1079 1080 virtual void accept(ir_visitor *v) 1081 { 1082 v->visit(this); 1083 } 1084 1085 virtual ir_visitor_status accept(ir_hierarchical_visitor *); 1086 1087 ir_rvalue *value; 1088}; 1089 1090 1091/** 1092 * Jump instructions used inside loops 1093 * 1094 * These include \c break and \c continue. The \c break within a loop is 1095 * different from the \c break within a switch-statement. 1096 * 1097 * \sa ir_switch_jump 1098 */ 1099class ir_loop_jump : public ir_jump { 1100public: 1101 enum jump_mode { 1102 jump_break, 1103 jump_continue 1104 }; 1105 1106 ir_loop_jump(jump_mode mode) 1107 { 1108 this->ir_type = ir_type_loop_jump; 1109 this->mode = mode; 1110 this->loop = loop; 1111 } 1112 1113 virtual ir_loop_jump *clone(void *mem_ctx, struct hash_table *) const; 1114 1115 virtual void accept(ir_visitor *v) 1116 { 1117 v->visit(this); 1118 } 1119 1120 virtual ir_visitor_status accept(ir_hierarchical_visitor *); 1121 1122 bool is_break() const 1123 { 1124 return mode == jump_break; 1125 } 1126 1127 bool is_continue() const 1128 { 1129 return mode == jump_continue; 1130 } 1131 1132 /** Mode selector for the jump instruction. */ 1133 enum jump_mode mode; 1134private: 1135 /** Loop containing this break instruction. */ 1136 ir_loop *loop; 1137}; 1138 1139/** 1140 * IR instruction representing discard statements. 1141 */ 1142class ir_discard : public ir_jump { 1143public: 1144 ir_discard() 1145 { 1146 this->ir_type = ir_type_discard; 1147 this->condition = NULL; 1148 } 1149 1150 ir_discard(ir_rvalue *cond) 1151 { 1152 this->ir_type = ir_type_discard; 1153 this->condition = cond; 1154 } 1155 1156 virtual ir_discard *clone(void *mem_ctx, struct hash_table *ht) const; 1157 1158 virtual void accept(ir_visitor *v) 1159 { 1160 v->visit(this); 1161 } 1162 1163 virtual ir_visitor_status accept(ir_hierarchical_visitor *); 1164 1165 virtual ir_discard *as_discard() 1166 { 1167 return this; 1168 } 1169 1170 ir_rvalue *condition; 1171}; 1172/*@}*/ 1173 1174 1175/** 1176 * Texture sampling opcodes used in ir_texture 1177 */ 1178enum ir_texture_opcode { 1179 ir_tex, /**< Regular texture look-up */ 1180 ir_txb, /**< Texture look-up with LOD bias */ 1181 ir_txl, /**< Texture look-up with explicit LOD */ 1182 ir_txd, /**< Texture look-up with partial derivatvies */ 1183 ir_txf /**< Texel fetch with explicit LOD */ 1184}; 1185 1186 1187/** 1188 * IR instruction to sample a texture 1189 * 1190 * The specific form of the IR instruction depends on the \c mode value 1191 * selected from \c ir_texture_opcodes. In the printed IR, these will 1192 * appear as: 1193 * 1194 * Texel offset (0 or an expression) 1195 * | Projection divisor 1196 * | | Shadow comparitor 1197 * | | | 1198 * v v v 1199 * (tex <type> <sampler> <coordinate> 0 1 ( )) 1200 * (txb <type> <sampler> <coordinate> 0 1 ( ) <bias>) 1201 * (txl <type> <sampler> <coordinate> 0 1 ( ) <lod>) 1202 * (txd <type> <sampler> <coordinate> 0 1 ( ) (dPdx dPdy)) 1203 * (txf <type> <sampler> <coordinate> 0 <lod>) 1204 */ 1205class ir_texture : public ir_rvalue { 1206public: 1207 ir_texture(enum ir_texture_opcode op) 1208 : op(op), projector(NULL), shadow_comparitor(NULL), offset(NULL) 1209 { 1210 this->ir_type = ir_type_texture; 1211 } 1212 1213 virtual ir_texture *clone(void *mem_ctx, struct hash_table *) const; 1214 1215 virtual ir_constant *constant_expression_value(); 1216 1217 virtual void accept(ir_visitor *v) 1218 { 1219 v->visit(this); 1220 } 1221 1222 virtual ir_visitor_status accept(ir_hierarchical_visitor *); 1223 1224 /** 1225 * Return a string representing the ir_texture_opcode. 1226 */ 1227 const char *opcode_string(); 1228 1229 /** Set the sampler and type. */ 1230 void set_sampler(ir_dereference *sampler, const glsl_type *type); 1231 1232 /** 1233 * Do a reverse-lookup to translate a string into an ir_texture_opcode. 1234 */ 1235 static ir_texture_opcode get_opcode(const char *); 1236 1237 enum ir_texture_opcode op; 1238 1239 /** Sampler to use for the texture access. */ 1240 ir_dereference *sampler; 1241 1242 /** Texture coordinate to sample */ 1243 ir_rvalue *coordinate; 1244 1245 /** 1246 * Value used for projective divide. 1247 * 1248 * If there is no projective divide (the common case), this will be 1249 * \c NULL. Optimization passes should check for this to point to a constant 1250 * of 1.0 and replace that with \c NULL. 1251 */ 1252 ir_rvalue *projector; 1253 1254 /** 1255 * Coordinate used for comparison on shadow look-ups. 1256 * 1257 * If there is no shadow comparison, this will be \c NULL. For the 1258 * \c ir_txf opcode, this *must* be \c NULL. 1259 */ 1260 ir_rvalue *shadow_comparitor; 1261 1262 /** Texel offset. */ 1263 ir_rvalue *offset; 1264 1265 union { 1266 ir_rvalue *lod; /**< Floating point LOD */ 1267 ir_rvalue *bias; /**< Floating point LOD bias */ 1268 struct { 1269 ir_rvalue *dPdx; /**< Partial derivative of coordinate wrt X */ 1270 ir_rvalue *dPdy; /**< Partial derivative of coordinate wrt Y */ 1271 } grad; 1272 } lod_info; 1273}; 1274 1275 1276struct ir_swizzle_mask { 1277 unsigned x:2; 1278 unsigned y:2; 1279 unsigned z:2; 1280 unsigned w:2; 1281 1282 /** 1283 * Number of components in the swizzle. 1284 */ 1285 unsigned num_components:3; 1286 1287 /** 1288 * Does the swizzle contain duplicate components? 1289 * 1290 * L-value swizzles cannot contain duplicate components. 1291 */ 1292 unsigned has_duplicates:1; 1293}; 1294 1295 1296class ir_swizzle : public ir_rvalue { 1297public: 1298 ir_swizzle(ir_rvalue *, unsigned x, unsigned y, unsigned z, unsigned w, 1299 unsigned count); 1300 1301 ir_swizzle(ir_rvalue *val, const unsigned *components, unsigned count); 1302 1303 ir_swizzle(ir_rvalue *val, ir_swizzle_mask mask); 1304 1305 virtual ir_swizzle *clone(void *mem_ctx, struct hash_table *) const; 1306 1307 virtual ir_constant *constant_expression_value(); 1308 1309 virtual ir_swizzle *as_swizzle() 1310 { 1311 return this; 1312 } 1313 1314 /** 1315 * Construct an ir_swizzle from the textual representation. Can fail. 1316 */ 1317 static ir_swizzle *create(ir_rvalue *, const char *, unsigned vector_length); 1318 1319 virtual void accept(ir_visitor *v) 1320 { 1321 v->visit(this); 1322 } 1323 1324 virtual ir_visitor_status accept(ir_hierarchical_visitor *); 1325 1326 bool is_lvalue() 1327 { 1328 return val->is_lvalue() && !mask.has_duplicates; 1329 } 1330 1331 /** 1332 * Get the variable that is ultimately referenced by an r-value 1333 */ 1334 virtual ir_variable *variable_referenced(); 1335 1336 ir_rvalue *val; 1337 ir_swizzle_mask mask; 1338 1339private: 1340 /** 1341 * Initialize the mask component of a swizzle 1342 * 1343 * This is used by the \c ir_swizzle constructors. 1344 */ 1345 void init_mask(const unsigned *components, unsigned count); 1346}; 1347 1348 1349class ir_dereference : public ir_rvalue { 1350public: 1351 virtual ir_dereference *clone(void *mem_ctx, struct hash_table *) const = 0; 1352 1353 virtual ir_dereference *as_dereference() 1354 { 1355 return this; 1356 } 1357 1358 bool is_lvalue(); 1359 1360 /** 1361 * Get the variable that is ultimately referenced by an r-value 1362 */ 1363 virtual ir_variable *variable_referenced() = 0; 1364}; 1365 1366 1367class ir_dereference_variable : public ir_dereference { 1368public: 1369 ir_dereference_variable(ir_variable *var); 1370 1371 virtual ir_dereference_variable *clone(void *mem_ctx, 1372 struct hash_table *) const; 1373 1374 virtual ir_constant *constant_expression_value(); 1375 1376 virtual ir_dereference_variable *as_dereference_variable() 1377 { 1378 return this; 1379 } 1380 1381 /** 1382 * Get the variable that is ultimately referenced by an r-value 1383 */ 1384 virtual ir_variable *variable_referenced() 1385 { 1386 return this->var; 1387 } 1388 1389 virtual ir_variable *whole_variable_referenced() 1390 { 1391 /* ir_dereference_variable objects always dereference the entire 1392 * variable. However, if this dereference is dereferenced by anything 1393 * else, the complete deferefernce chain is not a whole-variable 1394 * dereference. This method should only be called on the top most 1395 * ir_rvalue in a dereference chain. 1396 */ 1397 return this->var; 1398 } 1399 1400 virtual void accept(ir_visitor *v) 1401 { 1402 v->visit(this); 1403 } 1404 1405 virtual ir_visitor_status accept(ir_hierarchical_visitor *); 1406 1407 /** 1408 * Object being dereferenced. 1409 */ 1410 ir_variable *var; 1411}; 1412 1413 1414class ir_dereference_array : public ir_dereference { 1415public: 1416 ir_dereference_array(ir_rvalue *value, ir_rvalue *array_index); 1417 1418 ir_dereference_array(ir_variable *var, ir_rvalue *array_index); 1419 1420 virtual ir_dereference_array *clone(void *mem_ctx, 1421 struct hash_table *) const; 1422 1423 virtual ir_constant *constant_expression_value(); 1424 1425 virtual ir_dereference_array *as_dereference_array() 1426 { 1427 return this; 1428 } 1429 1430 /** 1431 * Get the variable that is ultimately referenced by an r-value 1432 */ 1433 virtual ir_variable *variable_referenced() 1434 { 1435 return this->array->variable_referenced(); 1436 } 1437 1438 virtual void accept(ir_visitor *v) 1439 { 1440 v->visit(this); 1441 } 1442 1443 virtual ir_visitor_status accept(ir_hierarchical_visitor *); 1444 1445 ir_rvalue *array; 1446 ir_rvalue *array_index; 1447 1448private: 1449 void set_array(ir_rvalue *value); 1450}; 1451 1452 1453class ir_dereference_record : public ir_dereference { 1454public: 1455 ir_dereference_record(ir_rvalue *value, const char *field); 1456 1457 ir_dereference_record(ir_variable *var, const char *field); 1458 1459 virtual ir_dereference_record *clone(void *mem_ctx, 1460 struct hash_table *) const; 1461 1462 virtual ir_constant *constant_expression_value(); 1463 1464 /** 1465 * Get the variable that is ultimately referenced by an r-value 1466 */ 1467 virtual ir_variable *variable_referenced() 1468 { 1469 return this->record->variable_referenced(); 1470 } 1471 1472 virtual void accept(ir_visitor *v) 1473 { 1474 v->visit(this); 1475 } 1476 1477 virtual ir_visitor_status accept(ir_hierarchical_visitor *); 1478 1479 ir_rvalue *record; 1480 const char *field; 1481}; 1482 1483 1484/** 1485 * Data stored in an ir_constant 1486 */ 1487union ir_constant_data { 1488 unsigned u[16]; 1489 int i[16]; 1490 float f[16]; 1491 bool b[16]; 1492}; 1493 1494 1495class ir_constant : public ir_rvalue { 1496public: 1497 ir_constant(const struct glsl_type *type, const ir_constant_data *data); 1498 ir_constant(bool b); 1499 ir_constant(unsigned int u); 1500 ir_constant(int i); 1501 ir_constant(float f); 1502 1503 /** 1504 * Construct an ir_constant from a list of ir_constant values 1505 */ 1506 ir_constant(const struct glsl_type *type, exec_list *values); 1507 1508 /** 1509 * Construct an ir_constant from a scalar component of another ir_constant 1510 * 1511 * The new \c ir_constant inherits the type of the component from the 1512 * source constant. 1513 * 1514 * \note 1515 * In the case of a matrix constant, the new constant is a scalar, \b not 1516 * a vector. 1517 */ 1518 ir_constant(const ir_constant *c, unsigned i); 1519 1520 /** 1521 * Return a new ir_constant of the specified type containing all zeros. 1522 */ 1523 static ir_constant *zero(void *mem_ctx, const glsl_type *type); 1524 1525 virtual ir_constant *clone(void *mem_ctx, struct hash_table *) const; 1526 1527 virtual ir_constant *constant_expression_value(); 1528 1529 virtual ir_constant *as_constant() 1530 { 1531 return this; 1532 } 1533 1534 virtual void accept(ir_visitor *v) 1535 { 1536 v->visit(this); 1537 } 1538 1539 virtual ir_visitor_status accept(ir_hierarchical_visitor *); 1540 1541 /** 1542 * Get a particular component of a constant as a specific type 1543 * 1544 * This is useful, for example, to get a value from an integer constant 1545 * as a float or bool. This appears frequently when constructors are 1546 * called with all constant parameters. 1547 */ 1548 /*@{*/ 1549 bool get_bool_component(unsigned i) const; 1550 float get_float_component(unsigned i) const; 1551 int get_int_component(unsigned i) const; 1552 unsigned get_uint_component(unsigned i) const; 1553 /*@}*/ 1554 1555 ir_constant *get_array_element(unsigned i) const; 1556 1557 ir_constant *get_record_field(const char *name); 1558 1559 /** 1560 * Determine whether a constant has the same value as another constant 1561 * 1562 * \sa ir_constant::is_zero, ir_constant::is_one, 1563 * ir_constant::is_negative_one 1564 */ 1565 bool has_value(const ir_constant *) const; 1566 1567 virtual bool is_zero() const; 1568 virtual bool is_one() const; 1569 virtual bool is_negative_one() const; 1570 1571 /** 1572 * Value of the constant. 1573 * 1574 * The field used to back the values supplied by the constant is determined 1575 * by the type associated with the \c ir_instruction. Constants may be 1576 * scalars, vectors, or matrices. 1577 */ 1578 union ir_constant_data value; 1579 1580 /* Array elements */ 1581 ir_constant **array_elements; 1582 1583 /* Structure fields */ 1584 exec_list components; 1585 1586private: 1587 /** 1588 * Parameterless constructor only used by the clone method 1589 */ 1590 ir_constant(void); 1591}; 1592 1593/*@}*/ 1594 1595/** 1596 * Apply a visitor to each IR node in a list 1597 */ 1598void 1599visit_exec_list(exec_list *list, ir_visitor *visitor); 1600 1601/** 1602 * Validate invariants on each IR node in a list 1603 */ 1604void validate_ir_tree(exec_list *instructions); 1605 1606/** 1607 * Make a clone of each IR instruction in a list 1608 * 1609 * \param in List of IR instructions that are to be cloned 1610 * \param out List to hold the cloned instructions 1611 */ 1612void 1613clone_ir_list(void *mem_ctx, exec_list *out, const exec_list *in); 1614 1615extern void 1616_mesa_glsl_initialize_variables(exec_list *instructions, 1617 struct _mesa_glsl_parse_state *state); 1618 1619extern void 1620_mesa_glsl_initialize_functions(_mesa_glsl_parse_state *state); 1621 1622extern void 1623_mesa_glsl_release_functions(void); 1624 1625extern void 1626reparent_ir(exec_list *list, void *mem_ctx); 1627 1628struct glsl_symbol_table; 1629 1630extern void 1631import_prototypes(const exec_list *source, exec_list *dest, 1632 struct glsl_symbol_table *symbols, void *mem_ctx); 1633 1634extern bool 1635ir_has_call(ir_instruction *ir); 1636 1637extern void 1638do_set_program_inouts(exec_list *instructions, struct gl_program *prog); 1639 1640#endif /* IR_H */ 1641