OSDN Git Service

From Craig Silverstein: implement -Ttext.
[pf3gnuchains/pf3gnuchains3x.git] / gold / options.cc
1 // options.c -- handle command line options for gold
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 #include "gold.h"
24
25 #include <iostream>
26 #include <sys/stat.h>
27 #include "filenames.h"
28 #include "libiberty.h"
29
30 #include "options.h"
31
32 namespace gold
33 {
34
35 // The information we keep for a single command line option.
36
37 struct options::One_option
38 {
39   // The single character option name, or '\0' if this is only a long
40   // option.
41   char short_option;
42
43   // The long option name, or NULL if this is only a short option.
44   const char* long_option;
45
46   // Description of the option for --help output, or NULL if there is none.
47   const char* doc;
48
49   // How to print the option name in --help output, or NULL to use the
50   // default.
51   const char* help_output;
52
53   // Long option dash control.  This is ignored if long_option is
54   // NULL.
55   enum
56     {
57       // Long option normally takes one dash; two dashes are also
58       // accepted.
59       ONE_DASH,
60       // Long option normally takes two dashes; one dash is also
61       // accepted.
62       TWO_DASHES,
63       // Long option always takes two dashes.
64       EXACTLY_TWO_DASHES
65     } dash;
66
67   // Function for special handling, or NULL.  Returns the number of
68   // arguments to skip.  This will normally be at least 1, but it may
69   // be 0 if this function changes *argv.  ARG points to the location
70   // in *ARGV where the option starts, which may be helpful for a
71   // short option.
72   int (*special)(int argc, char** argv, char *arg, Command_line*);
73
74   // If this is a position independent option which does not take an
75   // argument, this is the member function to call to record it.
76   void (General_options::*general_noarg)();
77
78   // If this is a position independent function which takes an
79   // argument, this is the member function to call to record it.
80   void (General_options::*general_arg)(const char*);
81
82   // If this is a position dependent option which does not take an
83   // argument, this is the member function to call to record it.
84   void (Position_dependent_options::*dependent_noarg)();
85
86   // If this is a position dependent option which takes an argument,
87   // this is the member function to record it.
88   void (Position_dependent_options::*dependent_arg)(const char*);
89
90   // Return whether this option takes an argument.
91   bool
92   takes_argument() const
93   { return this->general_arg != NULL || this->dependent_arg != NULL; }
94 };
95
96 class options::Command_line_options
97 {
98  public:
99   static const One_option options[];
100   static const int options_size;
101 };
102
103 } // End namespace gold.
104
105 namespace
106 {
107
108 // Handle the special -l option, which adds an input file.
109
110 int
111 library(int argc, char** argv, char* arg, gold::Command_line* cmdline)
112 {
113   return cmdline->process_l_option(argc, argv, arg);
114 }
115
116 // Handle the special --start-group option.
117
118 int
119 start_group(int, char**, char* arg, gold::Command_line* cmdline)
120 {
121   cmdline->start_group(arg);
122   return 1;
123 }
124
125 // Handle the special --end-group option.
126
127 int
128 end_group(int, char**, char* arg, gold::Command_line* cmdline)
129 {
130   cmdline->end_group(arg);
131   return 1;
132 }
133
134 // Report usage information for ld --help, and exit.
135
136 int
137 help(int, char**, char*, gold::Command_line*)
138 {
139   printf(_("Usage: %s [options] file...\nOptions:\n"), gold::program_name);
140
141   const int options_size = gold::options::Command_line_options::options_size;
142   const gold::options::One_option* options =
143     gold::options::Command_line_options::options;
144   for (int i = 0; i < options_size; ++i)
145     {
146       if (options[i].doc == NULL)
147         continue;
148
149       printf("  ");
150       int len = 2;
151       bool comma = false;
152
153       int j = i;
154       do
155         {
156           if (options[j].help_output != NULL)
157             {
158               if (comma)
159                 {
160                   printf(", ");
161                   len += 2;
162                 }
163               printf(options[j].help_output);
164               len += std::strlen(options[i].help_output);
165               comma = true;
166             }
167           else
168             {
169               if (options[j].short_option != '\0')
170                 {
171                   if (comma)
172                     {
173                       printf(", ");
174                       len += 2;
175                     }
176                   printf("-%c", options[j].short_option);
177                   len += 2;
178                   comma = true;
179                 }
180
181               if (options[j].long_option != NULL)
182                 {
183                   if (comma)
184                     {
185                       printf(", ");
186                       len += 2;
187                     }
188                   if (options[j].dash == gold::options::One_option::ONE_DASH)
189                     {
190                       printf("-");
191                       ++len;
192                     }
193                   else
194                     {
195                       printf("--");
196                       len += 2;
197                     }
198                   printf("%s", options[j].long_option);
199                   len += std::strlen(options[j].long_option);
200                   comma = true;
201                 }
202             }
203           ++j;
204         }
205       while (j < options_size && options[j].doc == NULL);
206
207       if (len >= 30)
208         {
209           printf("\n");
210           len = 0;
211         }
212       for (; len < 30; ++len)
213         std::putchar(' ');
214
215       std::puts(options[i].doc);
216     }
217
218   ::exit(0);
219
220   return 0;
221 }
222
223 // Report version information.
224
225 int
226 version(int, char**, char* opt, gold::Command_line*)
227 {
228   gold::print_version(opt[0] == 'v' && opt[1] == '\0');
229   ::exit(0);
230   return 0;
231 }
232
233 // If the default sysroot is relocatable, try relocating it based on
234 // the prefix FROM.
235
236 char*
237 get_relative_sysroot(const char* from)
238 {
239   char* path = make_relative_prefix(gold::program_name, from,
240                                     TARGET_SYSTEM_ROOT);
241   if (path != NULL)
242     {
243       struct stat s;
244       if (::stat(path, &s) == 0 && S_ISDIR(s.st_mode))
245         return path;
246       free(path);
247     }
248
249   return NULL;
250 }
251
252 // Return the default sysroot.  This is set by the --with-sysroot
253 // option to configure.
254
255 std::string
256 get_default_sysroot()
257 {
258   const char* sysroot = TARGET_SYSTEM_ROOT;
259   if (*sysroot == '\0')
260     return "";
261
262   if (TARGET_SYSTEM_ROOT_RELOCATABLE)
263     {
264       char* path = get_relative_sysroot (BINDIR);
265       if (path == NULL)
266         path = get_relative_sysroot (TOOLBINDIR);
267       if (path != NULL)
268         {
269           std::string ret = path;
270           free(path);
271           return ret;
272         }
273     }
274
275   return sysroot;
276 }
277
278 } // End anonymous namespace.
279
280 namespace gold
281 {
282
283 // Helper macros used to specify the options.  We could also do this
284 // using constructors, but then g++ would generate code to initialize
285 // the array.  We want the array to be initialized statically so that
286 // we get better startup time.
287
288 #define GENERAL_NOARG(short_option, long_option, doc, help, dash, func) \
289   { short_option, long_option, doc, help, options::One_option::dash, \
290       NULL, func, NULL, NULL, NULL }
291 #define GENERAL_ARG(short_option, long_option, doc, help, dash, func)   \
292   { short_option, long_option, doc, help, options::One_option::dash, \
293       NULL, NULL, func, NULL, NULL }
294 #define POSDEP_NOARG(short_option, long_option, doc, help, dash, func)  \
295   { short_option, long_option, doc, help, options::One_option::dash, \
296       NULL,  NULL, NULL, func, NULL }
297 #define POSDEP_ARG(short_option, long_option, doc, help, dash, func)    \
298   { short_option, long_option, doc, help, options::One_option::dash, \
299       NULL, NULL, NULL, NULL, func }
300 #define SPECIAL(short_option, long_option, doc, help, dash, func)       \
301   { short_option, long_option, doc, help, options::One_option::dash, \
302       func, NULL, NULL, NULL, NULL }
303
304 // Here is the actual list of options which we accept.
305
306 const options::One_option
307 options::Command_line_options::options[] =
308 {
309   POSDEP_NOARG('\0', "as-needed",
310                N_("Only set DT_NEEDED for dynamic libs if used"),
311                NULL, TWO_DASHES, &Position_dependent_options::set_as_needed),
312   POSDEP_NOARG('\0', "no-as-needed",
313                N_("Always DT_NEEDED for dynamic libs (default)"),
314                NULL, TWO_DASHES, &Position_dependent_options::clear_as_needed),
315   GENERAL_NOARG('E', "export-dynamic", N_("Export all dynamic symbols"),
316                 NULL, TWO_DASHES, &General_options::set_export_dynamic),
317   GENERAL_NOARG('\0', "eh-frame-hdr", N_("Create exception frame header"),
318                 NULL, TWO_DASHES, &General_options::set_create_eh_frame_hdr),
319   GENERAL_ARG('I', "dynamic-linker", N_("Set dynamic linker path"),
320               N_("-I PROGRAM, --dynamic-linker PROGRAM"), TWO_DASHES,
321               &General_options::set_dynamic_linker),
322   SPECIAL('l', "library", N_("Search for library LIBNAME"),
323           N_("-lLIBNAME, --library LIBNAME"), TWO_DASHES,
324           &library),
325   GENERAL_ARG('L', "library-path", N_("Add directory to search path"),
326               N_("-L DIR, --library-path DIR"), TWO_DASHES,
327               &General_options::add_to_search_path),
328   GENERAL_ARG('m', NULL, N_("Ignored for compatibility"), NULL, ONE_DASH,
329               &General_options::ignore),
330   GENERAL_ARG('o', "output", N_("Set output file name"),
331               N_("-o FILE, --output FILE"), TWO_DASHES,
332               &General_options::set_output_file_name),
333   GENERAL_ARG('O', NULL, N_("Optimize output file size"),
334               N_("-O level"), ONE_DASH,
335               &General_options::set_optimization_level),
336   GENERAL_NOARG('r', NULL, N_("Generate relocatable output"), NULL,
337                 ONE_DASH, &General_options::set_relocatable),
338   GENERAL_ARG('R', "rpath", N_("Add DIR to runtime search path"),
339               N_("-R DIR, -rpath DIR"), ONE_DASH,
340               &General_options::add_to_rpath),
341   GENERAL_ARG('\0', "rpath-link",
342               N_("Add DIR to link time shared library search path"),
343               N_("--rpath-link DIR"), TWO_DASHES,
344               &General_options::add_to_rpath_link),
345   GENERAL_NOARG('s', "strip-all", N_("Strip all symbols"), NULL,
346                 TWO_DASHES, &General_options::set_strip_all),
347   GENERAL_NOARG('S', "strip-debug", N_("Strip debugging information"), NULL,
348                 TWO_DASHES, &General_options::set_strip_debug),
349   GENERAL_NOARG('\0', "shared", N_("Generate shared library"),
350                 NULL, ONE_DASH, &General_options::set_shared),
351   GENERAL_NOARG('\0', "static", N_("Do not link against shared libraries"),
352                 NULL, ONE_DASH, &General_options::set_static),
353   GENERAL_NOARG('\0', "stats", N_("Print resource usage statistics"),
354                 NULL, TWO_DASHES, &General_options::set_stats),
355   GENERAL_ARG('\0', "sysroot", N_("Set target system root directory"),
356               N_("--sysroot DIR"), TWO_DASHES, &General_options::set_sysroot),
357   GENERAL_ARG('\0', "Ttext", N_("Set the address of the .text section"),
358               N_("-Ttext ADDRESS"), ONE_DASH,
359               &General_options::set_text_segment_address),
360   POSDEP_NOARG('\0', "whole-archive",
361                N_("Include all archive contents"),
362                NULL, TWO_DASHES,
363                &Position_dependent_options::set_whole_archive),
364   POSDEP_NOARG('\0', "no-whole-archive",
365                N_("Include only needed archive contents"),
366                NULL, TWO_DASHES,
367                &Position_dependent_options::clear_whole_archive),
368   SPECIAL('(', "start-group", N_("Start a library search group"), NULL,
369           TWO_DASHES, &start_group),
370   SPECIAL(')', "end-group", N_("End a library search group"), NULL,
371           TWO_DASHES, &end_group),
372   SPECIAL('\0', "help", N_("Report usage information"), NULL,
373           TWO_DASHES, &help),
374   SPECIAL('v', "version", N_("Report version information"), NULL,
375           TWO_DASHES, &version)
376 };
377
378 const int options::Command_line_options::options_size =
379   sizeof (options) / sizeof (options[0]);
380
381 // The default values for the general options.
382
383 General_options::General_options()
384   : export_dynamic_(false),
385     dynamic_linker_(NULL),
386     search_path_(),
387     optimization_level_(0),
388     output_file_name_("a.out"),
389     is_relocatable_(false),
390     strip_(STRIP_NONE),
391     create_eh_frame_hdr_(false),
392     rpath_(),
393     rpath_link_(),
394     is_shared_(false),
395     is_static_(false),
396     print_stats_(false),
397     sysroot_(),
398     text_segment_address_(-1U)   // -1 indicates value not set by user
399 {
400 }
401
402 // The default values for the position dependent options.
403
404 Position_dependent_options::Position_dependent_options()
405   : do_static_search_(false),
406     as_needed_(false),
407     include_whole_archive_(false)
408 {
409 }
410
411 // Add the sysroot, if any, to the search paths.
412
413 void
414 General_options::add_sysroot()
415 {
416   if (this->sysroot_.empty())
417     {
418       this->sysroot_ = get_default_sysroot();
419       if (this->sysroot_.empty())
420         return;
421     }
422
423   const char* sysroot = this->sysroot_.c_str();
424   char* canonical_sysroot = lrealpath(sysroot);
425
426   for (Dir_list::iterator p = this->search_path_.begin();
427        p != this->search_path_.end();
428        ++p)
429     p->add_sysroot(sysroot, canonical_sysroot);
430
431   free(canonical_sysroot);
432 }
433
434 // Search_directory methods.
435
436 // This is called if we have a sysroot.  Apply the sysroot if
437 // appropriate.  Record whether the directory is in the sysroot.
438
439 void
440 Search_directory::add_sysroot(const char* sysroot,
441                               const char* canonical_sysroot)
442 {
443   gold_assert(*sysroot != '\0');
444   if (this->put_in_sysroot_)
445     {
446       if (!IS_DIR_SEPARATOR(this->name_[0])
447           && !IS_DIR_SEPARATOR(sysroot[strlen(sysroot) - 1]))
448         this->name_ = '/' + this->name_;
449       this->name_ = sysroot + this->name_;
450       this->is_in_sysroot_ = true;
451     }
452   else
453     {
454       // Check whether this entry is in the sysroot.  To do this
455       // correctly, we need to use canonical names.  Otherwise we will
456       // get confused by the ../../.. paths that gcc tends to use.
457       char* canonical_name = lrealpath(this->name_.c_str());
458       int canonical_name_len = strlen(canonical_name);
459       int canonical_sysroot_len = strlen(canonical_sysroot);
460       if (canonical_name_len > canonical_sysroot_len
461           && IS_DIR_SEPARATOR(canonical_name[canonical_sysroot_len]))
462         {
463           canonical_name[canonical_sysroot_len] = '\0';
464           if (FILENAME_CMP(canonical_name, canonical_sysroot) == 0)
465             this->is_in_sysroot_ = true;
466         }
467       free(canonical_name);
468     }
469 }
470
471 // Input_arguments methods.
472
473 // Add a file to the list.
474
475 void
476 Input_arguments::add_file(const Input_file_argument& file)
477 {
478   if (!this->in_group_)
479     this->input_argument_list_.push_back(Input_argument(file));
480   else
481     {
482       gold_assert(!this->input_argument_list_.empty());
483       gold_assert(this->input_argument_list_.back().is_group());
484       this->input_argument_list_.back().group()->add_file(file);
485     }
486 }
487
488 // Start a group.
489
490 void
491 Input_arguments::start_group()
492 {
493   gold_assert(!this->in_group_);
494   Input_file_group* group = new Input_file_group();
495   this->input_argument_list_.push_back(Input_argument(group));
496   this->in_group_ = true;
497 }
498
499 // End a group.
500
501 void
502 Input_arguments::end_group()
503 {
504   gold_assert(this->in_group_);
505   this->in_group_ = false;
506 }
507
508 // Command_line options.
509
510 Command_line::Command_line()
511   : options_(), position_options_(), inputs_()
512 {
513 }
514
515 // Process the command line options.
516
517 void
518 Command_line::process(int argc, char** argv)
519 {
520   const int options_size = options::Command_line_options::options_size;
521   const options::One_option* options =
522     options::Command_line_options::options;
523   bool no_more_options = false;
524   int i = 0;
525   while (i < argc)
526     {
527       if (argv[i][0] != '-' || no_more_options)
528         {
529           this->add_file(argv[i], false);
530           ++i;
531           continue;
532         }
533
534       // Option starting with '-'.
535       int dashes = 1;
536       if (argv[i][1] == '-')
537         {
538           dashes = 2;
539           if (argv[i][2] == '\0')
540             {
541               no_more_options = true;
542               continue;
543             }
544         }
545
546       // Look for a long option match.
547       char* opt = argv[i] + dashes;
548       char first = opt[0];
549       int skiparg = 0;
550       char* arg = strchr(opt, '=');
551       bool argument_with_equals = arg != NULL;
552       if (arg != NULL)
553         {
554           *arg = '\0';
555           ++arg;
556         }
557       else if (i + 1 < argc)
558         {
559           arg = argv[i + 1];
560           skiparg = 1;
561         }
562
563       int j;
564       for (j = 0; j < options_size; ++j)
565         {
566           if (options[j].long_option != NULL
567               && (dashes == 2
568                   || (options[j].dash
569                       != options::One_option::EXACTLY_TWO_DASHES))
570               && first == options[j].long_option[0]
571               && strcmp(opt, options[j].long_option) == 0)
572             {
573               if (options[j].special)
574                 i += options[j].special(argc - 1, argv + i, opt, this);
575               else
576                 {
577                   if (!options[j].takes_argument())
578                     {
579                       if (argument_with_equals)
580                         this->usage(_("unexpected argument"), argv[i]);
581                       arg = NULL;
582                       skiparg = 0;
583                     }
584                   else
585                     {
586                       if (arg == NULL)
587                         this->usage(_("missing argument"), argv[i]);
588                     }
589                   this->apply_option(options[j], arg);
590                   i += skiparg + 1;
591                 }
592               break;
593             }
594         }
595       if (j < options_size)
596         continue;
597
598       // If we saw two dashes, we need to see a long option.
599       if (dashes == 2)
600         this->usage(_("unknown option"), argv[i]);
601
602       // Look for a short option match.  There may be more than one
603       // short option in a given argument.
604       bool done = false;
605       char* s = argv[i] + 1;
606       ++i;
607       while (*s != '\0' && !done)
608         {
609           char opt = *s;
610           int j;
611           for (j = 0; j < options_size; ++j)
612             {
613               if (options[j].short_option == opt)
614                 {
615                   if (options[j].special)
616                     {
617                       // Undo the argument skip done above.
618                       --i;
619                       i += options[j].special(argc - i, argv + i, s, this);
620                       done = true;
621                     }
622                   else
623                     {
624                       arg = NULL;
625                       if (options[j].takes_argument())
626                         {
627                           if (s[1] != '\0')
628                             {
629                               arg = s + 1;
630                               done = true;
631                             }
632                           else if (i < argc)
633                             {
634                               arg = argv[i];
635                               ++i;
636                             }
637                           else
638                             this->usage(_("missing argument"), opt);
639                         }
640                       this->apply_option(options[j], arg);
641                     }
642                   break;
643                 }
644             }
645
646           if (j >= options_size)
647             this->usage(_("unknown option"), *s);
648
649           ++s;
650         }
651     }
652
653   if (this->inputs_.in_group())
654     {
655       fprintf(stderr, _("%s: missing group end"), program_name);
656       this->usage();
657     }
658
659   // FIXME: We should only do this when configured in native mode.
660   this->options_.add_to_search_path_with_sysroot("/lib");
661   this->options_.add_to_search_path_with_sysroot("/usr/lib");
662
663   this->options_.add_sysroot();
664
665   // Ensure options don't contradict each other and are otherwise kosher.
666   this->normalize_options();
667 }
668
669 // Ensure options don't contradict each other and are otherwise kosher.
670
671 void
672 Command_line::normalize_options()
673 {
674   // If the user specifies both -s and -r, convert the -s as -S.
675   // -r requires us to keep externally visible symbols!
676   if (this->options_.strip_all() && this->options_.is_relocatable())
677     {
678       // Clears the strip_all() status, replacing it with strip_debug().
679       this->options_.set_strip_debug();
680     }
681
682   // FIXME: we can/should be doing a lot more sanity checking here.
683 }
684
685
686 // Apply a command line option.
687
688 void
689 Command_line::apply_option(const options::One_option& opt,
690                            const char* arg)
691 {
692   if (arg == NULL)
693     {
694       if (opt.general_noarg)
695         (this->options_.*(opt.general_noarg))();
696       else if (opt.dependent_noarg)
697         (this->position_options_.*(opt.dependent_noarg))();
698       else
699         gold_unreachable();
700     }
701   else
702     {
703       if (opt.general_arg)
704         (this->options_.*(opt.general_arg))(arg);
705       else if (opt.dependent_arg)
706         (this->position_options_.*(opt.dependent_arg))(arg);
707       else
708         gold_unreachable();
709     }
710 }
711
712 // Add an input file or library.
713
714 void
715 Command_line::add_file(const char* name, bool is_lib)
716 {
717   Input_file_argument file(name, is_lib, "", this->position_options_);
718   this->inputs_.add_file(file);
719 }
720
721 // Handle the -l option, which requires special treatment.
722
723 int
724 Command_line::process_l_option(int argc, char** argv, char* arg)
725 {
726   int ret;
727   const char* libname;
728   if (arg[1] != '\0')
729     {
730       ret = 1;
731       libname = arg + 1;
732     }
733   else if (argc > 1)
734     {
735       ret = 2;
736       libname = argv[argc + 1];
737     }
738   else
739     this->usage(_("missing argument"), arg);
740
741   this->add_file(libname, true);
742
743   return ret;
744 }
745
746 // Handle the --start-group option.
747
748 void
749 Command_line::start_group(const char* arg)
750 {
751   if (this->inputs_.in_group())
752     this->usage(_("may not nest groups"), arg);
753   this->inputs_.start_group();
754 }
755
756 // Handle the --end-group option.
757
758 void
759 Command_line::end_group(const char* arg)
760 {
761   if (!this->inputs_.in_group())
762     this->usage(_("group end without group start"), arg);
763   this->inputs_.end_group();
764 }
765
766 // Report a usage error.  */
767
768 void
769 Command_line::usage()
770 {
771   fprintf(stderr,
772           _("%s: use the --help option for usage information\n"),
773           program_name);
774   ::exit(1);
775 }
776
777 void
778 Command_line::usage(const char* msg, const char *opt)
779 {
780   fprintf(stderr,
781           _("%s: %s: %s\n"),
782           program_name, opt, msg);
783   this->usage();
784 }
785
786 void
787 Command_line::usage(const char* msg, char opt)
788 {
789   fprintf(stderr,
790           _("%s: -%c: %s\n"),
791           program_name, opt, msg);
792   this->usage();
793 }
794
795 } // End namespace gold.