com.facebook.buck.cxx.toolchain.nativelink

Class NativeLinkables

java.lang.Object

com.facebook.buck.cxx.toolchain.nativelink.NativeLinkables

public class NativeLinkables
extends Object

Utility functions for interacting with NativeLinkable objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NativeLinkables.SharedLibrariesBuilder Builds a map of shared library names to paths from NativeLinkables, throwing a useful error on duplicates.

Method Summary

Modifier and Type	Method and Description
static Linker.LinkableDepType	getLinkStyle(NativeLinkableGroup.Linkage preferredLinkage, Linker.LinkableDepType requestedLinkStyle) Determine the final Linker.LinkableDepType given a preferred and requested linkage.
static Linker.LinkableDepType	getLinkStyle(NativeLinkableGroup.Linkage preferredLinkage, Linker.LinkableDepType requestedLinkStyle, Optional<PicType> picTypeForSharedLinking) Determine the final Linker.LinkableDepType given a preferred and requested linkage.
static NativeLinkableInput	getNativeLinkableInput(Linker.LinkableDepType linkStyle, NativeLinkable nativeLinkable, ActionGraphBuilder graphBuilder, TargetConfiguration targetConfiguration) Get the NativeLinkableInput for a NativeLinkable.
static com.google.common.collect.ImmutableList<? extends NativeLinkable>	getNativeLinkables(ActionGraphBuilder graphBuilder, Iterable<? extends NativeLinkable> inputs, Linker.LinkableDepType linkStyle) Extract from the dependency graph all the libraries which must be considered for linking.
static com.google.common.collect.ImmutableList<? extends NativeLinkable>	getNativeLinkables(ActionGraphBuilder graphBuilder, Iterable<? extends NativeLinkable> inputs, Linker.LinkableDepType linkStyle, Optional<LinkableListFilter> filter) Extract from the dependency graph all the libraries which must be considered for linking.
static com.google.common.collect.ImmutableList<? extends NativeLinkable>	getNativeLinkables(ActionGraphBuilder graphBuilder, Iterable<? extends NativeLinkable> inputs, Linker.LinkableDepType linkStyle, java.util.function.Predicate<? super NativeLinkable> traverse) Extract from the dependency graph all the libraries which must be considered for linking.
static com.google.common.collect.ImmutableList<? extends NativeLinkable>	getNativeLinkables(ActionGraphBuilder graphBuilder, Iterable<? extends NativeLinkable> inputs, Linker.LinkableDepType linkStyle, java.util.function.Predicate<? super NativeLinkable> traverse, Optional<LinkableListFilter> filter) Extract from the dependency graph all the libraries which must be considered for linking.
static com.google.common.collect.ImmutableList<? extends NativeLinkable>	getTopoSortedNativeLinkables(Iterable<? extends NativeLinkable> roots, TopologicalSort.Traversable<NativeLinkable> depsFn)
static NativeLinkableInput	getTransitiveNativeLinkableInput(ActionGraphBuilder graphBuilder, TargetConfiguration targetConfiguration, Iterable<? extends NativeLinkable> roots, Linker.LinkableDepType depType) Collect up and merge all NativeLinkableInput objects from transitively traversing all unbroken dependency chains of NativeLinkable objects found via the passed in NativeLinkable roots.
static com.google.common.collect.ImmutableList<? extends NativeLinkable>	getTransitiveNativeLinkables(ActionGraphBuilder graphBuilder, Iterable<? extends NativeLinkable> roots) Collect up and merge all NativeLinkableInput objects from transitively traversing all unbroken dependency chains of NativeLinkable objects found via the passed in NativeLinkable roots.
static com.google.common.collect.ImmutableSortedMap<String,SourcePath>	getTransitiveSharedLibraries(ActionGraphBuilder graphBuilder, Iterable<? extends NativeLinkable> roots, boolean alwaysIncludeRoots) Collect all the shared libraries generated by NativeLinkables found by transitively traversing all unbroken dependency chains of NativeLinkable objects found via the passed in NativeLinkable roots.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getTopoSortedNativeLinkables

public static com.google.common.collect.ImmutableList<? extends NativeLinkable> getTopoSortedNativeLinkables(Iterable<? extends NativeLinkable> roots,
                                                                                                             TopologicalSort.Traversable<NativeLinkable> depsFn)

Returns:

the nodes found from traversing the given roots in topologically sorted order.

getNativeLinkables

