com.facebook.buck.cxx.toolchain.linker.impl

Class DarwinLinker

java.lang.Object

com.facebook.buck.core.toolchain.tool.DelegatingTool

com.facebook.buck.cxx.toolchain.linker.impl.DarwinLinker

All Implemented Interfaces:

AddsToRuleKey, Tool, HasIncrementalThinLTO, HasLinkerMap, HasLTO, Linker

public class DarwinLinker
extends DelegatingTool
implements Linker, HasLinkerMap, HasIncrementalThinLTO, HasLTO

A specialization of Linker containing information specific to the Darwin implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface com.facebook.buck.cxx.toolchain.linker.Linker

Linker.CxxRuntimeType, Linker.ExtraOutputsDeriver, Linker.LinkableDepType, Linker.LinkType, Linker.SharedLibraryLoadingType

Constructor Summary

Constructors

Constructor and Description
DarwinLinker(Tool tool, boolean cacheLinks, boolean scrubConcurrently)

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableList<Arg>	createUndefinedSymbolsLinkerArgs(ProjectFilesystem projectFilesystem, BuildRuleParams baseParams, ActionGraphBuilder graphBuilder, BuildTarget target, com.google.common.collect.ImmutableList<? extends SourcePath> symbolFiles) Generate a necessary linker arguments to propagate undefined symbols to a link command.
Iterable<Arg>	fatLTO(Path output)
Iterable<Arg>	fileList(Path fileListPath) Specifies that the linker should link the files listed in file.
Optional<Linker.ExtraOutputsDeriver>	getExtraOutputsDeriver()
Iterable<String>	getIgnoreUndefinedSymbolsFlags()
Iterable<String>	getNoAsNeededSharedLibsFlags()
com.google.common.collect.ImmutableList<FileScrubber>	getScrubbers(com.google.common.collect.ImmutableMap<Path,Path> cellRootMap)
Iterable<Arg>	getSharedLibFlag()
Linker.SharedLibraryLoadingType	getSharedLibraryLoadingType()
boolean	getUseUnixPathSeparator()
Iterable<Arg>	incrementalThinLTOFlags(Path output)
String	libOrigin()
Iterable<Arg>	linkerMap(Path output)
Path	linkerMapPath(Path output)
Iterable<Arg>	linkWhole(Arg input, SourcePathResolverAdapter resolver)
Path	ltoPath(Path output)
String	origin()
Iterable<String>	outputArgs(String path)
String	preloadEnvVar()
String	searchPathEnvVar()
Iterable<String>	soname(String arg)
Iterable<Arg>	thinLTO(Path output)

Methods inherited from class com.facebook.buck.core.toolchain.tool.DelegatingTool

getCommandPrefix, getEnvironment

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.facebook.buck.cxx.toolchain.linker.Linker

fileList

Methods inherited from interface com.facebook.buck.core.toolchain.tool.Tool

getCommandPrefix, getEnvironment

Constructor Detail

DarwinLinker

public DarwinLinker(Tool tool,
                    boolean cacheLinks,
                    boolean scrubConcurrently)

Method Detail

getScrubbers

public com.google.common.collect.ImmutableList<FileScrubber> getScrubbers(com.google.common.collect.ImmutableMap<Path,Path> cellRootMap)

Specified by:

getScrubbers in interface Linker

Parameters:

cellRootMap - Replacement map for cell roots found in paths, to some suitably normalized form (such as a relative path from root cell).

linkWhole

public Iterable<Arg> linkWhole(Arg input,
                               SourcePathResolverAdapter resolver)

Specified by:

linkWhole in interface Linker

Returns:

the platform-specific way to specify that the library represented by the given argument should be linked whole.

linkerMap

public Iterable<Arg> linkerMap(Path output)

Specified by:

linkerMap in interface HasLinkerMap

Parameters:

output - the path of the output binary

Returns:

the platform-specific way to generate a link-map file.

linkerMapPath

public Path linkerMapPath(Path output)

Specified by:

linkerMapPath in interface HasLinkerMap

Parameters:

output - the path of the output binary

Returns:

the path of the output binary's link-map file generated by the linker.

thinLTO

public Iterable<Arg> thinLTO(Path output)

Specified by:

thinLTO in interface HasLTO

Parameters:

output - the path of the output binary

Returns:

