// Copyright 2016 The Bazel Authors. All rights reserved. // // 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 com.google.devtools.build.lib.analysis; import com.google.common.base.Preconditions; import com.google.common.base.Strings; import com.google.common.hash.HashCode; import com.google.common.hash.Hashing; import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable; import com.google.devtools.build.lib.skyframe.serialization.PathCodec; import com.google.devtools.build.lib.skyframe.serialization.SerializationException; import com.google.devtools.build.lib.vfs.Path; import com.google.protobuf.CodedInputStream; import com.google.protobuf.CodedOutputStream; import java.io.IOException; import java.util.Objects; import javax.annotation.Nullable; /** * Represents the server install directory, which contains the Bazel installation and embedded * binaries. * *
The installBase
is the directory where the Blaze binary has been installed. The
* outputBase
is the directory below which Blaze puts all its state.
*/
@Immutable
public final class ServerDirectories {
/** Where Blaze gets unpacked. */
private final Path installBase;
/** The content hash of everything in installBase. */
@Nullable private final HashCode installMD5;
/** The root of the temp and output trees. */
private final Path outputBase;
public ServerDirectories(Path installBase, Path outputBase, @Nullable String installMD5) {
this(
installBase,
outputBase,
Strings.isNullOrEmpty(installMD5) ? null : checkMD5(HashCode.fromString(installMD5)));
}
private ServerDirectories(Path installBase, Path outputBase, HashCode installMD5) {
this.installBase = installBase;
this.outputBase = outputBase;
this.installMD5 = installMD5;
}
public ServerDirectories(Path installBase, Path outputBase) {
this(installBase, outputBase, (HashCode) null);
}
private static HashCode checkMD5(HashCode hash) {
Preconditions.checkArgument(hash.bits() == Hashing.md5().bits(),
"Hash '%s' has %s bits", hash, hash.bits());
return hash;
}
/**
* Returns the installation base directory. Currently used by info command only.
*/
public Path getInstallBase() {
return installBase;
}
/**
* Returns the base of the output tree, which hosts all build and scratch
* output for a user and workspace.
*/
public Path getOutputBase() {
return outputBase;
}
/**
* Returns the installed embedded binaries directory, under the shared
* installBase location.
*/
public Path getEmbeddedBinariesRoot() {
return installBase.getChild("_embedded_binaries");
}
/**
* Returns the MD5 content hash of the blaze binary (includes deploy JAR, embedded binaries, and
* anything else that ends up in the install_base).
*/
public HashCode getInstallMD5() {
return installMD5;
}
@Override
public int hashCode() {
return Objects.hash(installBase, installMD5, outputBase);
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (!(obj instanceof ServerDirectories)) {
return false;
}
ServerDirectories that = (ServerDirectories) obj;
return this.installBase.equals(that.installBase)
&& Objects.equals(this.installMD5, that.installMD5)
&& this.outputBase.equals(that.outputBase);
}
void serialize(CodedOutputStream out, PathCodec pathCodec)
throws IOException, SerializationException {
pathCodec.serialize(installBase, out);
out.writeBoolNoTag(installMD5 != null);
if (installMD5 != null) {
out.writeByteArrayNoTag(installMD5.asBytes());
}
pathCodec.serialize(outputBase, out);
}
static ServerDirectories deserialize(CodedInputStream in, PathCodec pathCodec)
throws IOException, SerializationException {
Path installBase = pathCodec.deserialize(in);
HashCode installMd5 = null;
if (in.readBool()) {
installMd5 = HashCode.fromBytes(in.readByteArray());
}
Path outputBase = pathCodec.deserialize(in);
return new ServerDirectories(installBase, outputBase, installMd5);
}
}