ArithmeticExpr.java

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.
// This file is copied from
// https://github.com/apache/impala/blob/branch-2.9.0/fe/src/main/java/org/apache/impala/ArithmeticExpr.java
// and modified by Doris

package org.apache.doris.analysis;

import org.apache.doris.catalog.Function;
import org.apache.doris.catalog.Function.NullableMode;
import org.apache.doris.catalog.FunctionSet;
import org.apache.doris.catalog.ScalarFunction;
import org.apache.doris.catalog.ScalarType;
import org.apache.doris.catalog.TableIf;
import org.apache.doris.catalog.TableIf.TableType;
import org.apache.doris.catalog.Type;
import org.apache.doris.common.AnalysisException;
import org.apache.doris.common.Config;
import org.apache.doris.thrift.TExprNode;
import org.apache.doris.thrift.TExprNodeType;
import org.apache.doris.thrift.TExprOpcode;

import com.google.common.base.Preconditions;
import com.google.common.collect.Lists;
import com.google.gson.annotations.SerializedName;

import java.util.List;
import java.util.Objects;

public class ArithmeticExpr extends Expr {

    enum OperatorPosition {
        BINARY_INFIX,
        UNARY_PREFIX,
        UNARY_POSTFIX,
    }

    public enum Operator {
        MULTIPLY("*", "multiply", OperatorPosition.BINARY_INFIX, TExprOpcode.MULTIPLY),
        DIVIDE("/", "divide", OperatorPosition.BINARY_INFIX, TExprOpcode.DIVIDE),
        MOD("%", "mod", OperatorPosition.BINARY_INFIX, TExprOpcode.MOD),
        INT_DIVIDE("DIV", "int_divide", OperatorPosition.BINARY_INFIX, TExprOpcode.INT_DIVIDE),
        ADD("+", "add", OperatorPosition.BINARY_INFIX, TExprOpcode.ADD),
        SUBTRACT("-", "subtract", OperatorPosition.BINARY_INFIX, TExprOpcode.SUBTRACT),
        BITAND("&", "bitand", OperatorPosition.BINARY_INFIX, TExprOpcode.BITAND),
        BITOR("|", "bitor", OperatorPosition.BINARY_INFIX, TExprOpcode.BITOR),
        BITXOR("^", "bitxor", OperatorPosition.BINARY_INFIX, TExprOpcode.BITXOR),
        BITNOT("~", "bitnot", OperatorPosition.UNARY_PREFIX, TExprOpcode.BITNOT),
        FACTORIAL("!", "factorial", OperatorPosition.UNARY_POSTFIX, TExprOpcode.FACTORIAL);

        private final String description;
        private final String name;
        private final OperatorPosition pos;
        private final TExprOpcode opcode;

        Operator(String description, String name, OperatorPosition pos, TExprOpcode opcode) {
            this.description = description;
            this.name = name;
            this.pos = pos;
            this.opcode = opcode;
        }

        @Override
        public String toString() {
            return description;
        }

        public String getName() {
            return name;
        }

        public TExprOpcode getOpcode() {
            return opcode;
        }

        public boolean isUnary() {
            return pos == OperatorPosition.UNARY_PREFIX
                    || pos == OperatorPosition.UNARY_POSTFIX;
        }

        public boolean isBinary() {
            return pos == OperatorPosition.BINARY_INFIX;
        }
    }

