path: root/src/main/java/com/google/devtools/build/lib/rules/nativedeps/NativeDepsHelper.java

// Copyright 2015 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.rules.nativedeps;

import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.Constants;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.actions.Root;
import com.google.devtools.build.lib.analysis.RuleContext;
import com.google.devtools.build.lib.analysis.actions.SymlinkAction;
import com.google.devtools.build.lib.analysis.config.BuildConfiguration;
import com.google.devtools.build.lib.collect.nestedset.NestedSet;
import com.google.devtools.build.lib.rules.cpp.CcLinkParams;
import com.google.devtools.build.lib.rules.cpp.CcToolchainProvider;
import com.google.devtools.build.lib.rules.cpp.CppBuildInfo;
import com.google.devtools.build.lib.rules.cpp.CppConfiguration;
import com.google.devtools.build.lib.rules.cpp.CppHelper;
import com.google.devtools.build.lib.rules.cpp.CppLinkAction;
import com.google.devtools.build.lib.rules.cpp.Link.LinkStaticness;
import com.google.devtools.build.lib.rules.cpp.Link.LinkTargetType;
import com.google.devtools.build.lib.rules.cpp.LinkerInputs;
import com.google.devtools.build.lib.rules.cpp.LinkerInputs.LibraryToLink;
import com.google.devtools.build.lib.util.Fingerprint;
import com.google.devtools.build.lib.vfs.PathFragment;

import java.util.ArrayList;
import java.util.Collection;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

/**
 * Helper class to create a dynamic library for rules which support integration with native code.
 *
 * <p>This library gets created by the build system by linking all C++ libraries in the transitive
 * closure of the dependencies into a standalone dynamic library, with some exceptions. It usually
 * does not include neverlink libraries or C++ binaries (or their transitive dependencies). Note
 * that some rules are implicitly neverlink.
 */
public abstract class NativeDepsHelper {
  /**
   * An implementation of {@link
   * com.google.devtools.build.lib.rules.cpp.CppLinkAction.LinkArtifactFactory} that can create
   * artifacts anywhere.
   *
   * <p>Necessary because the actions of nativedeps libraries should be shareable, and thus cannot
   * be under the package directory.
   */
  private static final CppLinkAction.LinkArtifactFactory SHAREABLE_LINK_ARTIFACT_FACTORY =
      new CppLinkAction.LinkArtifactFactory() {
        @Override
        public Artifact create(RuleContext ruleContext, PathFragment rootRelativePath) {
          return ruleContext.getShareableArtifact(rootRelativePath,
              ruleContext.getConfiguration().getBinDirectory());
        }
      };

  private NativeDepsHelper() {}

  /**
   * Creates an Action to create a dynamic library by linking all native code
   * (C/C++) libraries in the transitive dependency closure of a rule.
   *
   * <p>This is used for all native code in a rule's dependencies, regardless of type.
   *
   * <p>We link the native deps in the equivalent of linkstatic=1, linkshared=1
   * mode.
   *
   * <p>linkstatic=1 means mostly-static mode, i.e. we select the ".a" (or
   * ".pic.a") files, but we don't include "-static" in linkopts.
   *
   * <p>linkshared=1 means we prefer the ".pic.a" files to the ".a" files, and
   * the LinkTargetType is set to DYNAMIC_LIBRARY which causes Link.java to
   * include "-shared" in the linker options.
   *
   * @param ruleContext the rule context to determine the native library
   * @param linkParams the {@link CcLinkParams} for the rule, collected with
   *        linkstatic = 1 and linkshared = 1
   * @param extraLinkOpts additional parameters to the linker
   * @param includeMalloc whether or not to link in the rule's malloc dependency
   * @param configuration the {@link BuildConfiguration} to run the link action under
   * @return the native library runfiles. If the transitive deps closure of
   *         the rule contains no native code libraries, its fields are null.
   */
  public static NativeDepsRunfiles maybeCreateNativeDepsAction(final RuleContext ruleContext,
      CcLinkParams linkParams, Collection<String> extraLinkOpts, boolean includeMalloc,
      final BuildConfiguration configuration) {
    if (includeMalloc) {
      // Add in the custom malloc dependency if it was requested.
      CcLinkParams.Builder linkParamsBuilder = CcLinkParams.builder(true, true);
      linkParamsBuilder.addTransitiveArgs(linkParams);
      linkParamsBuilder.addTransitiveTarget(CppHelper.mallocForTarget(ruleContext));
      linkParams = linkParamsBuilder.build();
    }

    if (linkParams.getLibraries().isEmpty()) {
      return NativeDepsRunfiles.EMPTY;
    }

    PathFragment relativePath = new PathFragment(ruleContext.getLabel().getName());
    PathFragment nativeDepsPath = relativePath.replaceName(
        relativePath.getBaseName() + Constants.NATIVE_DEPS_LIB_SUFFIX + ".so");
    Artifact nativeDeps = ruleContext.getPackageRelativeArtifact(nativeDepsPath,
        configuration.getBinDirectory());

    return createNativeDepsAction(
        ruleContext,
        linkParams,
        extraLinkOpts,
        configuration,
        CppHelper.getToolchain(ruleContext),
        nativeDeps,
        ruleContext.getConfiguration().getBinDirectory(), /*useDynamicRuntime*/
        true);
  }

