1 // options.h -- handle command line options for gold -*- C++ -*-
3 // Copyright 2006, 2007, 2008 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.
24 // Holds everything we get from the command line.
25 // General_options (from Command_line::options())
26 // Options which are not position dependent.
27 // Input_argument (from Command_line::inputs())
28 // The list of input files, including -l options.
29 // Position_dependent_options (from Input_argument::options())
30 // Position dependent options which apply to this argument.
32 #ifndef GOLD_OPTIONS_H
33 #define GOLD_OPTIONS_H
46 class Input_file_group;
47 class Position_dependent_options;
52 class Command_line_options;
55 struct One_debug_option;
57 } // End namespace gold::options.
59 // A directory to search. For each directory we record whether it is
60 // in the sysroot. We need to know this so that, if a linker script
61 // is found within the sysroot, we will apply the sysroot to any files
62 // named by that script.
64 class Search_directory
67 // We need a default constructor because we put this in a
70 : name_(NULL), put_in_sysroot_(false), is_in_sysroot_(false)
73 // This is the usual constructor.
74 Search_directory(const char* name, bool put_in_sysroot)
75 : name_(name), put_in_sysroot_(put_in_sysroot), is_in_sysroot_(false)
76 { gold_assert(!this->name_.empty()); }
78 // This is called if we have a sysroot. The sysroot is prefixed to
79 // any entries for which put_in_sysroot_ is true. is_in_sysroot_ is
80 // set to true for any enries which are in the sysroot (this will
81 // naturally include any entries for which put_in_sysroot_ is true).
82 // SYSROOT is the sysroot, CANONICAL_SYSROOT is the result of
83 // passing SYSROOT to lrealpath.
85 add_sysroot(const char* sysroot, const char* canonical_sysroot);
87 // Get the directory name.
90 { return this->name_; }
92 // Return whether this directory is in the sysroot.
95 { return this->is_in_sysroot_; }
103 // The position independent options which apply to the whole link.
104 // There are a lot of them.
106 class General_options
109 General_options(Script_options*);
111 // -e: set entry address.
114 { return this->script_options_->entry(); }
116 // -E: export dynamic symbols.
118 export_dynamic() const
119 { return this->export_dynamic_; }
121 // -h: shared library name.
124 { return this->soname_; }
126 // -I: dynamic linker name.
128 dynamic_linker() const
129 { return this->dynamic_linker_; }
131 // -L: Library search path.
132 typedef std::vector<Search_directory> Dir_list;
136 { return this->search_path_; }
138 // -O: optimization level (0: don't try to optimize output size).
140 optimization_level() const
141 { return this->optimization_level_; }
143 // -o: Output file name.
145 output_file_name() const
146 { return this->output_file_name_; }
148 // -r: Whether we are doing a relocatable link.
150 is_relocatable() const
151 { return this->is_relocatable_; }
153 // -s: Strip all symbols.
156 { return this->strip_ == STRIP_ALL; }
158 // -S: Strip debugging information.
161 { return this->strip_ == STRIP_ALL || this->strip_ == STRIP_DEBUG; }
163 // --strip-debug-gdb: strip only debugging information that's not
164 // used by gdb (at least, for gdb versions <= 6.7).
166 strip_debug_gdb() const
167 { return this->strip_debug() || this->strip_ == STRIP_DEBUG_UNUSED_BY_GDB; }
169 // --allow-shlib-undefined: do not warn about unresolved symbols in
170 // --shared libraries.
172 allow_shlib_undefined() const
173 { return this->allow_shlib_undefined_; }
175 // -Bsymbolic: bind defined symbols locally.
178 { return this->symbolic_; }
180 // --compress-debug-sections: compress .debug_* sections in the
181 // output file using the given compression method. This is useful
182 // when the tools (such as gdb) support compressed sections.
184 compress_debug_sections() const
185 { return this->compress_debug_sections_ != NO_COMPRESSION; }
188 zlib_compress_debug_sections() const
189 { return this->compress_debug_sections_ == ZLIB_COMPRESSION; }
191 // --demangle: demangle C++ symbols in our log messages.
194 { return this->demangle_; }
196 // --detect-odr-violations: Whether to search for One Defn Rule violations.
198 detect_odr_violations() const
199 { return this->detect_odr_violations_; }
201 // --eh-frame-hdr: Whether to generate an exception frame header.
203 create_eh_frame_hdr() const
204 { return this->create_eh_frame_hdr_; }
206 // --rpath: The runtime search path.
209 { return this->rpath_; }
211 // --rpath-link: The link time search patch for shared libraries.
214 { return this->rpath_link_; }
216 // --shared: Whether generating a shared object.
219 { return this->is_shared_; }
221 // --static: Whether doing a static link.
224 { return this->is_static_; }
226 // --stats: Print resource usage statistics.
229 { return this->print_stats_; }
231 // --sysroot: The system root of a cross-linker.
234 { return this->sysroot_; }
236 // --version-script: The version script to apply if --shared is true.
237 const Version_script_info&
238 version_script() const
239 { return *this->script_options_->version_script_info(); }
241 // -Ttext: The address of the .text section
243 text_segment_address() const
244 { return this->text_segment_address_; }
246 // Whether -Ttext was used.
248 user_set_text_segment_address() const
249 { return this->text_segment_address_ != -1U; }
251 // --threads: Whether to use threads.
254 { return this->threads_; }
256 // --thread-count-initial: Threads to use in initial pass.
258 thread_count_initial() const
259 { return this->thread_count_initial_; }
261 // --thread-count-middle: Threads to use in middle pass.
263 thread_count_middle() const
264 { return this->thread_count_middle_; }
266 // --thread-count-final: Threads to use in final pass.
268 thread_count_final() const
269 { return this->thread_count_final_; }
271 // -z execstack, -z noexecstack
273 is_execstack_set() const
274 { return this->execstack_ != EXECSTACK_FROM_INPUT; }
277 is_stack_executable() const
278 { return this->execstack_ == EXECSTACK_YES; }
283 { return this->debug_; }
285 // Return the options which may be set from a linker script.
288 { return this->script_options_; }
290 const Script_options*
291 script_options() const
292 { return this->script_options_; }
295 // Don't copy this structure.
296 General_options(const General_options&);
297 General_options& operator=(const General_options&);
299 friend class Command_line;
300 friend class options::Command_line_options;
302 // Which symbols to strip.
305 // Don't strip any symbols.
307 // Strip all symbols.
309 // Strip debugging information.
311 // Strip debugging information that's not used by gdb (at least <= 6.7)
312 STRIP_DEBUG_UNUSED_BY_GDB
315 // Whether to mark the stack as executable.
318 // Not set on command line.
319 EXECSTACK_FROM_INPUT,
320 // Mark the stack as executable.
322 // Mark the stack as not executable.
326 // What compression method to use
327 enum CompressionMethod
334 set_entry(const char* arg)
335 { this->script_options_->set_entry(arg, strlen(arg)); }
339 { this->export_dynamic_ = true; }
342 set_soname(const char* arg)
343 { this->soname_ = arg; }
346 set_dynamic_linker(const char* arg)
347 { this->dynamic_linker_ = arg; }
350 add_to_search_path(const char* arg)
351 { this->search_path_.push_back(Search_directory(arg, false)); }
354 add_to_search_path_with_sysroot(const char* arg)
355 { this->search_path_.push_back(Search_directory(arg, true)); }
358 set_optimization_level(const char* arg)
361 this->optimization_level_ = strtol(arg, &endptr, 0);
362 if (*endptr != '\0' || this->optimization_level_ < 0)
363 gold_fatal(_("invalid optimization level: %s"), arg);
367 set_output_file_name(const char* arg)
368 { this->output_file_name_ = arg; }
372 { this->is_relocatable_ = true; }
376 { this->strip_ = STRIP_ALL; }
378 // Note: normalize_options() depends on the fact that this turns off
379 // STRIP_ALL if it were already set.
382 { this->strip_ = STRIP_DEBUG; }
385 set_strip_debug_gdb()
386 { this->strip_ = STRIP_DEBUG_UNUSED_BY_GDB; }
389 set_allow_shlib_undefined()
390 { this->allow_shlib_undefined_ = true; }
393 set_no_allow_shlib_undefined()
394 { this->allow_shlib_undefined_ = false; }
398 { this->symbolic_ = true; }
400 void set_compress_debug_sections(const char* arg)
402 if (strcmp(arg, "none") == 0)
403 this->compress_debug_sections_ = NO_COMPRESSION;
405 else if (strcmp(arg, "zlib") == 0)
406 this->compress_debug_sections_ = ZLIB_COMPRESSION;
409 gold_fatal(_("unsupported argument to --compress-debug-sections: %s"),
414 define_symbol(const char* arg);
418 { this->demangle_ = true; }
422 { this->demangle_ = false; }
425 set_detect_odr_violations()
426 { this->detect_odr_violations_ = true; }
429 set_create_eh_frame_hdr()
430 { this->create_eh_frame_hdr_ = true; }
433 add_to_rpath(const char* arg)
434 { this->rpath_.push_back(Search_directory(arg, false)); }
437 add_to_rpath_link(const char* arg)
438 { this->rpath_link_.push_back(Search_directory(arg, false)); }
442 { this->is_shared_ = true; }
446 { this->is_static_ = true; }
450 { this->print_stats_ = true; }
453 set_sysroot(const char* arg)
454 { this->sysroot_ = arg; }
457 set_text_segment_address(const char* arg)
460 this->text_segment_address_ = strtoull(arg, &endptr, 0);
462 || this->text_segment_address_ == -1U)
463 gold_fatal(_("invalid argument to -Ttext: %s"), arg);
467 parse_thread_count(const char* arg)
470 const int count = strtol(arg, &endptr, 0);
471 if (*endptr != '\0' || count < 0)
472 gold_fatal(_("invalid thread count: %s"), arg);
479 #ifndef ENABLE_THREADS
480 gold_fatal(_("--threads not supported"));
482 this->threads_ = true;
487 { this->threads_ = false; }
490 set_thread_count(const char* arg)
492 int count = this->parse_thread_count(arg);
493 this->thread_count_initial_ = count;
494 this->thread_count_middle_ = count;
495 this->thread_count_final_ = count;
499 set_thread_count_initial(const char* arg)
500 { this->thread_count_initial_ = this->parse_thread_count(arg); }
503 set_thread_count_middle(const char* arg)
504 { this->thread_count_middle_ = this->parse_thread_count(arg); }
507 set_thread_count_final(const char* arg)
508 { this->thread_count_final_ = this->parse_thread_count(arg); }
516 { this->execstack_ = EXECSTACK_YES; }
520 { this->execstack_ = EXECSTACK_NO; }
523 set_debug(unsigned int flags)
524 { this->debug_ = flags; }
526 // Handle the -z option.
528 handle_z_option(const char*);
530 // Handle the --debug option.
532 handle_debug_option(const char*);
534 // Apply any sysroot to the directory lists.
538 bool export_dynamic_;
540 const char* dynamic_linker_;
541 Dir_list search_path_;
542 int optimization_level_;
543 const char* output_file_name_;
544 bool is_relocatable_;
546 bool allow_shlib_undefined_;
548 CompressionMethod compress_debug_sections_;
550 bool detect_odr_violations_;
551 bool create_eh_frame_hdr_;
553 Dir_list rpath_link_;
557 std::string sysroot_;
558 uint64_t text_segment_address_;
560 int thread_count_initial_;
561 int thread_count_middle_;
562 int thread_count_final_;
563 Execstack execstack_;
565 // Some options can also be set from linker scripts. Those are
567 Script_options* script_options_;
570 // The current state of the position dependent options.
572 class Position_dependent_options
575 Position_dependent_options();
577 // -Bdynamic/-Bstatic: Whether we are searching for a static archive
578 // -rather than a shared object.
580 do_static_search() const
581 { return this->do_static_search_; }
583 // --as-needed: Whether to add a DT_NEEDED argument only if the
584 // dynamic object is used.
587 { return this->as_needed_; }
589 // --whole-archive: Whether to include the entire contents of an
592 include_whole_archive() const
593 { return this->include_whole_archive_; }
597 { this->do_static_search_ = true; }
601 { this->do_static_search_ = false; }
605 { this->as_needed_ = true; }
609 { this->as_needed_ = false; }
613 { this->include_whole_archive_ = true; }
616 clear_whole_archive()
617 { this->include_whole_archive_ = false; }
620 bool do_static_search_;
622 bool include_whole_archive_;
625 // A single file or library argument from the command line.
627 class Input_file_argument
630 // name: file name or library name
631 // is_lib: true if name is a library name: that is, emits the leading
632 // "lib" and trailing ".so"/".a" from the name
633 // extra_search_path: an extra directory to look for the file, prior
634 // to checking the normal library search path. If this is "",
635 // then no extra directory is added.
636 // options: The position dependent options at this point in the
637 // command line, such as --whole-archive.
638 Input_file_argument()
639 : name_(), is_lib_(false), extra_search_path_(""), options_()
642 Input_file_argument(const char* name, bool is_lib,
643 const char* extra_search_path,
644 const Position_dependent_options& options)
645 : name_(name), is_lib_(is_lib), extra_search_path_(extra_search_path),
651 { return this->name_.c_str(); }
653 const Position_dependent_options&
655 { return this->options_; }
659 { return this->is_lib_; }
662 extra_search_path() const
664 return (this->extra_search_path_.empty()
666 : this->extra_search_path_.c_str());
669 // Return whether this file may require a search using the -L
672 may_need_search() const
673 { return this->is_lib_ || !this->extra_search_path_.empty(); }
676 // We use std::string, not const char*, here for convenience when
677 // using script files, so that we do not have to preserve the string
681 std::string extra_search_path_;
682 Position_dependent_options options_;
685 // A file or library, or a group, from the command line.
690 // Create a file or library argument.
691 explicit Input_argument(Input_file_argument file)
692 : is_file_(true), file_(file), group_(NULL)
695 // Create a group argument.
696 explicit Input_argument(Input_file_group* group)
697 : is_file_(false), group_(group)
700 // Return whether this is a file.
703 { return this->is_file_; }
705 // Return whether this is a group.
708 { return !this->is_file_; }
710 // Return the information about the file.
711 const Input_file_argument&
714 gold_assert(this->is_file_);
718 // Return the information about the group.
719 const Input_file_group*
722 gold_assert(!this->is_file_);
729 gold_assert(!this->is_file_);
735 Input_file_argument file_;
736 Input_file_group* group_;
739 // A group from the command line. This is a set of arguments within
740 // --start-group ... --end-group.
742 class Input_file_group
745 typedef std::vector<Input_argument> Files;
746 typedef Files::const_iterator const_iterator;
752 // Add a file to the end of the group.
754 add_file(const Input_file_argument& arg)
755 { this->files_.push_back(Input_argument(arg)); }
757 // Iterators to iterate over the group contents.
761 { return this->files_.begin(); }
765 { return this->files_.end(); }
771 // A list of files from the command line or a script.
773 class Input_arguments
776 typedef std::vector<Input_argument> Input_argument_list;
777 typedef Input_argument_list::const_iterator const_iterator;
780 : input_argument_list_(), in_group_(false)
785 add_file(const Input_file_argument& arg);
787 // Start a group (the --start-group option).
791 // End a group (the --end-group option).
795 // Return whether we are currently in a group.
798 { return this->in_group_; }
800 // The number of entries in the list.
803 { return this->input_argument_list_.size(); }
805 // Iterators to iterate over the list of input files.
809 { return this->input_argument_list_.begin(); }
813 { return this->input_argument_list_.end(); }
815 // Return whether the list is empty.
818 { return this->input_argument_list_.empty(); }
821 Input_argument_list input_argument_list_;
825 // All the information read from the command line.
830 typedef Input_arguments::const_iterator const_iterator;
832 Command_line(Script_options*);
834 // Process the command line options. This will exit with an
835 // appropriate error message if an unrecognized option is seen.
837 process(int argc, char** argv);
839 // Process one command-line option. This takes the index of argv to
840 // process, and returns the index for the next option.
842 process_one_option(int argc, char** argv, int i, bool* no_more_options);
844 // Handle a -l option.
846 process_l_option(int, char**, char*, bool);
848 // Handle a --start-group option.
850 start_group(const char* arg);
852 // Handle a --end-group option.
854 end_group(const char* arg);
856 // Get an option argument--a helper function for special processing.
858 get_special_argument(const char* longname, int argc, char** argv,
859 const char* arg, bool long_option,
862 // Get the general options.
863 const General_options&
865 { return this->options_; }
867 // Get the position dependent options.
868 const Position_dependent_options&
869 position_dependent_options() const
870 { return this->position_options_; }
872 // Get the options which may be set from a linker script.
875 { return this->options_.script_options(); }
877 const Script_options*
878 script_options() const
879 { return this->options_.script_options(); }
881 // The number of input files.
883 number_of_input_files() const
884 { return this->inputs_.size(); }
886 // Iterators to iterate over the list of input files.
890 { return this->inputs_.begin(); }
894 { return this->inputs_.end(); }
897 Command_line(const Command_line&);
898 Command_line& operator=(const Command_line&);
900 // Report usage error.
902 usage() ATTRIBUTE_NORETURN;
904 usage(const char* msg, const char* opt) ATTRIBUTE_NORETURN;
906 usage(const char* msg, char opt) ATTRIBUTE_NORETURN;
908 // Apply a command line option.
910 apply_option(const gold::options::One_option&, const char*);
914 add_file(const char* name, bool is_lib);
916 // Examine the result of processing the command-line, and verify
917 // the flags do not contradict each other or are otherwise illegal.
921 General_options options_;
922 Position_dependent_options position_options_;
923 Input_arguments inputs_;
926 } // End namespace gold.
928 #endif // !defined(GOLD_OPTIONS_H)