13883670119

Committed 16 Mar 2025 01:05PM UTC coverage: 77.261% (-0.01%) from 77.273%

Build # 13883670119

Build Type

push

github

Committed by

web-flow

Commit Message

Refactor ast::Node (add numChildren method, use in64_t) (#223)

* Add numChildren method to be called instead of `node->children.size()`
* Use int64_t instead of long int everywhere
* Related refactoring (includes, unsigned suffixes, const &)

Run Details

90 of 99 new or added lines in 7 files covered. (90.91%)

1 existing line in 1 file now uncovered.

4373 of 5660 relevant lines covered (77.26%)

250.94 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

80.71

/compiler/lib/backend/ast/optimizer/optimizer.cpp

#include "optimizer/optimizer.hpp"

#include <algorithm>
#include <cstdint>
#include <variant>

#include "compiler/ast/node.hpp"
#include "compiler/ast/node_type.hpp"
#include "compiler/utils/language.hpp"

#include "optimizer/optimizer_context.hpp"

using namespace ast;
using namespace optimizer;

namespace language = utils::language;

namespace {

bool isLiteral(const Node::Ptr &node) {
    switch (node->type) {
    case NodeType::IntegerLiteralValue:
    case NodeType::FloatingPointLiteralValue:
    case NodeType::StringLiteralValue:
        return true;
    default:
        return false;
    }
}

bool isAssignment(const Node::Ptr &node) {
    return node->type == NodeType::BinaryOperation && node->binOp() == BinaryOperation::Assign;
}

bool isZeroIntLiteral(const Node::Ptr &node) {
    return node->type == NodeType::IntegerLiteralValue && node->intNum() == 0;
}

bool isNonZeroIntLiteral(const Node::Ptr &node) {
    return node->type == NodeType::IntegerLiteralValue && node->intNum() != 0;
}

bool isZeroFloatLiteral(const Node::Ptr &node) {
    return node->type == NodeType::FloatingPointLiteralValue && node->fpNum() == 0.0;
}

bool isNonZeroFloatLiteral(const Node::Ptr &node) {
    return node->type == NodeType::FloatingPointLiteralValue && node->fpNum() != 0.0;
}

bool isTruthyLiteral(const Node::Ptr &node) {
    return isNonZeroIntLiteral(node) || isNonZeroFloatLiteral(node);
}

bool isFalsyLiteral(const Node::Ptr &node) {
    return isZeroIntLiteral(node) || isZeroFloatLiteral(node);
}

bool isNumericLiteral(const Node::Ptr &node) {
    return node->type == NodeType::IntegerLiteralValue || node->type == NodeType::FloatingPointLiteralValue;
}

bool isModifiedVariable(const Node::Ptr &node, OptimizerContext &ctx) {
    return node->type == NodeType::VariableName && ctx.findVariable(node).attributes.modified;
}

bool isNonModifiedVariable(const Node::Ptr &node, OptimizerContext &ctx) {
    return node->type == NodeType::VariableName && !ctx.findVariable(node).attributes.modified &&
           node->parent->type != NodeType::VariableDeclaration;
}

bool isVariableWithType(const Node::Ptr &node, TypeId typeId, OptimizerContext &ctx) {
    return node->type == NodeType::VariableName && ctx.findVariable(node).type == typeId;
}

bool canBeConstantInt(const Node::Ptr &node, OptimizerContext &ctx) {
    return node->type == NodeType::IntegerLiteralValue || isVariableWithType(node, BuiltInTypes::IntType, ctx);
}

bool canBeConstantFloat(const Node::Ptr &node, OptimizerContext &ctx) {
    return node->type == NodeType::FloatingPointLiteralValue || isVariableWithType(node, BuiltInTypes::FloatType, ctx);
}

} // namespace

int64_t calculateIntOperation(Node::Ptr &first, Node::Ptr &second, BinaryOperation operation, OptimizerContext &ctx) {
    int64_t lhs = first->type == NodeType::VariableName ? std::get<int64_t>(ctx.findVariableValue(first->str()))
                                                        : first->intNum();
    int64_t rhs = second->type == NodeType::VariableName ? std::get<int64_t>(ctx.findVariableValue(second->str()))
                                                         : second->intNum();

    switch (operation) {
    case BinaryOperation::Add:
        return lhs + rhs;
    case BinaryOperation::Sub:
        return lhs - rhs;
    case BinaryOperation::Mult:
        return lhs * rhs;
    case BinaryOperation::Div:
        return lhs / rhs;
    case BinaryOperation::Equal:
        return lhs == rhs;
    case BinaryOperation::And:
        return lhs && rhs;
    case BinaryOperation::Or:
        return lhs || rhs;
    case BinaryOperation::Greater:
        return lhs > rhs;
    case BinaryOperation::GreaterEqual:
        return lhs >= rhs;
    case BinaryOperation::Less:
        return lhs < rhs;
    case BinaryOperation::LessEqual:
        return lhs <= rhs;
    case BinaryOperation::NotEqual:
        return lhs != rhs;
    default:
        return 0;
    }
}

double calculateFloatOperation(Node::Ptr &first, Node::Ptr &second, BinaryOperation operation, OptimizerContext &ctx) {
    double lhs =
        first->type == NodeType::VariableName ? std::get<double>(ctx.findVariableValue(first->str())) : first->fpNum();
    double rhs = second->type == NodeType::VariableName ? std::get<double>(ctx.findVariableValue(second->str()))
                                                        : second->fpNum();

    switch (operation) {
    case BinaryOperation::FAdd:
        return lhs + rhs;
    case BinaryOperation::FSub:
        return lhs - rhs;
    case BinaryOperation::FMult:
        return lhs * rhs;
    case BinaryOperation::FDiv:
        return lhs / rhs;
    case BinaryOperation::FEqual:
        return lhs == rhs;
    case BinaryOperation::FAnd:
        return lhs && rhs;
    case BinaryOperation::FOr:
        return lhs || rhs;
    case BinaryOperation::FGreater:
        return lhs > rhs;
    case BinaryOperation::FGreaterEqual:
        return lhs >= rhs;
    case BinaryOperation::FLess:
        return lhs < rhs;
    case BinaryOperation::FLessEqual:
        return lhs <= rhs;
    case BinaryOperation::FNotEqual:
        return lhs != rhs;
    default:
        return 0.0;
    }
}

bool constantPropagation(Node::Ptr &first, Node::Ptr &second, OptimizerContext &ctx) {
    auto parent = first->parent;
    if (isAssignment(parent) || isModifiedVariable(first, ctx) || isModifiedVariable(second, ctx))
        return false;
    if (canBeConstantInt(first, ctx) && canBeConstantInt(second, ctx)) {
        parent->type = NodeType::IntegerLiteralValue;
        parent->value = calculateIntOperation(first, second, parent->binOp(), ctx);
        parent->children.clear();
        return true;
    }
    if (canBeConstantFloat(first, ctx) && canBeConstantFloat(second, ctx)) {
        parent->type = NodeType::FloatingPointLiteralValue;
        parent->value = calculateFloatOperation(first, second, parent->binOp(), ctx);
        parent->children.clear();
        return true;
    }
    return false;
}

void processTypeConversion(Node::Ptr &node, OptimizerContext &ctx) {
    Node::Ptr &operand = node->lastChild();
    if (isNumericLiteral(operand)) {
        if (node->firstChild()->typeId() == BuiltInTypes::FloatType) {
            node->type = NodeType::FloatingPointLiteralValue;
            node->value = static_cast<double>(operand->intNum());
        } else {
            node->type = NodeType::IntegerLiteralValue;
            node->value = static_cast<int64_t>(operand->fpNum());
        }
        node->children.clear();
        return;
    }

    if (isNonModifiedVariable(operand, ctx)) {
        const std::string &varName = operand->str();
        if (node->firstChild()->typeId() == BuiltInTypes::FloatType) {
            node->type = NodeType::FloatingPointLiteralValue;
            node->value = static_cast<double>(std::get<int64_t>(ctx.findVariableValue(varName)));
        } else {
            node->type = NodeType::IntegerLiteralValue;
            node->value = static_cast<int64_t>(std::get<double>(ctx.findVariableValue(varName)));
        }
        node->children.clear();
    }
}

bool constantFolding(Node::Ptr &first, Node::Ptr &second, OptimizerContext &ctx) {
    auto parent = first->parent;
    if (first->type == NodeType::IntegerLiteralValue && second->type == NodeType::IntegerLiteralValue) {
        parent->type = NodeType::IntegerLiteralValue;
        parent->value = calculateIntOperation(first, second, parent->binOp(), ctx);
        parent->children.clear();
        return true;
    }
    if (first->type == NodeType::FloatingPointLiteralValue && second->type == NodeType::FloatingPointLiteralValue) {
        parent->type = NodeType::FloatingPointLiteralValue;
        parent->value = calculateFloatOperation(first, second, parent->binOp(), ctx);
        parent->children.clear();
        return true;
    }
    return false;
}

void variablePropagation(Node::Ptr &node, OptimizerContext &ctx) {
    const std::string &varName = node->str();
    if (!ctx.hasVariable(varName))
        return;
    auto variableIter = ctx.findVariableValue(varName);
    if (ctx.findVariable(node).type == BuiltInTypes::FloatType) {
        node->type = NodeType::FloatingPointLiteralValue;
        node->value = std::get<double>(variableIter);
    } else {
        node->type = NodeType::IntegerLiteralValue;
        node->value = std::get<int64_t>(variableIter);
    }
}

void pushVariableAttribute(Node::Ptr &node, Node::Ptr &child, OptimizerContext &ctx) {
    TypeId type;
    auto parent = node->parent;
    for (auto &iter : parent->children) {
        if (iter->type == NodeType::TypeName) {
            type = iter->typeId();
            continue;
        }
        if (iter->type == NodeType::VariableName) {
            const std::string &varName = iter->str();
            if (type == BuiltInTypes::IntType)
                ctx.values.front().emplace(varName, child->intNum()); // fix
            else if (type == BuiltInTypes::FloatType)
                ctx.values.front().emplace(varName, child->fpNum());
        }
    }
}

void processExpression(Node::Ptr &node, OptimizerContext &ctx);

void copyExpression(const Node::Ptr &node, Node::Ptr &newExpr, std::unordered_map<std::string, Node::Ptr> &map) {
    for (const auto &child : node->children) {
        auto type = child->type;
        switch (type) {
        case NodeType::BinaryOperation:
            newExpr->children.emplace_back(new Node(child->binOp(), newExpr));
            copyExpression(child, newExpr->children.back(), map);
            break;
        case NodeType::TypeConversion:
            newExpr->children.emplace_back(new Node(NodeType::TypeConversion, newExpr));
            copyExpression(child, newExpr->children.back(), map);
            break;
        case NodeType::IntegerLiteralValue:
            newExpr->children.emplace_back(new Node(child->intNum(), newExpr));
            break;
        case NodeType::FloatingPointLiteralValue:
            newExpr->children.emplace_back(new Node(child->fpNum(), newExpr));
            break;
        case NodeType::VariableName:
            newExpr->children.emplace_back(map[child->str()]);
            newExpr->children.back()->parent = newExpr;
            break;
        case NodeType::TypeName:
            newExpr->children.emplace_back(new Node(child->typeId(), newExpr));
            break;
        default:
            break;
        }
    }
}

void processFunctionCall(Node::Ptr &node, Node functionRoot) {
    if (functionRoot.numChildren() != 1U)
        return;
    auto returnExpr = functionRoot.lastChild()->lastChild();
    if (isNumericLiteral(returnExpr->firstChild())) {
        Node::Ptr newExpr;
        auto literal = returnExpr->firstChild();
        if (literal->type == NodeType::IntegerLiteralValue)
            newExpr = std::make_shared<Node>(literal->intNum(), node->parent);
        if (literal->type == NodeType::FloatingPointLiteralValue)
            newExpr = std::make_shared<Node>(literal->fpNum(), node->parent);
        node = newExpr;
    }

    if (node->numChildren() > 1U) {
        std::unordered_map<std::string, Node::Ptr> map;
        auto nodeArgsIter = node->secondChild()->children.begin();
        for (auto &argsIter : functionRoot.parent->secondChild()->children) {
            map[argsIter->lastChild()->str()] = (*nodeArgsIter)->firstChild();
            nodeArgsIter++;
        }
        Node::Ptr newExpr = std::make_shared<Node>(NodeType::Expression, node->parent);
        copyExpression(returnExpr, newExpr, map);
        node = newExpr->firstChild();
        node->parent = newExpr->parent;
    }
}

bool processBinaryOperation(Node::Ptr &node, OptimizerContext &ctx) {
    auto first = node->firstChild();
    auto second = node->lastChild();
    bool haveFunctionCall = false;
    if (first->type == NodeType::BinaryOperation)
        haveFunctionCall = processBinaryOperation(first, ctx);
    if (second->type == NodeType::BinaryOperation)
        haveFunctionCall = processBinaryOperation(second, ctx);
    if (first->type == NodeType::TypeConversion)
        processTypeConversion(first, ctx);
    if (second->type == NodeType::TypeConversion)
        processTypeConversion(second, ctx);
    bool isConsExpr = constantFolding(first, second, ctx);
    bool isNotModifiedExpr = false;
    if (!isConsExpr)
        isNotModifiedExpr = constantPropagation(first, second, ctx);
    if (first->type == NodeType::FunctionCall) {
        haveFunctionCall = true;
        auto funct = ctx.functions.find(first->firstChild()->str());
        funct->second.useCount++;
        if (funct->second.returnType != BuiltInTypes::NoneType) {
            for (auto &rootIter : ctx.root->children) {
                if (rootIter->firstChild()->str() == funct->first) {
                    processFunctionCall(node->firstChild(), *(rootIter->lastChild()));
                    break;
                }
            }
        }
    }
    if (second->type == NodeType::FunctionCall) {
        haveFunctionCall = true;
        auto funct = ctx.functions.find(second->firstChild()->str());
        funct->second.useCount++;
        if (funct->second.returnType != BuiltInTypes::NoneType) {
            for (auto &rootIter : ctx.root->children) {
                if (rootIter->firstChild()->str() == funct->first) {
                    processFunctionCall(node->lastChild(), *(rootIter->lastChild()));
                    break;
                }
            }
        }
    }
    if (haveFunctionCall)
        processExpression(node, ctx);
    return haveFunctionCall;
}

void processExpression(Node::Ptr &node, OptimizerContext &ctx) {
    for (auto &child : node->children) {
        if (child->type == NodeType::BinaryOperation) {
            auto first = child->firstChild();
            auto second = child->lastChild();
            bool haveFunctionCall = false;
            if (first->type == NodeType::BinaryOperation)
                haveFunctionCall = processBinaryOperation(first, ctx);
            if (second->type == NodeType::BinaryOperation)
                haveFunctionCall = processBinaryOperation(second, ctx);
            if (haveFunctionCall)
                processExpression(node, ctx);
            if (child->binOp() == BinaryOperation::Assign) {
                if (isNonModifiedVariable(second, ctx)) {
                    variablePropagation(second, ctx);
                }
            }
            if (first->type == NodeType::TypeConversion)
                processTypeConversion(first, ctx);
            if (second->type == NodeType::TypeConversion)
                processTypeConversion(second, ctx);
            bool isConsExpr = constantFolding(first, second, ctx);
            bool isNotModifiedExpr = false;
            if (!isConsExpr)
                isNotModifiedExpr = constantPropagation(first, second, ctx);
            if (isConsExpr || isNotModifiedExpr) {
                pushVariableAttribute(node, child, ctx);
            }
            if (first->type == NodeType::FunctionCall) {
                ctx.functions.find(first->firstChild()->str())->second.useCount++;
                haveFunctionCall = true;
            }
            if (second->type == NodeType::FunctionCall) {
                haveFunctionCall = true;
                auto funct = ctx.functions.find(second->firstChild()->str());
                funct->second.useCount++;
                if (funct->second.returnType != BuiltInTypes::NoneType) {
                    for (auto &rootIter : ctx.root->children) {
                        if (rootIter->firstChild()->str() == funct->first) {
                            processFunctionCall(child->lastChild(), *(rootIter->lastChild()));
                            break;
                        }
                    }
                }
                processExpression(node, ctx);
            }
            if (isAssignment(child) && haveFunctionCall) {
                ctx.findVariable(child->firstChild()).attributes.modified = true;
            }
            continue;
        }

        if (child->type == NodeType::FunctionCall) {
            auto lastChild = child->lastChild();
            processExpression(lastChild, ctx);
            ctx.functions.find(child->firstChild()->str())->second.useCount++;
            if (lastChild->type == NodeType::FunctionName)
                continue;
        }

        if (child->type == NodeType::TypeConversion) {
            processTypeConversion(child, ctx);
            pushVariableAttribute(node, child, ctx);
            continue;
        }

        if (isNumericLiteral(child)) {
            pushVariableAttribute(node, child, ctx);
            continue;
        }

        if (isNonModifiedVariable(child, ctx)) {
            variablePropagation(child, ctx);
            continue;
        }

        processExpression(child, ctx);
    }
}

void changeVariablesAttributes(Node::Ptr &node, OptimizerContext &ctx) {
    for (auto &child : node->children) {
        if (child->type == NodeType::Expression) {
            auto &exprNode = child->firstChild();
            if (isAssignment(exprNode)) {
                ctx.findVariable(exprNode->firstChild()).attributes.modified = true;
            }
        }
    }
}

bool isUnusedVariable(const std::list<ast::Node::Ptr>::iterator &nodeIter, const std::string &name,
                      bool isFirstCall = true) {
    Node::Ptr &node = *nodeIter;
    auto &children = node->parent->children;
    auto endIter = children.end();
    if (node->parent->type == NodeType::BranchRoot && !isFirstCall) {
        endIter = std::find_if(children.begin(), children.end(), [&name](const Node::Ptr &node) {
            return node->type == NodeType::VariableDeclaration && node->secondChild()->str() == name;
        });
    }
    for (auto childIter = nodeIter; childIter != endIter; childIter++) {
        Node::Ptr &child = *childIter;
        if (child->type != NodeType::VariableDeclaration && !child->children.empty()) {
            bool unused = isUnusedVariable(child->children.begin(), name, false);
            if (child->type != NodeType::BranchRoot && unused)
                continue;
            return unused;
        }
        if (child->type == NodeType::VariableName && child->str() == name)
            return false;
    }
    return true;
}

void processBranchRoot(Node::Ptr &node, OptimizerContext &ctx) {
    ctx.variables.push_front(&node->variables());
    ctx.values.emplace_front();
    for (auto childIter = node->children.begin(); childIter != node->children.end(); childIter++) {
        Node::Ptr &child = *childIter;
        if (child->type == NodeType::Expression || child->type == NodeType::VariableDeclaration) {
            processExpression(child, ctx);
        }

        if (child->type == NodeType::IfStatement) {
            processExpression(child->firstChild(), ctx);
            auto &exprResult = child->firstChild()->firstChild();
            if (isNumericLiteral(exprResult)) {
                child->children.pop_front();
                if (isTruthyLiteral(exprResult)) {
                    processBranchRoot(child->children.front(), ctx);
                    child = child->children.front();
                } else {
                    child->children.pop_front();
                    for (auto &ifChild : child->children) {
                        if (ifChild->type == NodeType::ElifStatement) {
                            processExpression(ifChild->firstChild(), ctx);
                        } else {
                            child = ifChild->firstChild();
                            processBranchRoot(child, ctx);
                            break;
                        }
                        auto &ifExprResult = ifChild->firstChild()->firstChild();
                        if (isNumericLiteral(ifExprResult)) {
                            ifChild->children.pop_front();
                            if (isTruthyLiteral(ifExprResult)) {
                                child = ifChild->children.front();
                                processBranchRoot(child, ctx);
                                break;
                            } else {
                                ifChild->children.clear();
                            }
                        }
                    }

                    child->children.remove_if([](const Node::Ptr &node) {
                        return node->type == NodeType::ElifStatement && node->children.empty();
                    });

                    if (child->children.empty()) {
                        child->type = NodeType::BranchRoot;
                    }
                }
            } else {
                changeVariablesAttributes(child->secondChild(), ctx);
                processBranchRoot(child->secondChild(), ctx);
            }
        }

        if (child->type == NodeType::WhileStatement) {
            processExpression(child->firstChild(), ctx);
            auto &exprResult = child->firstChild()->firstChild();
            if (isNumericLiteral(exprResult)) {
                if (isFalsyLiteral(exprResult)) {
                    child->children.clear();
                    child->type = NodeType::BranchRoot;
                } else if (isTruthyLiteral(exprResult)) {
                    auto currNode = child->parent;
                    auto prevNode = child;
                    while (currNode->parent->type != NodeType::FunctionDefinition) {
                        if ((currNode->type == NodeType::IfStatement || currNode->type == NodeType::ElifStatement ||
                             currNode->type == NodeType::WhileStatement) &&
                            isNumericLiteral(currNode->firstChild()->firstChild()) &&
                            !isTruthyLiteral(currNode->firstChild()->firstChild()))
                            break;
                        prevNode = currNode;
                        currNode = currNode->parent;
                    }
                    if (currNode->parent->type == NodeType::FunctionDefinition) {
                        auto iter =
                            std::find_if(currNode->children.begin(), currNode->children.end(),
                                         [&prevNode](const Node::Ptr &node) { return node.get() == prevNode.get(); });
                        currNode->children.erase(std::next(iter), currNode->children.end());
                        break;
                    }
                }
            } else {
                changeVariablesAttributes(child->secondChild(), ctx);
                processBranchRoot(child->secondChild(), ctx);
            }
        }

        if (child->type == NodeType::ReturnStatement) {
            processExpression(child->firstChild(), ctx);
            if (node->parent->type == NodeType::FunctionDefinition) {
                node->children.erase(std::next(childIter), node->children.end());
                break;
            }
        }

        if (child->type == NodeType::VariableDeclaration && ctx.options.has(OptimizerOptions::RemoveUnusedVariables)) {
            auto name = child->secondChild()->str();
            auto iter = std::next(childIter);
            if (iter == node->children.end() || isUnusedVariable(iter, name)) {
                child->children.clear();
                child->type = NodeType::BranchRoot;
            }
        }
    }
    ctx.variables.pop_front();
    ctx.values.pop_front();
}

void removeEmptyBranchRoots(const Node::Ptr &node) {
    for (auto &child : node->children) {
        if (!child->children.empty())
            removeEmptyBranchRoots(child);
        if (child->numChildren() == 1U && child->firstChild()->type == NodeType::BranchRoot &&
            child->type != NodeType::ElseStatement && child->type != NodeType::FunctionDefinition)
            child = child->firstChild();
        child->children.remove_if([](const Node::Ptr &node) {
            return node->type == NodeType::BranchRoot && node->children.empty() ||
                   node->type == NodeType::WhileStatement && node->numChildren() == 1U ||
                   node->type == NodeType::IfStatement && node->numChildren() == 1U;
        });
    }
}

void removeUnusedFunctions(SyntaxTree &tree) {
    tree.root->children.remove_if([&functions = tree.functions](const Node::Ptr &node) {
        const std::string &funcName = node->firstChild()->str();
        return functions[funcName].useCount == 0 && funcName != language::funcMain;
    });
}

void Optimizer::process(SyntaxTree &tree, const OptimizerOptions &options) {
    if (options == OptimizerOptions::none())
        return;

    OptimizerContext ctx(tree.functions, options);
    ctx.root = tree.root;
    for (auto &node : tree.root->children) {
        if (node->type == NodeType::FunctionDefinition) {
            auto child = node->children.begin();
            std::advance(child, 3);
            processBranchRoot(*child, ctx);
        }
    }

    if (ctx.options.has(OptimizerOptions::RemoveUnusedFunctions))
        removeUnusedFunctions(tree);

    removeEmptyBranchRoots(tree.root);
}

vla5924-practice / compiler-project / 13883670119

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous