JavaUdf.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.

package org.apache.doris.nereids.trees.expressions.functions.udf;

import org.apache.doris.catalog.Env;
import org.apache.doris.catalog.Function;
import org.apache.doris.catalog.Function.NullableMode;
import org.apache.doris.catalog.FunctionName;
import org.apache.doris.catalog.FunctionSignature;
import org.apache.doris.catalog.FunctionVolatility;
import org.apache.doris.catalog.Type;
import org.apache.doris.common.util.URI;
import org.apache.doris.nereids.exceptions.AnalysisException;
import org.apache.doris.nereids.trees.expressions.Expression;
import org.apache.doris.nereids.trees.expressions.SlotReference;
import org.apache.doris.nereids.trees.expressions.VolatileExpression;
import org.apache.doris.nereids.trees.expressions.VolatileIdentity;
import org.apache.doris.nereids.trees.expressions.functions.ExplicitlyCastableSignature;
import org.apache.doris.nereids.trees.expressions.functions.Udf;
import org.apache.doris.nereids.trees.expressions.functions.scalar.ScalarFunction;
import org.apache.doris.nereids.trees.expressions.visitor.ExpressionVisitor;
import org.apache.doris.nereids.types.DataType;

import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;

import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;

/**
 * Java UDF for Nereids
 */
public class JavaUdf extends ScalarFunction implements ExplicitlyCastableSignature, Udf, VolatileExpression {
    private final String dbName;
    private final long functionId;
    private final Function.BinaryType binaryType;
    private final FunctionSignature signature;
    private final NullableMode nullableMode;
    private final FunctionVolatility volatility;
    private final VolatileIdentity volatileIdentity;
    private final String objectFile;
    private final String symbol;
    private final String prepareFn;
    private final String closeFn;
    private final String checkSum;
    private final boolean isStaticLoad;
    private final long expirationTime;

    /**
     * Constructor of UDF
     */
    public JavaUdf(String name, long functionId, String dbName, Function.BinaryType binaryType,
            FunctionSignature signature,
            NullableMode nullableMode, FunctionVolatility volatility, VolatileIdentity volatileIdentity,
            String objectFile, String symbol, String prepareFn, String closeFn,
            String checkSum, boolean isStaticLoad, long expirationTime, Expression... args) {
        super(name, args);
        this.dbName = dbName;
        this.functionId = functionId;
        this.binaryType = binaryType;
        this.signature = signature;
        this.nullableMode = nullableMode;
        this.volatility = volatility;
        this.volatileIdentity = volatileIdentity;
        this.objectFile = objectFile;
        this.symbol = symbol;
        this.prepareFn = prepareFn;
        this.closeFn = closeFn;
        this.checkSum = checkSum;
        this.isStaticLoad = isStaticLoad;
        this.expirationTime = expirationTime;
    }

    @Override
    public List<FunctionSignature> getSignatures() {
        return ImmutableList.of(signature);
    }

    @Override
    public boolean hasVarArguments() {
        return signature.hasVarArgs;
    }

    @Override
    public int arity() {
        return signature.argumentsTypes.size();
    }

    @Override
    public NullableMode getNullableMode() {
        return nullableMode;
    }

    /**
     * withChildren.
     */
    @Override
    public JavaUdf withChildren(List<Expression> children) {
        Preconditions.checkArgument(children.size() == this.children.size());
        return new JavaUdf(getName(), functionId, dbName, binaryType, signature, nullableMode,
                volatility, volatileIdentity,
                objectFile, symbol, prepareFn, closeFn, checkSum, isStaticLoad, expirationTime,
                children.toArray(new Expression[0]));
    }

    @Override
    public VolatileIdentity getVolatileIdentity() {
        return volatileIdentity;
    }

    @Override
    public JavaUdf withIgnoreUniqueId(boolean ignoreUniqueId) {
        Preconditions.checkState(isVolatile(), "Only volatile Java UDF can ignore unique id");
        return new JavaUdf(getName(), functionId, dbName, binaryType, signature, nullableMode,
                volatility, volatileIdentity.withIgnoreUniqueId(ignoreUniqueId),
                objectFile, symbol, prepareFn, closeFn, checkSum, isStaticLoad, expirationTime,
                children.toArray(new Expression[0]));
    }

