aboutsummaryrefslogtreecommitdiff
path: root/gold/options.h
blob: 1b3f39686e2544b2154bbd316b0b00f4a09ce639 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
// options.h -- handle command line options for gold  -*- C++ -*-

// Copyright 2006, 2007, 2008 Free Software Foundation, Inc.
// Written by Ian Lance Taylor <iant@google.com>.

// This file is part of gold.

// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 3 of the License, or
// (at your option) any later version.

// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
// MA 02110-1301, USA.

// Command_line
//   Holds everything we get from the command line.
// General_options (from Command_line::options())
//   Options which are not position dependent.
// Input_argument (from Command_line::inputs())
//   The list of input files, including -l options.
// Position_dependent_options (from Input_argument::options())
//   Position dependent options which apply to this argument.

#ifndef GOLD_OPTIONS_H
#define GOLD_OPTIONS_H

#include <cstdlib>
#include <list>
#include <string>
#include <vector>

#include "elfcpp.h"
#include "script.h"

namespace gold
{

class Command_line;
class Input_file_group;
class Position_dependent_options;
class Target;

namespace options
{

class Command_line_options;
struct One_option;
struct One_z_option;
struct One_debug_option;

} // End namespace gold::options.

// A directory to search.  For each directory we record whether it is
// in the sysroot.  We need to know this so that, if a linker script
// is found within the sysroot, we will apply the sysroot to any files
// named by that script.

class Search_directory
{
 public:
  // We need a default constructor because we put this in a
  // std::vector.
  Search_directory()
    : name_(NULL), put_in_sysroot_(false), is_in_sysroot_(false)
  { }

  // This is the usual constructor.
  Search_directory(const char* name, bool put_in_sysroot)
    : name_(name), put_in_sysroot_(put_in_sysroot), is_in_sysroot_(false)
  {
    if (this->name_.empty())
      this->name_ = ".";
  }

  // This is called if we have a sysroot.  The sysroot is prefixed to
  // any entries for which put_in_sysroot_ is true.  is_in_sysroot_ is
  // set to true for any enries which are in the sysroot (this will
  // naturally include any entries for which put_in_sysroot_ is true).
  // SYSROOT is the sysroot, CANONICAL_SYSROOT is the result of
  // passing SYSROOT to lrealpath.
  void
  add_sysroot(const char* sysroot, const char* canonical_sysroot);

  // Get the directory name.
  const std::string&
  name() const
  { return this->name_; }

  // Return whether this directory is in the sysroot.
  bool
  is_in_sysroot() const
  { return this->is_in_sysroot_; }

 private:
  std::string name_;
  bool put_in_sysroot_;
  bool is_in_sysroot_;
};

// The position independent options which apply to the whole link.
// There are a lot of them.

class General_options
{
 public:
  enum Object_format
  {
    // Ordinary ELF.
    OBJECT_FORMAT_ELF,
    // Straight binary format.
    OBJECT_FORMAT_BINARY
  };

  General_options();

  // -d: define common symbols.
  bool
  define_common() const
  { return this->define_common_; }

  // -e: set entry address.
  const char*
  entry() const
  { return this->entry_; }

  // -E: export dynamic symbols.
  bool
  export_dynamic() const
  { return this->export_dynamic_; }

  // -h: shared library name.
  const char*
  soname() const
  { return this->soname_; }

  // -I: dynamic linker name.
  const char*
  dynamic_linker() const
  { return this->dynamic_linker_; }

  // -L: Library search path.
  typedef std::vector<Search_directory> Dir_list;

  const Dir_list&
  library_path() const
  { return this->search_path_; }

  // -O: optimization level (0: don't try to optimize output size).
  int
  optimize() const
  { return this->optimization_level_; }

  // -o: Output file name.
  const char*
  output_file_name() const
  { return this->output_file_name_; }

  // --oformat: Output format.
  Object_format
  oformat_enum() const
  { return this->oformat_; }

  const char*
  oformat() const
  { return this->oformat_string_; }

  // Return the default target.
  Target*
  default_target() const;

  // -q: Whether to emit relocations.
  bool
  emit_relocs() const
  { return this->emit_relocs_; }

  // -r: Whether we are doing a relocatable link.
  bool
  relocatable() const
  { return this->is_relocatable_; }

