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
44 class Input_file_group;
48 class Command_line_options;
51 } // End namespace gold::options.
53 // A directory to search. For each directory we record whether it is
54 // in the sysroot. We need to know this so that, if a linker script
55 // is found within the sysroot, we will apply the sysroot to any files
56 // named by that script.
58 class Search_directory
61 // We need a default constructor because we put this in a
64 : name_(NULL), put_in_sysroot_(false), is_in_sysroot_(false)
67 // This is the usual constructor.
68 Search_directory(const char* name, bool put_in_sysroot)
69 : name_(name), put_in_sysroot_(put_in_sysroot), is_in_sysroot_(false)
70 { gold_assert(!this->name_.empty()); }
72 // This is called if we have a sysroot. The sysroot is prefixed to
73 // any entries for which put_in_sysroot_ is true. is_in_sysroot_ is
74 // set to true for any enries which are in the sysroot (this will
75 // naturally include any entries for which put_in_sysroot_ is true).
76 // SYSROOT is the sysroot, CANONICAL_SYSROOT is the result of
77 // passing SYSROOT to lrealpath.
79 add_sysroot(const char* sysroot, const char* canonical_sysroot);
81 // Get the directory name.
84 { return this->name_; }
86 // Return whether this directory is in the sysroot.
89 { return this->is_in_sysroot_; }
97 // The position independent options which apply to the whole link.
98 // There are a lot of them.
100 class General_options
105 // -E: export dynamic symbols.
107 export_dynamic() const
108 { return this->export_dynamic_; }
110 // -I: dynamic linker name.
112 dynamic_linker() const
113 { return this->dynamic_linker_; }
115 // -L: Library search path.
116 typedef std::vector<Search_directory> Dir_list;
120 { return this->search_path_; }
122 // -O: optimization level (0: don't try to optimize output size).
124 optimization_level() const
125 { return this->optimization_level_; }
127 // -o: Output file name.
129 output_file_name() const
130 { return this->output_file_name_; }
132 // -r: Whether we are doing a relocatable link.
134 is_relocatable() const
135 { return this->is_relocatable_; }
137 // -s: Strip all symbols.
140 { return this->strip_ == STRIP_ALL; }
142 // -S: Strip debugging information.
145 { return this->strip_ == STRIP_ALL || this->strip_ == STRIP_DEBUG; }
147 // --eh-frame-hdr: Whether to generate an exception frame header.
149 create_eh_frame_hdr() const
150 { return this->create_eh_frame_hdr_; }
152 // --rpath: The runtime search path.
155 { return this->rpath_; }
157 // --rpath-link: The link time search patch for shared libraries.
160 { return this->rpath_link_; }
162 // --shared: Whether generating a shared object.
165 { return this->is_shared_; }
167 // --static: Whether doing a static link.
170 { return this->is_static_; }
172 // --sysroot: The system root of a cross-linker.
175 { return this->sysroot_; }
178 // Don't copy this structure.
179 General_options(const General_options&);
180 General_options& operator=(const General_options&);
182 friend class Command_line;
183 friend class options::Command_line_options;
185 // Which symbols to strip.
188 // Don't strip any symbols.
190 // Strip all symbols.
192 // Strip debugging information.
198 { this->export_dynamic_ = true; }
201 set_dynamic_linker(const char* arg)
202 { this->dynamic_linker_ = arg; }
205 add_to_search_path(const char* arg)
206 { this->search_path_.push_back(Search_directory(arg, false)); }
209 add_to_search_path_with_sysroot(const char* arg)
210 { this->search_path_.push_back(Search_directory(arg, true)); }
213 set_optimization_level(const char* arg)
214 { this->optimization_level_ = atoi(arg); }
217 set_output_file_name(const char* arg)
218 { this->output_file_name_ = arg; }
222 { this->is_relocatable_ = true; }
226 { this->strip_ = STRIP_ALL; }
228 // Note: normalize_options() depends on the fact that this turns off
229 // STRIP_ALL if it were already set.
232 { this->strip_ = STRIP_DEBUG; }
235 set_create_eh_frame_hdr()
236 { this->create_eh_frame_hdr_ = true; }
239 add_to_rpath(const char* arg)
240 { this->rpath_.push_back(Search_directory(arg, false)); }
243 add_to_rpath_link(const char* arg)
244 { this->rpath_link_.push_back(Search_directory(arg, false)); }
248 { this->is_shared_ = true; }
252 { this->is_static_ = true; }
255 set_sysroot(const char* arg)
256 { this->sysroot_ = arg; }
262 // Apply any sysroot to the directory lists.
266 bool export_dynamic_;
267 const char* dynamic_linker_;
268 Dir_list search_path_;
269 int optimization_level_;
270 const char* output_file_name_;
271 bool is_relocatable_;
273 bool create_eh_frame_hdr_;
275 Dir_list rpath_link_;
278 std::string sysroot_;
281 // The current state of the position dependent options.
283 class Position_dependent_options
286 Position_dependent_options();
288 // -Bstatic: Whether we are searching for a static archive rather
289 // than a shared object.
291 do_static_search() const
292 { return this->do_static_search_; }
294 // --as-needed: Whether to add a DT_NEEDED argument only if the
295 // dynamic object is used.
298 { return this->as_needed_; }
300 // --whole-archive: Whether to include the entire contents of an
303 include_whole_archive() const
304 { return this->include_whole_archive_; }
308 { this->do_static_search_ = true; }
312 { this->do_static_search_ = false; }
316 { this->as_needed_ = true; }
320 { this->as_needed_ = false; }
324 { this->include_whole_archive_ = true; }
327 clear_whole_archive()
328 { this->include_whole_archive_ = false; }
331 bool do_static_search_;
333 bool include_whole_archive_;
336 // A single file or library argument from the command line.
338 class Input_file_argument
341 // name: file name or library name
342 // is_lib: true if name is a library name: that is, emits the leading
343 // "lib" and trailing ".so"/".a" from the name
344 // extra_search_path: an extra directory to look for the file, prior
345 // to checking the normal library search path. If this is "",
346 // then no extra directory is added.
347 // options: The position dependent options at this point in the
348 // command line, such as --whole-archive.
349 Input_file_argument()
350 : name_(), is_lib_(false), extra_search_path_(""), options_()
353 Input_file_argument(const char* name, bool is_lib,
354 const char* extra_search_path,
355 const Position_dependent_options& options)
356 : name_(name), is_lib_(is_lib), extra_search_path_(extra_search_path),
362 { return this->name_.c_str(); }
364 const Position_dependent_options&
366 { return this->options_; }
370 { return this->is_lib_; }
373 extra_search_path() const
375 return (this->extra_search_path_.empty()
377 : this->extra_search_path_.c_str());
380 // Return whether this file may require a search using the -L
383 may_need_search() const
384 { return this->is_lib_ || !this->extra_search_path_.empty(); }
387 // We use std::string, not const char*, here for convenience when
388 // using script files, so that we do not have to preserve the string
392 std::string extra_search_path_;
393 Position_dependent_options options_;
396 // A file or library, or a group, from the command line.
401 // Create a file or library argument.
402 explicit Input_argument(Input_file_argument file)
403 : is_file_(true), file_(file), group_(NULL)
406 // Create a group argument.
407 explicit Input_argument(Input_file_group* group)
408 : is_file_(false), group_(group)
411 // Return whether this is a file.
414 { return this->is_file_; }
416 // Return whether this is a group.
419 { return !this->is_file_; }
421 // Return the information about the file.
422 const Input_file_argument&
425 gold_assert(this->is_file_);
429 // Return the information about the group.
430 const Input_file_group*
433 gold_assert(!this->is_file_);
440 gold_assert(!this->is_file_);
446 Input_file_argument file_;
447 Input_file_group* group_;
450 // A group from the command line. This is a set of arguments within
451 // --start-group ... --end-group.
453 class Input_file_group
456 typedef std::vector<Input_argument> Files;
457 typedef Files::const_iterator const_iterator;
463 // Add a file to the end of the group.
465 add_file(const Input_file_argument& arg)
466 { this->files_.push_back(Input_argument(arg)); }
468 // Iterators to iterate over the group contents.
472 { return this->files_.begin(); }
476 { return this->files_.end(); }
482 // A list of files from the command line or a script.
484 class Input_arguments
487 typedef std::vector<Input_argument> Input_argument_list;
488 typedef Input_argument_list::const_iterator const_iterator;
491 : input_argument_list_(), in_group_(false)
496 add_file(const Input_file_argument& arg);
498 // Start a group (the --start-group option).
502 // End a group (the --end-group option).
506 // Return whether we are currently in a group.
509 { return this->in_group_; }
511 // Iterators to iterate over the list of input files.
515 { return this->input_argument_list_.begin(); }
519 { return this->input_argument_list_.end(); }
521 // Return whether the list is empty.
524 { return this->input_argument_list_.empty(); }
527 Input_argument_list input_argument_list_;
531 // All the information read from the command line.
536 typedef Input_arguments::const_iterator const_iterator;
540 // Process the command line options. This will exit with an
541 // appropriate error message if an unrecognized option is seen.
543 process(int argc, char** argv);
545 // Handle a -l option.
547 process_l_option(int, char**, char*);
549 // Handle a --start-group option.
551 start_group(const char* arg);
553 // Handle a --end-group option.
555 end_group(const char* arg);
557 // Get the general options.
558 const General_options&
560 { return this->options_; }
562 // Iterators to iterate over the list of input files.
566 { return this->inputs_.begin(); }
570 { return this->inputs_.end(); }
573 Command_line(const Command_line&);
574 Command_line& operator=(const Command_line&);
576 // Report usage error.
578 usage() ATTRIBUTE_NORETURN;
580 usage(const char* msg, const char* opt) ATTRIBUTE_NORETURN;
582 usage(const char* msg, char opt) ATTRIBUTE_NORETURN;
584 // Apply a command line option.
586 apply_option(const gold::options::One_option&, const char*);
590 add_file(const char* name, bool is_lib);
592 // Examine the result of processing the command-line, and verify
593 // the flags do not contradict each other or are otherwise illegal.
597 General_options options_;
598 Position_dependent_options position_options_;
599 Input_arguments inputs_;
602 } // End namespace gold.
604 #endif // !defined(GOLD_OPTIONS_H)