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: set entry address.
114 { return this->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 // -Ttext: The address of the .text section
238 text_segment_address() const
239 { return this->text_segment_address_; }
241 // Whether -Ttext was used.
243 user_set_text_segment_address() const
244 { return this->text_segment_address_ != -1U; }
246 // --threads: Whether to use threads.
249 { return this->threads_; }
251 // --thread-count-initial: Threads to use in initial pass.
253 thread_count_initial() const
254 { return this->thread_count_initial_; }
256 // --thread-count-middle: Threads to use in middle pass.
258 thread_count_middle() const
259 { return this->thread_count_middle_; }
261 // --thread-count-final: Threads to use in final pass.
263 thread_count_final() const
264 { return this->thread_count_final_; }
266 // -z execstack, -z noexecstack
268 is_execstack_set() const
269 { return this->execstack_ != EXECSTACK_FROM_INPUT; }
272 is_stack_executable() const
273 { return this->execstack_ == EXECSTACK_YES; }
278 { return this->debug_; }
281 // Don't copy this structure.
282 General_options(const General_options&);
283 General_options& operator=(const General_options&);
285 friend class Command_line;
286 friend class options::Command_line_options;
288 // Which symbols to strip.
291 // Don't strip any symbols.
293 // Strip all symbols.
295 // Strip debugging information.
297 // Strip debugging information that's not used by gdb (at least <= 6.7)
298 STRIP_DEBUG_UNUSED_BY_GDB
301 // Whether to mark the stack as executable.
304 // Not set on command line.
305 EXECSTACK_FROM_INPUT,
306 // Mark the stack as executable.
308 // Mark the stack as not executable.
312 // What compression method to use
313 enum CompressionMethod
320 set_entry(const char* arg)
321 { this->entry_ = arg; }
325 { this->export_dynamic_ = true; }
328 set_soname(const char* arg)
329 { this->soname_ = arg; }
332 set_dynamic_linker(const char* arg)
333 { this->dynamic_linker_ = arg; }
336 add_to_search_path(const char* arg)
337 { this->search_path_.push_back(Search_directory(arg, false)); }
340 add_to_search_path_with_sysroot(const char* arg)
341 { this->search_path_.push_back(Search_directory(arg, true)); }
344 set_optimization_level(const char* arg)
347 this->optimization_level_ = strtol(arg, &endptr, 0);
348 if (*endptr != '\0' || this->optimization_level_ < 0)
349 gold_fatal(_("invalid optimization level: %s"), arg);
353 set_output_file_name(const char* arg)
354 { this->output_file_name_ = arg; }
358 { this->is_relocatable_ = true; }
362 { this->strip_ = STRIP_ALL; }
364 // Note: normalize_options() depends on the fact that this turns off
365 // STRIP_ALL if it were already set.
368 { this->strip_ = STRIP_DEBUG; }
371 set_strip_debug_gdb()
372 { this->strip_ = STRIP_DEBUG_UNUSED_BY_GDB; }
375 set_allow_shlib_undefined()
376 { this->allow_shlib_undefined_ = true; }
379 set_no_allow_shlib_undefined()
380 { this->allow_shlib_undefined_ = false; }
384 { this->symbolic_ = true; }
386 void set_compress_debug_sections(const char* arg)
388 if (strcmp(arg, "none") == 0)
389 this->compress_debug_sections_ = NO_COMPRESSION;
391 else if (strcmp(arg, "zlib") == 0)
392 this->compress_debug_sections_ = ZLIB_COMPRESSION;
395 gold_fatal(_("unsupported argument to --compress-debug-sections: %s"),
401 { this->demangle_ = true; }
405 { this->demangle_ = false; }
408 set_detect_odr_violations()
409 { this->detect_odr_violations_ = true; }
412 set_create_eh_frame_hdr()
413 { this->create_eh_frame_hdr_ = true; }
416 add_to_rpath(const char* arg)
417 { this->rpath_.push_back(Search_directory(arg, false)); }
420 add_to_rpath_link(const char* arg)
421 { this->rpath_link_.push_back(Search_directory(arg, false)); }
425 { this->is_shared_ = true; }
429 { this->is_static_ = true; }
433 { this->print_stats_ = true; }
436 set_sysroot(const char* arg)
437 { this->sysroot_ = arg; }
440 set_text_segment_address(const char* arg)
443 this->text_segment_address_ = strtoull(arg, &endptr, 0);
445 || this->text_segment_address_ == -1U)
446 gold_fatal(_("invalid argument to -Ttext: %s"), arg);
450 parse_thread_count(const char* arg)
453 const int count = strtol(arg, &endptr, 0);
454 if (*endptr != '\0' || count < 0)
455 gold_fatal(_("invalid thread count: %s"), arg);
462 #ifndef ENABLE_THREADS
463 gold_fatal(_("--threads not supported"));
465 this->threads_ = true;
470 { this->threads_ = false; }
473 set_thread_count(const char* arg)
475 int count = this->parse_thread_count(arg);
476 this->thread_count_initial_ = count;
477 this->thread_count_middle_ = count;
478 this->thread_count_final_ = count;
482 set_thread_count_initial(const char* arg)
483 { this->thread_count_initial_ = this->parse_thread_count(arg); }
486 set_thread_count_middle(const char* arg)
487 { this->thread_count_middle_ = this->parse_thread_count(arg); }
490 set_thread_count_final(const char* arg)
491 { this->thread_count_final_ = this->parse_thread_count(arg); }
499 { this->execstack_ = EXECSTACK_YES; }
503 { this->execstack_ = EXECSTACK_NO; }
506 set_debug(unsigned int flags)
507 { this->debug_ = flags; }
509 // Handle the -z option.
511 handle_z_option(const char*);
513 // Handle the --debug option.
515 handle_debug_option(const char*);
517 // Apply any sysroot to the directory lists.
522 bool export_dynamic_;
524 const char* dynamic_linker_;
525 Dir_list search_path_;
526 int optimization_level_;
527 const char* output_file_name_;
528 bool is_relocatable_;
530 bool allow_shlib_undefined_;
532 CompressionMethod compress_debug_sections_;
534 bool detect_odr_violations_;
535 bool create_eh_frame_hdr_;
537 Dir_list rpath_link_;
541 std::string sysroot_;
542 uint64_t text_segment_address_;
544 int thread_count_initial_;
545 int thread_count_middle_;
546 int thread_count_final_;
547 Execstack execstack_;
551 // The current state of the position dependent options.
553 class Position_dependent_options
556 Position_dependent_options();
558 // -Bdynamic/-Bstatic: Whether we are searching for a static archive
559 // -rather than a shared object.
561 do_static_search() const
562 { return this->do_static_search_; }
564 // --as-needed: Whether to add a DT_NEEDED argument only if the
565 // dynamic object is used.
568 { return this->as_needed_; }
570 // --whole-archive: Whether to include the entire contents of an
573 include_whole_archive() const
574 { return this->include_whole_archive_; }
578 { this->do_static_search_ = true; }
582 { this->do_static_search_ = false; }
586 { this->as_needed_ = true; }
590 { this->as_needed_ = false; }
594 { this->include_whole_archive_ = true; }
597 clear_whole_archive()
598 { this->include_whole_archive_ = false; }
601 bool do_static_search_;
603 bool include_whole_archive_;
606 // A single file or library argument from the command line.
608 class Input_file_argument
611 // name: file name or library name
612 // is_lib: true if name is a library name: that is, emits the leading
613 // "lib" and trailing ".so"/".a" from the name
614 // extra_search_path: an extra directory to look for the file, prior
615 // to checking the normal library search path. If this is "",
616 // then no extra directory is added.
617 // options: The position dependent options at this point in the
618 // command line, such as --whole-archive.
619 Input_file_argument()
620 : name_(), is_lib_(false), extra_search_path_(""), options_()
623 Input_file_argument(const char* name, bool is_lib,
624 const char* extra_search_path,
625 const Position_dependent_options& options)
626 : name_(name), is_lib_(is_lib), extra_search_path_(extra_search_path),
632 { return this->name_.c_str(); }
634 const Position_dependent_options&
636 { return this->options_; }
640 { return this->is_lib_; }
643 extra_search_path() const
645 return (this->extra_search_path_.empty()
647 : this->extra_search_path_.c_str());
650 // Return whether this file may require a search using the -L
653 may_need_search() const
654 { return this->is_lib_ || !this->extra_search_path_.empty(); }
657 // We use std::string, not const char*, here for convenience when
658 // using script files, so that we do not have to preserve the string
662 std::string extra_search_path_;
663 Position_dependent_options options_;
666 // A file or library, or a group, from the command line.
671 // Create a file or library argument.
672 explicit Input_argument(Input_file_argument file)
673 : is_file_(true), file_(file), group_(NULL)
676 // Create a group argument.
677 explicit Input_argument(Input_file_group* group)
678 : is_file_(false), group_(group)
681 // Return whether this is a file.
684 { return this->is_file_; }
686 // Return whether this is a group.
689 { return !this->is_file_; }
691 // Return the information about the file.
692 const Input_file_argument&
695 gold_assert(this->is_file_);
699 // Return the information about the group.
700 const Input_file_group*
703 gold_assert(!this->is_file_);
710 gold_assert(!this->is_file_);
716 Input_file_argument file_;
717 Input_file_group* group_;
720 // A group from the command line. This is a set of arguments within
721 // --start-group ... --end-group.
723 class Input_file_group
726 typedef std::vector<Input_argument> Files;
727 typedef Files::const_iterator const_iterator;
733 // Add a file to the end of the group.
735 add_file(const Input_file_argument& arg)
736 { this->files_.push_back(Input_argument(arg)); }
738 // Iterators to iterate over the group contents.
742 { return this->files_.begin(); }
746 { return this->files_.end(); }
752 // A list of files from the command line or a script.
754 class Input_arguments
757 typedef std::vector<Input_argument> Input_argument_list;
758 typedef Input_argument_list::const_iterator const_iterator;
761 : input_argument_list_(), in_group_(false)
766 add_file(const Input_file_argument& arg);
768 // Start a group (the --start-group option).
772 // End a group (the --end-group option).
776 // Return whether we are currently in a group.
779 { return this->in_group_; }
781 // The number of entries in the list.
784 { return this->input_argument_list_.size(); }
786 // Iterators to iterate over the list of input files.
790 { return this->input_argument_list_.begin(); }
794 { return this->input_argument_list_.end(); }
796 // Return whether the list is empty.
799 { return this->input_argument_list_.empty(); }
802 Input_argument_list input_argument_list_;
806 // All the information read from the command line.
811 typedef Input_arguments::const_iterator const_iterator;
815 // Process the command line options. This will exit with an
816 // appropriate error message if an unrecognized option is seen.
818 process(int argc, char** argv);
820 // Process one command-line option. This takes the index of argv to
821 // process, and returns the index for the next option.
823 process_one_option(int argc, char** argv, int i, bool* no_more_options);
825 // Handle a -l option.
827 process_l_option(int, char**, char*, bool);
829 // Handle a --start-group option.
831 start_group(const char* arg);
833 // Handle a --end-group option.
835 end_group(const char* arg);
837 // Set the entry symbol from a linker script.
839 set_entry(const char* entry)
840 { this->options_.set_entry(entry); }
842 // Get an option argument--a helper function for special processing.
844 get_special_argument(const char* longname, int argc, char** argv,
845 const char* arg, bool long_option,
848 // Get the general options.
849 const General_options&
851 { return this->options_; }
853 // Get the position dependent options.
854 const Position_dependent_options&
855 position_dependent_options() const
856 { return this->position_options_; }
858 // The number of input files.
860 number_of_input_files() const
861 { return this->inputs_.size(); }
863 // Iterators to iterate over the list of input files.
867 { return this->inputs_.begin(); }
871 { return this->inputs_.end(); }
874 Command_line(const Command_line&);
875 Command_line& operator=(const Command_line&);
877 // Report usage error.
879 usage() ATTRIBUTE_NORETURN;
881 usage(const char* msg, const char* opt) ATTRIBUTE_NORETURN;
883 usage(const char* msg, char opt) ATTRIBUTE_NORETURN;
885 // Apply a command line option.
887 apply_option(const gold::options::One_option&, const char*);
891 add_file(const char* name, bool is_lib);
893 // Examine the result of processing the command-line, and verify
894 // the flags do not contradict each other or are otherwise illegal.
898 General_options options_;
899 Position_dependent_options position_options_;
900 Input_arguments inputs_;
903 } // End namespace gold.
905 #endif // !defined(GOLD_OPTIONS_H)