/*
* Copyright 2017 - 2019 Volker Berlin (i-net software)
*
* Licensed 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 de.inetsoftware.jwebassembly.module;
import java.io.BufferedInputStream;
import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.net.URLClassLoader;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.function.Consumer;
import java.util.zip.ZipEntry;
import java.util.zip.ZipInputStream;
import javax.annotation.Nonnull;
import de.inetsoftware.classparser.ClassFile;
import de.inetsoftware.classparser.Code;
import de.inetsoftware.classparser.ConstantClass;
import de.inetsoftware.classparser.FieldInfo;
import de.inetsoftware.classparser.MethodInfo;
import de.inetsoftware.jwebassembly.JWebAssembly;
import de.inetsoftware.jwebassembly.WasmException;
import de.inetsoftware.jwebassembly.module.TypeManager.StructType;
import de.inetsoftware.jwebassembly.wasm.AnyType;
import de.inetsoftware.jwebassembly.wasm.NamedStorageType;
import de.inetsoftware.jwebassembly.wasm.StructOperator;
import de.inetsoftware.jwebassembly.wasm.ValueType;
import de.inetsoftware.jwebassembly.watparser.WatParser;
/**
* Generate the WebAssembly output.
*
* @author Volker Berlin
*/
public class ModuleGenerator {
private final ModuleWriter writer;
private final URLClassLoader libraries;
private final JavaMethodWasmCodeBuilder javaCodeBuilder = new JavaMethodWasmCodeBuilder();
private final WatParser watParser = new WatParser();
private String sourceFile;
private String className;
private FunctionManager functions = new FunctionManager();
private TypeManager types = new TypeManager();
private CodeOptimizer optimizer = new CodeOptimizer();
/**
* Create a new generator.
*
* @param writer
* the target writer
* @param libraries
* libraries
*/
public ModuleGenerator( @Nonnull ModuleWriter writer, @Nonnull List<URL> libraries ) {
this.writer = writer;
this.libraries = new URLClassLoader( libraries.toArray( new URL[libraries.size()] ) );
javaCodeBuilder.init( types );
((WasmCodeBuilder)watParser).init( types );
scanLibraries( libraries );
}
/**
* Scan the libraries for annotated methods
*
* @param libraries
* libraries
*/
private void scanLibraries( @Nonnull List<URL> libraries ) {
// search for replacement methods in the libraries
for( URL url : libraries ) {
try {
File file = new File(url.toURI());
if( file.isDirectory() ) {
for( Iterator<Path> iterator = Files.walk( file.toPath() ).iterator(); iterator.hasNext(); ) {
Path path = iterator.next();
if( path.toString().endsWith( ".class" ) ) {
ClassFile classFile = new ClassFile( new BufferedInputStream( Files.newInputStream( path ) ) );
prepare( classFile );
}
}
}
} catch( Exception e ) {
e.printStackTrace();
}
try (ZipInputStream input = new ZipInputStream( url.openStream() )) {
do {
ZipEntry entry = input.getNextEntry();
if( entry == null ) {
break;
}
if( entry.getName().endsWith( ".class" ) ) {
ClassFile classFile = new ClassFile( new BufferedInputStream( input ) {
@Override
public void close() {
} // does not close the zip stream
} );
prepare( classFile );
}
} while( true );
} catch( IOException e ) {
e.printStackTrace();
}
}
}
/**
* Prepare the content of the class.
*
* @param classFile
* the class file
* @throws WasmException
* if some Java code can't converted
*/
public void prepare( ClassFile classFile ) {
iterateMethods( classFile, m -> prepareMethod( m ) );
}
/**
* Finish the prepare after all classes/methods are prepare. This must be call before we can start with write the
* first method.
* @throws IOException
* if any I/O error occur
*/
public void prepareFinish() throws IOException {
writer.prepareFinish();
FunctionName next;
while( (next = functions.nextScannLater()) != null ) {
ClassFile classFile = ClassFile.get( next.className, libraries );
if( classFile == null ) {
} else {
iterateMethods( classFile, method -> {
FunctionName name = new FunctionName( method );
if( functions.needToScan( name ) ) {
//TODO
}
} );
}
functions.markAsScanned( next );
}
}
/**
* Finish the code generation.
*
* @throws IOException
* if any I/O error occur
*/
public void finish() throws IOException {
FunctionName next;
while( (next = functions.nextWriteLater()) != null ) {
ClassFile classFile = ClassFile.get( next.className, libraries );
if( classFile == null ) {
if( next instanceof SyntheticFunctionName ) {
writeMethodImpl( next, true, ((SyntheticFunctionName)next).getCodeBuilder( watParser ) );
} else {
throw new WasmException( "Missing function: " + next.signatureName, -1 );
}
} else {
iterateMethods( classFile, method -> {
try {
FunctionName name;
Map<String, Object> wat = method.getAnnotation( JWebAssembly.TEXTCODE_ANNOTATION );
if( wat != null ) {
String signature = (String)wat.get( "signature" );
if( signature == null ) {
signature = method.getType();
}
name = new FunctionName( method, signature );
} else {
name = new FunctionName( method );
method = functions.replace( name, method );
}
if( functions.needToWrite( name ) ) {
writeMethod( name, method );
}
} catch (IOException ioex){
throw WasmException.create( ioex, sourceFile, className, -1 );
}
} );
}
if( functions.needToWrite( next ) ) {
throw new WasmException( "Missing function: " + next.signatureName, -1 );
}
}
}
/**
* Set the StructType into the instruction and write the types/structs if needed.
*
* @param instruction
* the struct instruction
* @throws IOException
* if any I/O error occur
*/
private void setStructType( WasmStructInstruction instruction ) throws IOException {
StructType type = instruction.getStructType();
writeStructType( type );
}
/**
* Write the struct type
*
* @param type
* the type
* @throws IOException
* if any I/O error occur
*/
private void writeStructType( StructType type ) throws IOException {
if( type == null || type.getCode() != Integer.MAX_VALUE ) {
return;
}
String className = type.getName();
List<NamedStorageType> list = new ArrayList<>();
listStructFields( className, list );
int id = writer.writeStruct( className, list );
types.useType( type, id, list );
for( NamedStorageType namedType : list ) {
AnyType fieldType = namedType.getType();
if( fieldType.getCode() == Integer.MAX_VALUE ) {
writeStructType( (StructType)fieldType );
}
}
}
/**
* List the non static fields of the class and its super classes.
*
* @param className
* the className
* @param list
* the container for the fields
* @throws IOException
* if any I/O error occur
*/
private void listStructFields( String className, List<NamedStorageType> list ) throws IOException {
ClassFile classFile = ClassFile.get( className, libraries );
if( classFile == null ) {
throw new WasmException( "Missing class: " + className, -1 );
}
ConstantClass superClass = classFile.getSuperClass();
if( superClass != null ) {
String superClassName = superClass.getName();
listStructFields( superClassName, list );
}
FieldInfo[] fields = classFile.getFields();
for( FieldInfo field : fields ) {
if( field.isStatic() ) {
continue;
}
list.add( new NamedStorageType( className, field, types ) );
}
}
/**
* Iterate over all methods of the classFile and run the handler.
*
* @param classFile
* the classFile
* @param handler
* the handler
* @throws WasmException
* if some Java code can't converted
*/
private void iterateMethods( ClassFile classFile, Consumer<MethodInfo> handler ) throws WasmException {
sourceFile = null; // clear previous value for the case an IO exception occur
className = null;
try {
sourceFile = classFile.getSourceFile();
className = classFile.getThisClass().getName();
MethodInfo[] methods = classFile.getMethods();
for( MethodInfo method : methods ) {
handler.accept( method );
}
} catch( IOException ioex ) {
throw WasmException.create( ioex, sourceFile, className, -1 );
}
}
/**
* Prepare the method.
*
* @param method
* the method
* @throws WasmException
* if some Java code can't converted
*/
private void prepareMethod( MethodInfo method ) throws WasmException {
try {
FunctionName name = new FunctionName( method );
Map<String,Object> annotationValues;
if( (annotationValues = method.getAnnotation( JWebAssembly.IMPORT_ANNOTATION )) != null ) {
if( !method.isStatic() ) {
throw new WasmException( "Import method must be static: " + name.fullName, -1 );
}
functions.markAsWritten( name );
String impoarModule = (String)annotationValues.get( "module" );
String importName = (String)annotationValues.get( "name" );
writer.prepareImport( name, impoarModule, importName );
writeMethodSignature( name, true, null );
return;
}
if( (annotationValues = method.getAnnotation( JWebAssembly.EXPORT_ANNOTATION )) != null ) {
if( !method.isStatic() ) {
throw new WasmException( "Export method must be static: " + name.fullName, -1 );
}
functions.markAsNeeded( name );
return;
}
if( (annotationValues = method.getAnnotation( JWebAssembly.REPLACE_ANNOTATION )) != null ) {
String signatureName = (String)annotationValues.get( "value" );
name = new FunctionName( signatureName );
functions.addReplacement( name, method );
return;
}
} catch( Exception ioex ) {
throw WasmException.create( ioex, sourceFile, className, -1 );
}
}
/**
* Write the content of a method.
*
* @param name
* the function name that should be written. This can be differ from the value in the MethodInfo
* @param method
* the method
* @throws WasmException
* if some Java code can't converted
*/
private void writeMethod( FunctionName name, MethodInfo method ) throws WasmException, IOException {
Code code = null;
try {
if( method.getAnnotation( JWebAssembly.IMPORT_ANNOTATION ) != null ) {
return;
}
WasmCodeBuilder codeBuilder;
code = method.getCode();
if( method.getAnnotation( JWebAssembly.TEXTCODE_ANNOTATION ) != null ) {
Map<String, Object> wat = method.getAnnotation( JWebAssembly.TEXTCODE_ANNOTATION );
String watCode = (String)wat.get( "value" );
String signature = (String)wat.get( "signature" );
if( signature == null ) {
signature = method.getType();
}
watParser.parse( watCode, code == null ? -1 : code.getFirstLineNr() );
codeBuilder = watParser;
} else if( code != null ) { // abstract methods and interface methods does not have code
javaCodeBuilder.buildCode( code, !method.getType().endsWith( ")V" ) );
codeBuilder = javaCodeBuilder;
} else {
throw new WasmException( "Abstract or native method can not be used: " + name.fullName, -1 );
}
writeExport( name, method );
writeMethodImpl( name, method.isStatic(), codeBuilder );
} catch( Exception ioex ) {
int lineNumber = code == null ? -1 : code.getFirstLineNr();
throw WasmException.create( ioex, sourceFile, className, lineNumber );
}
}
private void writeMethodImpl( FunctionName name, boolean isStatic, WasmCodeBuilder codeBuilder ) throws WasmException, IOException {
writer.writeMethodStart( name, sourceFile );
functions.markAsWritten( name );
writeMethodSignature( name, isStatic, codeBuilder );
List<WasmInstruction> instructions = codeBuilder.getInstructions();
optimizer.optimze( instructions );
int lastJavaSourceLine = -1;
for( WasmInstruction instruction : instructions ) {
try {
// add source-map information
int javaSourceLine = instruction.getLineNumber();
if( javaSourceLine >= 0 && javaSourceLine != lastJavaSourceLine ) {
writer.markSourceLine( javaSourceLine );
lastJavaSourceLine = javaSourceLine;
}
switch( instruction.getType() ) {
case Block:
switch( ((WasmBlockInstruction)instruction).getOperation() ) {
case TRY:
case CATCH:
writer.writeException();
break;
default:
}
break;
case Call:
functions.markAsNeeded( ((WasmCallInstruction)instruction).getFunctionName() );
break;
case Struct:
WasmStructInstruction instr = (WasmStructInstruction)instruction;
setStructType( instr );
if( instr.getOperator() == StructOperator.NEW_DEFAULT ) {
List<NamedStorageType> list = instr.getStructType().getFields();
for( NamedStorageType storageType : list ) {
writer.writeDefaultValue( storageType.getType() );
}
}
break;
default:
}
instruction.writeTo( writer );
} catch( Throwable th ) {
throw WasmException.create( th, instruction.getLineNumber() );
}
}
writer.writeMethodFinish();
}
/**
* Look for a Export annotation and if there write an export directive.
*
* @param name
* the function name
* @param method
* the method
*
* @throws IOException
* if any IOException occur
*/
private void writeExport( FunctionName name, MethodInfo method ) throws IOException {
Map<String,Object> export = method.getAnnotation( JWebAssembly.EXPORT_ANNOTATION );
if( export != null ) {
String exportName = (String)export.get( "name" );
if( exportName == null ) {
exportName = method.getName(); // TODO naming conversion rule if no name was set
}
writer.writeExport( name, exportName );
}
}
/**
* Write the parameter and return signatures
*
* @param name
* the Java signature, typical method.getType();
* @param isStatic
* if method is static
* @param codeBuilder
* the calculated variables
* @throws IOException
* if any I/O error occur
* @throws WasmException
* if some Java code can't converted
*/
private void writeMethodSignature( FunctionName name, boolean isStatic, WasmCodeBuilder codeBuilder ) throws IOException, WasmException {
int paramCount = 0;
if( !isStatic ) {
StructType instanceType = types.valueOf( name.className );
writeStructType( instanceType );
writer.writeMethodParam( "param", instanceType, "this" );
}
Iterator<AnyType> parser = name.getSignature();
AnyType type;
for( String kind : new String[] {"param","result"}) {
while( parser.hasNext() && (type = parser.next()) != null ) {
String paramName = null;
if( kind == "param" ) {
if( codeBuilder != null ) {
paramName = codeBuilder.getLocalName( paramCount );
}
paramCount++;
}
if( type != ValueType.empty ) {
writer.writeMethodParam( kind, type, paramName );
}
}
}
if( codeBuilder != null ) {
if( !isStatic ) {
paramCount++;
}
List<AnyType> localTypes = codeBuilder.getLocalTypes( paramCount );
for( int i = 0; i < localTypes.size(); i++ ) {
type = localTypes.get( i );
int idx = paramCount + i;
String paramName = codeBuilder.getLocalName( idx );
writer.writeMethodParam( "local", type, paramName );
}
}
writer.writeMethodParamFinish( );
}
}