com.facebook.buck.cxx.toolchain.linker

Interface Linker

All Superinterfaces:

AddsToRuleKey, Tool

All Known Implementing Classes:

DarwinLinker, GnuLinker, WindowsLinker

public interface Linker
extends Tool

An object wrapping a linker, providing its source path and an interface to decorate arguments with specific flags.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Linker.CxxRuntimeType The various styles of runtime library to which we can link shared objects.
static interface	Linker.ExtraOutputsDeriver Derives extra outputs from linker args
static class	Linker.LinkableDepType The various ways to link in dependencies.
static class	Linker.LinkType The various ways to link an output file.
static class	Linker.SharedLibraryLoadingType The various ways to load shared libraries on different platforms

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.
default Iterable<Arg>	fileList(AbsPath fileListPath) Abs-path version of fileList(Path).
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()
String	libOrigin()
Iterable<Arg>	linkWhole(Arg input, SourcePathResolverAdapter resolver)
String	origin()
Iterable<String>	outputArgs(String path)
String	preloadEnvVar()
String	searchPathEnvVar()
Iterable<String>	soname(String soname)

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

getCommandPrefix, getEnvironment

Method Detail

getScrubbers

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

Parameters:

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

linkWhole

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

Returns:

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

soname

Iterable<String> soname(String soname)

Returns:

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

fileList

Iterable<Arg> fileList(Path fileListPath)

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.

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.

fileList

default Iterable<Arg> fileList(AbsPath fileListPath)

Abs-path version of fileList(Path).

origin

String origin()

Returns:

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

libOrigin

String libOrigin()

Returns:

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

searchPathEnvVar

String searchPathEnvVar()

Returns:

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

preloadEnvVar

String preloadEnvVar()

Returns:

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

getNoAsNeededSharedLibsFlags

Iterable<String> getNoAsNeededSharedLibsFlags()

Returns:

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

getIgnoreUndefinedSymbolsFlags

Iterable<String> getIgnoreUndefinedSymbolsFlags()

Returns:

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

createUndefinedSymbolsLinkerArgs

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. May need to create a BuildRule, in which case, target will be used as its name.

Parameters:

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.

getSharedLibFlag

Iterable<Arg> getSharedLibFlag()

outputArgs

Iterable<String> outputArgs(String path)

getSharedLibraryLoadingType

Linker.SharedLibraryLoadingType getSharedLibraryLoadingType()

getExtraOutputsDeriver

Optional<Linker.ExtraOutputsDeriver> getExtraOutputsDeriver()

getUseUnixPathSeparator

boolean getUseUnixPathSeparator()