Java Launcher: Create classpath jar with a random name
When the classpath is too long, the launcher creates a jar file to pass
the classpath value. This change makes the jar file's name random.
It fixed the bug that when running multiple instances of the same java binary,
they all try to create the same classpath jar file. For example, when
running java_test with shard_count > 1.
Also, we delete the classpath jar file after the program finishes, so
that we don't leave any garbages behind.
Change-Id: I67926b3ef76dcb1806797e977ecaa7c6763c5cf2
PiperOrigin-RevId: 169087032
diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/java/java_stub_template.txt b/src/main/java/com/google/devtools/build/lib/bazel/rules/java/java_stub_template.txt
index d5495c0..856615e 100644
--- a/src/main/java/com/google/devtools/build/lib/bazel/rules/java/java_stub_template.txt
+++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/java/java_stub_template.txt
@@ -216,6 +216,12 @@
}
fi
+if is_macos || [[ ${OSTYPE} == "freebsd" ]]; then
+ function md5func() { md5 -q $@ ; }
+else
+ function md5func() { md5sum $@ | awk '{print $1}' ; }
+fi
+
# Set JAVABIN to the path to the JVM launcher.
%javabin%
@@ -291,8 +297,9 @@
done
unset IFS
+ RAND_ID=$(cat /dev/urandom | head -c 128 | md5func)
# Create manifest file
- MANIFEST_FILE="${self}.jar_manifest"
+ MANIFEST_FILE="${self}-${RAND_ID}.jar_manifest"
echo "Manifest-Version: 1.0" >$MANIFEST_FILE
CLASSPATH_LINE="Class-Path:$MANIFEST_CLASSPATH"
@@ -308,14 +315,21 @@
echo "Created-By: Bazel" >>$MANIFEST_FILE
# Create classpath JAR file
- MANIFEST_JAR_FILE="${self}-classpath.jar"
- is_windows && MANIFEST_JAR_FILE="$(cygpath --windows "$MANIFEST_JAR_FILE")"
+ MANIFEST_JAR_FILE="${self}-${RAND_ID}-classpath.jar"
+ if is_windows; then
+ MANIFEST_JAR_FILE="$(cygpath --windows "$MANIFEST_JAR_FILE")"
+ MANIFEST_FILE="$(cygpath --windows "$MANIFEST_FILE")"
+ fi
JARBIN="${JARBIN:-$(rlocation "$1")}"
$JARBIN cvfm "$MANIFEST_JAR_FILE" "$MANIFEST_FILE" >/dev/null || \
die "ERROR: $self failed because $JARBIN failed"
# Execute JAVA command
$JAVABIN -classpath "$MANIFEST_JAR_FILE" "${ARGS[@]}"
+ exit_code=$?
+ rm -f "$MANIFEST_FILE"
+ rm -f "$MANIFEST_JAR_FILE"
+ exit $exit_code
}
# If the user didn't specify a --classpath_limit, use the default value.
diff --git a/src/test/py/bazel/launcher_test.py b/src/test/py/bazel/launcher_test.py
index 7f81864..6c93abe 100644
--- a/src/test/py/bazel/launcher_test.py
+++ b/src/test/py/bazel/launcher_test.py
@@ -496,9 +496,7 @@
self.AssertExitCode(exit_code, 0, stderr)
self.assertIn('-classpath', stdout)
classpath = stdout[stdout.index('-classpath') + 1]
- self.assertIn('foo-classpath.jar', classpath)
- classpath_jar = os.path.join(bazel_bin, 'foo', 'foo-classpath.jar')
- self.assertTrue(os.path.exists(classpath_jar))
+ self.assertRegexpMatches(classpath, r'foo-[A-Za-z0-9]+-classpath.jar$')
def AssertRunfilesManifestContains(self, manifest, entry):
with open(manifest, 'r') as f:
diff --git a/src/test/shell/bazel/java_launcher_test.sh b/src/test/shell/bazel/java_launcher_test.sh
index 87afe7a..81ef4b7 100755
--- a/src/test/shell/bazel/java_launcher_test.sh
+++ b/src/test/shell/bazel/java_launcher_test.sh
@@ -62,14 +62,10 @@
${PRODUCT_NAME}-bin/$pkg/java/hello/hello >& "$TEST_log" || \
fail "expected success"
expect_log "Hello World!"
- [ -e "${PRODUCT_NAME}-bin/$pkg/java/hello/hello-classpath.jar" ] && \
- fail "did not expect to create classpath jar"
${PRODUCT_NAME}-bin/$pkg/java/hello/hello --classpath_limit=0 >& "$TEST_log" || \
fail "expected success"
expect_log "Hello World!"
- [ -e "${PRODUCT_NAME}-bin/$pkg/java/hello/hello-classpath.jar" ] || \
- fail "expected to create classpath jar"
}
run_suite "Java launcher tests"
diff --git a/src/tools/launcher/java_launcher.cc b/src/tools/launcher/java_launcher.cc
index 24fca58..e13d268 100644
--- a/src/tools/launcher/java_launcher.cc
+++ b/src/tools/launcher/java_launcher.cc
@@ -135,7 +135,8 @@
string binary_base_path =
GetBinaryPathWithoutExtension(this->GetCommandlineArguments()[0]);
- string jar_manifest_file_path = binary_base_path + ".jar_manifest";
+ string rand_id = "-" + GetRandomStr(10);
+ string jar_manifest_file_path = binary_base_path + rand_id + ".jar_manifest";
ofstream jar_manifest_file(jar_manifest_file_path);
jar_manifest_file << "Manifest-Version: 1.0\n";
// No line in the MANIFEST.MF file may be longer than 72 bytes.
@@ -152,7 +153,7 @@
// Create the command for generating classpath jar.
// We pass the command to cmd.exe to use redirection for suppressing output.
- string manifest_jar_path = binary_base_path + "-classpath.jar";
+ string manifest_jar_path = binary_base_path + rand_id + "-classpath.jar";
string jar_bin = this->Rlocation(this->GetLaunchInfoByKey(JAR_BIN_PATH));
vector<string> arguments;
arguments.push_back("/c");
@@ -168,6 +169,9 @@
die("Couldn't create classpath jar: %s", manifest_jar_path.c_str());
}
+ // Delete jar_manifest_file after classpath jar is created.
+ DeleteFileByPath(jar_manifest_file_path.c_str());
+
return manifest_jar_path;
}
@@ -261,8 +265,10 @@
// Check if CLASSPATH is over classpath length limit.
// If it does, then we create a classpath jar to pass CLASSPATH value.
string classpath_str = classpath.str();
+ string classpath_jar = "";
if (classpath_str.length() > this->classpath_limit) {
- arguments.push_back(CreateClasspathJar(classpath_str));
+ classpath_jar = CreateClasspathJar(classpath_str);
+ arguments.push_back(classpath_jar);
} else {
arguments.push_back(classpath_str);
}
@@ -290,7 +296,14 @@
arguments.push_back(arg);
}
- return this->LaunchProcess(java_bin, arguments);
+ ExitCode exit_code = this->LaunchProcess(java_bin, arguments);
+
+ // Delete classpath jar file after execution.
+ if (!classpath_jar.empty()) {
+ DeleteFileByPath(classpath_jar.c_str());
+ }
+
+ return exit_code;
}
} // namespace launcher
diff --git a/src/tools/launcher/util/launcher_util.cc b/src/tools/launcher/util/launcher_util.cc
index 149c5f3..c1ae804 100644
--- a/src/tools/launcher/util/launcher_util.cc
+++ b/src/tools/launcher/util/launcher_util.cc
@@ -12,6 +12,8 @@
// See the License for the specific language governing permissions and
// limitations under the License.
+// For rand_s function, https://msdn.microsoft.com/en-us/library/sxtz2fa8.aspx
+#define _CRT_RAND_S
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
@@ -91,6 +93,10 @@
(dwAttrib & FILE_ATTRIBUTE_DIRECTORY));
}
+bool DeleteFileByPath(const char* path) {
+ return DeleteFileW(AsAbsoluteWindowsPath(path).c_str());
+}
+
string GetBinaryPathWithoutExtension(const string& binary) {
if (binary.find(".exe", binary.size() - 4) != string::npos) {
return binary.substr(0, binary.length() - 4);
@@ -152,5 +158,17 @@
return SetEnvironmentVariableA(env_name.c_str(), value.c_str());
}
+string GetRandomStr(size_t len) {
+ static const char alphabet[] =
+ "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
+ ostringstream rand_str;
+ unsigned int x;
+ for (size_t i = 0; i < len; i++) {
+ rand_s(&x);
+ rand_str << alphabet[x % strlen(alphabet)];
+ }
+ return rand_str.str();
+}
+
} // namespace launcher
} // namespace bazel
diff --git a/src/tools/launcher/util/launcher_util.h b/src/tools/launcher/util/launcher_util.h
index 6ae5782..807c761 100644
--- a/src/tools/launcher/util/launcher_util.h
+++ b/src/tools/launcher/util/launcher_util.h
@@ -57,6 +57,9 @@
// Check if a directory exists at a given path.
bool DoesDirectoryPathExist(const char* path);
+// Delete a file at a given path.
+bool DeleteFileByPath(const char* path);
+
// Get the value of a specific environment variable
//
// Return true if succeeded and the result is stored in buffer.
@@ -68,6 +71,10 @@
// Return true if succeeded, otherwise false.
bool SetEnv(const std::string& env_name, const std::string& value);
+// Return a random string with a given length.
+// The string consists of a-zA-Z0-9
+std::string GetRandomStr(size_t len);
+
} // namespace launcher
} // namespace bazel
