1 // parameters.h -- general parameters for a link using 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.
23 #ifndef GOLD_PARAMETERS_H
24 #define GOLD_PARAMETERS_H
29 class General_options;
32 // Here we define the Parameters class which simply holds simple
33 // general parameters which apply to the entire link. We use a global
34 // variable for this. This is in contrast to the General_options
35 // class, which holds the complete state of position independent
36 // command line options. The hope is that Parameters will stay fairly
37 // simple, so that if this turns into a library it will be clear how
38 // these parameters should be set.
45 // Return the error object.
48 { return this->errors_; }
50 // Return the output file name.
52 output_file_name() const
54 gold_assert(this->options_valid_);
55 return this->output_file_name_;
58 // Whether we are generating a regular executable.
60 output_is_executable() const
62 gold_assert(this->output_file_type_ != OUTPUT_INVALID);
63 return this->output_file_type_ == OUTPUT_EXECUTABLE;
66 // Whether we are generating a shared library.
68 output_is_shared() const
70 gold_assert(this->output_file_type_ != OUTPUT_INVALID);
71 return this->output_file_type_ == OUTPUT_SHARED;
74 // Whether we are generating an object file.
76 output_is_object() const
78 gold_assert(this->output_file_type_ != OUTPUT_INVALID);
79 return this->output_file_type_ == OUTPUT_OBJECT;
82 // Whether we are generating position-independent output.
83 // This is the case when generating either a shared library
84 // or a regular executable with the --pic-executable option.
85 // FIXME: support --pic-executable
87 output_is_position_independent() const
88 { return output_is_shared(); }
90 // The target system root directory. This is NULL if there isn't
95 gold_assert(this->options_valid_);
96 return this->sysroot_;
99 // Whether to strip all symbols.
103 gold_assert(this->strip_ != STRIP_INVALID);
104 return this->strip_ == STRIP_ALL;
107 // Whether to strip debugging information.
111 gold_assert(this->strip_ != STRIP_INVALID);
112 return this->strip_ == STRIP_ALL || this->strip_ == STRIP_DEBUG;
115 // Whether to permit unresolved references from shared libraries.
117 allow_shlib_undefined() const
119 gold_assert(this->options_valid_);
120 return this->allow_shlib_undefined_;
123 // Whether we are doing a symbolic link, in which all defined
124 // symbols are bound locally.
128 gold_assert(this->options_valid_);
129 return this->symbolic_;
132 // Whether we should try to detect violations of the One Definition Rule.
134 detect_odr_violations() const
136 gold_assert(this->options_valid_);
137 return this->detect_odr_violations_;
140 // The general linker optimization level.
142 optimization_level() const
144 gold_assert(this->options_valid_);
145 return this->optimization_level_;
148 // Whether the -E/--export-dynamic flag is set.
150 export_dynamic() const
152 gold_assert(this->options_valid_);
153 return this->export_dynamic_;
156 // Whether we are doing a static link--a link in which none of the
157 // input files are shared libraries. This is only known after we
158 // have seen all the input files.
160 doing_static_link() const
162 gold_assert(this->is_doing_static_link_valid_);
163 return this->doing_static_link_;
166 // The size of the output file we are generating. This should
171 gold_assert(this->is_size_and_endian_valid_);
175 // Whether the output is big endian.
177 is_big_endian() const
179 gold_assert(this->is_size_and_endian_valid_);
180 return this->is_big_endian_;
183 // Set values recorded from options.
185 set_from_options(const General_options*);
187 // Set whether we are doing a static link.
189 set_doing_static_link(bool doing_static_link);
191 // Set the size and endianness.
193 set_size_and_endianness(int size, bool is_big_endian);
196 // The types of output files.
197 enum Output_file_type
201 // Generating executable.
203 // Generating shared library.
205 // Generating object file.
209 // Which symbols to strip.
214 // Don't strip any symbols.
216 // Strip all symbols.
218 // Strip debugging information.
222 // A pointer to the error handling object.
225 // Whether the fields set from the options are valid.
227 // The output file name.
228 const char* output_file_name_;
229 // The type of the output file.
230 Output_file_type output_file_type_;
231 // The target system root directory.
232 std::string sysroot_;
233 // Which symbols to strip.
235 // Whether to allow undefined references from shared libraries.
236 bool allow_shlib_undefined_;
237 // Whether we are doing a symbolic link.
239 // Whether we try to detect One Definition Rule violations.
240 bool detect_odr_violations_;
241 // The optimization level.
242 int optimization_level_;
243 // Whether the -E/--export-dynamic flag is set.
244 bool export_dynamic_;
246 // Whether the doing_static_link_ field is valid.
247 bool is_doing_static_link_valid_;
248 // Whether we are doing a static link.
249 bool doing_static_link_;
250 // Whether the size_ and is_big_endian_ fields are valid.
251 bool is_size_and_endian_valid_;
252 // The size of the output file--32 or 64.
254 // Whether the output file is big endian.
258 // This is a global variable.
259 extern const Parameters* parameters;
261 // Initialize the global variable.
262 extern void initialize_parameters(Errors*);
265 extern void set_parameters_from_options(const General_options*);
267 // Set the size and endianness of the global parameters variable.
268 extern void set_parameters_size_and_endianness(int size, bool is_big_endian);
270 // Set whether we are doing a static link.
271 extern void set_parameters_doing_static_link(bool doing_static_link);
273 } // End namespace gold.
275 #endif // !defined(GOLD_PARAMETERS_H)