1 // options.c -- handle command line options for gold
3 // Copyright 2006, 2007 Free Software Foundation, Inc.
4 // Written by Ian Lance Taylor <iant@google.com>.
6 // This file is part of gold.
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 3 of the License, or
11 // (at your option) any later version.
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 // GNU General Public License for more details.
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the Free Software
20 // Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
21 // MA 02110-1301, USA.
27 #include "filenames.h"
28 #include "libiberty.h"
35 // The information we keep for a single command line option.
37 struct options::One_option
39 // The single character option name, or '\0' if this is only a long
43 // The long option name, or NULL if this is only a short option.
44 const char* long_option;
46 // Description of the option for --help output, or NULL if there is none.
49 // How to print the option name in --help output, or NULL to use the
51 const char* help_output;
53 // Long option dash control. This is ignored if long_option is
57 // Long option normally takes one dash; two dashes are also
60 // Long option normally takes two dashes; one dash is also
63 // Long option always takes two dashes.
67 // Function for special handling, or NULL. Returns the number of
68 // arguments to skip. This will normally be at least 1, but it may
69 // be 0 if this function changes *argv. ARG points to the location
70 // in *ARGV where the option starts, which may be helpful for a
72 int (*special)(int argc, char** argv, char *arg, Command_line*);
74 // If this is a position independent option which does not take an
75 // argument, this is the member function to call to record it.
76 void (General_options::*general_noarg)();
78 // If this is a position independent function which takes an
79 // argument, this is the member function to call to record it.
80 void (General_options::*general_arg)(const char*);
82 // If this is a position dependent option which does not take an
83 // argument, this is the member function to call to record it.
84 void (Position_dependent_options::*dependent_noarg)();
86 // If this is a position dependent option which takes an argument,
87 // this is the member function to record it.
88 void (Position_dependent_options::*dependent_arg)(const char*);
90 // Return whether this option takes an argument.
92 takes_argument() const
93 { return this->general_arg != NULL || this->dependent_arg != NULL; }
96 class options::Command_line_options
99 static const One_option options[];
100 static const int options_size;
103 } // End namespace gold.
108 // Handle the special -l option, which adds an input file.
111 library(int argc, char** argv, char* arg, gold::Command_line* cmdline)
113 return cmdline->process_l_option(argc, argv, arg);
116 // Handle the special --start-group option.
119 start_group(int, char**, char* arg, gold::Command_line* cmdline)
121 cmdline->start_group(arg);
125 // Handle the special --end-group option.
128 end_group(int, char**, char* arg, gold::Command_line* cmdline)
130 cmdline->end_group(arg);
134 // Report usage information for ld --help, and exit.
137 help(int, char**, char*, gold::Command_line*)
139 printf(_("Usage: %s [options] file...\nOptions:\n"), gold::program_name);
141 const int options_size = gold::options::Command_line_options::options_size;
142 const gold::options::One_option* options =
143 gold::options::Command_line_options::options;
144 for (int i = 0; i < options_size; ++i)
146 if (options[i].doc == NULL)
156 if (options[j].help_output != NULL)
163 printf(options[j].help_output);
164 len += std::strlen(options[i].help_output);
169 if (options[j].short_option != '\0')
176 printf("-%c", options[j].short_option);
181 if (options[j].long_option != NULL)
188 if (options[j].dash == gold::options::One_option::ONE_DASH)
198 printf("%s", options[j].long_option);
199 len += std::strlen(options[j].long_option);
205 while (j < options_size && options[j].doc == NULL);
212 for (; len < 30; ++len)
215 std::puts(options[i].doc);
223 // Report version information.
226 version(int, char**, char* opt, gold::Command_line*)
228 gold::print_version(opt[0] == 'v' && opt[1] == '\0');
233 // If the default sysroot is relocatable, try relocating it based on
237 get_relative_sysroot(const char* from)
239 char* path = make_relative_prefix(gold::program_name, from,
244 if (::stat(path, &s) == 0 && S_ISDIR(s.st_mode))
252 // Return the default sysroot. This is set by the --with-sysroot
253 // option to configure.
256 get_default_sysroot()
258 const char* sysroot = TARGET_SYSTEM_ROOT;
259 if (*sysroot == '\0')
262 if (TARGET_SYSTEM_ROOT_RELOCATABLE)
264 char* path = get_relative_sysroot (BINDIR);
266 path = get_relative_sysroot (TOOLBINDIR);
269 std::string ret = path;
278 } // End anonymous namespace.
283 // Helper macros used to specify the options. We could also do this
284 // using constructors, but then g++ would generate code to initialize
285 // the array. We want the array to be initialized statically so that
286 // we get better startup time.
288 #define GENERAL_NOARG(short_option, long_option, doc, help, dash, func) \
289 { short_option, long_option, doc, help, options::One_option::dash, \
290 NULL, func, NULL, NULL, NULL }
291 #define GENERAL_ARG(short_option, long_option, doc, help, dash, func) \
292 { short_option, long_option, doc, help, options::One_option::dash, \
293 NULL, NULL, func, NULL, NULL }
294 #define POSDEP_NOARG(short_option, long_option, doc, help, dash, func) \
295 { short_option, long_option, doc, help, options::One_option::dash, \
296 NULL, NULL, NULL, func, NULL }
297 #define POSDEP_ARG(short_option, long_option, doc, help, dash, func) \
298 { short_option, long_option, doc, help, options::One_option::dash, \
299 NULL, NULL, NULL, NULL, func }
300 #define SPECIAL(short_option, long_option, doc, help, dash, func) \
301 { short_option, long_option, doc, help, options::One_option::dash, \
302 func, NULL, NULL, NULL, NULL }
304 // Here is the actual list of options which we accept.
306 const options::One_option
307 options::Command_line_options::options[] =
309 POSDEP_NOARG('\0', "as-needed",
310 N_("Only set DT_NEEDED for dynamic libs if used"),
311 NULL, TWO_DASHES, &Position_dependent_options::set_as_needed),
312 POSDEP_NOARG('\0', "no-as-needed",
313 N_("Always DT_NEEDED for dynamic libs (default)"),
314 NULL, TWO_DASHES, &Position_dependent_options::clear_as_needed),
315 POSDEP_NOARG('\0', "Bdynamic",
316 N_("-l searches for shared libraries"),
318 &Position_dependent_options::set_dynamic_search),
319 POSDEP_NOARG('\0', "Bstatic",
320 N_("-l does not search for shared libraries"),
322 &Position_dependent_options::set_static_search),
323 GENERAL_NOARG('\0', "Bsymbolic", N_("Bind defined symbols locally"),
324 NULL, ONE_DASH, &General_options::set_symbolic),
325 GENERAL_NOARG('E', "export-dynamic", N_("Export all dynamic symbols"),
326 NULL, TWO_DASHES, &General_options::set_export_dynamic),
327 GENERAL_NOARG('\0', "eh-frame-hdr", N_("Create exception frame header"),
328 NULL, TWO_DASHES, &General_options::set_create_eh_frame_hdr),
329 GENERAL_ARG('I', "dynamic-linker", N_("Set dynamic linker path"),
330 N_("-I PROGRAM, --dynamic-linker PROGRAM"), TWO_DASHES,
331 &General_options::set_dynamic_linker),
332 SPECIAL('l', "library", N_("Search for library LIBNAME"),
333 N_("-lLIBNAME, --library LIBNAME"), TWO_DASHES,
335 GENERAL_ARG('L', "library-path", N_("Add directory to search path"),
336 N_("-L DIR, --library-path DIR"), TWO_DASHES,
337 &General_options::add_to_search_path),
338 GENERAL_ARG('m', NULL, N_("Ignored for compatibility"), NULL, ONE_DASH,
339 &General_options::ignore),
340 GENERAL_ARG('o', "output", N_("Set output file name"),
341 N_("-o FILE, --output FILE"), TWO_DASHES,
342 &General_options::set_output_file_name),
343 GENERAL_ARG('O', NULL, N_("Optimize output file size"),
344 N_("-O level"), ONE_DASH,
345 &General_options::set_optimization_level),
346 GENERAL_NOARG('r', NULL, N_("Generate relocatable output"), NULL,
347 ONE_DASH, &General_options::set_relocatable),
348 GENERAL_ARG('R', "rpath", N_("Add DIR to runtime search path"),
349 N_("-R DIR, -rpath DIR"), ONE_DASH,
350 &General_options::add_to_rpath),
351 GENERAL_ARG('\0', "rpath-link",
352 N_("Add DIR to link time shared library search path"),
353 N_("--rpath-link DIR"), TWO_DASHES,
354 &General_options::add_to_rpath_link),
355 GENERAL_NOARG('s', "strip-all", N_("Strip all symbols"), NULL,
356 TWO_DASHES, &General_options::set_strip_all),
357 GENERAL_NOARG('S', "strip-debug", N_("Strip debugging information"), NULL,
358 TWO_DASHES, &General_options::set_strip_debug),
359 GENERAL_NOARG('\0', "shared", N_("Generate shared library"),
360 NULL, ONE_DASH, &General_options::set_shared),
361 GENERAL_NOARG('\0', "static", N_("Do not link against shared libraries"),
362 NULL, ONE_DASH, &General_options::set_static),
363 GENERAL_NOARG('\0', "stats", N_("Print resource usage statistics"),
364 NULL, TWO_DASHES, &General_options::set_stats),
365 GENERAL_ARG('\0', "sysroot", N_("Set target system root directory"),
366 N_("--sysroot DIR"), TWO_DASHES, &General_options::set_sysroot),
367 GENERAL_ARG('\0', "Ttext", N_("Set the address of the .text section"),
368 N_("-Ttext ADDRESS"), ONE_DASH,
369 &General_options::set_text_segment_address),
370 GENERAL_NOARG('\0', "threads", N_("Run the linker multi-threaded"),
371 NULL, TWO_DASHES, &General_options::set_threads),
372 GENERAL_NOARG('\0', "no-threads", N_("Do not run the linker multi-threaded"),
373 NULL, TWO_DASHES, &General_options::clear_threads),
374 GENERAL_ARG('\0', "thread-count", N_("Number of threads to use"),
375 N_("--thread-count COUNT"), TWO_DASHES,
376 &General_options::set_thread_count),
377 GENERAL_ARG('\0', "thread-count-initial",
378 N_("Number of threads to use in initial pass"),
379 N_("--thread-count-initial COUNT"), TWO_DASHES,
380 &General_options::set_thread_count_initial),
381 GENERAL_ARG('\0', "thread-count-middle",
382 N_("Number of threads to use in middle pass"),
383 N_("--thread-count-middle COUNT"), TWO_DASHES,
384 &General_options::set_thread_count_middle),
385 GENERAL_ARG('\0', "thread-count-final",
386 N_("Number of threads to use in final pass"),
387 N_("--thread-count-final COUNT"), TWO_DASHES,
388 &General_options::set_thread_count_final),
389 POSDEP_NOARG('\0', "whole-archive",
390 N_("Include all archive contents"),
392 &Position_dependent_options::set_whole_archive),
393 POSDEP_NOARG('\0', "no-whole-archive",
394 N_("Include only needed archive contents"),
396 &Position_dependent_options::clear_whole_archive),
397 SPECIAL('(', "start-group", N_("Start a library search group"), NULL,
398 TWO_DASHES, &start_group),
399 SPECIAL(')', "end-group", N_("End a library search group"), NULL,
400 TWO_DASHES, &end_group),
401 SPECIAL('\0', "help", N_("Report usage information"), NULL,
403 SPECIAL('v', "version", N_("Report version information"), NULL,
404 TWO_DASHES, &version)
407 const int options::Command_line_options::options_size =
408 sizeof (options) / sizeof (options[0]);
410 // The default values for the general options.
412 General_options::General_options()
413 : export_dynamic_(false),
414 dynamic_linker_(NULL),
416 optimization_level_(0),
417 output_file_name_("a.out"),
418 is_relocatable_(false),
421 create_eh_frame_hdr_(false),
428 text_segment_address_(-1U), // -1 indicates value not set by user
430 thread_count_initial_(0),
431 thread_count_middle_(0),
432 thread_count_final_(0)
436 // The default values for the position dependent options.
438 Position_dependent_options::Position_dependent_options()
439 : do_static_search_(false),
441 include_whole_archive_(false)
445 // Add the sysroot, if any, to the search paths.
448 General_options::add_sysroot()
450 if (this->sysroot_.empty())
452 this->sysroot_ = get_default_sysroot();
453 if (this->sysroot_.empty())
457 const char* sysroot = this->sysroot_.c_str();
458 char* canonical_sysroot = lrealpath(sysroot);
460 for (Dir_list::iterator p = this->search_path_.begin();
461 p != this->search_path_.end();
463 p->add_sysroot(sysroot, canonical_sysroot);
465 free(canonical_sysroot);
468 // Search_directory methods.
470 // This is called if we have a sysroot. Apply the sysroot if
471 // appropriate. Record whether the directory is in the sysroot.
474 Search_directory::add_sysroot(const char* sysroot,
475 const char* canonical_sysroot)
477 gold_assert(*sysroot != '\0');
478 if (this->put_in_sysroot_)
480 if (!IS_DIR_SEPARATOR(this->name_[0])
481 && !IS_DIR_SEPARATOR(sysroot[strlen(sysroot) - 1]))
482 this->name_ = '/' + this->name_;
483 this->name_ = sysroot + this->name_;
484 this->is_in_sysroot_ = true;
488 // Check whether this entry is in the sysroot. To do this
489 // correctly, we need to use canonical names. Otherwise we will
490 // get confused by the ../../.. paths that gcc tends to use.
491 char* canonical_name = lrealpath(this->name_.c_str());
492 int canonical_name_len = strlen(canonical_name);
493 int canonical_sysroot_len = strlen(canonical_sysroot);
494 if (canonical_name_len > canonical_sysroot_len
495 && IS_DIR_SEPARATOR(canonical_name[canonical_sysroot_len]))
497 canonical_name[canonical_sysroot_len] = '\0';
498 if (FILENAME_CMP(canonical_name, canonical_sysroot) == 0)
499 this->is_in_sysroot_ = true;
501 free(canonical_name);
505 // Input_arguments methods.
507 // Add a file to the list.
510 Input_arguments::add_file(const Input_file_argument& file)
512 if (!this->in_group_)
513 this->input_argument_list_.push_back(Input_argument(file));
516 gold_assert(!this->input_argument_list_.empty());
517 gold_assert(this->input_argument_list_.back().is_group());
518 this->input_argument_list_.back().group()->add_file(file);
525 Input_arguments::start_group()
527 gold_assert(!this->in_group_);
528 Input_file_group* group = new Input_file_group();
529 this->input_argument_list_.push_back(Input_argument(group));
530 this->in_group_ = true;
536 Input_arguments::end_group()
538 gold_assert(this->in_group_);
539 this->in_group_ = false;
542 // Command_line options.
544 Command_line::Command_line()
545 : options_(), position_options_(), inputs_()
549 // Process the command line options.
552 Command_line::process(int argc, char** argv)
554 const int options_size = options::Command_line_options::options_size;
555 const options::One_option* options =
556 options::Command_line_options::options;
557 bool no_more_options = false;
561 if (argv[i][0] != '-' || no_more_options)
563 this->add_file(argv[i], false);
568 // Option starting with '-'.
570 if (argv[i][1] == '-')
573 if (argv[i][2] == '\0')
575 no_more_options = true;
580 // Look for a long option match.
581 char* opt = argv[i] + dashes;
584 char* arg = strchr(opt, '=');
585 bool argument_with_equals = arg != NULL;
591 else if (i + 1 < argc)
598 for (j = 0; j < options_size; ++j)
600 if (options[j].long_option != NULL
603 != options::One_option::EXACTLY_TWO_DASHES))
604 && first == options[j].long_option[0]
605 && strcmp(opt, options[j].long_option) == 0)
607 if (options[j].special)
608 i += options[j].special(argc - 1, argv + i, opt, this);
611 if (!options[j].takes_argument())
613 if (argument_with_equals)
614 this->usage(_("unexpected argument"), argv[i]);
621 this->usage(_("missing argument"), argv[i]);
623 this->apply_option(options[j], arg);
629 if (j < options_size)
632 // If we saw two dashes, we need to see a long option.
634 this->usage(_("unknown option"), argv[i]);
636 // Look for a short option match. There may be more than one
637 // short option in a given argument.
639 char* s = argv[i] + 1;
641 while (*s != '\0' && !done)
645 for (j = 0; j < options_size; ++j)
647 if (options[j].short_option == opt)
649 if (options[j].special)
651 // Undo the argument skip done above.
653 i += options[j].special(argc - i, argv + i, s, this);
659 if (options[j].takes_argument())
672 this->usage(_("missing argument"), opt);
674 this->apply_option(options[j], arg);
680 if (j >= options_size)
681 this->usage(_("unknown option"), *s);
687 if (this->inputs_.in_group())
689 fprintf(stderr, _("%s: missing group end"), program_name);
693 // FIXME: We should only do this when configured in native mode.
694 this->options_.add_to_search_path_with_sysroot("/lib");
695 this->options_.add_to_search_path_with_sysroot("/usr/lib");
697 this->options_.add_sysroot();
699 // Ensure options don't contradict each other and are otherwise kosher.
700 this->normalize_options();
703 // Ensure options don't contradict each other and are otherwise kosher.
706 Command_line::normalize_options()
708 // If the user specifies both -s and -r, convert the -s as -S.
709 // -r requires us to keep externally visible symbols!
710 if (this->options_.strip_all() && this->options_.is_relocatable())
712 // Clears the strip_all() status, replacing it with strip_debug().
713 this->options_.set_strip_debug();
716 // FIXME: we can/should be doing a lot more sanity checking here.
720 // Apply a command line option.
723 Command_line::apply_option(const options::One_option& opt,
728 if (opt.general_noarg)
729 (this->options_.*(opt.general_noarg))();
730 else if (opt.dependent_noarg)
731 (this->position_options_.*(opt.dependent_noarg))();
738 (this->options_.*(opt.general_arg))(arg);
739 else if (opt.dependent_arg)
740 (this->position_options_.*(opt.dependent_arg))(arg);
746 // Add an input file or library.
749 Command_line::add_file(const char* name, bool is_lib)
751 Input_file_argument file(name, is_lib, "", this->position_options_);
752 this->inputs_.add_file(file);
755 // Handle the -l option, which requires special treatment.
758 Command_line::process_l_option(int argc, char** argv, char* arg)
770 libname = argv[argc + 1];
773 this->usage(_("missing argument"), arg);
775 this->add_file(libname, true);
780 // Handle the --start-group option.
783 Command_line::start_group(const char* arg)
785 if (this->inputs_.in_group())
786 this->usage(_("may not nest groups"), arg);
787 this->inputs_.start_group();
790 // Handle the --end-group option.
793 Command_line::end_group(const char* arg)
795 if (!this->inputs_.in_group())
796 this->usage(_("group end without group start"), arg);
797 this->inputs_.end_group();
800 // Report a usage error. */
803 Command_line::usage()
806 _("%s: use the --help option for usage information\n"),
812 Command_line::usage(const char* msg, const char *opt)
816 program_name, opt, msg);
821 Command_line::usage(const char* msg, char opt)
825 program_name, opt, msg);
829 } // End namespace gold.