    /** Return a copy with a new per-call identity when this UDF is VOLATILE. */
    public JavaUdf withFreshVolatileIdentity() {
        if (volatility != FunctionVolatility.VOLATILE) {
            return this;
        }
        return new JavaUdf(getName(), functionId, dbName, binaryType, signature, nullableMode,
                volatility, VolatileIdentity.newVolatileIdentity(),
                objectFile, symbol, prepareFn, closeFn, checkSum, isStaticLoad, expirationTime,
                children.toArray(new Expression[0]));
    }

    @Override
    public boolean isDeterministic() {
        return volatility == FunctionVolatility.IMMUTABLE;
    }

    @Override
    public boolean equals(Object o) {
        if (!(o instanceof JavaUdf)) {
            return false;
        }
        JavaUdf other = (JavaUdf) o;
        return volatileIdentity.equalsByIdentity(other.volatileIdentity, super.equals(o));
    }

    @Override
    public int computeHashCode() {
        return volatileIdentity.hashCodeByIdentity(super.computeHashCode());
    }

    /**
     * translate catalog java udf to nereids java udf
     */
    public static void translateToNereidsFunction(String dbName, org.apache.doris.catalog.ScalarFunction scalar) {
        String fnName = scalar.functionName();
        DataType retType = DataType.fromCatalogType(scalar.getReturnType());
        List<DataType> argTypes = Arrays.stream(scalar.getArgs())
                .map(DataType::fromCatalogType)
                .collect(Collectors.toList());

        FunctionSignature.FuncSigBuilder sigBuilder = FunctionSignature.ret(retType);
        FunctionSignature sig = scalar.hasVarArgs()
                ? sigBuilder.varArgs(argTypes.toArray(new DataType[0]))
                : sigBuilder.args(argTypes.toArray(new DataType[0]));

        SlotReference[] arguments = argTypes.stream()
                .map(type -> new SlotReference(type.toString(), type))
                .toArray(SlotReference[]::new);

        JavaUdf udf = new JavaUdf(fnName, scalar.getId(), dbName, scalar.getBinaryType(), sig,
                scalar.getNullableMode(), scalar.getVolatility(), createVolatileIdentity(scalar.getVolatility()),
                scalar.getLocation() == null ? null : scalar.getLocation().getLocation(),
                scalar.getSymbolName(),
                scalar.getPrepareFnSymbol(),
                scalar.getCloseFnSymbol(),
                scalar.getChecksum(), scalar.isStaticLoad(), scalar.getExpirationTime(),
                arguments);

        JavaUdfBuilder builder = new JavaUdfBuilder(udf);
        Env.getCurrentEnv().getFunctionRegistry().addUdf(dbName, fnName, builder);
    }

    @Override
    public <R, C> R accept(ExpressionVisitor<R, C> visitor, C context) {
        return visitor.visitJavaUdf(this, context);
    }

    @Override
    public Function getCatalogFunction() {
        try {
            org.apache.doris.catalog.ScalarFunction expr = org.apache.doris.catalog.ScalarFunction.createUdf(
                    binaryType,
                    new FunctionName(dbName, getName()),
                    signature.argumentsTypes.stream().map(DataType::toCatalogDataType).toArray(Type[]::new),
                    signature.returnType.toCatalogDataType(),
                    signature.hasVarArgs,
                    objectFile == null ? null : URI.create(objectFile),
                    symbol,
                    prepareFn,
                    closeFn
            );
            expr.setNullableMode(nullableMode);
            expr.setChecksum(checkSum);
            expr.setId(functionId);
            expr.setStaticLoad(isStaticLoad);
            expr.setExpirationTime(expirationTime);
            expr.setVolatility(volatility);
            return expr;
        } catch (Exception e) {
            throw new AnalysisException(e.getMessage(), e.getCause());
        }
    }

    private static VolatileIdentity createVolatileIdentity(FunctionVolatility volatility) {
        return volatility == FunctionVolatility.VOLATILE
                ? VolatileIdentity.newVolatileIdentity() : VolatileIdentity.NON_VOLATILE;
    }
}