    public static void initBuiltins(FunctionSet functionSet) {
        // init vec build function
        for (int i = 0; i < Type.getNumericTypes().size(); i++) {
            Type t1 = Type.getNumericTypes().get(i);
            for (int j = 0; j < Type.getNumericTypes().size(); j++) {
                Type t2 = Type.getNumericTypes().get(j);

                // For old planner, set enableDecimal256 to false to keep the original behaviour
                Type retType = Type.getNextNumType(Type.getAssignmentCompatibleType(t1, t2, false, false));
                NullableMode mode = retType.isDecimalV3() ? NullableMode.CUSTOM : NullableMode.DEPEND_ON_ARGUMENT;
                functionSet.addBuiltin(ScalarFunction.createBuiltinOperator(
                        Operator.MULTIPLY.getName(), Lists.newArrayList(t1, t2), retType, mode));
                functionSet.addBuiltin(ScalarFunction.createBuiltinOperator(
                        Operator.ADD.getName(), Lists.newArrayList(t1, t2), retType, mode));
                functionSet.addBuiltin(ScalarFunction.createBuiltinOperator(
                        Operator.SUBTRACT.getName(), Lists.newArrayList(t1, t2), retType, mode));
            }
        }

        functionSet.addBuiltin(ScalarFunction.createBuiltinOperator(
                Operator.DIVIDE.getName(),
                Lists.<Type>newArrayList(Type.DOUBLE, Type.DOUBLE),
                Type.DOUBLE, Function.NullableMode.ALWAYS_NULLABLE));
        functionSet.addBuiltin(ScalarFunction.createBuiltinOperator(
                Operator.DIVIDE.getName(),
                Lists.<Type>newArrayList(Type.MAX_DECIMALV2_TYPE, Type.MAX_DECIMALV2_TYPE),
                Type.MAX_DECIMALV2_TYPE, Function.NullableMode.ALWAYS_NULLABLE));
        functionSet.addBuiltin(ScalarFunction.createBuiltinOperator(
                Operator.DIVIDE.getName(),
                Lists.<Type>newArrayList(Type.DECIMAL32, Type.DECIMAL32),
                Type.DECIMAL32, Function.NullableMode.ALWAYS_NULLABLE));
        functionSet.addBuiltin(ScalarFunction.createBuiltinOperator(
                Operator.DIVIDE.getName(),
                Lists.<Type>newArrayList(Type.DECIMAL32, Type.DECIMAL64),
                Type.DECIMAL32, Function.NullableMode.ALWAYS_NULLABLE));
        functionSet.addBuiltin(ScalarFunction.createBuiltinOperator(
                Operator.DIVIDE.getName(),
                Lists.<Type>newArrayList(Type.DECIMAL32, Type.DECIMAL128),
                Type.DECIMAL32, Function.NullableMode.ALWAYS_NULLABLE));
        functionSet.addBuiltin(ScalarFunction.createBuiltinOperator(
                Operator.DIVIDE.getName(),
                Lists.<Type>newArrayList(Type.DECIMAL64, Type.DECIMAL64),
                Type.DECIMAL64, Function.NullableMode.ALWAYS_NULLABLE));
        functionSet.addBuiltin(ScalarFunction.createBuiltinOperator(
                Operator.DIVIDE.getName(),
                Lists.<Type>newArrayList(Type.DECIMAL64, Type.DECIMAL128),
                Type.DECIMAL64, Function.NullableMode.ALWAYS_NULLABLE));
        functionSet.addBuiltin(ScalarFunction.createBuiltinOperator(
                Operator.DIVIDE.getName(),
                Lists.<Type>newArrayList(Type.DECIMAL128, Type.DECIMAL128),
                Type.DECIMAL128, Function.NullableMode.ALWAYS_NULLABLE));
        functionSet.addBuiltin(ScalarFunction.createBuiltinOperator(
                Operator.DIVIDE.getName(),
                Lists.<Type>newArrayList(Type.DECIMAL64, Type.DECIMAL32),
                Type.DECIMAL32, Function.NullableMode.ALWAYS_NULLABLE));
        functionSet.addBuiltin(ScalarFunction.createBuiltinOperator(
                Operator.DIVIDE.getName(),
                Lists.<Type>newArrayList(Type.DECIMAL128, Type.DECIMAL64),
                Type.DECIMAL64, Function.NullableMode.ALWAYS_NULLABLE));
        functionSet.addBuiltin(ScalarFunction.createBuiltinOperator(
                Operator.DIVIDE.getName(),
                Lists.<Type>newArrayList(Type.DECIMAL128, Type.DECIMAL32),
                Type.DECIMAL128, Function.NullableMode.ALWAYS_NULLABLE));

        functionSet.addBuiltin(ScalarFunction.createBuiltinOperator(
                Operator.MOD.getName(),
                Lists.<Type>newArrayList(Type.FLOAT, Type.FLOAT),
                Type.FLOAT, Function.NullableMode.ALWAYS_NULLABLE));
        functionSet.addBuiltin(ScalarFunction.createBuiltinOperator(
                Operator.MOD.getName(),
                Lists.<Type>newArrayList(Type.DOUBLE, Type.DOUBLE),
                Type.DOUBLE, Function.NullableMode.ALWAYS_NULLABLE));
        functionSet.addBuiltin(ScalarFunction.createBuiltinOperator(
                Operator.MOD.getName(),
                Lists.<Type>newArrayList(Type.MAX_DECIMALV2_TYPE, Type.MAX_DECIMALV2_TYPE),
                Type.MAX_DECIMALV2_TYPE, Function.NullableMode.ALWAYS_NULLABLE));
        functionSet.addBuiltin(ScalarFunction.createBuiltinOperator(
                Operator.MOD.getName(),
                Lists.<Type>newArrayList(Type.DECIMAL32, Type.DECIMAL32),
                Type.DECIMAL32, Function.NullableMode.ALWAYS_NULLABLE));
        functionSet.addBuiltin(ScalarFunction.createBuiltinOperator(
                Operator.MOD.getName(),
                Lists.<Type>newArrayList(Type.DECIMAL64, Type.DECIMAL64),
                Type.DECIMAL64, Function.NullableMode.ALWAYS_NULLABLE));
        functionSet.addBuiltin(ScalarFunction.createBuiltinOperator(
                Operator.MOD.getName(),
                Lists.<Type>newArrayList(Type.DECIMAL128, Type.DECIMAL128),
                Type.DECIMAL128, Function.NullableMode.ALWAYS_NULLABLE));

        for (int i = 0; i < Type.getIntegerTypes().size(); i++) {
            Type t1 = Type.getIntegerTypes().get(i);
            for (int j = 0; j < Type.getIntegerTypes().size(); j++) {
                Type t2 = Type.getIntegerTypes().get(j);

                // For old planner, set enableDecimal256 to false to keep the original behaviour
                functionSet.addBuiltin(ScalarFunction.createBuiltinOperator(
                        Operator.INT_DIVIDE.getName(), Lists.newArrayList(t1, t2),
                        Type.getAssignmentCompatibleType(t1, t2, false, false),
                        Function.NullableMode.ALWAYS_NULLABLE));
                functionSet.addBuiltin(ScalarFunction.createBuiltinOperator(
                        Operator.MOD.getName(), Lists.newArrayList(t1, t2),
                        Type.getAssignmentCompatibleType(t1, t2, false, false),
                        Function.NullableMode.ALWAYS_NULLABLE));
            }
        }
    }