  // -s: Strip all symbols.
  bool
  strip_all() const
  { return this->strip_ == STRIP_ALL; }

  // -S: Strip debugging information.
  bool
  strip_debug() const
  { return this->strip_ == STRIP_ALL || this->strip_ == STRIP_DEBUG; }

  // --strip-debug-gdb: strip only debugging information that's not
  // used by gdb (at least, for gdb versions <= 6.7).
  bool
  strip_debug_gdb() const
  { return this->strip_debug() || this->strip_ == STRIP_DEBUG_UNUSED_BY_GDB; }

  // --allow-shlib-undefined: do not warn about unresolved symbols in
  // --shared libraries.
  bool
  allow_shlib_undefined() const
  { return this->allow_shlib_undefined_; }

  // -Bsymbolic: bind defined symbols locally.
  bool
  Bsymbolic() const
  { return this->symbolic_; }

  // --compress-debug-sections: compress .debug_* sections in the
  // output file using the given compression method.  This is useful
  // when the tools (such as gdb) support compressed sections.
  bool
  compress_debug_sections() const
  { return this->compress_debug_sections_ != NO_COMPRESSION; }

  bool
  zlib_compress_debug_sections() const
  { return this->compress_debug_sections_ == ZLIB_COMPRESSION; }

  // --demangle: demangle C++ symbols in our log messages.
  bool
  demangle() const
  { return this->demangle_; }

  // --detect-odr-violations: Whether to search for One Defn Rule violations.
  bool
  detect_odr_violations() const
  { return this->detect_odr_violations_; }

  // --eh-frame-hdr: Whether to generate an exception frame header.
  bool
  eh_frame_hdr() const
  { return this->create_eh_frame_hdr_; }

  // --rpath: The runtime search path.
  const Dir_list&
  rpath() const
  { return this->rpath_; }

  // --rpath-link: The link time search patch for shared libraries.
  const Dir_list&
  rpath_link() const
  { return this->rpath_link_; }

  // --shared: Whether generating a shared object.
  bool
  shared() const
  { return this->is_shared_; }

  // This is not defined via a flag, but combines flags to say whether
  // the output is position-independent or not.
  bool
  output_is_position_independent() const
  { return this->shared(); }

  // --static: Whether doing a static link.
  bool
  is_static() const
  { return this->is_static_; }

  // --stats: Print resource usage statistics.
  bool
  stats() const
  { return this->print_stats_; }

  // --sysroot: The system root of a cross-linker.
  const std::string&
  sysroot() const
  { return this->sysroot_; }

  // -Tbss: The address of the BSS segment
  uint64_t
  Tbss() const
  { return this->bss_segment_address_; }

  // Whether -Tbss was used.
  bool
  user_set_Tbss() const
  { return this->bss_segment_address_ != -1U; }

  // -Tdata: The address of the data segment
  uint64_t
  Tdata() const
  { return this->data_segment_address_; }

  // Whether -Tdata was used.
  bool
  user_set_Tdata() const
  { return this->data_segment_address_ != -1U; }

  // -Ttext: The address of the .text section
  uint64_t
  Ttext() const
  { return this->text_segment_address_; }

  // Whether -Ttext was used.
  bool
  user_set_Ttext() const
  { return this->text_segment_address_ != -1U; }

  // --threads: Whether to use threads.
  bool
  threads() const
  { return this->threads_; }

  // --thread-count-initial: Threads to use in initial pass.
  int
  thread_count_initial() const
  { return this->thread_count_initial_; }

  // --thread-count-middle: Threads to use in middle pass.
  int
  thread_count_middle() const
  { return this->thread_count_middle_; }

  // --thread-count-final: Threads to use in final pass.
  int
  thread_count_final() const
  { return this->thread_count_final_; }

  // -z execstack, -z noexecstack
  bool
  is_execstack_set() const
  { return this->execstack_ != EXECSTACK_FROM_INPUT; }

  bool
  is_stack_executable() const
  { return this->execstack_ == EXECSTACK_YES; }

  // -z max-page-size
  uint64_t
  max_page_size() const
  { return this->max_page_size_; }

  // -z common-page-size
  uint64_t
  common_page_size() const
  { return this->common_page_size_; }

  // --debug
  unsigned int
  debug() const
  { return this->debug_; }

 private:
  // Don't copy this structure.
  General_options(const General_options&);
  General_options& operator=(const General_options&);

