6902337: fix langtools build to allow forward refs into jdk/ repo

Reviewed-by: ohair, mcimadamore
This commit is contained in:
Jonathan Gibbons 2009-11-20 11:18:43 -08:00
parent 046d1831b0
commit 42bf8347dc
4 changed files with 506 additions and 12 deletions

@ -133,6 +133,23 @@ ifdef ALT_BOOTDIR
ANT_JAVA_HOME = JAVA_HOME=$(ALT_BOOTDIR)
endif
# To facilitate bootstrapping, much of langtools can be compiled with (just)
# a boot JDK. However, some source files need to be compiled against
# new JDK API. In a bootstrap build, an import JDK may not be available,
# so build.xml can also build against the source files in a jdk repo,
# in which case it will automatically generate stub files for the new JDK API.
ifdef JDK_TOPDIR
ANT_OPTIONS += -Dimport.jdk=$(JDK_TOPDIR)
else
ifdef ALT_JDK_TOPDIR
ANT_OPTIONS += -Dimport.jdk=$(ALT_JDK_TOPDIR)
else
ifdef ALT_JDK_IMPORT_DIR
ANT_OPTIONS += -Dimport.jdk=$(ALT_JDK_IMPORT_DIR)
endif
endif
endif
ifdef ALT_OUTPUTDIR
OUTPUTDIR = $(ALT_OUTPUTDIR)
ANT_OPTIONS += -Dbuild.dir=$(ALT_OUTPUTDIR)/build

@ -148,6 +148,13 @@ apt.tests = \
#
# The following files require the import JDK to be available
require.import.jdk.files =
# The following files in the import jdk source directory are required
# in order to compile the files defined in ${require.import.jdk.files}
import.jdk.stub.files =
# The following value is used by the main jtreg target.
# An empty value means all tests
# Override as desired to run a specific set of tests