the platform-specific way to set the path for thin lto object files.

incrementalThinLTOFlags

public Iterable<Arg> incrementalThinLTOFlags(Path output)

Specified by:

incrementalThinLTOFlags in interface HasIncrementalThinLTO

Parameters:

output - the path of the output index files

Returns:

the platform-specific way to generate intermediate build products for ThinLTO.

fatLTO

public Iterable<Arg> fatLTO(Path output)

Specified by:

fatLTO in interface HasLTO

Parameters:

output - the path of the output binary

Returns:

the platform-specific way to set the path for monolithic lto object files.

ltoPath

public Path ltoPath(Path output)

Specified by:

ltoPath in interface HasLTO

Parameters:

output - the path of the output binary

Returns:

the path of the lto object files generated by the linker.

soname

public Iterable<String> soname(String arg)

Specified by:

soname in interface Linker

Returns:

the platform-specific way to specify that linker should use the given soname when linking a shared library.

fileList

public Iterable<Arg> fileList(Path fileListPath)

Description copied from interface: Linker

Specifies that the linker should link the files listed in file. This is an alternative to listing the files on the command line. The file names are listed one per line separated only by newlines. Spaces and tabs are assumed to be part of the file name.

Specified by:

fileList in interface Linker

Parameters:

fileListPath - the path to file which contains contents for file list to link

Returns:

the platform-specific way to support the feature. Empty list if feature is not supported.

origin

public String origin()

Specified by:

origin in interface Linker

Returns:

the placeholder used by the dynamic loader for the directory containing the top-level executable.

libOrigin

public String libOrigin()

Specified by:

libOrigin in interface Linker

Returns:

the placeholder used by the dynamic loader for the directory containing the top-level library (useful for e.g. plugins).

searchPathEnvVar

public String searchPathEnvVar()

Specified by:

searchPathEnvVar in interface Linker

Returns:

the name of the environment variable for the shared library runtime search path.

preloadEnvVar

public String preloadEnvVar()

Specified by:

preloadEnvVar in interface Linker

Returns:

the name of the environment variable for the shared library preload search path.

createUndefinedSymbolsLinkerArgs

public com.google.common.collect.ImmutableList<Arg> createUndefinedSymbolsLinkerArgs(ProjectFilesystem projectFilesystem,
                                                                                     BuildRuleParams baseParams,
                                                                                     ActionGraphBuilder graphBuilder,
                                                                                     BuildTarget target,
                                                                                     com.google.common.collect.ImmutableList<? extends SourcePath> symbolFiles)

Description copied from interface: Linker

Generate a necessary linker arguments to propagate undefined symbols to a link command. May need to create a BuildRule, in which case, target will be used as its name.

Specified by:

createUndefinedSymbolsLinkerArgs in interface Linker

target - the name to give any BuildRule that needs to be created to facilitate generating the arguments,

symbolFiles - the symbols files, each listing undefined symbols, one per line, to add to the link.

Returns:

the list of linker arguments needed to propagate the list of undefined symbols to the link command.

getNoAsNeededSharedLibsFlags

public Iterable<String> getNoAsNeededSharedLibsFlags()

Specified by:

getNoAsNeededSharedLibsFlags in interface Linker

Returns:

arguments to pass to the linker to disable dropping runtime references to shared libs which do not resolve symbols as link-time.

getIgnoreUndefinedSymbolsFlags

public Iterable<String> getIgnoreUndefinedSymbolsFlags()

Specified by:

getIgnoreUndefinedSymbolsFlags in interface Linker

Returns:

arguments to pass to the linker so that it ignores undefined symbols when linking.

getSharedLibFlag

public Iterable<Arg> getSharedLibFlag()

Specified by:

getSharedLibFlag in interface Linker

outputArgs

public Iterable<String> outputArgs(String path)

Specified by:

outputArgs in interface Linker

getSharedLibraryLoadingType

public Linker.SharedLibraryLoadingType getSharedLibraryLoadingType()

Specified by:

getSharedLibraryLoadingType in interface Linker

getExtraOutputsDeriver

public Optional<Linker.ExtraOutputsDeriver> getExtraOutputsDeriver()

Specified by:

getExtraOutputsDeriver in interface Linker

getUseUnixPathSeparator

public boolean getUseUnixPathSeparator()

Specified by:

getUseUnixPathSeparator in interface Linker