2007-10-03 H.J. Lu <hongjiu.lu@intel.com>
[binutils.git] / gold / parameters.h
blob2a21607bb2b2712d5ca41f291dc24d510b1dcd9c
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
26 namespace gold
29 class General_options;
31 // Here we define the Parameters class which simply holds simple
32 // general parameters which apply to the entire link. We use a global
33 // variable for this. This is in contrast to the General_options
34 // class, which holds the complete state of position independent
35 // command line options. The hope is that Parameters will stay fairly
36 // simple, so that if this turns into a library it will be clear how
37 // these parameters should be set.
39 class Parameters
41 public:
42 Parameters(const General_options*);
44 // Whether we are generating a regular executable.
45 bool
46 output_is_executable() const
47 { return this->output_file_type_ == OUTPUT_EXECUTABLE; }
49 // Whether we are generating a shared library.
50 bool
51 output_is_shared() const
52 { return this->output_file_type_ == OUTPUT_SHARED; }
54 // Whether we are generating an object file.
55 bool
56 output_is_object() const
57 { return this->output_file_type_ == OUTPUT_OBJECT; }
59 // Whether we are doing a static link--a link in which none of the
60 // input files are shared libraries. This is only known after we
61 // have seen all the input files.
62 bool
63 doing_static_link() const
65 gold_assert(this->is_doing_static_link_valid_);
66 return this->doing_static_link_;
69 // The size of the output file we are generating. This should
70 // return 32 or 64.
71 int
72 get_size() const
74 gold_assert(this->is_size_and_endian_valid_);
75 return this->size_;
78 // Whether the output is big endian.
79 bool
80 is_big_endian() const
82 gold_assert(this->is_size_and_endian_valid_);
83 return this->is_big_endian_;
86 // The general linker optimization level.
87 int
88 optimization_level() const
89 { return this->optimization_level_; }
91 // Set whether we are doing a static link.
92 void
93 set_doing_static_link(bool doing_static_link);
95 // Set the size and endianness.
96 void
97 set_size_and_endianness(int size, bool is_big_endian);
99 private:
100 // The types of output files.
101 enum Output_file_type
103 // Generating executable.
104 OUTPUT_EXECUTABLE,
105 // Generating shared library.
106 OUTPUT_SHARED,
107 // Generating object file.
108 OUTPUT_OBJECT
111 // The type of the output file.
112 Output_file_type output_file_type_;
113 // Whether the doing_static_link_ field is valid.
114 bool is_doing_static_link_valid_;
115 // Whether we are doing a static link.
116 bool doing_static_link_;
117 // Whether the size_ and is_big_endian_ fields are valid.
118 bool is_size_and_endian_valid_;
119 // The size of the output file--32 or 64.
120 int size_;
121 // Whether the output file is big endian.
122 bool is_big_endian_;
123 // The optimization level.
124 int optimization_level_;
127 // This is a global variable.
128 extern const Parameters* parameters;
130 // Initialize the global variable.
131 extern void initialize_parameters(const General_options*);
133 // Set the size and endianness of the global parameters variable.
134 extern void set_parameters_size_and_endianness(int size, bool is_big_endian);
136 // Set whether we are doing a static link.
137 extern void set_parameters_doing_static_link(bool doing_static_link);
139 } // End namespace gold.
141 #endif // !defined(GOLD_PARAMATERS_H)