@ -56,6 +56,7 @@
<property name="build.coverage.dir" location="${build.dir}/coverage"/>
<property name="build.classes.dir" location="${build.dir}/classes"/>
<property name="build.gensrc.dir" location="${build.dir}/gensrc"/>
<property name="build.genstubs.dir" location="${build.dir}/genstubs"/>
<property name="build.javadoc.dir" location="${build.dir}/javadoc"/>
<property name="build.jtreg.dir" location="${build.dir}/jtreg"/>
<property name="build.toolclasses.dir" location="${build.dir}/toolclasses"/>
@ -93,6 +94,41 @@
<isset property="target.java.home"/>
</condition>
<!-- Logic for handling access import jdk classes, if available.
import.jdk should be unset, or set to jdk home (to use rt.jar)
or to jdk repo (to use src/share/classes).
Based on the value, if any, set up default values for javac's sourcepath,
classpath and bootclasspath. Note: the default values are overridden
in the build-bootstrap-classes macro. -->
<available property="import.jdk.src.dir" value="${import.jdk}/src/share/classes"
filepath="${import.jdk}/src/share/classes" file="java/nio/file/Path.java"/>
<available property="import.jdk.jar" value="${import.jdk}/jre/lib/rt.jar"
ignoresystemclasses="true"
classpath="${import.jdk}/jre/lib/rt.jar" classname="java.nio.file.Path"/>
<condition property="javac.sourcepath" value="${build.genstubs.dir}" else="">
<isset property="import.jdk.src.dir"/>
</condition>
<property name="javac.classpath" value=""/>
<condition property="javac.bootclasspath.opt"
value="-Xbootclasspath:${build.classes.dir}:${import.jdk.jar}"
else="-Xbootclasspath/p:${build.classes.dir}">
<isset property="import.jdk.jar"/>
</condition>
<condition property="exclude.files" value="" else="${require.import.jdk.files}">
<isset property="import.jdk"/>
</condition>
<!-- for debugging -->
<target name="check-import.jdk">
<echo message="import.jdk: ${import.jdk}"/>
<echo message="import.jdk.jar: ${import.jdk.jar}"/>
<echo message="import.jdk.src.dir: ${import.jdk.src.dir}"/>
</target>
<!-- Standard target to build deliverables for JDK build. -->
@ -108,11 +144,15 @@
<zip file="${dist.lib.dir}/src.zip" basedir="${src.classes.dir}"/>
</target>
<target name="build-bootstrap-tools" depends="build-bootstrap-javac,build-bootstrap-javadoc,build-bootstrap-doclets,build-bootstrap-javah"/>
<target name="build-bootstrap-tools"
depends="build-bootstrap-javac,build-bootstrap-javadoc,build-bootstrap-doclets,build-bootstrap-javah"
/>
<target name="build-all-tools" depends="build-javac,build-javadoc,build-doclets,build-javah,build-javap,build-apt"/>
<target name="build-all-tools"
depends="build-javac,build-javadoc,build-doclets,build-javah,build-javap,build-apt"
/>
<target name="build-all-classes" depends="build-bootstrap-javac">
<target name="build-all-classes" depends="build-bootstrap-javac,-create-import-jdk-stubs">
<build-classes includes="${javac.includes} ${javadoc.includes} ${doclets.includes} ${javah.includes} ${javap.includes} ${apt.includes}"/>
</target>
@ -197,7 +237,7 @@
<build-bootstrap-tool name="javac"/>
</target>
<target name="build-classes-javac" depends="build-bootstrap-javac">
<target name="build-classes-javac" depends="build-bootstrap-javac,-create-import-jdk-stubs">
<build-classes includes="${javac.includes}"/>
</target>
@ -379,6 +419,17 @@
<target name="apt" depends="build-apt,jtreg-apt,findbugs-apt"/>
<!-- Create import JDK stubs -->
<target name="-create-import-jdk-stubs" depends="-def-genstubs" if="import.jdk.src.dir">
<mkdir dir="${build.genstubs.dir}"/>
<genstubs
srcdir="${import.jdk.src.dir}" destdir="${build.genstubs.dir}"
includes="${import.jdk.stub.files}"
fork="true" classpath="${build.toolclasses.dir}:${build.bootstrap.dir}/classes:${ant.home}/lib/ant.jar"
/>
</target>
<!-- Check targets -->
<target name="-check-boot.java.home" depends="-def-check">
@ -446,16 +497,23 @@
<target name="-def-build-classes" depends="-def-pcompile">
<macrodef name="build-classes">
<attribute name="includes"/>
<attribute name="excludes" default="**/package-info.java"/>
<attribute name="excludes" default="${exclude.files} **/package-info.java"/>
<attribute name="classes.dir" default="${build.classes.dir}"/>
<attribute name="gensrc.dir" default="${build.gensrc.dir}"/>
<attribute name="bootclasspath" default="${build.bootstrap.dir}/classes"/>
<attribute name="javac.bootclasspath" default="${build.bootstrap.dir}/classes"/>
<attribute name="bootclasspath.opt" default="${javac.bootclasspath.opt}"/>
<attribute name="classpath" default="${javac.classpath}"/>
<attribute name="sourcepath" default="${javac.sourcepath}"/>
<attribute name="java.home" default="${boot.java.home}"/>
<attribute name="source" default="${javac.source}"/>
<attribute name="target" default="${javac.target}"/>
<attribute name="release" default="${release}"/>
<attribute name="full.version" default="${full.version}"/>
<sequential>
<echo level="verbose" message="build-classes: excludes=@{excludes}"/>
<echo level="verbose" message="build-classes: bootclasspath.opt=@{bootclasspath.opt}"/>
<echo level="verbose" message="build-classes: classpath=@{classpath}"/>
<echo level="verbose" message="build-classes: sourcepath=@{sourcepath}"/>
<mkdir dir="@{gensrc.dir}"/>
<mkdir dir="@{classes.dir}"/>
<pcompile srcdir="${src.classes.dir}"
@ -479,14 +537,17 @@
destdir="@{classes.dir}"
includes="@{includes}"
excludes="@{excludes}"
sourcepath=""
sourcepath="@{sourcepath}"
classpath="@{classpath}"
includeAntRuntime="no"
source="@{source}"
target="@{target}"
debug="${javac.debug}"
debuglevel="${javac.debuglevel}">
<compilerarg value="-J-Xbootclasspath/p:@{bootclasspath}"/>
<compilerarg value="-Xbootclasspath/p:@{classes.dir}"/>
<compilerarg value="-implicit:none"/>
<compilerarg value="-Xprefer:source"/>
<compilerarg value="-J-Xbootclasspath/p:@{javac.bootclasspath}"/>
<compilerarg line="@{bootclasspath.opt}"/>
<compilerarg line="${javac.no.jdk.warnings}"/>
<compilerarg line="${javac.version.opt}"/>
<compilerarg line="${javac.lint.opts}"/>
@ -526,9 +587,12 @@
target="${boot.javac.target}"
gensrc.dir="${build.bootstrap.dir}/gensrc"
classes.dir="${build.bootstrap.dir}/classes"
bootclasspath=""
javac.bootclasspath=""
bootclasspath.opt="-Xbootclasspath/p:${build.bootstrap.dir}/classes"
sourcepath=""
release="${bootstrap.release}"
full.version="${bootstrap.full.version}"/>
full.version="${bootstrap.full.version}"
excludes="${require.import.jdk.files} **/package-info.java"/>
</presetdef>
</target>
@ -546,6 +610,20 @@
classpath="${build.toolclasses.dir}/"/>
</target>
<target name="-def-genstubs" depends="build-bootstrap-javac">
<mkdir dir="${build.toolclasses.dir}"/>
<javac fork="true"
source="${boot.javac.source}"
target="${boot.javac.target}"
executable="${boot.java.home}/bin/javac"
srcdir="${make.tools.dir}/GenStubs"
destdir="${build.toolclasses.dir}/"
classpath="${build.bootstrap.dir}/classes:${ant.home}/lib/ant.jar"/>
<taskdef name="genstubs"
classname="GenStubs$$Ant"
classpath="${build.toolclasses.dir}/"/>
</target>
<target name="-def-javadoc-tool" depends="-check-target.java.home">
<macrodef name="javadoc-tool">
<attribute name="name"/>
@ -707,7 +785,7 @@
<!-- standard JDK target -->
<target name="sanity"
description="display settings of congiguration values">
description="display settings of configuration values">
<echo level="info">ant.home = ${ant.home}</echo>
<echo level="info">boot.java.home = ${boot.java.home}</echo>
<echo level="info">target.java.home = ${target.java.home}</echo>