    @SerializedName("op")
    private final Operator op;

    public ArithmeticExpr(Operator op, Expr e1, Expr e2) {
        super();
        this.op = op;
        Preconditions.checkNotNull(e1);
        children.add(e1);
        Preconditions.checkArgument(
                op == Operator.BITNOT && e2 == null || op != Operator.BITNOT && e2 != null);
        if (e2 != null) {
            children.add(e2);
        }
    }

    /**
     * constructor only used for Nereids.
     */
    public ArithmeticExpr(Operator op, Expr e1, Expr e2, Type returnType, NullableMode nullableMode) {
        this(op, e1, e2);
        List<Type> argTypes;
        if (e2 == null) {
            argTypes = Lists.newArrayList(e1.getType());
        } else {
            argTypes = Lists.newArrayList(e1.getType(), e2.getType());
        }
        fn = new Function(new FunctionName(op.getName()), argTypes, returnType, false, true, nullableMode);
        type = returnType;
    }

    /**
     * Copy c'tor used in clone().
     */
    protected ArithmeticExpr(ArithmeticExpr other) {
        super(other);
        this.op = other.op;
    }

    @Override
    public String toString() {
        return toSql();
    }

    @Override
    public Expr clone() {
        return new ArithmeticExpr(this);
    }

    @Override
    public String toSqlImpl() {
        if (children.size() == 1) {
            return op.toString() + " " + getChild(0).toSql();
        } else {
            return "(" + getChild(0).toSql() + " " + op.toString() + " " + getChild(1).toSql() + ")";
        }
    }

