1 // options.h -- handle command line options for gold -*- C++ -*-
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.
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
111 // -E: export dynamic symbols.
113 export_dynamic() const
114 { return this->export_dynamic_; }
116 // -h: shared library name.
119 { return this->soname_; }
121 // -I: dynamic linker name.
123 dynamic_linker() const
124 { return this->dynamic_linker_; }
126 // -L: Library search path.
127 typedef std::vector<Search_directory> Dir_list;
131 { return this->search_path_; }
133 // -O: optimization level (0: don't try to optimize output size).
135 optimization_level() const
136 { return this->optimization_level_; }
138 // -o: Output file name.
140 output_file_name() const
141 { return this->output_file_name_; }
143 // -r: Whether we are doing a relocatable link.
145 is_relocatable() const
146 { return this->is_relocatable_; }
148 // -s: Strip all symbols.
151 { return this->strip_ == STRIP_ALL; }
153 // -S: Strip debugging information.
156 { return this->strip_ == STRIP_ALL || this->strip_ == STRIP_DEBUG; }
158 // --strip-debug-gdb: strip only debugging information that's not
159 // used by gdb (at least, for gdb versions <= 6.7).
161 strip_debug_gdb() const
162 { return this->strip_debug() || this->strip_ == STRIP_DEBUG_UNUSED_BY_GDB; }
164 // --allow-shlib-undefined: do not warn about unresolved symbols in
165 // --shared libraries.
167 allow_shlib_undefined() const
168 { return this->allow_shlib_undefined_; }
170 // -Bsymbolic: bind defined symbols locally.
173 { return this->symbolic_; }
175 // --compress-debug-sections: compress .debug_* sections in the
176 // output file using the given compression method. This is useful
177 // when the tools (such as gdb) support compressed sections.
179 compress_debug_sections() const
180 { return this->compress_debug_sections_ != NO_COMPRESSION; }
183 zlib_compress_debug_sections() const
184 { return this->compress_debug_sections_ == ZLIB_COMPRESSION; }
186 // --demangle: demangle C++ symbols in our log messages.
189 { return this->demangle_; }
191 // --detect-odr-violations: Whether to search for One Defn Rule violations.
193 detect_odr_violations() const
194 { return this->detect_odr_violations_; }
196 // --eh-frame-hdr: Whether to generate an exception frame header.
198 create_eh_frame_hdr() const
199 { return this->create_eh_frame_hdr_; }
201 // --rpath: The runtime search path.
204 { return this->rpath_; }
206 // --rpath-link: The link time search patch for shared libraries.
209 { return this->rpath_link_; }
211 // --shared: Whether generating a shared object.
214 { return this->is_shared_; }
216 // --static: Whether doing a static link.
219 { return this->is_static_; }
221 // --stats: Print resource usage statistics.
224 { return this->print_stats_; }
226 // --sysroot: The system root of a cross-linker.
229 { return this->sysroot_; }
231 // -Ttext: The address of the .text section
233 text_segment_address() const
234 { return this->text_segment_address_; }
236 // Whether -Ttext was used.
238 user_set_text_segment_address() const
239 { return this->text_segment_address_ != -1U; }
241 // --threads: Whether to use threads.
244 { return this->threads_; }
246 // --thread-count-initial: Threads to use in initial pass.
248 thread_count_initial() const
249 { return this->thread_count_initial_; }
251 // --thread-count-middle: Threads to use in middle pass.
253 thread_count_middle() const
254 { return this->thread_count_middle_; }
256 // --thread-count-final: Threads to use in final pass.
258 thread_count_final() const
259 { return this->thread_count_final_; }
261 // -z execstack, -z noexecstack
263 is_execstack_set() const
264 { return this->execstack_ != EXECSTACK_FROM_INPUT; }
267 is_stack_executable() const
268 { return this->execstack_ == EXECSTACK_YES; }
273 { return this->debug_; }
276 // Don't copy this structure.
277 General_options(const General_options&);
278 General_options& operator=(const General_options&);
280 friend class Command_line;
281 friend class options::Command_line_options;
283 // Which symbols to strip.
286 // Don't strip any symbols.
288 // Strip all symbols.
290 // Strip debugging information.
292 // Strip debugging information that's not used by gdb (at least <= 6.7)
293 STRIP_DEBUG_UNUSED_BY_GDB
296 // Whether to mark the stack as executable.
299 // Not set on command line.
300 EXECSTACK_FROM_INPUT,
301 // Mark the stack as executable.
303 // Mark the stack as not executable.
307 // What compression method to use
308 enum CompressionMethod
316 { this->export_dynamic_ = true; }
319 set_soname(const char* arg)
320 { this->soname_ = arg; }
323 set_dynamic_linker(const char* arg)
324 { this->dynamic_linker_ = arg; }
327 add_to_search_path(const char* arg)
328 { this->search_path_.push_back(Search_directory(arg, false)); }
331 add_to_search_path_with_sysroot(const char* arg)
332 { this->search_path_.push_back(Search_directory(arg, true)); }
335 set_optimization_level(const char* arg)
338 this->optimization_level_ = strtol(arg, &endptr, 0);
339 if (*endptr != '\0' || this->optimization_level_ < 0)
340 gold_fatal(_("invalid optimization level: %s"), arg);
344 set_output_file_name(const char* arg)
345 { this->output_file_name_ = arg; }
349 { this->is_relocatable_ = true; }
353 { this->strip_ = STRIP_ALL; }
355 // Note: normalize_options() depends on the fact that this turns off
356 // STRIP_ALL if it were already set.
359 { this->strip_ = STRIP_DEBUG; }
362 set_strip_debug_gdb()
363 { this->strip_ = STRIP_DEBUG_UNUSED_BY_GDB; }
366 set_allow_shlib_undefined()
367 { this->allow_shlib_undefined_ = true; }
370 set_no_allow_shlib_undefined()
371 { this->allow_shlib_undefined_ = false; }
375 { this->symbolic_ = true; }
377 void set_compress_debug_sections(const char* arg)
379 if (strcmp(arg, "none") == 0)
380 this->compress_debug_sections_ = NO_COMPRESSION;
382 else if (strcmp(arg, "zlib") == 0)
383 this->compress_debug_sections_ = ZLIB_COMPRESSION;
386 gold_fatal(_("unsupported argument to --compress-debug-sections: %s"),
392 { this->demangle_ = true; }
396 { this->demangle_ = false; }
399 set_detect_odr_violations()
400 { this->detect_odr_violations_ = true; }
403 set_create_eh_frame_hdr()
404 { this->create_eh_frame_hdr_ = true; }
407 add_to_rpath(const char* arg)
408 { this->rpath_.push_back(Search_directory(arg, false)); }
411 add_to_rpath_link(const char* arg)
412 { this->rpath_link_.push_back(Search_directory(arg, false)); }
416 { this->is_shared_ = true; }
420 { this->is_static_ = true; }
424 { this->print_stats_ = true; }
427 set_sysroot(const char* arg)
428 { this->sysroot_ = arg; }
431 set_text_segment_address(const char* arg)
434 this->text_segment_address_ = strtoull(arg, &endptr, 0);
436 || this->text_segment_address_ == -1U)
437 gold_fatal(_("invalid argument to -Ttext: %s"), arg);
441 parse_thread_count(const char* arg)
444 const int count = strtol(arg, &endptr, 0);
445 if (*endptr != '\0' || count < 0)
446 gold_fatal(_("invalid thread count: %s"), arg);
453 #ifndef ENABLE_THREADS
454 gold_fatal(_("--threads not supported"));
456 this->threads_ = true;
461 { this->threads_ = false; }
464 set_thread_count(const char* arg)
466 int count = this->parse_thread_count(arg);
467 this->thread_count_initial_ = count;
468 this->thread_count_middle_ = count;
469 this->thread_count_final_ = count;
473 set_thread_count_initial(const char* arg)
474 { this->thread_count_initial_ = this->parse_thread_count(arg); }
477 set_thread_count_middle(const char* arg)
478 { this->thread_count_middle_ = this->parse_thread_count(arg); }
481 set_thread_count_final(const char* arg)
482 { this->thread_count_final_ = this->parse_thread_count(arg); }
490 { this->execstack_ = EXECSTACK_YES; }
494 { this->execstack_ = EXECSTACK_NO; }
497 set_debug(unsigned int flags)
498 { this->debug_ = flags; }
500 // Handle the -z option.
502 handle_z_option(const char*);
504 // Handle the --debug option.
506 handle_debug_option(const char*);
508 // Apply any sysroot to the directory lists.
512 bool export_dynamic_;
514 const char* dynamic_linker_;
515 Dir_list search_path_;
516 int optimization_level_;
517 const char* output_file_name_;
518 bool is_relocatable_;
520 bool allow_shlib_undefined_;
522 CompressionMethod compress_debug_sections_;
524 bool detect_odr_violations_;
525 bool create_eh_frame_hdr_;
527 Dir_list rpath_link_;
531 std::string sysroot_;
532 uint64_t text_segment_address_;
534 int thread_count_initial_;
535 int thread_count_middle_;
536 int thread_count_final_;
537 Execstack execstack_;
541 // The current state of the position dependent options.
543 class Position_dependent_options
546 Position_dependent_options();
548 // -Bdynamic/-Bstatic: Whether we are searching for a static archive
549 // -rather than a shared object.
551 do_static_search() const
552 { return this->do_static_search_; }
554 // --as-needed: Whether to add a DT_NEEDED argument only if the
555 // dynamic object is used.
558 { return this->as_needed_; }
560 // --whole-archive: Whether to include the entire contents of an
563 include_whole_archive() const
564 { return this->include_whole_archive_; }
568 { this->do_static_search_ = true; }
572 { this->do_static_search_ = false; }
576 { this->as_needed_ = true; }
580 { this->as_needed_ = false; }
584 { this->include_whole_archive_ = true; }
587 clear_whole_archive()
588 { this->include_whole_archive_ = false; }
591 bool do_static_search_;
593 bool include_whole_archive_;
596 // A single file or library argument from the command line.
598 class Input_file_argument
601 // name: file name or library name
602 // is_lib: true if name is a library name: that is, emits the leading
603 // "lib" and trailing ".so"/".a" from the name
604 // extra_search_path: an extra directory to look for the file, prior
605 // to checking the normal library search path. If this is "",
606 // then no extra directory is added.
607 // options: The position dependent options at this point in the
608 // command line, such as --whole-archive.
609 Input_file_argument()
610 : name_(), is_lib_(false), extra_search_path_(""), options_()
613 Input_file_argument(const char* name, bool is_lib,
614 const char* extra_search_path,
615 const Position_dependent_options& options)
616 : name_(name), is_lib_(is_lib), extra_search_path_(extra_search_path),
622 { return this->name_.c_str(); }
624 const Position_dependent_options&
626 { return this->options_; }
630 { return this->is_lib_; }
633 extra_search_path() const
635 return (this->extra_search_path_.empty()
637 : this->extra_search_path_.c_str());
640 // Return whether this file may require a search using the -L
643 may_need_search() const
644 { return this->is_lib_ || !this->extra_search_path_.empty(); }
647 // We use std::string, not const char*, here for convenience when
648 // using script files, so that we do not have to preserve the string
652 std::string extra_search_path_;
653 Position_dependent_options options_;
656 // A file or library, or a group, from the command line.
661 // Create a file or library argument.
662 explicit Input_argument(Input_file_argument file)
663 : is_file_(true), file_(file), group_(NULL)
666 // Create a group argument.
667 explicit Input_argument(Input_file_group* group)
668 : is_file_(false), group_(group)
671 // Return whether this is a file.
674 { return this->is_file_; }
676 // Return whether this is a group.
679 { return !this->is_file_; }
681 // Return the information about the file.
682 const Input_file_argument&
685 gold_assert(this->is_file_);
689 // Return the information about the group.
690 const Input_file_group*
693 gold_assert(!this->is_file_);
700 gold_assert(!this->is_file_);
706 Input_file_argument file_;
707 Input_file_group* group_;
710 // A group from the command line. This is a set of arguments within
711 // --start-group ... --end-group.
713 class Input_file_group
716 typedef std::vector<Input_argument> Files;
717 typedef Files::const_iterator const_iterator;
723 // Add a file to the end of the group.
725 add_file(const Input_file_argument& arg)
726 { this->files_.push_back(Input_argument(arg)); }
728 // Iterators to iterate over the group contents.
732 { return this->files_.begin(); }
736 { return this->files_.end(); }
742 // A list of files from the command line or a script.
744 class Input_arguments
747 typedef std::vector<Input_argument> Input_argument_list;
748 typedef Input_argument_list::const_iterator const_iterator;
751 : input_argument_list_(), in_group_(false)
756 add_file(const Input_file_argument& arg);
758 // Start a group (the --start-group option).
762 // End a group (the --end-group option).
766 // Return whether we are currently in a group.
769 { return this->in_group_; }
771 // The number of entries in the list.
774 { return this->input_argument_list_.size(); }
776 // Iterators to iterate over the list of input files.
780 { return this->input_argument_list_.begin(); }
784 { return this->input_argument_list_.end(); }
786 // Return whether the list is empty.
789 { return this->input_argument_list_.empty(); }
792 Input_argument_list input_argument_list_;
796 // All the information read from the command line.
801 typedef Input_arguments::const_iterator const_iterator;
805 // Process the command line options. This will exit with an
806 // appropriate error message if an unrecognized option is seen.
808 process(int argc, char** argv);
810 // Process one command-line option. This takes the index of argv to
811 // process, and returns the index for the next option.
813 process_one_option(int argc, char** argv, int i, bool* no_more_options);
815 // Handle a -l option.
817 process_l_option(int, char**, char*, bool);
819 // Handle a --start-group option.
821 start_group(const char* arg);
823 // Handle a --end-group option.
825 end_group(const char* arg);
827 // Get an option argument--a helper function for special processing.
829 get_special_argument(const char* longname, int argc, char** argv,
830 const char* arg, bool long_option,
833 // Get the general options.
834 const General_options&
836 { return this->options_; }
838 // Get the position dependent options.
839 const Position_dependent_options&
840 position_dependent_options() const
841 { return this->position_options_; }
843 // The number of input files.
845 number_of_input_files() const
846 { return this->inputs_.size(); }
848 // Iterators to iterate over the list of input files.
852 { return this->inputs_.begin(); }
856 { return this->inputs_.end(); }
859 Command_line(const Command_line&);
860 Command_line& operator=(const Command_line&);
862 // Report usage error.
864 usage() ATTRIBUTE_NORETURN;
866 usage(const char* msg, const char* opt) ATTRIBUTE_NORETURN;
868 usage(const char* msg, char opt) ATTRIBUTE_NORETURN;
870 // Apply a command line option.
872 apply_option(const gold::options::One_option&, const char*);
876 add_file(const char* name, bool is_lib);
878 // Examine the result of processing the command-line, and verify
879 // the flags do not contradict each other or are otherwise illegal.
883 General_options options_;
884 Position_dependent_options position_options_;
885 Input_arguments inputs_;
888 } // End namespace gold.
890 #endif // !defined(GOLD_OPTIONS_H)