@ -0,0 +1,392 @@
/*
* Copyright 2009 Sun Microsystems, Inc. All Rights Reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Sun designates this
* particular file as subject to the "Classpath" exception as provided
* by Sun in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
* CA 95054 USA or visit www.sun.com if you need additional information or
* have any questions.
*/
import java.io.*;
import java.util.*;
import javax.tools.JavaFileObject;
import javax.tools.StandardJavaFileManager;
import javax.tools.StandardLocation;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.DirectoryScanner;
import org.apache.tools.ant.taskdefs.MatchingTask;
import org.apache.tools.ant.types.Path;
import org.apache.tools.ant.types.Reference;
import com.sun.source.tree.CompilationUnitTree;
import com.sun.source.util.JavacTask;
import com.sun.tools.javac.api.JavacTool;
import com.sun.tools.javac.code.Flags;
import com.sun.tools.javac.code.TypeTags;
import com.sun.tools.javac.tree.JCTree;
import com.sun.tools.javac.tree.JCTree.JCBlock;
import com.sun.tools.javac.tree.JCTree.JCCompilationUnit;
import com.sun.tools.javac.tree.JCTree.JCLiteral;
import com.sun.tools.javac.tree.JCTree.JCMethodDecl;
import com.sun.tools.javac.tree.JCTree.JCModifiers;
import com.sun.tools.javac.tree.JCTree.JCStatement;
import com.sun.tools.javac.tree.JCTree.JCVariableDecl;
import com.sun.tools.javac.tree.Pretty;
import com.sun.tools.javac.tree.TreeTranslator;
/**
* Generate stub source files by removing implementation details from input files.
*
* This is a special purpose stub generator, specific to the needs of generating
* stub files for JDK 7 API that are needed to compile langtools files that depend
* on that API. The stub generator works by removing as much of the API source code
* as possible without affecting the public signature, in order to reduce the
* transitive closure of the API being referenced. The resulting stubs can be
* put on the langtools sourcepath with -implicit:none to compile the langtools
* files that depend on the JDK 7 API.
*
* Usage:
* genstubs -s <outdir> -sourcepath <path> <classnames>
*
* The specified class names are looked up on the sourcepath, and corresponding
* stubs are written to the source output directory.
*
* Classes are parsed into javac ASTs, then processed with a javac TreeTranslator
* to remove implementation details, and written out in the source output directory.
* Documentation comments and annotations are removed. Method bodies are removed
* and methods are marked native. Private and package-private field definitions
* have their initializers replace with 0, 0.0, false, null as appropriate.
*
* An Ant task, Main$Ant is also provided. Files are specified with an implicit
* fileset, using srcdir as a base directory. The set of files to be included
* is specified with an includes attribute or nested <includes> set. However,
* unlike a normal fileset, an empty includes attribute means "no files" instead
* of "all files". The Ant task also accepts "fork=true" and classpath attribute
* or nested <classpath> element to run GenStubs in a separate VM with the specified
* path. This is likely necessary if a JDK 7 parser is required to read the
* JDK 7 input files.
*/
public class GenStubs {
static class Fault extends Exception {
private static final long serialVersionUID = 0;
Fault(String message) {
super(message);
}
Fault(String message, Throwable cause) {
super(message);
initCause(cause);
}
}
public static void main(String[] args) {
boolean ok = new GenStubs().run(args);
if (!ok)
System.exit(1);
}
boolean run(String... args) {
File outdir = null;
String sourcepath = null;
List<String> classes = new ArrayList<String>();
for (ListIterator<String> iter = Arrays.asList(args).listIterator(); iter.hasNext(); ) {
String arg = iter.next();
if (arg.equals("-s") && iter.hasNext())
outdir = new File(iter.next());
else if (arg.equals("-sourcepath") && iter.hasNext())
sourcepath = iter.next();
else if (arg.startsWith("-"))
throw new IllegalArgumentException(arg);
else {
classes.add(arg);
while (iter.hasNext())
classes.add(iter.next());
}
}
return run(sourcepath, outdir, classes);
}
boolean run(String sourcepath, File outdir, List<String> classes) {
//System.err.println("run: sourcepath:" + sourcepath + " outdir:" + outdir + " classes:" + classes);
if (sourcepath == null)
throw new IllegalArgumentException("sourcepath not set");
if (outdir == null)
throw new IllegalArgumentException("source output dir not set");
JavacTool tool = JavacTool.create();
StandardJavaFileManager fm = tool.getStandardFileManager(null, null, null);
try {
fm.setLocation(StandardLocation.SOURCE_OUTPUT, Collections.singleton(outdir));
fm.setLocation(StandardLocation.SOURCE_PATH, splitPath(sourcepath));
List<JavaFileObject> files = new ArrayList<JavaFileObject>();
for (String c: classes) {
JavaFileObject fo = fm.getJavaFileForInput(
StandardLocation.SOURCE_PATH, c, JavaFileObject.Kind.SOURCE);
if (fo == null)
error("class not found: " + c);
else
files.add(fo);
}
JavacTask t = tool.getTask(null, fm, null, null, null, files);
Iterable<? extends CompilationUnitTree> trees = t.parse();
for (CompilationUnitTree tree: trees) {
makeStub(fm, tree);
}
} catch (IOException e) {
error("IO error " + e, e);
}
return (errors == 0);
}
void makeStub(StandardJavaFileManager fm, CompilationUnitTree tree) throws IOException {
CompilationUnitTree tree2 = new StubMaker().translate(tree);
String className = fm.inferBinaryName(StandardLocation.SOURCE_PATH, tree.getSourceFile());
JavaFileObject fo = fm.getJavaFileForOutput(StandardLocation.SOURCE_OUTPUT,
className, JavaFileObject.Kind.SOURCE, null);
// System.err.println("Writing " + className + " to " + fo.getName());
Writer out = fo.openWriter();
try {
new Pretty(out, true).printExpr((JCTree) tree2);
} finally {
out.close();
}
}
List<File> splitPath(String path) {
List<File> list = new ArrayList<File>();
for (String p: path.split(File.pathSeparator)) {
if (p.length() > 0)
list.add(new File(p));
}
return list;
}
void error(String message) {
System.err.println(message);
errors++;
}
void error(String message, Throwable cause) {
error(message);
}
int errors;
class StubMaker extends TreeTranslator {
CompilationUnitTree translate(CompilationUnitTree tree) {
return super.translate((JCCompilationUnit) tree);
}
/**
* compilation units: remove javadoc comments
* -- required, in order to remove @deprecated tags, since we
* (separately) remove all annotations, including @Deprecated
*/
public void visitTopLevel(JCCompilationUnit tree) {
super.visitTopLevel(tree);
tree.docComments = Collections.emptyMap();
}
/**
* methods: remove method bodies, make methods native
*/
@Override
public void visitMethodDef(JCMethodDecl tree) {
tree.mods = translate(tree.mods);
tree.restype = translate(tree.restype);
tree.typarams = translateTypeParams(tree.typarams);
tree.params = translateVarDefs(tree.params);
tree.thrown = translate(tree.thrown);
if (tree.restype != null && tree.body != null) {
tree.mods.flags |= Flags.NATIVE;
tree.body = null;
}
result = tree;
}
/**
* modifiers: remove annotations
*/
@Override
public void visitModifiers(JCModifiers tree) {
tree.annotations = com.sun.tools.javac.util.List.nil();
result = tree;
}
/**
* field definitions: replace initializers with 0, 0.0, false etc
* when possible -- i.e. leave public, protected initializers alone
*/
@Override
public void visitVarDef(JCVariableDecl tree) {
tree.mods = translate(tree.mods);
tree.vartype = translate(tree.vartype);
if (tree.init != null) {
if ((tree.mods.flags & (Flags.PUBLIC | Flags.PROTECTED)) != 0)
tree.init = translate(tree.init);
else {
String t = tree.vartype.toString();
if (t.equals("boolean"))
tree.init = new JCLiteral(TypeTags.BOOLEAN, 0) { };
else if (t.equals("byte"))
tree.init = new JCLiteral(TypeTags.BYTE, 0) { };
else if (t.equals("char"))
tree.init = new JCLiteral(TypeTags.CHAR, 0) { };
else if (t.equals("double"))
tree.init = new JCLiteral(TypeTags.DOUBLE, 0.d) { };
else if (t.equals("float"))
tree.init = new JCLiteral(TypeTags.FLOAT, 0.f) { };
else if (t.equals("int"))
tree.init = new JCLiteral(TypeTags.INT, 0) { };
else if (t.equals("long"))
tree.init = new JCLiteral(TypeTags.LONG, 0) { };
else if (t.equals("short"))
tree.init = new JCLiteral(TypeTags.SHORT, 0) { };
else
tree.init = new JCLiteral(TypeTags.BOT, null) { };
}
}
result = tree;
}
}
//---------- Ant Invocation ------------------------------------------------
public static class Ant extends MatchingTask {
private File srcDir;
private File destDir;
private boolean fork;
private Path classpath;
private String includes;
public void setSrcDir(File dir) {
this.srcDir = dir;
}
public void setDestDir(File dir) {
this.destDir = dir;
}
public void setFork(boolean v) {
this.fork = v;
}
public void setClasspath(Path cp) {
if (classpath == null)
classpath = cp;
else
classpath.append(cp);
}
public Path createClasspath() {
if (classpath == null) {
classpath = new Path(getProject());
}
return classpath.createPath();
}
public void setClasspathRef(Reference r) {
createClasspath().setRefid(r);
}
public void setIncludes(String includes) {
super.setIncludes(includes);
this.includes = includes;
}
@Override
public void execute() {
if (includes != null && includes.trim().isEmpty())
return;
DirectoryScanner s = getDirectoryScanner(srcDir);
String[] files = s.getIncludedFiles();
// System.err.println("Ant.execute: srcDir " + srcDir);
// System.err.println("Ant.execute: destDir " + destDir);
// System.err.println("Ant.execute: files " + Arrays.asList(files));
files = filter(srcDir, destDir, files);
if (files.length == 0)
return;
System.out.println("Generating " + files.length + " stub files to " + destDir);
List<String> classNames = new ArrayList<String>();
for (String file: files) {
classNames.add(file.replaceAll(".java$", "").replace('/', '.'));
}
if (!fork) {
GenStubs m = new GenStubs();
boolean ok = m.run(srcDir.getPath(), destDir, classNames);
if (!ok)
throw new BuildException("genstubs failed");
} else {
List<String> cmd = new ArrayList<String>();
String java_home = System.getProperty("java.home");
cmd.add(new File(new File(java_home, "bin"), "java").getPath());
if (classpath != null)
cmd.add("-Xbootclasspath/p:" + classpath);
cmd.add(GenStubs.class.getName());
cmd.add("-sourcepath");
cmd.add(srcDir.getPath());
cmd.add("-s");
cmd.add(destDir.getPath());
cmd.addAll(classNames);
//System.err.println("GenStubs exec " + cmd);
ProcessBuilder pb = new ProcessBuilder(cmd);
pb.redirectErrorStream(true);
try {
Process p = pb.start();
BufferedReader in = new BufferedReader(new InputStreamReader(p.getInputStream()));
try {
String line;
while ((line = in.readLine()) != null)
System.out.println(line);
} finally {
in.close();
}
int rc = p.waitFor();
if (rc != 0)
throw new BuildException("genstubs failed");
} catch (IOException e) {
throw new BuildException("genstubs failed", e);
} catch (InterruptedException e) {
throw new BuildException("genstubs failed", e);
}
}
}
String[] filter(File srcDir, File destDir, String[] files) {
List<String> results = new ArrayList<String>();
for (String f: files) {
long srcTime = new File(srcDir, f).lastModified();
long destTime = new File(destDir, f).lastModified();
if (srcTime > destTime)
results.add(f);
}
return results.toArray(new String[results.size()]);
}
}
}