  private static final String ANDROID_UNIQUE_DIR = "nativedeps";

  /**
   * Creates an Action to create a dynamic library for Android by linking all native code (C/C++)
   * libraries in the transitive dependency closure of a rule.
   *
   * <p>We link the native deps in the equivalent of linkstatic=1, linkshared=1 mode.
   *
   * <p>linkstatic=1 means mostly-static mode, i.e. we select the ".a" (or ".pic.a") files, but we
   * don't include "-static" in linkopts.
   *
   * <p>linkshared=1 means we prefer the ".pic.a" files to the ".a" files, and the LinkTargetType is
   * set to DYNAMIC_LIBRARY which causes Link.java to include "-shared" in the linker options.
   *
   * @param ruleContext the rule context to determine the native deps library
   * @param linkParams the {@link CcLinkParams} for the rule, collected with linkstatic = 1 and
   *        linkshared = 1
   * @return the native deps library runfiles. If the transitive deps closure of the rule contains
   *         no native code libraries, its fields are null.
   */
  public static Artifact maybeCreateAndroidNativeDepsAction(final RuleContext ruleContext,
      CcLinkParams linkParams, final BuildConfiguration configuration,
      CcToolchainProvider toolchain) {
    if (linkParams.getLibraries().isEmpty()) {
      return null;
    }

    PathFragment labelName = new PathFragment(ruleContext.getLabel().getName());
    Artifact nativeDeps = ruleContext.getUniqueDirectoryArtifact(ANDROID_UNIQUE_DIR,
        labelName.replaceName("lib" + labelName.getBaseName() + ".so"),
        configuration.getBinDirectory());

    return createNativeDepsAction(
            ruleContext,
            linkParams, /** extraLinkOpts */
            ImmutableList.<String>of(),
            configuration,
            toolchain,
            nativeDeps,
            configuration.getBinDirectory(),
            /*useDynamicRuntime*/ false)
        .getLibrary();
  }