public static com.google.common.collect.ImmutableList<? extends NativeLinkable> getNativeLinkables(ActionGraphBuilder graphBuilder,
                                                                                                   Iterable<? extends NativeLinkable> inputs,
                                                                                                   Linker.LinkableDepType linkStyle,
                                                                                                   java.util.function.Predicate<? super NativeLinkable> traverse,
                                                                                                   Optional<LinkableListFilter> filter)

Extract from the dependency graph all the libraries which must be considered for linking.

Traversal proceeds depending on whether each dependency is to be statically or dynamically linked.

Parameters:

linkStyle - how dependencies should be linked, if their preferred_linkage is NativeLinkable.Linkage.ANY.

getNativeLinkables

public static com.google.common.collect.ImmutableList<? extends NativeLinkable> getNativeLinkables(ActionGraphBuilder graphBuilder,
                                                                                                   Iterable<? extends NativeLinkable> inputs,
                                                                                                   Linker.LinkableDepType linkStyle,
                                                                                                   java.util.function.Predicate<? super NativeLinkable> traverse)

Extract from the dependency graph all the libraries which must be considered for linking.

getNativeLinkables

public static com.google.common.collect.ImmutableList<? extends NativeLinkable> getNativeLinkables(ActionGraphBuilder graphBuilder,
                                                                                                   Iterable<? extends NativeLinkable> inputs,
                                                                                                   Linker.LinkableDepType linkStyle)

Extract from the dependency graph all the libraries which must be considered for linking.

getNativeLinkables

public static com.google.common.collect.ImmutableList<? extends NativeLinkable> getNativeLinkables(ActionGraphBuilder graphBuilder,
                                                                                                   Iterable<? extends NativeLinkable> inputs,
                                                                                                   Linker.LinkableDepType linkStyle,
                                                                                                   Optional<LinkableListFilter> filter)

Extract from the dependency graph all the libraries which must be considered for linking.

getLinkStyle

public static Linker.LinkableDepType getLinkStyle(NativeLinkableGroup.Linkage preferredLinkage,
                                                  Linker.LinkableDepType requestedLinkStyle,
                                                  Optional<PicType> picTypeForSharedLinking)

Determine the final Linker.LinkableDepType given a preferred and requested linkage.

getLinkStyle

public static Linker.LinkableDepType getLinkStyle(NativeLinkableGroup.Linkage preferredLinkage,
                                                  Linker.LinkableDepType requestedLinkStyle)

Determine the final Linker.LinkableDepType given a preferred and requested linkage.

getNativeLinkableInput

public static NativeLinkableInput getNativeLinkableInput(Linker.LinkableDepType linkStyle,
                                                         NativeLinkable nativeLinkable,
                                                         ActionGraphBuilder graphBuilder,
                                                         TargetConfiguration targetConfiguration)

Get the NativeLinkableInput for a NativeLinkable.

getTransitiveNativeLinkableInput

public static NativeLinkableInput getTransitiveNativeLinkableInput(ActionGraphBuilder graphBuilder,
                                                                   TargetConfiguration targetConfiguration,
                                                                   Iterable<? extends NativeLinkable> roots,
                                                                   Linker.LinkableDepType depType)

Collect up and merge all NativeLinkableInput objects from transitively traversing all unbroken dependency chains of NativeLinkable objects found via the passed in NativeLinkable roots.

getTransitiveNativeLinkables

public static com.google.common.collect.ImmutableList<? extends NativeLinkable> getTransitiveNativeLinkables(ActionGraphBuilder graphBuilder,
                                                                                                             Iterable<? extends NativeLinkable> roots)

Collect up and merge all NativeLinkableInput objects from transitively traversing all unbroken dependency chains of NativeLinkable objects found via the passed in NativeLinkable roots.

getTransitiveSharedLibraries

public static com.google.common.collect.ImmutableSortedMap<String,SourcePath> getTransitiveSharedLibraries(ActionGraphBuilder graphBuilder,
                                                                                                           Iterable<? extends NativeLinkable> roots,
                                                                                                           boolean alwaysIncludeRoots)

Collect all the shared libraries generated by NativeLinkables found by transitively traversing all unbroken dependency chains of NativeLinkable objects found via the passed in NativeLinkable roots.

Parameters:

alwaysIncludeRoots - whether to include shared libraries from roots, even if they prefer static linkage.

Returns:

a mapping of library name to the library SourcePath.