  friend class Command_line;
  friend class options::Command_line_options;

  // Which symbols to strip.
  enum Strip
  {
    // Don't strip any symbols.
    STRIP_NONE,
    // Strip all symbols.
    STRIP_ALL,
    // Strip debugging information.
    STRIP_DEBUG,
    // Strip debugging information that's not used by gdb (at least <= 6.7)
    STRIP_DEBUG_UNUSED_BY_GDB
  };

  // Whether to mark the stack as executable.
  enum Execstack
  {
    // Not set on command line.
    EXECSTACK_FROM_INPUT,
    // Mark the stack as executable.
    EXECSTACK_YES,
    // Mark the stack as not executable.
    EXECSTACK_NO
  };

  // What compression method to use
  enum CompressionMethod
  {
    NO_COMPRESSION,
    ZLIB_COMPRESSION,
  };

  void
  set_define_common(bool value)
  {
    this->define_common_ = value;
    this->user_set_define_common_ = true;
  }

  void
  set_no_define_common(bool value)
  { this->set_define_common(!value); }

  bool
  user_set_define_common() const
  { return this->user_set_define_common_; }

  void
  set_entry(const char* arg)
  { this->entry_ = arg; }

  void
  set_export_dynamic(bool value)
  { this->export_dynamic_ = value; }

  void
  set_soname(const char* arg)
  { this->soname_ = arg; }

  void
  set_dynamic_linker(const char* arg)
  { this->dynamic_linker_ = arg; }

  void
  add_to_search_path(const char* arg)
  { this->search_path_.push_back(Search_directory(arg, false)); }

  void
  add_to_search_path_with_sysroot(const char* arg)
  { this->search_path_.push_back(Search_directory(arg, true)); }

  void
  set_optimize(const char* arg)
  {
    char* endptr;
    this->optimization_level_ = strtol(arg, &endptr, 0);
    if (*endptr != '\0' || this->optimization_level_ < 0)
      gold_fatal(_("invalid optimization level: %s"), arg);
  }

  void
  set_output(const char* arg)
  { this->output_file_name_ = arg; }

  void
  set_oformat(const char*);

  void
  set_emit_relocs(bool value)
  { this->emit_relocs_ = value; }

  void
  set_relocatable(bool value)
  { this->is_relocatable_ = value; }

  void
  set_strip_all(bool)
  { this->strip_ = STRIP_ALL; }

  // Note: normalize_options() depends on the fact that this turns off
  // STRIP_ALL if it were already set.
  void
  set_strip_debug(bool)
  { this->strip_ = STRIP_DEBUG; }

  void
  set_strip_debug_gdb(bool)
  { this->strip_ = STRIP_DEBUG_UNUSED_BY_GDB; }

  void
  set_allow_shlib_undefined(bool value)
  { this->allow_shlib_undefined_ = value; }

  void
  set_no_allow_shlib_undefined(bool value)
  { this->set_allow_shlib_undefined(!value); }

  void
  set_Bsymbolic(bool value)
  { this->symbolic_ = value; }

  void set_compress_debug_sections(const char* arg)
  {
    if (strcmp(arg, "none") == 0)
      this->compress_debug_sections_ = NO_COMPRESSION;
#ifdef HAVE_ZLIB_H
    else if (strcmp(arg, "zlib") == 0)
      this->compress_debug_sections_ = ZLIB_COMPRESSION;
#endif
    else
      gold_fatal(_("unsupported argument to --compress-debug-sections: %s"),
                 arg);
  }

  void
  add_to_defsym(const char* arg);

  void
  set_demangle(bool value)
  { this->demangle_ = value; }

  void
  set_no_demangle(bool value)
  { this->set_demangle(!value); }

  void
  set_detect_odr_violations(bool value)
  { this->detect_odr_violations_ = value; }

  void
  set_eh_frame_hdr(bool value)
  { this->create_eh_frame_hdr_ = value; }

  void
  add_to_rpath(const char* arg)
  { this->rpath_.push_back(Search_directory(arg, false)); }

  void
  add_to_rpath_link(const char* arg)
  { this->rpath_link_.push_back(Search_directory(arg, false)); }

  void
  set_shared(bool value)
  { this->is_shared_ = value; }

  void
  set_static(bool value)
  { this->is_static_ = value; }

