Merge pull request #2167 from hangshao0/CDS

Contribute the source code of CDS adapter to OpenJ9

cdsadapter/.project

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>cdsadapter</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+	</buildSpec>
+	<natures>
+	</natures>
+</projectDescription>

cdsadapter/com.ibm.cds/src/com/ibm/cds/CDSBundleEntry.java

@@ -0,0 +1,114 @@
+/*******************************************************************************
+ * Copyright (c) 2006, 2018 IBM Corp. and others
+ *
+ * This program and the accompanying materials are made available under
+ * the terms of the Eclipse Public License 2.0 which accompanies this
+ * distribution and is available at https://www.eclipse.org/legal/epl-2.0/
+ * or the Apache License, Version 2.0 which accompanies this distribution and
+ * is available at https://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * This Source Code may also be made available under the following
+ * Secondary Licenses when the conditions for such availability set
+ * forth in the Eclipse Public License, v. 2.0 are satisfied: GNU
+ * General Public License, version 2 with the GNU Classpath
+ * Exception [1] and GNU General Public License, version 2 with the
+ * OpenJDK Assembly Exception [2].
+ *
+ * [1] https://www.gnu.org/software/classpath/license.html
+ * [2] http://openjdk.java.net/legal/assembly-exception.html
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 OR LicenseRef-GPL-2.0 WITH Assembly-exception
+ *******************************************************************************/
+
+package com.ibm.cds;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URL;
+
+import org.eclipse.osgi.storage.bundlefile.BundleEntry;
+
+/**
+ * A bundle entry for a class that is found in the shared classes cache
+ */
+public class CDSBundleEntry extends BundleEntry {
+	String path;
+	byte[] classbytes;
+	BundleEntry wrapped;
+
+	/**
+	 * The constructor
+	 * @param path the path to the class file
+	 * @param classbytes the magic cookie bytes for the class in the shared cache
+	 * @param wrapped the actual bundleEntry where the class comes from
+	 */
+	public CDSBundleEntry(String path, byte[] classbytes, BundleEntry wrapped) {
+		super();
+		this.path = path;
+		this.classbytes = classbytes;
+		this.wrapped = wrapped;
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.eclipse.osgi.baseadaptor.bundlefile.BundleEntry#getFileURL()
+	 * uses the wrapped bundle file to get the actual file url to the content of
+	 * the class on disk.
+	 * 
+	 * This should is likely never to be called.
+	 */
+	public URL getFileURL() {
+		return wrapped.getFileURL();
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.eclipse.osgi.baseadaptor.bundlefile.BundleEntry#getInputStream()
+	 * wraps the classbytes into a ByteArrayInputStream.  This should not be used
+	 * by classloading.
+	 */
+	public InputStream getInputStream() throws IOException {
+		// someone is trying to get the real bytes of the class file!!
+		// just return the entry from the wrapped file instead of the magic cookie
+		return wrapped.getInputStream();
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.eclipse.osgi.baseadaptor.bundlefile.BundleEntry#getBytes()
+	 * if classbytes is not null, it returns the magic cookie for the shared class.  This is used to define 
+	 * the class during class loading.
+	 * if classbytes is null, it gets the contents from actual BundleEntry and caches it in classbytes.
+	 */
+	public byte[] getBytes() throws IOException {
+		if (classbytes == null) {
+			classbytes = wrapped.getBytes();
+		}
+		return classbytes;
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.eclipse.osgi.baseadaptor.bundlefile.BundleEntry#getLocalURL()
+	 * uses the wrapped bundle file to get the actual local url to the content of
+	 * the class on disk.
+	 * 
+	 * This should is likely never to be called.
+	 */
+	public URL getLocalURL() {
+		return wrapped.getLocalURL();
+	}
+
+	public String getName() {
+		return path;
+	}
+
+	public long getSize() {
+		return wrapped.getSize();
+	}
+
+	public long getTime() {
+		return wrapped.getTime();
+	}
+}
+

cdsadapter/com.ibm.cds/src/com/ibm/cds/CDSBundleFile.java

@@ -0,0 +1,135 @@
+/*******************************************************************************
+ * Copyright (c) 2006, 2018 IBM Corp. and others
+ *
+ * This program and the accompanying materials are made available under
+ * the terms of the Eclipse Public License 2.0 which accompanies this
+ * distribution and is available at https://www.eclipse.org/legal/epl-2.0/
+ * or the Apache License, Version 2.0 which accompanies this distribution and
+ * is available at https://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * This Source Code may also be made available under the following
+ * Secondary Licenses when the conditions for such availability set
+ * forth in the Eclipse Public License, v. 2.0 are satisfied: GNU
+ * General Public License, version 2 with the GNU Classpath
+ * Exception [1] and GNU General Public License, version 2 with the
+ * OpenJDK Assembly Exception [2].
+ *
+ * [1] https://www.gnu.org/software/classpath/license.html
+ * [2] http://openjdk.java.net/legal/assembly-exception.html
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 OR LicenseRef-GPL-2.0 WITH Assembly-exception
+ *******************************************************************************/
+
+package com.ibm.cds;
+
+
+import java.net.MalformedURLException;
+import java.net.URL;
+
+import org.eclipse.osgi.storage.bundlefile.BundleEntry;
+import org.eclipse.osgi.storage.bundlefile.BundleFile;
+import org.eclipse.osgi.storage.bundlefile.BundleFileWrapper;
+
+import com.ibm.oti.shared.SharedClassURLHelper;
+
+/**
+ * Wraps an actual BundleFile object for purposes of loading classes from the
+ * shared classes cache. 
+ */
+public class CDSBundleFile extends BundleFileWrapper  {
+	private URL url; // the URL to the content of the real bundle file
+	private SharedClassURLHelper urlHelper; // the url helper set by the classloader
+	private boolean primed = false;
+
+	/**
+	 * The constructor
+	 * @param wrapped the real bundle file
+	 */
+	public CDSBundleFile(BundleFile wrapped) {
+		super(wrapped);
+		// get the url to the content of the real bundle file
+		try {
+			this.url = new URL("file", "", wrapped.getBaseFile().getAbsolutePath());
+		} catch (MalformedURLException e) {
+			// do nothing
+		}
+	}
+
+	public CDSBundleFile(BundleFile bundleFile, SharedClassURLHelper urlHelper) {
+		this(bundleFile);
+		this.urlHelper = urlHelper;
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.eclipse.osgi.storage.bundlefile.BundleFile#getEntry(java.lang.String)
+	 * 
+	 * If path is not for a class then just use the wrapped bundle file to answer the call. 
+	 * If the path is for a class, it returns a CDSBundleEntry object.
+	 * If the path is for a class, it will look for the magic cookie in the 
+	 * shared classes cache. If found, the bytes representing the magic cookie are stored in CDSBundleEntry object.
+	 */
+	public BundleEntry getEntry(String path) {
+		String classFileExt = ".class";
+		BundleEntry wrappedEntry = super.getEntry(path);
+		if (wrappedEntry == null) {
+			return null;
+		}
+		if ((false == primed) || (false == path.endsWith(classFileExt))) {
+			return wrappedEntry;
+		}
+
+		byte[] classbytes = getClassBytes(path.substring(0, path.length()-classFileExt.length()));
+		BundleEntry be = new CDSBundleEntry(path, classbytes, wrappedEntry);
+		return be;
+	}
+
+	/**
+	 * Returns the file url to the content of the actual bundle file 
+	 * @return the file url to the content of the actual bundle file
+	 */
+	URL getURL() {
+		return url;
+	}
+
+	/**
+	 * Returns the url helper for this bundle file.  This is set by the 
+	 * class loading hook
+	 * @return the url helper for this bundle file
+	 */
+	SharedClassURLHelper getURLHelper() {
+		return urlHelper;
+	}
+
+	/**
+	 * Sets the url helper for this bundle file.  This is called by the 
+	 * class loading hook.
+	 * @param urlHelper the url helper
+	 */
+	void setURLHelper(SharedClassURLHelper urlHelper) {
+		this.urlHelper = urlHelper;
+		this.primed = false; // always unprime when a new urlHelper is set
+	}
+
+	/**
+	 * Sets the primed flag for the bundle file.  This is called by the 
+	 * class loading hook after the first class has been loaded from disk for 
+	 * this bundle file.
+	 * @param primed the primed flag
+	 */
+	void setPrimed(boolean primed) {
+		this.primed = primed;
+	}
+
+	/**
+	 * Searches in the shared classes cache for the specified class name.
+	 * @param name the name of the class
+	 * @return the magic cookie to the shared class or null if the class is not in the cache.
+	 */
+	private byte[] getClassBytes(String name) {
+		if (urlHelper == null || url == null)
+			return null;
+		return urlHelper.findSharedClass(url, name);
+	}
+}
+

cdsadapter/com.ibm.cds/src/com/ibm/cds/CDSHookConfigurator.java

@@ -0,0 +1,47 @@
+/*******************************************************************************
+ * Copyright (c) 2006, 2018 IBM Corp. and others
+ *
+ * This program and the accompanying materials are made available under
+ * the terms of the Eclipse Public License 2.0 which accompanies this
+ * distribution and is available at https://www.eclipse.org/legal/epl-2.0/
+ * or the Apache License, Version 2.0 which accompanies this distribution and
+ * is available at https://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * This Source Code may also be made available under the following
+ * Secondary Licenses when the conditions for such availability set
+ * forth in the Eclipse Public License, v. 2.0 are satisfied: GNU
+ * General Public License, version 2 with the GNU Classpath
+ * Exception [1] and GNU General Public License, version 2 with the
+ * OpenJDK Assembly Exception [2].
+ *
+ * [1] https://www.gnu.org/software/classpath/license.html
+ * [2] http://openjdk.java.net/legal/assembly-exception.html
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 OR LicenseRef-GPL-2.0 WITH Assembly-exception
+ *******************************************************************************/
+
+package com.ibm.cds;
+
+import org.eclipse.osgi.internal.hookregistry.HookConfigurator;
+import org.eclipse.osgi.internal.hookregistry.HookRegistry;
+
+public class CDSHookConfigurator implements HookConfigurator {
+	//////////////// HookConfigurator //////////////////
+	static public boolean 	SUPPRESS_ERROR_REPORTING = "true".equals(System.getProperty("ibm.cds.suppresserrors"));
+	public void addHooks(HookRegistry hookRegistry) {
+		try {
+			Class.forName("com.ibm.oti.shared.SharedClassHelperFactory");
+		} catch (ClassNotFoundException e) {
+			// not running on J9
+			if (!SUPPRESS_ERROR_REPORTING) {
+				System.err.println("The IBM Class Sharing Adaptor will not work in this configuration.");
+				System.err.println("You are not running on a J9 Java VM.");
+			}
+			return;
+		}
+		CDSHookImpls hooks = new CDSHookImpls();
+		hookRegistry.addClassLoaderHook(hooks);
+		hookRegistry.addBundleFileWrapperFactoryHook(hooks);
+	}
+
+}