    @Override
    public String toSqlImpl(boolean disableTableName, boolean needExternalSql, TableType tableType,
            TableIf table) {
        if (children.size() == 1) {
            return op.toString() + " " + getChild(0).toSql(disableTableName, needExternalSql, tableType, table);
        } else {
            return "(" + getChild(0).toSql(disableTableName, needExternalSql, tableType, table) + " " + op.toString()
                    + " " + getChild(1).toSql(disableTableName, needExternalSql, tableType, table) + ")";
        }
    }

    @Override
    public String toDigestImpl() {
        if (children.size() == 1) {
            return op.toString() + " " + getChild(0).toDigest();
        } else {
            return getChild(0).toDigest() + " " + op.toString() + " " + getChild(1).toDigest();
        }
    }

    @Override
    protected void toThrift(TExprNode msg) {
        msg.node_type = TExprNodeType.ARITHMETIC_EXPR;
        if (!(type.isDecimalV2() || type.isDecimalV3())) {
            msg.setOpcode(op.getOpcode());
        }
    }

    @Override
    public boolean equals(Object obj) {
        if (!super.equals(obj)) {
            return false;
        }
        return ((ArithmeticExpr) obj).opcode == opcode;
    }

    /**
     * Convert integer type to decimal type.
     */
    public static Type convertIntToDecimalV3Type(Type type) throws AnalysisException {
        if (type.isLargeIntType()) {
            return ScalarType.createDecimalV3Type(ScalarType.MAX_DECIMAL128_PRECISION, 0);
        } else if (type.isBigIntType()) {
            return ScalarType.createDecimalV3Type(ScalarType.MAX_DECIMAL64_PRECISION, 0);
        } else if (type.isInteger32Type()) {
            return ScalarType.createDecimalV3Type(ScalarType.MAX_DECIMAL32_PRECISION, 0);
        } else {
            Preconditions.checkState(false,
                    "Implicit converting to decimal for arithmetic operations only support integer");
            return Type.INVALID;
        }
    }

    public static Type convertDecimalV2ToDecimalV3Type(ScalarType type) {
        return ScalarType.createDecimalV3Type(type.decimalPrecision(), type.decimalScale());
    }

