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
;
33 // Here we define the Parameters class which simply holds simple
34 // general parameters which apply to the entire link. We use a global
35 // variable for this. This is in contrast to the General_options
36 // class, which holds the complete state of position independent
37 // command line options. The hope is that Parameters will stay fairly
38 // simple, so that if this turns into a library it will be clear how
39 // these parameters should be set.
46 // Return the error object.
49 { return this->errors_
; }
51 // Whether the options are valid. This should not normally be
52 // called, but it is needed by gold_exit.
55 { return this->options_valid_
; }
57 // Whether to use threads.
61 gold_assert(this->options_valid_
);
62 return this->threads_
;
65 // Return the output file name.
67 output_file_name() const
69 gold_assert(this->options_valid_
);
70 return this->output_file_name_
;
73 // Whether we are generating a regular executable.
75 output_is_executable() const
77 gold_assert(this->output_file_type_
!= OUTPUT_INVALID
);
78 return this->output_file_type_
== OUTPUT_EXECUTABLE
;
81 // Whether we are generating a shared library.
83 output_is_shared() const
85 gold_assert(this->output_file_type_
!= OUTPUT_INVALID
);
86 return this->output_file_type_
== OUTPUT_SHARED
;
89 // Whether we are generating an object file.
91 output_is_object() const
93 gold_assert(this->output_file_type_
!= OUTPUT_INVALID
);
94 return this->output_file_type_
== OUTPUT_OBJECT
;
97 // Whether we are generating position-independent output.
98 // This is the case when generating either a shared library
99 // or a regular executable with the --pic-executable option.
100 // FIXME: support --pic-executable
102 output_is_position_independent() const
103 { return output_is_shared(); }
105 // The target system root directory. This is NULL if there isn't
110 gold_assert(this->options_valid_
);
111 return this->sysroot_
;
114 // Whether to strip all symbols.
118 gold_assert(this->strip_
!= STRIP_INVALID
);
119 return this->strip_
== STRIP_ALL
;
122 // Whether to strip debugging information.
126 gold_assert(this->strip_
!= STRIP_INVALID
);
127 return this->strip_
== STRIP_ALL
|| this->strip_
== STRIP_DEBUG
;
130 // Whether to strip debugging information that's not used by gdb.
132 strip_debug_gdb() const
134 gold_assert(this->strip_
!= STRIP_INVALID
);
135 return this->strip_debug() || this->strip_
== STRIP_DEBUG_UNUSED_BY_GDB
;
138 // Whether to permit unresolved references from shared libraries.
140 allow_shlib_undefined() const
142 gold_assert(this->options_valid_
);
143 return this->allow_shlib_undefined_
;
146 // Whether we are doing a symbolic link, in which all defined
147 // symbols are bound locally.
151 gold_assert(this->options_valid_
);
152 return this->symbolic_
;
155 // Whether we should demangle C++ symbols in our log messages.
158 { return this->demangle_
; }
160 // Whether we should try to detect violations of the One Definition Rule.
162 detect_odr_violations() const
164 gold_assert(this->options_valid_
);
165 return this->detect_odr_violations_
;
168 // The general linker optimization level.
170 optimization_level() const
172 gold_assert(this->options_valid_
);
173 return this->optimization_level_
;
176 // Whether the -E/--export-dynamic flag is set.
178 export_dynamic() const
180 gold_assert(this->options_valid_
);
181 return this->export_dynamic_
;
184 // Return the debug flags. These are the flags for which we should
185 // report internal debugging information.
189 gold_assert(this->options_valid_
);
193 // Whether we are doing a static link--a link in which none of the
194 // input files are shared libraries. This is only known after we
195 // have seen all the input files.
197 doing_static_link() const
199 gold_assert(this->is_doing_static_link_valid_
);
200 return this->doing_static_link_
;
203 // The target of the output file we are generating.
207 gold_assert(this->is_target_valid_
);
208 return this->target_
;
211 // The size of the output file we are generating. This should
216 gold_assert(this->is_target_valid_
);
220 // Whether the output is big endian.
222 is_big_endian() const
224 gold_assert(this->is_target_valid_
);
225 return this->is_big_endian_
;
228 // Set values recorded from options.
230 set_from_options(const General_options
*);
232 // Set whether we are doing a static link.
234 set_doing_static_link(bool doing_static_link
);
238 set_target(Target
* target
);
241 // The types of output files.
242 enum Output_file_type
246 // Generating executable.
248 // Generating shared library.
250 // Generating object file.
254 // Which symbols to strip.
259 // Don't strip any symbols.
261 // Strip all symbols.
263 // Strip debugging information.
265 // Strip debugging information that's not used by gdb (at least <= 6.7)
266 STRIP_DEBUG_UNUSED_BY_GDB
269 // A pointer to the error handling object.
272 // Whether the fields set from the options are valid.
274 // Whether to use threads.
276 // The output file name.
277 const char* output_file_name_
;
278 // The type of the output file.
279 Output_file_type output_file_type_
;
280 // The target system root directory.
281 std::string sysroot_
;
282 // Which symbols to strip.
284 // Whether to allow undefined references from shared libraries.
285 bool allow_shlib_undefined_
;
286 // Whether we are doing a symbolic link.
288 // Whether we should demangle C++ symbols in our log messages.
290 // Whether we try to detect One Definition Rule violations.
291 bool detect_odr_violations_
;
292 // The optimization level.
293 int optimization_level_
;
294 // Whether the -E/--export-dynamic flag is set.
295 bool export_dynamic_
;
299 // Whether the doing_static_link_ field is valid.
300 bool is_doing_static_link_valid_
;
301 // Whether we are doing a static link.
302 bool doing_static_link_
;
303 // Whether the target_ field is valid.
304 bool is_target_valid_
;
307 // The size of the output file--32 or 64.
309 // Whether the output file is big endian.
313 // This is a global variable.
314 extern const Parameters
* parameters
;
316 // Initialize the global variable.
317 extern void initialize_parameters(Errors
*);
320 extern void set_parameters_from_options(const General_options
*);
322 // Set the target recorded in the global parameters variable.
323 extern void set_parameters_target(Target
* target
);
325 // Set whether we are doing a static link.
326 extern void set_parameters_doing_static_link(bool doing_static_link
);
328 // Return whether we are doing a particular debugging type. The
329 // argument is one of the flags from debug.h.
332 is_debugging_enabled(unsigned int type
)
333 { return (parameters
->debug() & type
) != 0; }
335 } // End namespace gold.
337 #endif // !defined(GOLD_PARAMETERS_H)