  private static NativeDepsRunfiles createNativeDepsAction(
      final RuleContext ruleContext,
      CcLinkParams linkParams,
      Collection<String> extraLinkOpts,
      BuildConfiguration configuration,
      CcToolchainProvider toolchain,
      Artifact nativeDeps,
      Root bindirIfShared,
      boolean useDynamicRuntime) {
    Preconditions.checkState(
        ruleContext.isLegalFragment(CppConfiguration.class),
        "%s does not have access to CppConfiguration",
        ruleContext.getRule().getRuleClass());
    List<String> linkopts = new ArrayList<>(extraLinkOpts);
    linkopts.addAll(linkParams.flattenedLinkopts());

    Map<Artifact, ImmutableList<Artifact>> linkstamps =
        CppHelper.resolveLinkstamps(ruleContext, linkParams);
    List<Artifact> buildInfoArtifacts = linkstamps.isEmpty()
        ? ImmutableList.<Artifact>of()
        : ruleContext.getBuildInfo(CppBuildInfo.KEY);

    boolean shareNativeDeps = configuration.getFragment(CppConfiguration.class).shareNativeDeps();
    NestedSet<LibraryToLink> linkerInputs = linkParams.getLibraries();
    Artifact sharedLibrary = shareNativeDeps
        ? ruleContext.getShareableArtifact(getSharedNativeDepsPath(
            LinkerInputs.toLibraryArtifacts(linkerInputs),
                linkopts, linkstamps.keySet(), buildInfoArtifacts,
                ruleContext.getFeatures()),
            ruleContext.getConfiguration().getBinDirectory())
        : nativeDeps;
    CppLinkAction.Builder builder = new CppLinkAction.Builder(
        ruleContext, sharedLibrary, configuration, toolchain);
    if (useDynamicRuntime) {
      builder.setRuntimeInputs(
          toolchain.getDynamicRuntimeLinkMiddleman(), toolchain.getDynamicRuntimeLinkInputs());
    } else {
      builder.setRuntimeInputs(
          toolchain.getStaticRuntimeLinkMiddleman(), toolchain.getStaticRuntimeLinkInputs());
    }
    CppLinkAction linkAction =
        builder
            .setLinkArtifactFactory(SHAREABLE_LINK_ARTIFACT_FACTORY)
            .setCrosstoolInputs(toolchain.getLink())
            .addLibraries(linkerInputs)
            .setLinkType(LinkTargetType.DYNAMIC_LIBRARY)
            .setLinkStaticness(LinkStaticness.MOSTLY_STATIC)
            .addLinkopts(linkopts)
            .setNativeDeps(true)
            .addLinkstamps(linkstamps)
            .build();

    ruleContext.registerAction(linkAction);
    Artifact linkerOutput = linkAction.getPrimaryOutput();

    if (shareNativeDeps) {
      // Collect dynamic-linker-resolvable symlinks for C++ runtime library dependencies.
      // Note we only need these symlinks when --share_native_deps is on, as shared native deps
      // mangle path names such that the library's conventional _solib RPATH entry
      // no longer resolves (because the target directory's relative depth gets lost).
      List<Artifact> runtimeSymlinks;
      if (useDynamicRuntime) {
        runtimeSymlinks = new LinkedList<>();
        for (final Artifact runtimeInput : toolchain.getDynamicRuntimeLinkInputs()) {
          final Artifact runtimeSymlink =
              ruleContext.getPackageRelativeArtifact(
                  getRuntimeLibraryPath(ruleContext, runtimeInput), bindirIfShared);
          // Since runtime library symlinks are underneath the target's output directory and
          // multiple targets may share the same output directory, we need to make sure this
          // symlink's generating action is only set once.
          ruleContext.registerAction(
              new SymlinkAction(ruleContext.getActionOwner(), runtimeInput, runtimeSymlink, null));
          runtimeSymlinks.add(runtimeSymlink);
        }
      } else {
        runtimeSymlinks = ImmutableList.of();
      }

      ruleContext.registerAction(
          new SymlinkAction(ruleContext.getActionOwner(), linkerOutput, nativeDeps, null));
      return new NativeDepsRunfiles(nativeDeps, runtimeSymlinks);
    }

    return new NativeDepsRunfiles(linkerOutput, ImmutableList.<Artifact>of());
  }

  /**
   * Returns the path, relative to the runfiles prefix, of a runtime library
   * symlink for the native library for the specified rule.
   */
  private static PathFragment getRuntimeLibraryPath(RuleContext ruleContext, Artifact lib) {
    PathFragment relativePath = new PathFragment(ruleContext.getLabel().getName());
    PathFragment libParentDir =
        relativePath.replaceName(lib.getExecPath().getParentDirectory().getBaseName());
    String libName = lib.getExecPath().getBaseName();
    return new PathFragment(libParentDir, new PathFragment(libName));
  }

  /**
   * Returns the path of the shared native library. The name must be
   * generated based on the rule-specific inputs to the link actions. At this
   * point this includes order-sensitive list of linker inputs and options
   * collected from the transitive closure and linkstamp-related artifacts that
   * are compiled during linking. All those inputs can be affected by modifying
   * target attributes (srcs/deps/stamp/etc). However, target build
   * configuration can be ignored since it will either change output directory
   * (in case of different configuration instances) or will not affect anything
   * (if two targets use same configuration). Final goal is for all native
   * libraries that use identical linker command to use same output name.
   *
   * <p>TODO(bazel-team): (2010) Currently process of identifying parameters that can
   * affect native library name is manual and should be kept in sync with the
   * code in the CppLinkAction.Builder/CppLinkAction/Link classes which are
   * responsible for generating linker command line. Ideally we should reuse
   * generated command line for both purposes - selecting a name of the
   * native library and using it as link action payload. For now, correctness
   * of the method below is only ensured by validations in the
   * CppLinkAction.Builder.build() method.
   */
  private static PathFragment getSharedNativeDepsPath(Iterable<Artifact> linkerInputs,
      Collection<String> linkopts, Iterable<Artifact> linkstamps,
      Iterable<Artifact> buildInfoArtifacts, Collection<String> features) {
    Fingerprint fp = new Fingerprint();
    for (Artifact input : linkerInputs) {
      fp.addString(input.getExecPathString());
    }
    fp.addStrings(linkopts);
    for (Artifact input : linkstamps) {
      fp.addString(input.getExecPathString());
    }
    for (Artifact input : buildInfoArtifacts) {
      fp.addString(input.getExecPathString());
    }
    for (String feature : features) {
      fp.addStrings(feature);
    }
    return new PathFragment(
        "_nativedeps/" + fp.hexDigestAndReset() + ".so");
  }
}