    private void analyzeDecimalV3Op(Type t1, Type t2) throws AnalysisException {
        Type t1TargetType = t1;
        Type t2TargetType = t2;
        switch (op) {
            case MULTIPLY:
            case ADD:
            case SUBTRACT:
            case MOD:
            case DIVIDE:
                if (t1.isFloatingPointType() || t2.isFloatingPointType()) {
                    type = castBinaryOp(ScalarType.DOUBLE);
                    break;
                }
                if (t1.isFixedPointType()) {
                    t1TargetType = convertIntToDecimalV3Type(t1);
                    castChild(t1TargetType, 0);
                }
                if (t2.isFixedPointType()) {
                    t2TargetType = convertIntToDecimalV3Type(t2);
                    castChild(t2TargetType, 1);
                }
                if (t1.isDecimalV2()) {
                    t1TargetType = convertDecimalV2ToDecimalV3Type((ScalarType) t1);
                    castChild(t1TargetType, 0);
                }
                if (t2.isDecimalV2()) {
                    t2TargetType = convertDecimalV2ToDecimalV3Type((ScalarType) t2);
                    castChild(t2TargetType, 1);
                }
                final int t1Precision = ((ScalarType) t1TargetType).getScalarPrecision();
                final int t2Precision = ((ScalarType) t2TargetType).getScalarPrecision();
                final int t1Scale = ((ScalarType) t1TargetType).getScalarScale();
                final int t2Scale = ((ScalarType) t2TargetType).getScalarScale();
                int precision = Math.max(t1Precision, t2Precision);
                int scale = Math.max(t1Scale, t2Scale);

                // operands: DECIMALV3(precision1, scale1) and DECIMALV3(precision2, scale2)
                // we use widthOfIntPart to present width of integer part.
                int widthOfIntPart1 = t1Precision - t1Scale;
                int widthOfIntPart2 = t2Precision - t2Scale;
                if (op == Operator.MULTIPLY) {
                    // target type: DECIMALV3(precision1 + precision2, scale1 + scale2)
                    scale = t1Scale + t2Scale;
                    precision = t1Precision + t2Precision;
                } else if (op == Operator.DIVIDE) {
                    precision = t1TargetType.getPrecision() + t2Scale + Config.div_precision_increment;
                    scale = t1Scale + Config.div_precision_increment;
                } else if (op == Operator.ADD || op == Operator.SUBTRACT) {
                    // target type: DECIMALV3(max(widthOfIntPart1, widthOfIntPart2) + max(scale1, scale2) + 1,
                    // max(scale1, scale2))
                    scale = Math.max(t1Scale, t2Scale);
                    precision = Math.max(widthOfIntPart1, widthOfIntPart2) + scale + 1;
                } else {
                    scale = Math.max(t1Scale, t2Scale);
                    precision = widthOfIntPart2 + scale;
                }
                if (precision > ScalarType.MAX_DECIMAL128_PRECISION) {
                    // TODO(gabriel): if precision is bigger than 38?
                    precision = ScalarType.MAX_DECIMAL128_PRECISION;
                }
                if (precision < scale) {
                    type = castBinaryOp(Type.DOUBLE);
                    break;
                }
                type = ScalarType.createDecimalV3Type(precision, scale);
                if (op == Operator.ADD || op == Operator.SUBTRACT) {
                    if (((ScalarType) type).getScalarScale() != ((ScalarType) children.get(0).type).getScalarScale()) {
                        castChild(type, 0);
                    }
                    if (((ScalarType) type).getScalarScale() != ((ScalarType) children.get(1).type).getScalarScale()) {
                        castChild(type, 1);
                    }
                } else if (op == Operator.DIVIDE && (t1TargetType.isDecimalV3())) {
                    int leftPrecision = t1Precision + t2Scale + Config.div_precision_increment;
                    int leftScale = t1Scale + t2Scale + Config.div_precision_increment;
                    if (leftPrecision < leftScale || leftPrecision > ScalarType.MAX_DECIMAL128_PRECISION) {
                        type = castBinaryOp(Type.DOUBLE);
                        break;
                    }
                    Expr child = getChild(0);
                    if (child instanceof DecimalLiteral) {
                        DecimalLiteral literalChild = (DecimalLiteral) child;
                        Expr newChild = literalChild
                                .castToDecimalV3ByDivde(ScalarType.createDecimalV3Type(leftPrecision, leftScale));
                        setChild(0, newChild);
                    } else {
                        castChild(ScalarType.createDecimalV3Type(leftPrecision, leftScale), 0);
                    }
                } else if (op == Operator.MOD) {
                    // TODO use max int part + max scale of two operands as result type
                    // because BE require the result and operands types are the exact the same decimalv3 type
                    precision = Math.max(widthOfIntPart1, widthOfIntPart2) + scale;
                    if (precision > ScalarType.MAX_DECIMAL128_PRECISION) {
                        type = castBinaryOp(Type.DOUBLE);
                    } else {
                        type = ScalarType.createDecimalV3Type(precision, scale);
                        castChild(type, 0);
                        castChild(type, 1);
                    }
                }
                break;
            case INT_DIVIDE:
            case BITAND:
            case BITOR:
            case BITXOR:
                type = castBinaryOp(Type.BIGINT);
                break;
            case BITNOT:
            case FACTORIAL:
                break;
            default:
                Preconditions.checkState(false,
                        "Unknown arithmetic operation " + op + " in: " + this.toSql());
                break;
        }
    }

    @Override
    public int hashCode() {
        return 31 * super.hashCode() + Objects.hashCode(op);
    }

    @Override
    protected void compactForLiteral(Type type) throws AnalysisException {
        super.compactForLiteral(type);
        Type t1 = getChild(0).getType();
        Type t2 = getChild(1).getType();
        if (t1.isDecimalV3() || t2.isDecimalV3()) {
            analyzeDecimalV3Op(t1, t2);
        }
    }
}