Young-Leo commented on code in PR #16228: URL: https://github.com/apache/iotdb/pull/16228#discussion_r2312344119
########## iotdb-core/datanode/src/main/java/org/apache/iotdb/db/queryengine/plan/relational/planner/PlanMemoryEstimator.java: ########## @@ -0,0 +1,719 @@ +/* + * 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.iotdb.db.queryengine.plan.relational.planner; + +import org.apache.iotdb.db.queryengine.plan.planner.plan.node.PlanNode; +import org.apache.iotdb.db.queryengine.plan.planner.plan.node.PlanVisitor; +import org.apache.iotdb.db.queryengine.plan.relational.planner.iterative.GroupReference; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.AggregationNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.AggregationTableScanNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.ApplyNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.CorrelatedJoinNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.DeviceTableScanNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.FilterNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.GroupNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.JoinNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.LimitNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.LinearFillNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.OffsetNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.OutputNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.PatternRecognitionNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.PreviousFillNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.ProjectNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.SemiJoinNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.SortNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.TableFunctionNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.TableFunctionProcessorNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.TopKNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.TreeDeviceViewScanNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.ValueFillNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.WindowNode; +import org.apache.iotdb.db.queryengine.plan.relational.sql.ast.ArithmeticBinaryExpression; +import org.apache.iotdb.db.queryengine.plan.relational.sql.ast.ArithmeticUnaryExpression; +import org.apache.iotdb.db.queryengine.plan.relational.sql.ast.AstVisitor; +import org.apache.iotdb.db.queryengine.plan.relational.sql.ast.BetweenPredicate; +import org.apache.iotdb.db.queryengine.plan.relational.sql.ast.ComparisonExpression; +import org.apache.iotdb.db.queryengine.plan.relational.sql.ast.Expression; +import org.apache.iotdb.db.queryengine.plan.relational.sql.ast.FunctionCall; +import org.apache.iotdb.db.queryengine.plan.relational.sql.ast.InPredicate; +import org.apache.iotdb.db.queryengine.plan.relational.sql.ast.Literal; +import org.apache.iotdb.db.queryengine.plan.relational.sql.ast.LogicalExpression; +import org.apache.iotdb.db.queryengine.plan.relational.sql.ast.Node; +import org.apache.iotdb.db.queryengine.plan.relational.sql.ast.NotExpression; +import org.apache.iotdb.db.queryengine.plan.relational.sql.ast.SymbolReference; + +import org.apache.tsfile.utils.RamUsageEstimator; + +import java.util.IdentityHashMap; +import java.util.List; +import java.util.Optional; + +import static java.util.Objects.requireNonNull; + +public final class PlanMemoryEstimator { + /** estimate the memory usage (in bytes) of the entire plan tree */ + public static long estimatePlan(final PlanNode root) { + requireNonNull(root, "root is null"); + Seen seen = new Seen(); + return new PlanSizer(seen).process(root, null); + } + + public static long estimateExpression(Expression e) { + if (e == null) return 0L; + Seen seen = new Seen(); + ExpressionSizer sz = new ExpressionSizer(seen); + return sz.process(e, null); + } + + private static final class Seen { + private final IdentityHashMap<Object, Boolean> visited = new IdentityHashMap<>(); + + boolean mark(Object o) { + if (o == null) return false; + // TRUE indicates the first occurrence and should be counted + return visited.put(o, Boolean.TRUE) == null; + } + } + + /* ========================== Expression Sizer =========================== */ + + private static final class ExpressionSizer extends AstVisitor<Long, Void> { + private final Seen seen; + + ExpressionSizer(Seen seen) { + this.seen = seen; + } + + private long sizeOfExpr(Expression e) { + if (e == null || !seen.mark(e)) return 0L; + long size = RamUsageEstimator.shallowSizeOfInstance(e.getClass()); + return size + process(e, null); + } + + @Override + protected Long visitNode(Node node, Void ctx) { + throw new UnsupportedOperationException( + "[ExpressionSizer] Unhandled node type: " + node.getClass().getName()); + + // return node == null || !seen.mark(node) ? 0L : RamUsageEstimator.sizeOfObject(node); + } + + @Override + protected Long visitExpression(Expression node, Void ctx) { + return 0L; + } + + @Override + protected Long visitLiteral(Literal node, Void ctx) { + return node == null || !seen.mark(node) ? 0L : RamUsageEstimator.sizeOfObject(node); + } + + @Override + protected Long visitSymbolReference(SymbolReference node, Void ctx) { + if (node == null || !seen.mark(node)) return 0L; + long size = RamUsageEstimator.shallowSizeOfInstance(node.getClass()); + size += RamUsageEstimator.sizeOf(node.getName()); + return size; + } + + @Override + protected Long visitLogicalExpression(LogicalExpression node, Void ctx) { + if (node == null || !seen.mark(node)) return 0L; + long size = RamUsageEstimator.shallowSizeOfInstance(node.getClass()); + if (node.getTerms() != null) { + for (Expression e : node.getTerms()) size += sizeOfExpr(e); + } + return size; + } + + @Override + protected Long visitComparisonExpression(ComparisonExpression node, Void ctx) { + if (node == null || !seen.mark(node)) return 0L; + long size = RamUsageEstimator.shallowSizeOfInstance(node.getClass()); + size += sizeOfExpr(node.getLeft()); + size += sizeOfExpr(node.getRight()); + return size; + } + + @Override + protected Long visitFunctionCall(FunctionCall node, Void ctx) { + if (node == null || !seen.mark(node)) return 0L; + long size = RamUsageEstimator.shallowSizeOfInstance(node.getClass()); + size += RamUsageEstimator.sizeOfObject(node.getName()); + if (node.getArguments() != null) { + for (Expression e : node.getArguments()) size += sizeOfExpr(e); + } + return size; + } + + @Override + protected Long visitBetweenPredicate(BetweenPredicate node, Void ctx) { + if (node == null || !seen.mark(node)) return 0L; + long size = RamUsageEstimator.shallowSizeOfInstance(node.getClass()); + size += sizeOfExpr(node.getValue()); + size += sizeOfExpr(node.getMin()); + size += sizeOfExpr(node.getMax()); + return size; + } + + @Override + protected Long visitInPredicate(InPredicate node, Void ctx) { + if (node == null || !seen.mark(node)) return 0L; + long size = RamUsageEstimator.shallowSizeOfInstance(node.getClass()); + size += sizeOfExpr(node.getValue()); + if (node.getValueList() != null) size += sizeOfExpr(node.getValueList()); + return size; + } + + @Override + protected Long visitNotExpression(NotExpression node, Void ctx) { + return node == null || !seen.mark(node) ? 0L : sizeOfExpr(node.getValue()); + } + + @Override + protected Long visitArithmeticBinary(ArithmeticBinaryExpression node, Void ctx) { + if (node == null || !seen.mark(node)) return 0L; + long size = RamUsageEstimator.shallowSizeOfInstance(node.getClass()); + size += sizeOfExpr(node.getLeft()); + size += sizeOfExpr(node.getRight()); + return size; + } + + @Override + protected Long visitArithmeticUnary(ArithmeticUnaryExpression node, Void ctx) { + return node == null || !seen.mark(node) ? 0L : sizeOfExpr(node.getValue()); + } + } + + /* ============================ Plan Sizer ============================== */ + + private static final class PlanSizer extends PlanVisitor<Long, Void> { + private final Seen seen; + private final ExpressionSizer exprSizer; + + PlanSizer(Seen seen) { + this.seen = seen; + this.exprSizer = new ExpressionSizer(seen); + } + + private long sizeOfPlan(PlanNode n) { + if (n == null || !seen.mark(n)) return 0L; + long size = RamUsageEstimator.shallowSizeOfInstance(n.getClass()); + if (n.getChildren() != null) { + for (PlanNode c : n.getChildren()) size += sizeOfPlan(c); + } + size += RamUsageEstimator.sizeOfObject(n.getPlanNodeId()); + return size; + } + + private long sizeOfExpr(Expression e) { + return exprSizer.process(e); + } + + @Override + public Long visitPlan(PlanNode node, Void ctx) { + if (node == null) return 0L; + throw new UnsupportedOperationException( + "[PlanSizer] Unhandled plan type: " + node.getClass().getName()); + + // return sizeOfPlan(node); Review Comment: Removed ########## iotdb-core/datanode/src/main/java/org/apache/iotdb/db/queryengine/plan/relational/planner/CachedValue.java: ########## @@ -0,0 +1,653 @@ +/* + * 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.iotdb.db.queryengine.plan.relational.planner; + +import org.apache.iotdb.db.queryengine.common.QueryId; +import org.apache.iotdb.db.queryengine.common.header.DatasetHeader; +import org.apache.iotdb.db.queryengine.plan.planner.plan.node.PlanNode; +import org.apache.iotdb.db.queryengine.plan.planner.plan.node.PlanVisitor; +import org.apache.iotdb.db.queryengine.plan.relational.metadata.ColumnSchema; +import org.apache.iotdb.db.queryengine.plan.relational.planner.iterative.GroupReference; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.AggregationNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.AggregationTableScanNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.ApplyNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.CorrelatedJoinNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.DeviceTableScanNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.FilterNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.GroupNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.JoinNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.LinearFillNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.OffsetNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.OutputNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.PatternRecognitionNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.PreviousFillNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.ProjectNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.SemiJoinNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.SortNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.TableFunctionNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.TableFunctionProcessorNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.TopKNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.TreeDeviceViewScanNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.ValueFillNode; +import org.apache.iotdb.db.queryengine.plan.relational.planner.node.WindowNode; +import org.apache.iotdb.db.queryengine.plan.relational.sql.ast.AstVisitor; +import org.apache.iotdb.db.queryengine.plan.relational.sql.ast.ComparisonExpression; +import org.apache.iotdb.db.queryengine.plan.relational.sql.ast.Expression; +import org.apache.iotdb.db.queryengine.plan.relational.sql.ast.Literal; +import org.apache.iotdb.db.queryengine.plan.relational.sql.ast.LogicalExpression; + +import com.google.common.collect.ImmutableList; +import org.apache.tsfile.read.common.type.Type; +import org.apache.tsfile.utils.RamUsageEstimator; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.stream.Collectors; + +public class CachedValue { + private static final int INSTANCE_SIZE = + (int) RamUsageEstimator.shallowSizeOfInstance(CachedValue.class); + + PlanNode planNode; + List<DeviceTableScanNode> scanNodes; + + DatasetHeader respHeader; + HashMap<Symbol, Type> symbolMap; + int symbolNextId; + + // Used for indexScan to fetch device + List<List<Expression>> metadataExpressionLists; + List<List<String>> attributeColumnsLists; + List<Map<Symbol, ColumnSchema>> assignmentsLists; + + List<Literal> literalReference; + + long estimatedMemoryUsage; + + public CachedValue( + PlanNode planNode, + List<DeviceTableScanNode> scanNodes, + List<Literal> literalReference, + DatasetHeader header, + HashMap<Symbol, Type> symbolMap, + int symbolNextId, + List<List<Expression>> metadataExpressionLists, + List<List<String>> attributeColumnsLists, + List<Map<Symbol, ColumnSchema>> assignmentsLists) { + this.planNode = planNode; + this.scanNodes = scanNodes; + this.respHeader = header; + this.symbolMap = symbolMap; + this.symbolNextId = symbolNextId; + this.metadataExpressionLists = metadataExpressionLists; + this.attributeColumnsLists = attributeColumnsLists; + this.assignmentsLists = assignmentsLists; + this.literalReference = literalReference; + this.estimatedMemoryUsage = estimateMemoryUsage(); + } + + public DatasetHeader getRespHeader() { + return respHeader; + } + + public PlanNode getPlanNode() { + return planNode; + } + + public List<DeviceTableScanNode> getScanNodes() { + return scanNodes; + } + + public HashMap<Symbol, Type> getSymbolMap() { + return symbolMap; + } + + public int getSymbolNextId() { + return symbolNextId; + } + + public List<List<Expression>> getMetadataExpressionLists() { + return metadataExpressionLists; + } + + public List<List<String>> getAttributeColumnsLists() { + return attributeColumnsLists; + } + + public List<Map<Symbol, ColumnSchema>> getAssignmentsLists() { + return assignmentsLists; + } + + public List<Literal> getLiteralReference() { + return literalReference; + } + + /** Clone a new planNode using the new literal list */ + public static PlanNode clonePlanWithNewLiterals(PlanNode node, ClonerContext context) { + return node.accept(new PlanNodeCloner(), context); + } + + /** Clone new metadataExpressions using the new literal list */ + public static List<Expression> cloneMetadataExpressions( + List<Expression> metadataExpressionList, List<Literal> newLiterals) { + if (metadataExpressionList == null) { + return null; + } + List<Expression> clonedList = new ArrayList<>(metadataExpressionList.size()); + ExpressionCloner exprCloner = new ExpressionCloner(); + for (Expression expr : metadataExpressionList) { + clonedList.add(expr.accept(exprCloner, newLiterals)); + } + return clonedList; + } + + /** + * ExpressionCloner is responsible for deep cloning SQL Expression trees. It replaces Literal + * nodes. + */ + private static class ExpressionCloner extends AstVisitor<Expression, List<Literal>> { + @Override + protected Expression visitExpression(Expression node, List<Literal> context) { + // Default case, just return the node itself + return node; + } + + @Override + protected Expression visitLiteral(Literal node, List<Literal> context) { + int idx = node.getLiteralIndex(); + if (idx >= 0 && idx < context.size()) { + return context.get(idx); + } + return node; + } + + @Override + protected Expression visitComparisonExpression( + ComparisonExpression node, List<Literal> context) { + return new ComparisonExpression( + node.getOperator(), + node.getLeft().accept(this, context), + node.getRight().accept(this, context)); + } + + @Override + protected Expression visitLogicalExpression(LogicalExpression node, List<Literal> context) { + List<Expression> newTerms = new ArrayList<>(); + for (Expression term : node.getTerms()) { + newTerms.add(term.accept(this, context)); + } + return new LogicalExpression(node.getOperator(), newTerms); + } + + // FunctionCall, Between, InPredicate, etc + } + + private static class PlanNodeCloner extends PlanVisitor<PlanNode, ClonerContext> { + private final ExpressionCloner exprCloner = new ExpressionCloner(); + + @Override + public PlanNode visitPlan(PlanNode node, ClonerContext context) { + // Default case, just return the node itself + // return node; Review Comment: Removed -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
