From Cary Coutant: preliminary shared library support.
[external/binutils.git] / gold / parameters.h
1 // parameters.h -- general parameters for a link using gold  -*- C++ -*-
2
3 // Copyright 2006, 2007 Free Software Foundation, Inc.
4 // Written by Ian Lance Taylor <iant@google.com>.
5
6 // This file is part of gold.
7
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.
12
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.
17
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.
22
23 #ifndef GOLD_PARAMETERS_H
24 #define GOLD_PARAMETERS_H
25
26 namespace gold
27 {
28
29 class General_options;
30 class Errors;
31
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.
39
40 class Parameters
41 {
42  public:
43   Parameters(const General_options*, Errors*);
44
45   // Return the error object.
46   Errors*
47   errors() const
48   { return this->errors_; }
49
50   // Return the output file name.
51   const char*
52   output_file_name() const
53   { return this->output_file_name_; }
54
55   // Whether we are generating a regular executable.
56   bool
57   output_is_executable() const
58   { return this->output_file_type_ == OUTPUT_EXECUTABLE; }
59
60   // Whether we are generating a shared library.
61   bool
62   output_is_shared() const
63   { return this->output_file_type_ == OUTPUT_SHARED; }
64
65   // Whether we are generating an object file.
66   bool
67   output_is_object() const
68   { return this->output_file_type_ == OUTPUT_OBJECT; }
69
70   // Whether we are generating position-independent output.
71   // This is the case when generating either a shared library
72   // or a regular executable with the --pic-executable option.
73   // FIXME: support --pic-executable
74   bool
75   output_is_position_independent() const
76   { return output_is_shared(); }
77
78   // The target system root directory.  This is NULL if there isn't
79   // one.
80   const std::string&
81   sysroot() const
82   { return this->sysroot_; }
83
84   // Whether to strip all symbols.
85   bool
86   strip_all() const
87   { return this->strip_ == STRIP_ALL; }
88
89   // Whether to strip debugging information.
90   bool
91   strip_debug() const
92   { return this->strip_ == STRIP_ALL || this->strip_ == STRIP_DEBUG; }
93
94   // Whether we are doing a static link--a link in which none of the
95   // input files are shared libraries.  This is only known after we
96   // have seen all the input files.
97   bool
98   doing_static_link() const
99   {
100     gold_assert(this->is_doing_static_link_valid_);
101     return this->doing_static_link_;
102   }
103
104   // The size of the output file we are generating.  This should
105   // return 32 or 64.
106   int
107   get_size() const
108   {
109     gold_assert(this->is_size_and_endian_valid_);
110     return this->size_;
111   }
112
113   // Whether the output is big endian.
114   bool
115   is_big_endian() const
116   {
117     gold_assert(this->is_size_and_endian_valid_);
118     return this->is_big_endian_;
119   }
120
121   // The general linker optimization level.
122   int
123   optimization_level() const
124   { return this->optimization_level_; }
125
126   // Whether the -E/--export-dynamic flag is set.
127   bool
128   export_dynamic() const
129   { return this->export_dynamic_; }
130
131   // Set whether we are doing a static link.
132   void
133   set_doing_static_link(bool doing_static_link);
134
135   // Set the size and endianness.
136   void
137   set_size_and_endianness(int size, bool is_big_endian);
138
139  private:
140   // The types of output files.
141   enum Output_file_type
142     {
143       // Generating executable.
144       OUTPUT_EXECUTABLE,
145       // Generating shared library.
146       OUTPUT_SHARED,
147       // Generating object file.
148       OUTPUT_OBJECT
149     };
150
151   // Which symbols to strip.
152   enum Strip
153   {
154     // Don't strip any symbols.
155     STRIP_NONE,
156     // Strip all symbols.
157     STRIP_ALL,
158     // Strip debugging information.
159     STRIP_DEBUG
160   };
161
162   // A pointer to the error handling object.
163   Errors* errors_;
164
165   // The output file name.
166   const char* output_file_name_;
167   // The type of the output file.
168   Output_file_type output_file_type_;
169   // The target system root directory.
170   std::string sysroot_;
171   // Which symbols to strip.
172   Strip strip_;
173
174   // Whether the doing_static_link_ field is valid.
175   bool is_doing_static_link_valid_;
176   // Whether we are doing a static link.
177   bool doing_static_link_;
178   // Whether the size_ and is_big_endian_ fields are valid.
179   bool is_size_and_endian_valid_;
180   // The size of the output file--32 or 64.
181   int size_;
182   // Whether the output file is big endian.
183   bool is_big_endian_;
184   // The optimization level.
185   int optimization_level_;
186   // Whether the -E/--export-dynamic flag is set.
187   bool export_dynamic_;
188 };
189
190 // This is a global variable.
191 extern const Parameters* parameters;
192
193 // Initialize the global variable.
194 extern void initialize_parameters(const General_options*, Errors*);
195
196 // Set the size and endianness of the global parameters variable.
197 extern void set_parameters_size_and_endianness(int size, bool is_big_endian);
198
199 // Set whether we are doing a static link.
200 extern void set_parameters_doing_static_link(bool doing_static_link);
201
202 } // End namespace gold.
203
204 #endif // !defined(GOLD_PARAMETERS_H)