  void
  set_stats(bool value)
  { this->print_stats_ = value; }

  void
  set_sysroot(const char* arg)
  { this->sysroot_ = arg; }

  void
  set_segment_address(const char* name, const char* arg, uint64_t* val)
  {
    char* endptr;
    *val = strtoull(arg, &endptr, 0);
    if (*endptr != '\0' || *val == -1U)
      gold_fatal(_("invalid argument to %s: %s"), name, arg);
  }

  void
  set_Tbss(const char* arg)
  { this->set_segment_address("-Tbss", arg, &this->bss_segment_address_); }

  void
  set_Tdata(const char* arg)
  { this->set_segment_address("-Tdata", arg, &this->data_segment_address_); }

  void
  set_Ttext(const char* arg)
  { this->set_segment_address("-Ttext", arg, &this->text_segment_address_); }

  int
  parse_thread_count(const char* arg)
  {
    char* endptr;
    const int count = strtol(arg, &endptr, 0);
    if (*endptr != '\0' || count < 0)
      gold_fatal(_("invalid thread count: %s"), arg);
    return count;
  }

  void
  set_threads(bool value)
  {
#ifndef ENABLE_THREADS
    if (value)
      gold_fatal(_("--threads not supported"));
#endif
    this->threads_ = value;
  }

  void
  set_no_threads(bool value)
  { this->set_threads(!value); }

  void
  set_thread_count(const char* arg)
  {
    int count = this->parse_thread_count(arg);
    this->thread_count_initial_ = count;
    this->thread_count_middle_ = count;
    this->thread_count_final_ = count;
  }

  void
  set_thread_count_initial(const char* arg)
  { this->thread_count_initial_ = this->parse_thread_count(arg); }

  void
  set_thread_count_middle(const char* arg)
  { this->thread_count_middle_ = this->parse_thread_count(arg); }

  void
  set_thread_count_final(const char* arg)
  { this->thread_count_final_ = this->parse_thread_count(arg); }

  void
  ignore(const char*)
  { }

  void
  set_execstack(bool)
  { this->execstack_ = EXECSTACK_YES; }

  void
  set_noexecstack(bool)
  { this->execstack_ = EXECSTACK_NO; }

  void
  set_max_page_size(const char* arg)
  {
    char* endptr;
    this->max_page_size_ = strtoull(arg, &endptr, 0);
    if (*endptr != '\0' || this->max_page_size_ == 0)
      gold_fatal(_("invalid max-page-size: %s"), arg);
  }

  void
  set_common_page_size(const char* arg)
  {
    char* endptr;
    this->common_page_size_ = strtoull(arg, &endptr, 0);
    if (*endptr != '\0' || this->common_page_size_ == 0)
      gold_fatal(_("invalid common-page-size: %s"), arg);
  }

  void
  set_debug(unsigned int flags)
  { this->debug_ = flags; }

  // Handle the -z option.
  void
  handle_z_option(const char*);

  // Handle the --debug option.
  void
  handle_debug_option(const char*);

  // Apply any sysroot to the directory lists.
  void
  add_sysroot();

  bool define_common_;
  bool user_set_define_common_;
  const char* entry_;
  bool export_dynamic_;
  const char* soname_;
  const char* dynamic_linker_;
  Dir_list search_path_;
  int optimization_level_;
  const char* output_file_name_;
  Object_format oformat_;
  const char* oformat_string_;
  bool emit_relocs_;
  bool is_relocatable_;
  Strip strip_;
  bool allow_shlib_undefined_;
  bool symbolic_;
  CompressionMethod compress_debug_sections_;
  bool demangle_;
  bool detect_odr_violations_;
  bool create_eh_frame_hdr_;
  Dir_list rpath_;
  Dir_list rpath_link_;
  bool is_shared_;
  bool is_static_;
  bool print_stats_;
  std::string sysroot_;
  uint64_t bss_segment_address_;
  uint64_t data_segment_address_;
  uint64_t text_segment_address_;
  bool threads_;
  int thread_count_initial_;
  int thread_count_middle_;
  int thread_count_final_;
  Execstack execstack_;
  uint64_t max_page_size_;
  uint64_t common_page_size_;
  unsigned int debug_;
};

// The current state of the position dependent options.

class Position_dependent_options
{
 public:
  typedef General_options::Object_format Object_format;

