org.apache.sysml.hops.rewrite.HopDagValidator Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of systemml Show documentation
Show all versions of systemml Show documentation
Declarative Machine Learning
/*
* 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.sysml.hops.rewrite;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.Set;
import java.util.stream.Collectors;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.sysml.hops.DataOp;
import org.apache.sysml.hops.FunctionOp;
import org.apache.sysml.hops.Hop;
import org.apache.sysml.hops.HopsException;
import org.apache.sysml.hops.LiteralOp;
import org.apache.sysml.parser.Expression;
import org.apache.sysml.runtime.DMLRuntimeException;
import org.apache.sysml.utils.Explain;
import static org.apache.sysml.hops.HopsException.check;
/**
* This class allows to check hop dags for validity, e.g., parent-child linking.
* Use it for debugging (enabled in {@link ProgramRewriter}).
*/
public class HopDagValidator {
private static final Log LOG = LogFactory.getLog(HopDagValidator.class.getName());
private HopDagValidator() {}
public static void validateHopDag(final ArrayList roots) throws HopsException {
if( roots == null )
return;
try {
Hop.resetVisitStatus(roots);
ValidatorState state = new ValidatorState();
for( Hop hop : roots )
rValidateHop(hop, state);
}
catch(HopsException ex) {
try {
LOG.error( "\n"+Explain.explainHops(roots) );
}catch(DMLRuntimeException e){}
throw ex;
}
}
public static void validateHopDag(final Hop root) throws HopsException {
if( root == null )
return;
try {
root.resetVisitStatus();
ValidatorState state = new ValidatorState();
rValidateHop(root, state);
}
catch(HopsException ex) {
try {
LOG.error( "\n"+Explain.explain(root) );
}catch(DMLRuntimeException e){}
throw ex;
}
}
private static class ValidatorState {
final Set seen = new HashSet<>();
}
private static void rValidateHop(final Hop hop, final ValidatorState state) throws HopsException {
final long id = hop.getHopID();
//check visit status
final boolean seen = !state.seen.add(id);
if (seen != hop.isVisited()) {
String parentIDs = hop.getParent().stream()
.map(h -> Long.toString(h.getHopID())).collect(Collectors.joining(", "));
//noinspection ConstantConditions
check(false, hop, parentIDs, seen);
}
if (seen) return; // we saw the Hop previously, no need to re-validate
//check parent linking
for( Hop parent : hop.getParent() )
check(parent.getInput().contains(hop), hop,
"not properly linked to its parent pid=%d %s",
parent.getHopID(), parent.getClass().getName());
final ArrayList input = hop.getInput();
final Expression.DataType dt = hop.getDataType();
final Expression.ValueType vt = hop.getValueType();
//check child linking
for( Hop child : input )
check(child.getParent().contains(hop), hop, "not properly linked to its child cid=%d %s",
child.getHopID(), child.getClass().getName());
//check empty children (other variable-length Hops must have at least one child)
if( input.isEmpty() )
check(hop instanceof DataOp || hop instanceof FunctionOp || hop instanceof LiteralOp, hop,
"is not a dataop/functionop/literal but has no children");
// check Hop has a legal arity (number of children)
hop.checkArity();
// check Matrix data type Hops must have Double Value type
if (dt == Expression.DataType.MATRIX )
check(vt == Expression.ValueType.DOUBLE, hop,
"has Matrix type but Value Type %s is not DOUBLE", vt);
//recursively process children
for( Hop child : input )
rValidateHop(child, state);
hop.setVisited();
}
}