Github user pwendell commented on a diff in the pull request:
https://github.com/apache/spark/pull/3916#discussion_r24960542
--- Diff:
launcher/src/main/java/org/apache/spark/launcher/AbstractLauncher.java ---
@@ -0,0 +1,499 @@
+/*
+ * 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.spark.launcher;
+
+import java.io.BufferedReader;
+import java.io.File;
+import java.io.FileFilter;
+import java.io.FileInputStream;
+import java.io.InputStreamReader;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Properties;
+import java.util.jar.JarFile;
+import java.util.regex.Pattern;
+
+/**
+ * Basic functionality for launchers - objects that encapsulate knowledge
about how to build the
+ * commands to run a Spark application or service. This class is not meant
to be extended by user
+ * code.
+ */
+public abstract class AbstractLauncher<T extends AbstractLauncher> extends
LauncherCommon {
+
+ private static final String ENV_SPARK_HOME = "SPARK_HOME";
+ private static final String DEFAULT_PROPERTIES_FILE =
"spark-defaults.conf";
+ static final String DEFAULT_MEM = "512m";
+
+ String javaHome;
+ String sparkHome;
+ String propertiesFile;
+ final Map<String, String> conf;
+ final Map<String, String> launcherEnv;
+
+ AbstractLauncher() {
+ this(Collections.<String, String>emptyMap());
+ }
+
+ protected AbstractLauncher(Map<String, String> env) {
+ this.conf = new HashMap<String, String>();
+ this.launcherEnv = new HashMap<String, String>(env);
+ }
+
+ @SuppressWarnings("unchecked")
+ private final T THIS = (T) this;
+
+ /**
+ * Set a custom JAVA_HOME for launching the Spark application.
+ *
+ * @param javaHome Path to the JAVA_HOME to use.
+ * @return This launcher.
+ */
+ public T setJavaHome(String javaHome) {
+ checkNotNull(javaHome, "javaHome");
+ this.javaHome = javaHome;
+ return THIS;
+ }
+
+ /**
+ * Set a custom Spark installation location for the application.
+ *
+ * @param sparkHome Path to the Spark installation to use.
+ * @return This launcher.
+ */
+ public T setSparkHome(String sparkHome) {
+ checkNotNull(sparkHome, "sparkHome");
+ launcherEnv.put(ENV_SPARK_HOME, sparkHome);
+ return THIS;
+ }
+
+ /**
+ * Set a custom properties file with Spark configuration for the
application.
+ *
+ * @param path Path to custom properties file to use.
+ * @return This launcher.
+ */
+ public T setPropertiesFile(String path) {
+ checkNotNull(path, "path");
+ this.propertiesFile = path;
+ return THIS;
+ }
+
+ /**
+ * Set a single configuration value for the application.
+ *
+ * @param key Configuration key.
+ * @param value The value to use.
+ * @return This launcher.
+ */
+ public T setConf(String key, String value) {
+ checkNotNull(key, "key");
+ checkNotNull(value, "value");
+ checkArgument(key.startsWith("spark."), "'key' must start with
'spark.'");
+ conf.put(key, value);
+ return THIS;
+ }
+
+ /**
+ * Launchers should implement this to create the command to be executed.
This method should
+ * also update the environment map with any environment variables needed
by the child process.
+ * <p/>
+ * Note that this method is a no-op in the base class, even though
subclasses in this package
+ * really must implement it. This approach was taken to allow this
method to be package private
+ * while still allowing CommandUtils.scala to extend this class for its
use.
+ *
+ * @param env Map containing environment variables to set for the Spark
job.
+ */
+ List<String> buildLauncherCommand(Map<String, String> env) throws
IOException {
+ throw new UnsupportedOperationException("Subclasses must implement
this method.");
+ }
+
+ /**
+ * Prepares the launcher command for execution from a shell script. This
is used by the `Main`
+ * class to service the scripts shipped with the Spark distribution.
+ */
+ List<String> buildShellCommand() throws IOException {
+ Map<String, String> childEnv = new HashMap<String,
String>(launcherEnv);
+ List<String> cmd = buildLauncherCommand(childEnv);
+ return isWindows() ? prepareForWindows(cmd, childEnv) :
prepareForBash(cmd, childEnv);
+ }
+
+ /**
+ * Loads the configuration file for the application, if it exists. This
is either the
+ * user-specified properties file, or the spark-defaults.conf file under
the Spark configuration
+ * directory.
+ */
+ Properties loadPropertiesFile() throws IOException {
+ Properties props = new Properties();
+ File propsFile;
+ if (propertiesFile != null) {
+ propsFile = new File(propertiesFile);
+ checkArgument(propsFile.isFile(), "Invalid properties file '%s'.",
propertiesFile);
+ } else {
+ propsFile = new File(getConfDir(), DEFAULT_PROPERTIES_FILE);
+ }
+
+ if (propsFile.isFile()) {
+ FileInputStream fd = null;
+ try {
+ fd = new FileInputStream(propsFile);
+ props.load(new InputStreamReader(fd, "UTF-8"));
+ } finally {
+ if (fd != null) {
+ try {
+ fd.close();
+ } catch (IOException e) {
+ // Ignore.
+ }
+ }
+ }
+ }
+
+ return props;
+ }
+
+ String getSparkHome() {
+ String path = getenv(ENV_SPARK_HOME);
+ checkState(path != null,
+ "Spark home not found; set it explicitly or use the SPARK_HOME
environment variable.");
+ return path;
+ }
+
+ protected List<String> buildJavaCommand(String extraClassPath) throws
IOException {
+ List<String> cmd = new ArrayList<String>();
+ if (javaHome == null) {
+ cmd.add(join(File.separator, System.getProperty("java.home"), "bin",
"java"));
+ } else {
+ cmd.add(join(File.separator, javaHome, "bin", "java"));
+ }
+
+ // Load extra JAVA_OPTS from conf/java-opts, if it exists.
+ File javaOpts = new File(join(File.separator, getConfDir(),
"java-opts"));
+ if (javaOpts.isFile()) {
+ BufferedReader br = new BufferedReader(new InputStreamReader(
+ new FileInputStream(javaOpts), "UTF-8"));
+ try {
+ String line;
+ while ((line = br.readLine()) != null) {
+ addOptionString(cmd, line);
+ }
+ } finally {
+ br.close();
+ }
+ }
+
+ cmd.add("-cp");
+ cmd.add(join(File.pathSeparator, buildClassPath(extraClassPath)));
+ return cmd;
+ }
+
+ /**
+ * Adds the default perm gen size option for Spark if the VM requires it
and the user hasn't
+ * set it.
+ */
+ protected void addPermGenSizeOpt(List<String> cmd) {
+ // Don't set MaxPermSize for Java 8 and later.
+ String[] version = System.getProperty("java.version").split("\\.");
+ if (Integer.parseInt(version[0]) > 1 || Integer.parseInt(version[1]) >
7) {
+ return;
+ }
+
+ for (String arg : cmd) {
+ if (arg.startsWith("-XX:MaxPermSize=")) {
+ return;
+ }
+ }
+
+ cmd.add("-XX:MaxPermSize=128m");
+ }
+
+ protected void addOptionString(List<String> cmd, String options) {
+ if (!isEmpty(options)) {
+ for (String opt : parseOptionString(options)) {
+ cmd.add(opt);
+ }
+ }
+ }
+
+ /**
+ * Builds the classpath for the application. Returns a list with one
classpath entry per element;
+ * each entry is formatted in the way expected by
<i>java.net.URLClassLoader</i> (more
+ * specifically, with trailing slashes for directories).
+ */
+ List<String> buildClassPath(String appClassPath) throws IOException {
+ String sparkHome = getSparkHome();
+ String scala = getScalaVersion();
+
+ List<String> cp = new ArrayList<String>();
+ addToClassPath(cp, getenv("SPARK_CLASSPATH"));
+ addToClassPath(cp, appClassPath);
+
+ addToClassPath(cp, getConfDir());
+
+ boolean prependClasses = !isEmpty(getenv("SPARK_PREPEND_CLASSES"));
+ boolean isTesting = "1".equals(getenv("SPARK_TESTING"));
+ if (prependClasses || isTesting) {
+ List<String> projects = Arrays.asList("core", "repl", "mllib",
"bagel", "graphx",
+ "streaming", "tools", "sql/catalyst", "sql/core", "sql/hive",
"sql/hive-thriftserver",
+ "yarn", "launcher");
+ if (prependClasses) {
+ System.err.println(
+ "NOTE: SPARK_PREPEND_CLASSES is set, placing locally compiled
Spark classes ahead of " +
+ "assembly.");
+ for (String project : projects) {
+ addToClassPath(cp,
String.format("%s/%s/target/scala-%s/classes", sparkHome, project,
+ scala));
+ }
+ }
+ if (isTesting) {
+ for (String project : projects) {
+ addToClassPath(cp,
String.format("%s/%s/target/scala-%s/test-classes", sparkHome,
+ project, scala));
+ }
+ }
+
+ // Add this path to include jars that are shaded in the final
deliverable created during
+ // the maven build. These jars are copied to this directory during
the build.
+ addToClassPath(cp, String.format("%s/core/target/jars/*",
sparkHome));
+ }
+
+ String assembly = findAssembly(scala);
+ addToClassPath(cp, assembly);
+
+ // When Hive support is needed, Datanucleus jars must be included on
the classpath. Datanucleus
+ // jars do not work if only included in the uber jar as plugin.xml
metadata is lost. Both sbt
+ // and maven will populate "lib_managed/jars/" with the datanucleus
jars when Spark is built
+ // with Hive, so first check if the datanucleus jars exist, and then
ensure the current Spark
+ // assembly is built for Hive, before actually populating the
CLASSPATH with the jars.
+ //
+ // This block also serves as a check for SPARK-1703, when the assembly
jar is built with
+ // Java 7 and ends up with too many files, causing issues with other
JDK versions.
+ boolean needsDataNucleus = false;
+ JarFile assemblyJar = null;
+ try {
+ assemblyJar = new JarFile(assembly);
+ needsDataNucleus =
assemblyJar.getEntry("org/apache/hadoop/hive/ql/exec/") != null;
+ } catch (IOException ioe) {
+ if (ioe.getMessage().indexOf("invalid CEN header") > 0) {
+ System.err.println(
+ "Loading Spark jar failed.\n" +
+ "This is likely because Spark was compiled with Java 7 and
run\n" +
+ "with Java 6 (see SPARK-1703). Please use Java 7 to run Spark\n"
+
+ "or build Spark with Java 6.");
+ System.exit(1);
+ } else {
+ throw ioe;
+ }
+ } finally {
+ if (assemblyJar != null) {
+ try {
+ assemblyJar.close();
+ } catch (IOException e) {
+ // Ignore.
+ }
+ }
+ }
+
+ if (needsDataNucleus) {
+ System.err.println("Spark assembly has been built with Hive,
including Datanucleus jars " +
+ "in classpath.");
+ File libdir;
+ if (new File(sparkHome, "RELEASE").isFile()) {
+ libdir = new File(sparkHome, "lib");
+ } else {
+ libdir = new File(sparkHome, "lib_managed/jars");
+ }
+
+ checkState(libdir.isDirectory(), "Library directory '%s' does not
exist.",
+ libdir.getAbsolutePath());
+ for (File jar : libdir.listFiles()) {
+ if (jar.getName().startsWith("datanucleus-")) {
+ addToClassPath(cp, jar.getAbsolutePath());
+ }
+ }
+ }
+
+ addToClassPath(cp, getenv("HADOOP_CONF_DIR"));
+ addToClassPath(cp, getenv("YARN_CONF_DIR"));
+ addToClassPath(cp, getenv("SPARK_DIST_CLASSPATH"));
+ return cp;
+ }
+
+ /**
+ * Adds entries to the classpath.
+ *
+ * @param cp List where to appended the new classpath entries.
+ * @param entries New classpath entries (separated by
File.pathSeparator).
+ */
+ private void addToClassPath(List<String> cp, String entries) {
+ if (isEmpty(entries)) {
+ return;
+ }
+ String[] split = entries.split(Pattern.quote(File.pathSeparator));
+ for (String entry : split) {
+ if (!isEmpty(entry)) {
+ if (new File(entry).isDirectory() &&
!entry.endsWith(File.separator)) {
+ entry += File.separator;
+ }
+ cp.add(entry);
+ }
+ }
+ }
+
+ String getScalaVersion() {
+ String scala = getenv("SPARK_SCALA_VERSION");
+ if (scala != null) {
+ return scala;
+ }
+
+ String sparkHome = getSparkHome();
+ File scala210 = new File(sparkHome, "assembly/target/scala-2.10");
+ File scala211 = new File(sparkHome, "assembly/target/scala-2.11");
+ if (scala210.isDirectory() && scala211.isDirectory()) {
+ checkState(false,
+ "Presence of build for both scala versions (2.10 and 2.11)
detected.\n" +
+ "Either clean one of them or set SPARK_SCALA_VERSION in your
environment.");
+ } else if (scala210.isDirectory()) {
+ return "2.10";
+ } else {
+ checkState(scala211.isDirectory(), "Cannot find any assembly build
directories.");
+ return "2.11";
+ }
+
+ throw new IllegalStateException("Should not reach here.");
+ }
+
+ private String findAssembly(String scalaVersion) {
+ String sparkHome = getSparkHome();
+ File libdir;
+ if (new File(sparkHome, "RELEASE").isFile()) {
+ libdir = new File(sparkHome, "lib");
+ checkState(libdir.isDirectory(), "Library directory '%s' does not
exist.",
+ libdir.getAbsolutePath());
+ } else {
+ libdir = new File(sparkHome,
String.format("assembly/target/scala-%s", scalaVersion));
+ }
+
+ final Pattern re = Pattern.compile("spark-assembly.*hadoop.*\\.jar");
+ FileFilter filter = new FileFilter() {
+ @Override
+ public boolean accept(File file) {
+ return file.isFile() && re.matcher(file.getName()).matches();
+ }
+ };
+ File[] assemblies = libdir.listFiles(filter);
+ checkState(assemblies != null && assemblies.length > 0, "No assemblies
found in '%s'.", libdir);
+ checkState(assemblies.length == 1, "Multiple assemblies found in
'%s'.", libdir);
+ return assemblies[0].getAbsolutePath();
+ }
+
+ private String getenv(String key) {
+ return firstNonEmpty(launcherEnv.get(key), System.getenv(key));
+ }
+
+ private String getConfDir() {
+ String confDir = getenv("SPARK_CONF_DIR");
+ return confDir != null ? confDir : join(File.separator,
getSparkHome(), "conf");
+ }
+
+ /**
+ * Prepare the command for execution from a bash script. The final
command will have commands to
+ * set up any needed environment variables needed by the child process.
+ */
+ private List<String> prepareForBash(List<String> cmd, Map<String,
String> childEnv) {
--- End diff --
This method along with `prepareForWindows` and `quoteForBatchScript` all
seem independent of the state inside of a given instance. Can they be made
static?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