  Position_dependent_options();

  // -Bdynamic/-Bstatic: Whether we are searching for a static archive
  // -rather than a shared object.
  bool
  Bdynamic() const
  { return !this->do_static_search_; }

  // --as-needed: Whether to add a DT_NEEDED argument only if the
  // dynamic object is used.
  bool
  as_needed() const
  { return this->as_needed_; }

  // --whole-archive: Whether to include the entire contents of an
  // --archive.
  bool
  whole_archive() const
  { return this->include_whole_archive_; }

  // --format: The format of the input file.
  Object_format
  format_enum() const
  { return this->input_format_; }

  void
  set_Bstatic(bool value)
  { this->do_static_search_ = value; }

  void
  set_Bdynamic(bool value)
  { this->set_Bstatic(!value); }

  void
  set_as_needed(bool value)
  { this->as_needed_ = value; }

  void
  set_no_as_needed(bool value)
  { this->set_as_needed(!value); }

  void
  set_whole_archive(bool value)
  { this->include_whole_archive_ = value; }

  void
  set_no_whole_archive(bool value)
  { this->set_whole_archive(!value); }

  void
  set_format(const char*);

  void
  set_format_enum(Object_format value)
  { this->input_format_ = value; }

 private:
  bool do_static_search_;
  bool as_needed_;
  bool include_whole_archive_;
  Object_format input_format_;
};

// A single file or library argument from the command line.

class Input_file_argument
{
 public:
  // name: file name or library name
  // is_lib: true if name is a library name: that is, emits the leading
  //         "lib" and trailing ".so"/".a" from the name
  // extra_search_path: an extra directory to look for the file, prior
  //         to checking the normal library search path.  If this is "",
  //         then no extra directory is added.
  // just_symbols: whether this file only defines symbols.
  // options: The position dependent options at this point in the
  //         command line, such as --whole-archive.
  Input_file_argument()
    : name_(), is_lib_(false), extra_search_path_(""), just_symbols_(false),
      options_()
  { }

  Input_file_argument(const char* name, bool is_lib,
                      const char* extra_search_path,
		      bool just_symbols,
		      const Position_dependent_options& options)
    : name_(name), is_lib_(is_lib), extra_search_path_(extra_search_path),
      just_symbols_(just_symbols), options_(options)
  { }

  const char*
  name() const
  { return this->name_.c_str(); }

  const Position_dependent_options&
  options() const
  { return this->options_; }

  bool
  is_lib() const
  { return this->is_lib_; }

  const char*
  extra_search_path() const
  {
    return (this->extra_search_path_.empty()
            ? NULL
	    : this->extra_search_path_.c_str());
  }

  // Return whether we should only read symbols from this file.
  bool
  just_symbols() const
  { return this->just_symbols_; }

  // Return whether this file may require a search using the -L
  // options.
  bool
  may_need_search() const
  { return this->is_lib_ || !this->extra_search_path_.empty(); }

 private:
  // We use std::string, not const char*, here for convenience when
  // using script files, so that we do not have to preserve the string
  // in that case.
  std::string name_;
  bool is_lib_;
  std::string extra_search_path_;
  bool just_symbols_;
  Position_dependent_options options_;
};

// A file or library, or a group, from the command line.

class Input_argument
{
 public:
  // Create a file or library argument.
  explicit Input_argument(Input_file_argument file)
    : is_file_(true), file_(file), group_(NULL)
  { }

  // Create a group argument.
  explicit Input_argument(Input_file_group* group)
    : is_file_(false), group_(group)
  { }

  // Return whether this is a file.
  bool
  is_file() const
  { return this->is_file_; }

  // Return whether this is a group.
  bool
  is_group() const
  { return !this->is_file_; }

  // Return the information about the file.
  const Input_file_argument&
  file() const
  {
    gold_assert(this->is_file_);
    return this->file_;
  }

  // Return the information about the group.
  const Input_file_group*
  group() const
  {
    gold_assert(!this->is_file_);
    return this->group_;
  }

  Input_file_group*
  group()
  {
    gold_assert(!this->is_file_);
    return this->group_;
  }

 private:
  bool is_file_;
  Input_file_argument file_;
  Input_file_group* group_;
};

// A group from the command line.  This is a set of arguments within
// --start-group ... --end-group.

class Input_file_group
{
 public:
  typedef std::vector<Input_argument> Files;
  typedef Files::const_iterator const_iterator;

