public void analyze(RexNode exp) {
assert (stack.isEmpty());
exp.accept(this);
// Deal with top of stack
assert (stack.size() == 1);
assert (parentCallTypeStack.isEmpty());
Constancy rootConstancy = stack.get(0);
if (rootConstancy == Constancy.REDUCIBLE_CONSTANT) {
// The entire subtree was constant, so add it to the result.
addResult(exp);
}
stack.clear();
}
/**
* Creates a relational expression which projects an array of expressions, and optionally
* optimizes.
*
* <p>The result may not be a {@link ProjectRel}. If the projection is trivial, <code>child</code>
* is returned directly; and future versions may return other formulations of expressions, such as
* {@link CalcRel}.
*
* @param child input relational expression
* @param exprs list of expressions for the input columns
* @param fieldNames aliases of the expressions, or null to generate
* @param optimize Whether to return <code>child</code> unchanged if the projections are trivial.
*/
public static RelNode createProject(
RelNode child, List<RexNode> exprs, List<String> fieldNames, boolean optimize) {
final RelOptCluster cluster = child.getCluster();
final RexProgram program =
RexProgram.create(child.getRowType(), exprs, null, fieldNames, cluster.getRexBuilder());
final List<RelCollation> collationList = program.getCollations(child.getCollationList());
if (DeprecateProjectAndFilter) {
return new CalcRel(
cluster, child.getTraitSet(), child, program.getOutputRowType(), program, collationList);
} else {
final RelDataType rowType =
RexUtil.createStructType(cluster.getTypeFactory(), exprs, fieldNames);
if (optimize && RemoveTrivialProjectRule.isIdentity(exprs, rowType, child.getRowType())) {
return child;
}
return new ProjectRel(
cluster,
cluster.traitSetOf(
collationList.isEmpty() ? RelCollationImpl.EMPTY : collationList.get(0)),
child,
exprs,
rowType,
ProjectRelBase.Flags.Boxed);
}
}
/**
* Creates a relational expression which projects an array of expressions, and optionally
* optimizes.
*
* <p>The result may not be a {@link ProjectRel}. If the projection is trivial, <code>child</code>
* is returned directly; and future versions may return other formulations of expressions, such as
* {@link CalcRel}.
*
* @param child input relational expression
* @param exprs list of expressions for the input columns
* @param fieldNames aliases of the expressions, or null to generate
* @param optimize Whether to return <code>child</code> unchanged if the projections are trivial.
*/
public static RelNode createProject(
RelNode child, List<RexNode> exprs, List<String> fieldNames, boolean optimize) {
final RelOptCluster cluster = child.getCluster();
final RexProgram program =
RexProgram.create(child.getRowType(), exprs, null, fieldNames, cluster.getRexBuilder());
final List<RelCollation> collationList = program.getCollations(child.getCollationList());
if (DEPRECATE_PROJECT_AND_FILTER) {
return new CalcRel(
cluster, child.getTraitSet(), child, program.getOutputRowType(), program, collationList);
} else {
final RelDataType rowType =
RexUtil.createStructType(
cluster.getTypeFactory(),
exprs,
fieldNames == null
? null
: SqlValidatorUtil.uniquify(fieldNames, SqlValidatorUtil.F_SUGGESTER));
if (optimize && RemoveTrivialProjectRule.isIdentity(exprs, rowType, child.getRowType())) {
return child;
}
return new ProjectRel(
cluster,
cluster.traitSetOf(
collationList.isEmpty() ? RelCollationImpl.EMPTY : collationList.get(0)),
child,
exprs,
rowType,
ProjectRelBase.Flags.BOXED);
}
}
private void addResult(RexNode exp) {
// Cast of literal can't be reduced, so skip those (otherwise we'd
// go into an infinite loop as we add them back).
if (exp.getKind() == RexKind.Cast) {
RexCall cast = (RexCall) exp;
RexNode operand = cast.getOperands()[0];
if (operand instanceof RexLiteral) {
return;
}
}
constExprs.add(exp);
// In the case where the expression corresponds to a UDR argument,
// we need to preserve casts. Note that this only applies to
// the topmost argument, not expressions nested within the UDR
// call.
//
// REVIEW zfong 6/13/08 - Are there other expressions where we
// also need to preserve casts?
if (parentCallTypeStack.isEmpty()) {
addCasts.add(false);
} else {
addCasts.add(
parentCallTypeStack.get(parentCallTypeStack.size() - 1)
instanceof FarragoUserDefinedRoutine);
}
}
/**
* Adds a child to this expression.
*
* @param child child to add
*/
public void addChild(SargExpr child) {
assert (child.getDataType() == dataType);
if (setOp == SargSetOperator.COMPLEMENT) {
assert (children.isEmpty());
}
children.add(child);
}
private SargIntervalSequence evaluateIntersection(List<SargIntervalSequence> list) {
SargIntervalSequence seq = null;
if (list.isEmpty()) {
// Counterintuitive but true: intersection of no sets is the
// universal set (kinda like 2^0=1). One way to prove this to
// yourself is to apply DeMorgan's law. The union of no sets is
// certainly the empty set. So the complement of that union is the
// universal set. That's equivalent to the intersection of the
// complements of no sets, which is the intersection of no sets.
// QED.
seq = new SargIntervalSequence();
seq.addInterval(new SargInterval(factory, getDataType()));
return seq;
}
// The way we evaluate the intersection is to start with the first
// entry as a baseline, and then keep deleting stuff from it by
// intersecting the other entrie in turn. Whatever makes it through
// this filtering remains as the final result.
for (SargIntervalSequence newSeq : list) {
if (seq == null) {
// first child
seq = newSeq;
continue;
}
intersectSequences(seq, newSeq);
}
return seq;
}
/**
* Reconstructs a rex predicate from a list of SargBindings which are AND'ed together.
*
* @param sargBindingList list of SargBindings to be converted.
* @return the rex predicate reconstructed from the list of SargBindings.
*/
public RexNode getSargBindingListToRexNode(List<SargBinding> sargBindingList) {
if (sargBindingList.isEmpty()) {
return null;
}
RexNode newAndNode = sarg2RexMap.get(sargBindingList.get(0).getExpr());
for (int i = 1; i < sargBindingList.size(); i++) {
RexNode nextNode = sarg2RexMap.get(sargBindingList.get(i).getExpr());
newAndNode =
factory.getRexBuilder().makeCall(SqlStdOperatorTable.andOperator, newAndNode, nextNode);
}
return newAndNode;
}
/**
* Reconstructs a rex predicate from the non-sargable filter predicates which are AND'ed together.
*
* @return the rex predicate reconstructed from the non-sargable predicates.
*/
public RexNode getNonSargFilterRexNode() {
if (nonSargFilterList.isEmpty()) {
return null;
}
RexNode newAndNode = nonSargFilterList.get(0);
for (int i = 1; i < nonSargFilterList.size(); i++) {
newAndNode =
factory
.getRexBuilder()
.makeCall(SqlStdOperatorTable.andOperator, newAndNode, nonSargFilterList.get(i));
}
return newAndNode;
}
/**
* Analyzes a rex predicate.
*
* @param rexPredicate predicate to be analyzed
* @return corresponding bound sarg expression, or null if analysis failed
*/
public SargBinding analyze(RexNode rexPredicate) {
NodeVisitor visitor = new NodeVisitor();
// Initialize analysis state.
exprStack = new ArrayList<SargExpr>();
failed = false;
boundInputRef = null;
clearLeaf();
// Walk the predicate.
rexPredicate.accept(visitor);
if (boundInputRef == null) {
// No variable references at all, so not sargable.
failed = true;
}
if (exprStack.isEmpty()) {
failed = true;
}
if (failed) {
return null;
}
// well-formedness assumption
assert (exprStack.size() == 1);
SargExpr expr = exprStack.get(0);
if (!testDynamicParamSupport(expr)) {
failed = true;
return null;
}
return new SargBinding(expr, boundInputRef);
}
private void onMatchRight(RelOptRuleCall call) {
final JoinRelBase topJoin = call.rel(0);
final JoinRelBase bottomJoin = call.rel(1);
final RelNode relC = call.rel(2);
final RelNode relA = bottomJoin.getLeft();
final RelNode relB = bottomJoin.getRight();
final RelOptCluster cluster = topJoin.getCluster();
// topJoin
// / \
// bottomJoin C
// / \
// A B
final int aCount = relA.getRowType().getFieldCount();
final int bCount = relB.getRowType().getFieldCount();
final int cCount = relC.getRowType().getFieldCount();
final BitSet bBitSet = BitSets.range(aCount, aCount + bCount);
// becomes
//
// newTopJoin
// / \
// newBottomJoin B
// / \
// A C
// If either join is not inner, we cannot proceed.
// (Is this too strict?)
if (topJoin.getJoinType() != JoinRelType.INNER
|| bottomJoin.getJoinType() != JoinRelType.INNER) {
return;
}
// Split the condition of topJoin into a conjunction. Each of the
// parts that does not use columns from B can be pushed down.
final List<RexNode> intersecting = new ArrayList<RexNode>();
final List<RexNode> nonIntersecting = new ArrayList<RexNode>();
split(topJoin.getCondition(), bBitSet, intersecting, nonIntersecting);
// If there's nothing to push down, it's not worth proceeding.
if (nonIntersecting.isEmpty()) {
return;
}
// Split the condition of bottomJoin into a conjunction. Each of the
// parts that use columns from B will need to be pulled up.
final List<RexNode> bottomIntersecting = new ArrayList<RexNode>();
final List<RexNode> bottomNonIntersecting = new ArrayList<RexNode>();
split(bottomJoin.getCondition(), bBitSet, bottomIntersecting, bottomNonIntersecting);
// target: | A | C |
// source: | A | B | C |
final Mappings.TargetMapping bottomMapping =
Mappings.createShiftMapping(
aCount + bCount + cCount, 0, 0, aCount, aCount, aCount + bCount, cCount);
List<RexNode> newBottomList = new ArrayList<RexNode>();
new RexPermuteInputsShuttle(bottomMapping, relA, relC)
.visitList(nonIntersecting, newBottomList);
final Mappings.TargetMapping bottomBottomMapping =
Mappings.createShiftMapping(aCount + bCount, 0, 0, aCount);
new RexPermuteInputsShuttle(bottomBottomMapping, relA, relC)
.visitList(bottomNonIntersecting, newBottomList);
final RexBuilder rexBuilder = cluster.getRexBuilder();
RexNode newBottomCondition = RexUtil.composeConjunction(rexBuilder, newBottomList, false);
final JoinRelBase newBottomJoin =
bottomJoin.copy(
bottomJoin.getTraitSet(), newBottomCondition, relA, relC, bottomJoin.getJoinType());
// target: | A | C | B |
// source: | A | B | C |
final Mappings.TargetMapping topMapping =
Mappings.createShiftMapping(
aCount + bCount + cCount,
0,
0,
aCount,
aCount + cCount,
aCount,
bCount,
aCount,
aCount + bCount,
cCount);
List<RexNode> newTopList = new ArrayList<RexNode>();
new RexPermuteInputsShuttle(topMapping, newBottomJoin, relB)
.visitList(intersecting, newTopList);
new RexPermuteInputsShuttle(topMapping, newBottomJoin, relB)
.visitList(bottomIntersecting, newTopList);
RexNode newTopCondition = RexUtil.composeConjunction(rexBuilder, newTopList, false);
@SuppressWarnings("SuspiciousNameCombination")
final JoinRelBase newTopJoin =
topJoin.copy(
topJoin.getTraitSet(), newTopCondition, newBottomJoin, relB, topJoin.getJoinType());
assert !Mappings.isIdentity(topMapping);
final RelNode newProject =
RelFactories.createProject(projectFactory, newTopJoin, Mappings.asList(topMapping));
call.transformTo(newProject);
}
/** Variant of {@link #trimFields(RelNode, BitSet, Set)} for {@link ProjectRel}. */
public TrimResult trimFields(
ProjectRel project, BitSet fieldsUsed, Set<RelDataTypeField> extraFields) {
final RelDataType rowType = project.getRowType();
final int fieldCount = rowType.getFieldCount();
final RelNode input = project.getChild();
final RelDataType inputRowType = input.getRowType();
// Which fields are required from the input?
BitSet inputFieldsUsed = new BitSet(inputRowType.getFieldCount());
final Set<RelDataTypeField> inputExtraFields = new LinkedHashSet<RelDataTypeField>(extraFields);
RelOptUtil.InputFinder inputFinder =
new RelOptUtil.InputFinder(inputFieldsUsed, inputExtraFields);
for (Ord<RexNode> ord : Ord.zip(project.getProjects())) {
if (fieldsUsed.get(ord.i)) {
ord.e.accept(inputFinder);
}
}
// Create input with trimmed columns.
TrimResult trimResult = trimChild(project, input, inputFieldsUsed, inputExtraFields);
RelNode newInput = trimResult.left;
final Mapping inputMapping = trimResult.right;
// If the input is unchanged, and we need to project all columns,
// there's nothing we can do.
if (newInput == input && fieldsUsed.cardinality() == fieldCount) {
return new TrimResult(project, Mappings.createIdentity(fieldCount));
}
// Some parts of the system can't handle rows with zero fields, so
// pretend that one field is used.
if (fieldsUsed.cardinality() == 0) {
final Mapping mapping = Mappings.create(MappingType.InverseSurjection, fieldCount, 1);
final RexLiteral expr =
project.getCluster().getRexBuilder().makeExactLiteral(BigDecimal.ZERO);
RelDataType newRowType =
project
.getCluster()
.getTypeFactory()
.createStructType(
Collections.singletonList(expr.getType()), Collections.singletonList("DUMMY"));
ProjectRel newProject =
new ProjectRel(
project.getCluster(),
project.getCluster().traitSetOf(RelCollationImpl.EMPTY),
newInput,
Collections.<RexNode>singletonList(expr),
newRowType,
project.getFlags());
return new TrimResult(newProject, mapping);
}
// Build new project expressions, and populate the mapping.
List<RexNode> newProjectExprList = new ArrayList<RexNode>();
final RexVisitor<RexNode> shuttle = new RexPermuteInputsShuttle(inputMapping, newInput);
final Mapping mapping =
Mappings.create(MappingType.InverseSurjection, fieldCount, fieldsUsed.cardinality());
for (Ord<RexNode> ord : Ord.zip(project.getProjects())) {
if (fieldsUsed.get(ord.i)) {
mapping.set(ord.i, newProjectExprList.size());
RexNode newProjectExpr = ord.e.accept(shuttle);
newProjectExprList.add(newProjectExpr);
}
}
final RelDataType newRowType =
project
.getCluster()
.getTypeFactory()
.createStructType(Mappings.apply3(mapping, rowType.getFieldList()));
final List<RelCollation> newCollations =
RexUtil.apply(inputMapping, project.getCollationList());
final RelNode newProject;
if (RemoveTrivialProjectRule.isIdentity(
newProjectExprList, newRowType, newInput.getRowType())) {
// The new project would be the identity. It is equivalent to return
// its child.
newProject = newInput;
} else {
newProject =
new ProjectRel(
project.getCluster(),
project
.getCluster()
.traitSetOf(
newCollations.isEmpty() ? RelCollationImpl.EMPTY : newCollations.get(0)),
newInput,
newProjectExprList,
newRowType,
project.getFlags());
assert newProject.getClass() == project.getClass();
}
return new TrimResult(newProject, mapping);
}
public RelNode copy(RelTraitSet traitSet, List<RelNode> inputs) {
assert traitSet.comprises(Convention.NONE);
assert inputs.isEmpty();
return new ValuesRel(getCluster(), rowType, tuples);
}
/**
* Reduces a list of expressions.
*
* @param rel Relational expression
* @param expList List of expressions, modified in place
* @return whether reduction found something to change, and succeeded
*/
static boolean reduceExpressions(RelNode rel, List<RexNode> expList) {
RexBuilder rexBuilder = rel.getCluster().getRexBuilder();
// Find reducible expressions.
FarragoSessionPlanner planner = (FarragoSessionPlanner) rel.getCluster().getPlanner();
FarragoSessionPreparingStmt preparingStmt = planner.getPreparingStmt();
List<RexNode> constExps = new ArrayList<RexNode>();
List<Boolean> addCasts = new ArrayList<Boolean>();
List<RexNode> removableCasts = new ArrayList<RexNode>();
findReducibleExps(preparingStmt, expList, constExps, addCasts, removableCasts);
if (constExps.isEmpty() && removableCasts.isEmpty()) {
return false;
}
// Remove redundant casts before reducing constant expressions.
// If the argument to the redundant cast is a reducible constant,
// reducing that argument to a constant first will result in not being
// able to locate the original cast expression.
if (!removableCasts.isEmpty()) {
List<RexNode> reducedExprs = new ArrayList<RexNode>();
List<Boolean> noCasts = new ArrayList<Boolean>();
for (RexNode exp : removableCasts) {
RexCall call = (RexCall) exp;
reducedExprs.add(call.getOperands()[0]);
noCasts.add(false);
}
RexReplacer replacer = new RexReplacer(rexBuilder, removableCasts, reducedExprs, noCasts);
replacer.apply(expList);
}
if (constExps.isEmpty()) {
return true;
}
// Compute the values they reduce to.
List<RexNode> reducedValues = new ArrayList<RexNode>();
ReentrantValuesStmt reentrantStmt =
new ReentrantValuesStmt(
preparingStmt.getRootStmtContext(), rexBuilder, constExps, reducedValues);
FarragoSession session = getSession(rel);
reentrantStmt.execute(session, true);
if (reentrantStmt.failed) {
return false;
}
// For ProjectRel, we have to be sure to preserve the result
// types, so always cast regardless of the expression type.
// For other RelNodes like FilterRel, in general, this isn't necessary,
// and the presence of casts could hinder other rules such as sarg
// analysis, which require bare literals. But there are special cases,
// like when the expression is a UDR argument, that need to be
// handled as special cases.
if (rel instanceof ProjectRel) {
for (int i = 0; i < reducedValues.size(); i++) {
addCasts.set(i, true);
}
}
RexReplacer replacer = new RexReplacer(rexBuilder, constExps, reducedValues, addCasts);
replacer.apply(expList);
return true;
}
