2 ##===- tools/llvm-config ---------------------------------------*- perl -*-===##
4 # The LLVM Compiler Infrastructure
6 # This file was developed by Eric Kidd and is distributed under
7 # the University of Illinois Open Source License. See LICENSE.TXT for details.
9 ##===----------------------------------------------------------------------===##
11 # Synopsis: Prints out compiler options needed to build against an installed
14 # Syntax: llvm-config OPTIONS... [COMPONENTS...]
16 ##===----------------------------------------------------------------------===##
22 #---- begin autoconf values ----
23 my $PACKAGE_NAME = q{@PACKAGE_NAME@};
24 my $VERSION = q{@PACKAGE_VERSION@};
25 my $PREFIX = q{@LLVM_PREFIX@};
26 my $LLVM_CONFIGTIME = q{@LLVM_CONFIGTIME@};
27 my $LLVM_SRC_ROOT = q{@abs_top_srcdir@};
28 my $LLVM_OBJ_ROOT = q{@abs_top_builddir@};
29 my $LLVM_ON_WIN32 = q{@LLVM_ON_WIN32@};
30 my $LLVM_ON_UNIX = q{@LLVM_ON_UNIX@};
31 my $LLVMGCCDIR = q{@LLVMGCCDIR@};
32 my $LLVMGCC = q{@LLVMGCC@};
33 my $LLVMGXX = q{@LLVMGXX@};
34 my $LLVMGCC_VERSION = q{@LLVMGCC_VERSION@};
35 my $LLVMGCC_MAJVERS = q{@LLVMGCC_MAJVERS@};
36 my $ENDIAN = q{@ENDIAN@};
37 my $SHLIBEXT = q{@SHLIBEXT@};
38 my $EXEEXT = q{@EXEEXT@};
40 my $ARCH = lc(q{@ARCH@});
41 my $TARGET_TRIPLE = q{@target@};
42 my $TARGETS_TO_BUILD = q{@TARGETS_TO_BUILD@};
43 my $TARGET_HAS_JIT = q{@TARGET_HAS_JIT@};
44 my @TARGETS_BUILT = map { lc($_) } qw{@TARGETS_TO_BUILD@};
45 #---- end autoconf values ----
47 #---- begin Makefile values ----
48 my $CXXFLAGS = q{@LLVM_CXXFLAGS@};
49 my $LDFLAGS = q{@LLVM_LDFLAGS@};
50 my $LLVM_BUILDMODE = q{@LLVM_BUILDMODE@};
51 #---- end Makefile values ----
53 # Figure out where llvm-config is being run from. Primarily, we care if it has
54 # been installed, or is running from the build directory, which changes the
55 # locations of some files.
57 # Convert the current executable name into its directory (e.g. ".").
58 my ($RUN_DIR) = ($0 =~ /^(.*)\/.*$/);
60 # Turn the directory into an absolute directory on the file system, also pop up
61 # from "bin" into the build or prefix dir.
62 my $ABS_RUN_DIR = `cd $RUN_DIR/..; pwd`;
65 # Compute the absolute object directory build, e.g. "foo/llvm/Debug".
66 my $ABS_OBJ_ROOT = `cd $LLVM_OBJ_ROOT/$LLVM_BUILDMODE; pwd`;
69 my $INCLUDEDIR = "$ABS_RUN_DIR/include";
70 my $LIBDIR = "$ABS_RUN_DIR/lib";
71 my $BINDIR = "$ABS_RUN_DIR/bin";
72 if ($ABS_RUN_DIR eq $ABS_OBJ_ROOT) {
73 # If we are running out of the build directory, the include dir is in the
75 $INCLUDEDIR = "$LLVM_SRC_ROOT/include";
77 # If installed, ignore the prefix the tree was configured with, use the
79 $PREFIX = $ABS_RUN_DIR;
83 sub fix_library_names (@);
84 sub fix_library_files (@);
85 sub expand_dependecies (@);
88 # Parse our command-line arguments.
93 my $want_libnames = 0;
94 my $want_libfiles = 0;
95 my $want_components = 0;
96 foreach my $arg (@ARGV) {
98 if ($arg eq "--version") {
99 $has_opt = 1; print "$VERSION\n";
100 } elsif ($arg eq "--use-current-dir-as-prefix") {
102 } elsif ($arg eq "--prefix") {
103 $has_opt = 1; print "$PREFIX\n";
104 } elsif ($arg eq "--bindir") {
105 $has_opt = 1; print "$BINDIR\n";
106 } elsif ($arg eq "--includedir") {
107 $has_opt = 1; print "$INCLUDEDIR\n";
108 } elsif ($arg eq "--libdir") {
109 $has_opt = 1; print "$LIBDIR\n";
110 } elsif ($arg eq "--cxxflags") {
111 $has_opt = 1; print "-I$INCLUDEDIR $CXXFLAGS\n";
112 } elsif ($arg eq "--ldflags") {
113 $has_opt = 1; print "-L$LIBDIR $LDFLAGS\n";
114 } elsif ($arg eq "--libs") {
115 $has_opt = 1; $want_libs = 1;
116 } elsif ($arg eq "--libnames") {
117 $has_opt = 1; $want_libnames = 1;
118 } elsif ($arg eq "--libfiles") {
119 $has_opt = 1; $want_libfiles = 1;
120 } elsif ($arg eq "--components") {
121 $has_opt = 1; print join(' ', name_map_entries), "\n";
122 } elsif ($arg eq "--targets-built") {
123 $has_opt = 1; print join(' ', @TARGETS_BUILT), "\n";
124 } elsif ($arg eq "--build-mode") {
125 $has_opt = 1; print "$LLVM_BUILDMODE\n";
126 } elsif ($arg eq "--obj-root") {
127 $has_opt = 1; print `cd $LLVM_OBJ_ROOT/; pwd` . "\n";
128 } elsif ($arg eq "--src-root") {
129 $has_opt = 1; print `cd $LLVM_SRC_ROOT/; pwd` . "\n";
134 push @components, $arg;
138 # If no options were specified, fail.
139 usage unless $has_opt;
141 # If no components were specified, default to 'all'.
142 if (@components == 0) {
143 push @components, 'all';
146 # Handle any arguments which require building our dependency graph.
147 if ($want_libs || $want_libnames || $want_libfiles) {
148 my @libs = expand_dependecies(@components);
149 print join(' ', fix_library_names(@libs)), "\n" if ($want_libs);
150 print join(' ', @libs), "\n" if ($want_libnames);
151 print join(' ', fix_library_files(@libs)), "\n" if ($want_libfiles);
156 #==========================================================================
158 #==========================================================================
161 print STDERR <<__EOD__;
162 Usage: llvm-config <OPTION>... [<COMPONENT>...]
164 Get various configuration information needed to compile programs which use
165 LLVM. Typically called from 'configure' scripts. Examples:
166 llvm-config --cxxflags
167 llvm-config --ldflags
168 llvm-config --libs engine bcreader scalaropts
171 --version Print LLVM version.
172 --prefix Print the installation prefix.
173 --src-root Print the source root LLVM was built from.
174 --obj-root Print the object root used to build LLVM.
175 --bindir Directory containing LLVM executables.
176 --includedir Directory containing LLVM headers.
177 --libdir Directory containing LLVM libraries.
178 --cxxflags C++ compiler flags for files that include LLVM headers.
179 --ldflags Print Linker flags.
180 --libs Libraries needed to link against LLVM components.
181 --libnames Bare library names for in-tree builds.
182 --libfiles Fully qualified library filenames for makefile depends.
183 --components List of all possible components.
184 --targets-built List of all targets currently built.
185 --build-mode Print build mode of LLVM tree (e.g. Debug or Release).
187 all All LLVM libraries (default).
188 backend Either a native backend or the C backend.
189 engine Either a native JIT or a bytecode interpreter.
194 # Use -lfoo instead of libfoo.a whenever possible, and add directories to
195 # files which can't be found using -L.
196 sub fix_library_names (@) {
199 foreach my $lib (@libs) {
200 # Transform the bare library name appropriately.
201 my ($basename) = ($lib =~ /^lib([^.]*)\.a/);
202 if (defined $basename) {
203 push @result, "-l$basename";
205 push @result, "$LIBDIR/$lib";
211 # Turn the list of libraries into a list of files.
212 sub fix_library_files(@) {
215 foreach my $lib (@libs) {
216 # Transform the bare library name into a filename.
217 push @result, "$LIBDIR/$lib";
222 #==========================================================================
223 # Library Dependency Analysis
224 #==========================================================================
225 # Given a few human-readable library names, find all their dependencies
226 # and sort them into an order which the linker will like. If we packed
227 # our libraries into fewer archives, we could make the linker do much
228 # of this work for us.
230 # Libraries have two different types of names in this code: Human-friendly
231 # "component" names entered on the command-line, and the raw file names
232 # we use internally (and ultimately pass to the linker).
234 # To understand this code, you'll need a working knowledge of Perl 5,
235 # and possibly some quality time with 'man perlref'.
237 sub load_dependencies;
239 sub have_native_backend;
240 sub find_best_engine;
241 sub expand_names (@);
242 sub find_all_required_sets (@);
243 sub find_all_required_sets_helper ($$@);
245 # Each "set" contains one or more libraries which must be included as a
246 # group (due to cyclic dependencies). Sets are represented as a Perl array
247 # reference pointing to a list of internal library names.
250 # Various mapping tables.
251 my %LIB_TO_SET_MAP; # Maps internal library names to their sets.
252 my %SET_DEPS; # Maps sets to a list of libraries they depend on.
253 my %NAME_MAP; # Maps human-entered names to internal names.
255 # Have our dependencies been loaded yet?
256 my $DEPENDENCIES_LOADED = 0;
258 # Given a list of human-friendly component names, translate them into a
259 # complete set of linker arguments.
260 sub expand_dependecies (@) {
263 my @required_sets = find_all_required_sets(expand_names(@libs));
264 my @sorted_sets = topologically_sort_sets(@required_sets);
266 # Expand the library sets into libraries.
268 foreach my $set (@sorted_sets) { push @result, @{$set}; }
272 # Load in the raw dependency data stored at the end of this file.
273 sub load_dependencies {
274 return if $DEPENDENCIES_LOADED;
275 $DEPENDENCIES_LOADED = 1;
278 my ($libs, $deps) = /^(^[^:]+): ?(.*)$/;
279 die "Malformed dependency data" unless defined $deps;
280 my @libs = split(' ', $libs);
281 my @deps = split(' ', $deps);
283 # Record our dependency data.
286 foreach my $lib (@libs) { $LIB_TO_SET_MAP{$lib} = $set; }
287 $SET_DEPS{$set} = \@deps;
292 # Build a map converting human-friendly component names into internal
295 # Add entries for all the actual libraries.
296 foreach my $set (@SETS) {
297 foreach my $lib (sort @$set) {
298 my $short_name = $lib;
299 $short_name =~ s/^(lib)?LLVM([^.]*)\..*$/$2/;
300 $short_name =~ tr/A-Z/a-z/;
301 $NAME_MAP{$short_name} = [$lib];
305 # Add virtual entries.
306 $NAME_MAP{'native'} = have_native_backend() ? [$ARCH] : [];
307 $NAME_MAP{'backend'} = have_native_backend() ? ['native'] : ['cbackend'];
308 $NAME_MAP{'engine'} = find_best_engine;
309 $NAME_MAP{'all'} = [name_map_entries]; # Must be last.
312 # Return true if we have a native backend to use.
313 sub have_native_backend {
315 foreach my $target (@TARGETS_BUILT) { $BUILT{$target} = 1; }
316 return defined $NAME_MAP{$ARCH} && defined $BUILT{$ARCH};
319 # Find a working subclass of ExecutionEngine for this platform.
320 sub find_best_engine {
321 if (have_native_backend && $TARGET_HAS_JIT) {
322 return ['jit', 'native'];
324 return ['interpreter'];
328 # Get all the human-friendly component names.
329 sub name_map_entries {
331 return sort keys %NAME_MAP;
334 # Map human-readable names to internal library names.
335 sub expand_names (@) {
338 foreach my $name (@names) {
339 if (defined $LIB_TO_SET_MAP{$name}) {
340 # We've hit bottom: An actual library name.
342 } elsif (defined $NAME_MAP{$name}) {
343 # We've found a short name to expand.
344 push @result, expand_names(@{$NAME_MAP{$name}});
346 print STDERR "llvm-config: unknown component name: $name\n";
353 # Given a list of internal library names, return all sets of libraries which
354 # will need to be included by the linker (in no particular order).
355 sub find_all_required_sets (@) {
359 find_all_required_sets_helper(\%sets_added, \@result, @libs);
363 # Recursive closures are pretty broken in Perl, so we're going to separate
364 # this function from find_all_required_sets and pass in the state we need
365 # manually, as references. Yes, this is fairly unpleasant.
366 sub find_all_required_sets_helper ($$@) {
367 my ($sets_added, $result, @libs) = @_;
368 foreach my $lib (@libs) {
369 my $set = $LIB_TO_SET_MAP{$lib};
370 next if defined $$sets_added{$set};
371 $$sets_added{$set} = 1;
373 find_all_required_sets_helper($sets_added, $result, @{$SET_DEPS{$set}});
377 # Print a list of sets, with a label. Used for debugging.
378 sub print_sets ($@) {
379 my ($label, @sets) = @_;
381 foreach my $set (@sets) { push @output, join(',', @$set); }
382 print "$label: ", join(';', @output), "\n";
385 # Returns true if $lib is a key in $added.
386 sub has_lib_been_added ($$) {
387 my ($added, $lib) = @_;
388 return defined $$added{$LIB_TO_SET_MAP{$lib}};
391 # Returns true if all the dependencies of $set appear in $added.
392 sub have_all_deps_been_added ($$) {
393 my ($added, $set) = @_;
394 #print_sets(" Checking", $set);
395 #print_sets(" Wants", $SET_DEPS{$set});
396 foreach my $lib (@{$SET_DEPS{$set}}) {
397 return 0 unless has_lib_been_added($added, $lib);
402 # Given a list of sets, topologically sort them using dependencies.
403 sub topologically_sort_sets (@) {
407 SCAN: while (@sets) { # We'll delete items from @sets as we go.
408 #print_sets("So far", reverse(@result));
409 #print_sets("Remaining", @sets);
410 for (my $i = 0; $i < @sets; ++$i) {
412 if (have_all_deps_been_added(\%added, $set)) {
415 #print "Removing $i.\n";
416 splice(@sets, $i, 1);
417 next SCAN; # Restart our scan.
420 die "Can't find a library with no dependencies";
422 return reverse(@result);
425 # Our library dependency data will be added after the '__END__' token, and will
426 # be read through the magic <DATA> filehandle.