  Input_file_group()
    : files_()
  { }

  // Add a file to the end of the group.
  void
  add_file(const Input_file_argument& arg)
  { this->files_.push_back(Input_argument(arg)); }

  // Iterators to iterate over the group contents.

  const_iterator
  begin() const
  { return this->files_.begin(); }

  const_iterator
  end() const
  { return this->files_.end(); }

 private:
  Files files_;
};

// A list of files from the command line or a script.

class Input_arguments
{
 public:
  typedef std::vector<Input_argument> Input_argument_list;
  typedef Input_argument_list::const_iterator const_iterator;

  Input_arguments()
    : input_argument_list_(), in_group_(false)
  { }

  // Add a file.
  void
  add_file(const Input_file_argument& arg);

  // Start a group (the --start-group option).
  void
  start_group();

  // End a group (the --end-group option).
  void
  end_group();

  // Return whether we are currently in a group.
  bool
  in_group() const
  { return this->in_group_; }

  // The number of entries in the list.
  int
  size() const
  { return this->input_argument_list_.size(); }

  // Iterators to iterate over the list of input files.

  const_iterator
  begin() const
  { return this->input_argument_list_.begin(); }

  const_iterator
  end() const
  { return this->input_argument_list_.end(); }

  // Return whether the list is empty.
  bool
  empty() const
  { return this->input_argument_list_.empty(); }

 private:
  Input_argument_list input_argument_list_;
  bool in_group_;
};

// All the information read from the command line.

class Command_line
{
 public:
  typedef Input_arguments::const_iterator const_iterator;

  Command_line();

  // Process the command line options.  This will exit with an
  // appropriate error message if an unrecognized option is seen.
  void
  process(int argc, char** argv);

  // Process one command-line option.  This takes the index of argv to
  // process, and returns the index for the next option.
  int
  process_one_option(int argc, char** argv, int i, bool* no_more_options);

  // Handle a -l option.
  int
  process_l_option(int, char**, char*, bool);

  // Handle a -R option when it means --rpath.
  void
  add_to_rpath(const char* arg)
  { this->options_.add_to_rpath(arg); }

  // Add a file for which we just read the symbols.
  void
  add_just_symbols_file(const char* arg)
  {
    this->inputs_.add_file(Input_file_argument(arg, false, "", true,
					       this->position_options_));
  }

  // Handle a --start-group option.
  void
  start_group(const char* arg);

  // Handle a --end-group option.
  void
  end_group(const char* arg);

  // Get an option argument--a helper function for special processing.
  const char*
  get_special_argument(const char* longname, int argc, char** argv,
		       const char* arg, bool long_option,
		       int *pret);

  // Get the general options.
  const General_options&
  options() const
  { return this->options_; }

  // Get the position dependent options.
  const Position_dependent_options&
  position_dependent_options() const
  { return this->position_options_; }

  // Get the linker-script options.
  Script_options&
  script_options()
  { return this->script_options_; }

  // Get the version-script options: a convenience routine.
  const Version_script_info&
  version_script() const
  { return *this->script_options_.version_script_info(); }

  // The number of input files.
  int
  number_of_input_files() const
  { return this->inputs_.size(); }

  // Iterators to iterate over the list of input files.

  const_iterator
  begin() const
  { return this->inputs_.begin(); }

  const_iterator
  end() const
  { return this->inputs_.end(); }

 private:
  Command_line(const Command_line&);
  Command_line& operator=(const Command_line&);

  // Report usage error.
  void
  usage() ATTRIBUTE_NORETURN;
  void
  usage(const char* msg, const char* opt) ATTRIBUTE_NORETURN;
  void
  usage(const char* msg, char opt) ATTRIBUTE_NORETURN;

  // Apply a command line option.
  void
  apply_option(const gold::options::One_option&, const char*);

  // Add a file.
  void
  add_file(const char* name, bool is_lib);

  // Examine the result of processing the command-line, and verify
  // the flags do not contradict each other or are otherwise illegal.
  void
  normalize_options();

  General_options options_;
  Position_dependent_options position_options_;
  Script_options script_options_;
  Input_arguments inputs_;
};

} // End namespace gold.

#endif // !defined(GOLD_OPTIONS_H)