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 // -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_
; }
280 // Return the options which may be set from a linker script.
283 { return this->script_options_
; }
285 const Script_options
*
286 script_options() const
287 { return this->script_options_
; }
290 // Don't copy this structure.
291 General_options(const General_options
&);
292 General_options
& operator=(const General_options
&);
294 friend class Command_line
;
295 friend class options::Command_line_options
;
297 // Which symbols to strip.
300 // Don't strip any symbols.
302 // Strip all symbols.
304 // Strip debugging information.
306 // Strip debugging information that's not used by gdb (at least <= 6.7)
307 STRIP_DEBUG_UNUSED_BY_GDB
310 // Whether to mark the stack as executable.
313 // Not set on command line.
314 EXECSTACK_FROM_INPUT
,
315 // Mark the stack as executable.
317 // Mark the stack as not executable.
321 // What compression method to use
322 enum CompressionMethod
329 set_entry(const char* arg
)
330 { this->script_options_
->set_entry(arg
, strlen(arg
)); }
334 { this->export_dynamic_
= true; }
337 set_soname(const char* arg
)
338 { this->soname_
= arg
; }
341 set_dynamic_linker(const char* arg
)
342 { this->dynamic_linker_
= arg
; }
345 add_to_search_path(const char* arg
)
346 { this->search_path_
.push_back(Search_directory(arg
, false)); }
349 add_to_search_path_with_sysroot(const char* arg
)
350 { this->search_path_
.push_back(Search_directory(arg
, true)); }
353 set_optimization_level(const char* arg
)
356 this->optimization_level_
= strtol(arg
, &endptr
, 0);
357 if (*endptr
!= '\0' || this->optimization_level_
< 0)
358 gold_fatal(_("invalid optimization level: %s"), arg
);
362 set_output_file_name(const char* arg
)
363 { this->output_file_name_
= arg
; }
367 { this->is_relocatable_
= true; }
371 { this->strip_
= STRIP_ALL
; }
373 // Note: normalize_options() depends on the fact that this turns off
374 // STRIP_ALL if it were already set.
377 { this->strip_
= STRIP_DEBUG
; }
380 set_strip_debug_gdb()
381 { this->strip_
= STRIP_DEBUG_UNUSED_BY_GDB
; }
384 set_allow_shlib_undefined()
385 { this->allow_shlib_undefined_
= true; }
388 set_no_allow_shlib_undefined()
389 { this->allow_shlib_undefined_
= false; }
393 { this->symbolic_
= true; }
395 void set_compress_debug_sections(const char* arg
)
397 if (strcmp(arg
, "none") == 0)
398 this->compress_debug_sections_
= NO_COMPRESSION
;
400 else if (strcmp(arg
, "zlib") == 0)
401 this->compress_debug_sections_
= ZLIB_COMPRESSION
;
404 gold_fatal(_("unsupported argument to --compress-debug-sections: %s"),
409 define_symbol(const char* arg
);
413 { this->demangle_
= true; }
417 { this->demangle_
= false; }
420 set_detect_odr_violations()
421 { this->detect_odr_violations_
= true; }
424 set_create_eh_frame_hdr()
425 { this->create_eh_frame_hdr_
= true; }
428 add_to_rpath(const char* arg
)
429 { this->rpath_
.push_back(Search_directory(arg
, false)); }
432 add_to_rpath_link(const char* arg
)
433 { this->rpath_link_
.push_back(Search_directory(arg
, false)); }
437 { this->is_shared_
= true; }
441 { this->is_static_
= true; }
445 { this->print_stats_
= true; }
448 set_sysroot(const char* arg
)
449 { this->sysroot_
= arg
; }
452 set_text_segment_address(const char* arg
)
455 this->text_segment_address_
= strtoull(arg
, &endptr
, 0);
457 || this->text_segment_address_
== -1U)
458 gold_fatal(_("invalid argument to -Ttext: %s"), arg
);
462 parse_thread_count(const char* arg
)
465 const int count
= strtol(arg
, &endptr
, 0);
466 if (*endptr
!= '\0' || count
< 0)
467 gold_fatal(_("invalid thread count: %s"), arg
);
474 #ifndef ENABLE_THREADS
475 gold_fatal(_("--threads not supported"));
477 this->threads_
= true;
482 { this->threads_
= false; }
485 set_thread_count(const char* arg
)
487 int count
= this->parse_thread_count(arg
);
488 this->thread_count_initial_
= count
;
489 this->thread_count_middle_
= count
;
490 this->thread_count_final_
= count
;
494 set_thread_count_initial(const char* arg
)
495 { this->thread_count_initial_
= this->parse_thread_count(arg
); }
498 set_thread_count_middle(const char* arg
)
499 { this->thread_count_middle_
= this->parse_thread_count(arg
); }
502 set_thread_count_final(const char* arg
)
503 { this->thread_count_final_
= this->parse_thread_count(arg
); }
511 { this->execstack_
= EXECSTACK_YES
; }
515 { this->execstack_
= EXECSTACK_NO
; }
518 set_debug(unsigned int flags
)
519 { this->debug_
= flags
; }
521 // Handle the -z option.
523 handle_z_option(const char*);
525 // Handle the --debug option.
527 handle_debug_option(const char*);
529 // Apply any sysroot to the directory lists.
533 bool export_dynamic_
;
535 const char* dynamic_linker_
;
536 Dir_list search_path_
;
537 int optimization_level_
;
538 const char* output_file_name_
;
539 bool is_relocatable_
;
541 bool allow_shlib_undefined_
;
543 CompressionMethod compress_debug_sections_
;
545 bool detect_odr_violations_
;
546 bool create_eh_frame_hdr_
;
548 Dir_list rpath_link_
;
552 std::string sysroot_
;
553 uint64_t text_segment_address_
;
555 int thread_count_initial_
;
556 int thread_count_middle_
;
557 int thread_count_final_
;
558 Execstack execstack_
;
560 // Some options can also be set from linker scripts. Those are
562 Script_options
* script_options_
;
565 // The current state of the position dependent options.
567 class Position_dependent_options
570 Position_dependent_options();
572 // -Bdynamic/-Bstatic: Whether we are searching for a static archive
573 // -rather than a shared object.
575 do_static_search() const
576 { return this->do_static_search_
; }
578 // --as-needed: Whether to add a DT_NEEDED argument only if the
579 // dynamic object is used.
582 { return this->as_needed_
; }
584 // --whole-archive: Whether to include the entire contents of an
587 include_whole_archive() const
588 { return this->include_whole_archive_
; }
592 { this->do_static_search_
= true; }
596 { this->do_static_search_
= false; }
600 { this->as_needed_
= true; }
604 { this->as_needed_
= false; }
608 { this->include_whole_archive_
= true; }
611 clear_whole_archive()
612 { this->include_whole_archive_
= false; }
615 bool do_static_search_
;
617 bool include_whole_archive_
;
620 // A single file or library argument from the command line.
622 class Input_file_argument
625 // name: file name or library name
626 // is_lib: true if name is a library name: that is, emits the leading
627 // "lib" and trailing ".so"/".a" from the name
628 // extra_search_path: an extra directory to look for the file, prior
629 // to checking the normal library search path. If this is "",
630 // then no extra directory is added.
631 // options: The position dependent options at this point in the
632 // command line, such as --whole-archive.
633 Input_file_argument()
634 : name_(), is_lib_(false), extra_search_path_(""), options_()
637 Input_file_argument(const char* name
, bool is_lib
,
638 const char* extra_search_path
,
639 const Position_dependent_options
& options
)
640 : name_(name
), is_lib_(is_lib
), extra_search_path_(extra_search_path
),
646 { return this->name_
.c_str(); }
648 const Position_dependent_options
&
650 { return this->options_
; }
654 { return this->is_lib_
; }
657 extra_search_path() const
659 return (this->extra_search_path_
.empty()
661 : this->extra_search_path_
.c_str());
664 // Return whether this file may require a search using the -L
667 may_need_search() const
668 { return this->is_lib_
|| !this->extra_search_path_
.empty(); }
671 // We use std::string, not const char*, here for convenience when
672 // using script files, so that we do not have to preserve the string
676 std::string extra_search_path_
;
677 Position_dependent_options options_
;
680 // A file or library, or a group, from the command line.
685 // Create a file or library argument.
686 explicit Input_argument(Input_file_argument file
)
687 : is_file_(true), file_(file
), group_(NULL
)
690 // Create a group argument.
691 explicit Input_argument(Input_file_group
* group
)
692 : is_file_(false), group_(group
)
695 // Return whether this is a file.
698 { return this->is_file_
; }
700 // Return whether this is a group.
703 { return !this->is_file_
; }
705 // Return the information about the file.
706 const Input_file_argument
&
709 gold_assert(this->is_file_
);
713 // Return the information about the group.
714 const Input_file_group
*
717 gold_assert(!this->is_file_
);
724 gold_assert(!this->is_file_
);
730 Input_file_argument file_
;
731 Input_file_group
* group_
;
734 // A group from the command line. This is a set of arguments within
735 // --start-group ... --end-group.
737 class Input_file_group
740 typedef std::vector
<Input_argument
> Files
;
741 typedef Files::const_iterator const_iterator
;
747 // Add a file to the end of the group.
749 add_file(const Input_file_argument
& arg
)
750 { this->files_
.push_back(Input_argument(arg
)); }
752 // Iterators to iterate over the group contents.
756 { return this->files_
.begin(); }
760 { return this->files_
.end(); }
766 // A list of files from the command line or a script.
768 class Input_arguments
771 typedef std::vector
<Input_argument
> Input_argument_list
;
772 typedef Input_argument_list::const_iterator const_iterator
;
775 : input_argument_list_(), in_group_(false)
780 add_file(const Input_file_argument
& arg
);
782 // Start a group (the --start-group option).
786 // End a group (the --end-group option).
790 // Return whether we are currently in a group.
793 { return this->in_group_
; }
795 // The number of entries in the list.
798 { return this->input_argument_list_
.size(); }
800 // Iterators to iterate over the list of input files.
804 { return this->input_argument_list_
.begin(); }
808 { return this->input_argument_list_
.end(); }
810 // Return whether the list is empty.
813 { return this->input_argument_list_
.empty(); }
816 Input_argument_list input_argument_list_
;
820 // All the information read from the command line.
825 typedef Input_arguments::const_iterator const_iterator
;
827 Command_line(Script_options
*);
829 // Process the command line options. This will exit with an
830 // appropriate error message if an unrecognized option is seen.
832 process(int argc
, char** argv
);
834 // Process one command-line option. This takes the index of argv to
835 // process, and returns the index for the next option.
837 process_one_option(int argc
, char** argv
, int i
, bool* no_more_options
);
839 // Handle a -l option.
841 process_l_option(int, char**, char*, bool);
843 // Handle a --start-group option.
845 start_group(const char* arg
);
847 // Handle a --end-group option.
849 end_group(const char* arg
);
851 // Get an option argument--a helper function for special processing.
853 get_special_argument(const char* longname
, int argc
, char** argv
,
854 const char* arg
, bool long_option
,
857 // Get the general options.
858 const General_options
&
860 { return this->options_
; }
862 // Get the position dependent options.
863 const Position_dependent_options
&
864 position_dependent_options() const
865 { return this->position_options_
; }
867 // Get the options which may be set from a linker script.
870 { return this->options_
.script_options(); }
872 const Script_options
*
873 script_options() const
874 { return this->options_
.script_options(); }
876 // The number of input files.
878 number_of_input_files() const
879 { return this->inputs_
.size(); }
881 // Iterators to iterate over the list of input files.
885 { return this->inputs_
.begin(); }
889 { return this->inputs_
.end(); }
892 Command_line(const Command_line
&);
893 Command_line
& operator=(const Command_line
&);
895 // Report usage error.
897 usage() ATTRIBUTE_NORETURN
;
899 usage(const char* msg
, const char* opt
) ATTRIBUTE_NORETURN
;
901 usage(const char* msg
, char opt
) ATTRIBUTE_NORETURN
;
903 // Apply a command line option.
905 apply_option(const gold::options::One_option
&, const char*);
909 add_file(const char* name
, bool is_lib
);
911 // Examine the result of processing the command-line, and verify
912 // the flags do not contradict each other or are otherwise illegal.
916 General_options options_
;
917 Position_dependent_options position_options_
;
918 Input_arguments inputs_
;
921 } // End namespace gold.
923 #endif // !defined(GOLD_OPTIONS_H)