irutils.h

/*
 * SPDX-FileCopyrightText: 2022 The P4 Language Consortium
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef IR_IRUTILS_H_
#define IR_IRUTILS_H_
 
#include <initializer_list>
#include <vector>
 
#include "lib/source_file.h"
 
namespace P4 {
 
class Transform;
 
namespace IR {
 
// Forward-declare some IR classes that are used in function declarations.
class BoolLiteral;
class StringLiteral;
class Constant;
class Expression;
class BaseListExpression;
class Literal;
class Node;
class StatOrDecl;
class StructExpression;
class Type;
class Type_Bits;
template <typename T>
class IndexedVector;

//
// Some of these are just thin wrappers around functions in the IR, but it's nice having everything
// in one place.
 
/* =========================================================================================
 *  Types
 * ========================================================================================= */

const Type_Bits *getBitTypeToFit(int value);
 
/* =========================================================================================
 *  Expressions
 * ========================================================================================= */

const IR::Constant *getMaxValueConstant(const Type *t, const Util::SourceInfo &srcInfo = {});

const IR::Expression *getDefaultValue(const Type *type, const Util::SourceInfo &srcInfo = {},
                                      bool valueRequired = false);

const IR::Constant *convertBoolLiteral(const IR::BoolLiteral *lit);

std::vector<const Expression *> flattenStructExpression(const StructExpression *structExpr);

std::vector<const Expression *> flattenListExpression(const BaseListExpression *listExpr);

std::vector<const Expression *> flattenListOrStructExpression(const Expression *listLikeExpr);
 
/* =========================================================================================
 *  Other helper functions
 * ========================================================================================= */

big_int getBigIntFromLiteral(const Literal *);

int getIntFromLiteral(const Literal *);

// This is 2^(t->size) - 1 for unsigned and 2^(t->size - 1) - 1 for signed.
big_int getMaxBvVal(const Type *t);

big_int getMaxBvVal(int bitWidth);

// This is 0 for unsigned and -(2^(t->size - 1)) for signed.
big_int getMinBvVal(const Type *t);

const IR::Node *inlineBlock(const Transform &, std::initializer_list<const IR::StatOrDecl *>);
const IR::Node *inlineBlock(const Transform &, const IR::IndexedVector<IR::StatOrDecl> &);
const IR::Node *inlineBlock(const Transform &, IR::IndexedVector<IR::StatOrDecl> &&);
 
}  // namespace IR
 
}  // namespace P4
 
#endif /* IR_IRUTILS_H_ */