Apply Bob Wilson's linker documenation clean ups.
[deliverable/binutils-gdb.git] / ld / ldlang.h
index bfdc9cbe46df649a1c28c51c1aaf48d9429acad5..a0fe13719b06db60bd454d440c615a369e68ff18 100644 (file)
@@ -1,12 +1,13 @@
-/* ldlang.h -
-
-   Copyright (C) 1991 Free Software Foundation, Inc.
+/* ldlang.h - linker command language support
+   Copyright 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
+   2001, 2002
+   Free Software Foundation, Inc.
 
    This file is part of GLD, the Gnu Linker.
 
    GLD 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 1, or (at your option)
+   the Free Software Foundation; either version 2, or (at your option)
    any later version.
 
    GLD is distributed in the hope that it will be useful,
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
-   along with GLD; see the file COPYING.  If not, write to
-   the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */
+   along with GLD; see the file COPYING.  If not, write to the Free
+   Software Foundation, 59 Temple Place - Suite 330, Boston, MA
+   02111-1307, USA.  */
 
+#ifndef LDLANG_H
+#define LDLANG_H
 
 typedef enum {
   lang_input_file_is_l_enum,
   lang_input_file_is_symbols_only_enum,
   lang_input_file_is_marker_enum,
   lang_input_file_is_fake_enum,
-lang_input_file_is_search_file_enum,
-  lang_input_file_is_file_enum } lang_input_file_enum_type;
+  lang_input_file_is_search_file_enum,
+  lang_input_file_is_file_enum
+} lang_input_file_enum_type;
+
+struct _fill_type {
+  size_t size;
+  unsigned char data[1];
+};
 
-typedef unsigned short fill_type;
 typedef struct statement_list {
   union lang_statement_union *head;
   union lang_statement_union **tail;
 } lang_statement_list_type;
 
-
-typedef struct {
-  boolean flag_read;
-  boolean flag_write;
-  boolean flag_executable;
-  boolean flag_loadable;
-} lang_section_flags_type;
-
 typedef struct memory_region_struct {
   char *name;
   struct memory_region_struct *next;
   bfd_vma origin;
-  bfd_offset length;
+  bfd_size_type length;
   bfd_vma current;
-  lang_section_flags_type flags;
-} lang_memory_region_type ;
+  bfd_size_type old_length;
+  flagword flags;
+  flagword not_flags;
+  bfd_boolean had_full_message;
+} lang_memory_region_type;
 
-typedef struct lang_statement_header_struct 
-{
-union  lang_statement_union  *next;
+typedef struct lang_statement_header_struct {
+  union lang_statement_union *next;
   enum statement_enum {
     lang_output_section_statement_enum,
     lang_assignment_statement_enum,
@@ -63,53 +66,83 @@ union  lang_statement_union  *next;
     lang_object_symbols_statement_enum,
     lang_fill_statement_enum,
     lang_data_statement_enum,
+    lang_reloc_statement_enum,
     lang_target_statement_enum,
     lang_output_statement_enum,
     lang_padding_statement_enum,
+    lang_group_statement_enum,
 
-    lang_afile_asection_pair_statement_enum
+    lang_afile_asection_pair_statement_enum,
+    lang_constructors_statement_enum
   } type;
-
 } lang_statement_header_type;
 
-
-typedef struct 
-{
+typedef struct {
   lang_statement_header_type header;
   union etree_union *exp;
-}  lang_assignment_statement_type;
-
+} lang_assignment_statement_type;
 
 typedef struct lang_target_statement_struct {
   lang_statement_header_type header;
-  CONST char *target;
+  const char *target;
 } lang_target_statement_type;
 
-
 typedef struct lang_output_statement_struct {
   lang_statement_header_type header;
-  CONST char *name;
+  const char *name;
 } lang_output_statement_type;
 
+/* Section types specified in a linker script.  */
+
+enum section_type {
+  normal_section,
+  dsect_section,
+  copy_section,
+  noload_section,
+  info_section,
+  overlay_section
+};
+
+/* This structure holds a list of program headers describing segments
+   in which this section should be placed.  */
 
-typedef struct lang_output_section_statement_struct 
-{
+struct lang_output_section_phdr_list {
+  struct lang_output_section_phdr_list *next;
+  const char *name;
+  bfd_boolean used;
+};
+
+typedef struct lang_output_section_statement_struct {
   lang_statement_header_type header;
   union etree_union *addr_tree;
   lang_statement_list_type children;
-  CONST char *memspec;
+  const char *memspec;
   union lang_statement_union *next;
-  CONST char *name;
-  unsigned long subsection_alignment;
-  boolean processed;
+  const char *name;
+
+  bfd_boolean processed;
 
   asection *bfd_section;
-  lang_section_flags_type flags;
+  flagword flags;              /* Or together of all input sections */
+  enum section_type sectype;
   struct memory_region_struct *region;
+  struct memory_region_struct *lma_region;
   size_t block_value;
-  fill_type fill;
-} lang_output_section_statement_type;
+  fill_type *fill;
+
+  int subsection_alignment;    /* alignment of components */
+  int section_alignment;       /* alignment of start of section */
+
+  union etree_union *load_base;
 
+  /* If non-null, an expression to evaluate after setting the section's
+     size.  The expression is evaluated inside REGION (above) with '.'
+     set to the end of the section.  Used in the last overlay section
+     to move '.' past all the overlaid sections.  */
+  union etree_union *update_dot_tree;
+
+  struct lang_output_section_phdr_list *phdrs;
+} lang_output_section_statement_type;
 
 typedef struct {
   lang_statement_header_type header;
@@ -121,90 +154,102 @@ typedef struct {
 
 typedef struct {
   lang_statement_header_type header;
-  fill_type fill;
+  fill_type *fill;
+  int size;
+  asection *output_section;
 } lang_fill_statement_type;
 
 typedef struct {
   lang_statement_header_type header;
   unsigned int type;
-  union  etree_union *exp;
+  union etree_union *exp;
   bfd_vma value;
   asection *output_section;
   bfd_vma output_vma;
 } lang_data_statement_type;
 
+/* Generate a reloc in the output file.  */
 
+typedef struct {
+  lang_statement_header_type header;
 
+  /* Reloc to generate.  */
+  bfd_reloc_code_real_type reloc;
 
-typedef struct lang_input_statement_struct
-  {
-    lang_statement_header_type header;
-    /* Name of this file.  */
-    CONST char *filename;
-    /* Name to use for the symbol giving address of text start */
-    /* Usually the same as filename, but for a file spec'd with -l
-       this is the -l switch itself rather than the filename.  */
-    CONST char *local_sym_name;
+  /* Reloc howto structure.  */
+  reloc_howto_type *howto;
 
-    /* Describe the layout of the contents of the file */
+  /* Section to generate reloc against.  Exactly one of section and
+     name must be NULL.  */
+  asection *section;
 
-    /* The file's a.out header.  */
-    /*  struct exec header;*/
-    /* Offset in file of GDB symbol segment, or 0 if there is none.  */
-    int symseg_offset;
+  /* Name of symbol to generate reloc against.  Exactly one of section
+     and name must be NULL.  */
+  const char *name;
 
-    /* Describe data from the file loaded into core */
+  /* Expression for addend.  */
+  union etree_union *addend_exp;
 
-    bfd *the_bfd;
+  /* Resolved addend.  */
+  bfd_vma addend_value;
 
-    boolean closed;
-    file_ptr passive_position;
+  /* Output section where reloc should be performed.  */
+  asection *output_section;
 
-    /* Symbol table of the file.  */
-    asymbol **asymbols;
-    unsigned int symbol_count;
+  /* VMA within output section.  */
+  bfd_vma output_vma;
+} lang_reloc_statement_type;
+
+typedef struct lang_input_statement_struct {
+  lang_statement_header_type header;
+  /* Name of this file.  */
+  const char *filename;
+  /* Name to use for the symbol giving address of text start */
+  /* Usually the same as filename, but for a file spec'd with -l
+     this is the -l switch itself rather than the filename.  */
+  const char *local_sym_name;
 
-    /* For library members only */
+  bfd *the_bfd;
 
-    /* For a library, points to chain of entries for the library members.  */
-    struct lang_input_statement_struct *subfiles;
-    /* For a library member, offset of the member within the archive.
-       Zero for files that are not library members.  */
-    /*  int starting_offset;*/
-    /* Size of contents of this file, if library member.  */
-    int total_size;
-    /* For library member, points to the library's own entry.  */
-    struct lang_input_statement_struct *superfile;
-    /* For library member, points to next entry for next member.  */
-    struct lang_input_statement_struct *chain;
-    /* Point to the next file - whatever it is, wanders up and down
-       archives */
+  bfd_boolean closed;
+  file_ptr passive_position;
 
-    union lang_statement_union  *next;
-    /* Point to the next file, but skips archive contents */
-    union  lang_statement_union  *next_real_file;
+  /* Symbol table of the file.  */
+  asymbol **asymbols;
+  unsigned int symbol_count;
 
-    boolean is_archive;
+  /* Point to the next file - whatever it is, wanders up and down
+     archives */
+
+  union lang_statement_union *next;
+  /* Point to the next file, but skips archive contents */
+  union lang_statement_union *next_real_file;
 
-    /* 1 means search a set of directories for this file.  */
-    boolean search_dirs_flag;
+  bfd_boolean is_archive;
 
-    /* 1 means this is base file of incremental load.
-       Do not load this file's text or data.
-       Also default text_start to after this file's bss. */
+  /* 1 means search a set of directories for this file.  */
+  bfd_boolean search_dirs_flag;
 
-    boolean just_syms_flag;
+  /* 1 means this is base file of incremental load.
+     Do not load this file's text or data.
+     Also default text_start to after this file's bss.  */
 
-    boolean loaded;
+  bfd_boolean just_syms_flag;
 
+  /* Whether to search for this entry as a dynamic archive.  */
+  bfd_boolean dynamic;
 
-    /*    unsigned int globals_in_this_file;*/
-    CONST char *target;
-    boolean real;
+  /* Whether to include the entire contents of an archive.  */
+  bfd_boolean whole_archive;
 
-    asection *common_section;
-    asection *common_output_section;
-  } lang_input_statement_type;
+  bfd_boolean loaded;
+
+#if 0
+  unsigned int globals_in_this_file;
+#endif
+  const char *target;
+  bfd_boolean real;
+} lang_input_statement_type;
 
 typedef struct {
   lang_statement_header_type header;
@@ -213,7 +258,6 @@ typedef struct {
 
 } lang_input_section_type;
 
-
 typedef struct {
   lang_statement_header_type header;
   asection *section;
@@ -222,15 +266,17 @@ typedef struct {
 
 typedef struct lang_wild_statement_struct {
   lang_statement_header_type header;
-CONST char *section_name;
-CONST char *filename;
+  const char *filename;
+  bfd_boolean filenames_sorted;
+  struct wildcard_list *section_list;
+  bfd_boolean keep_sections;
   lang_statement_list_type children;
 } lang_wild_statement_type;
 
 typedef struct lang_address_statement_struct {
   lang_statement_header_type header;
-  CONST  char *section_name;
-  union  etree_union *address;
+  const char *section_name;
+  union etree_union *address;
 } lang_address_statement_type;
 
 typedef struct {
@@ -238,15 +284,24 @@ typedef struct {
   bfd_vma output_offset;
   size_t size;
   asection *output_section;
-  fill_type fill;
+  fill_type *fill;
 } lang_padding_statement_type;
 
-typedef union lang_statement_union 
-{
+/* A group statement collects a set of libraries together.  The
+   libraries are searched multiple times, until no new undefined
+   symbols are found.  The effect is to search a group of libraries as
+   though they were a single library.  */
+
+typedef struct {
+  lang_statement_header_type header;
+  lang_statement_list_type children;
+} lang_group_statement_type;
+
+typedef union lang_statement_union {
   lang_statement_header_type header;
-  union lang_statement_union *next;
   lang_wild_statement_type wild_statement;
   lang_data_statement_type data_statement;
+  lang_reloc_statement_type reloc_statement;
   lang_address_statement_type address_statement;
   lang_output_section_statement_type output_section_statement;
   lang_afile_asection_pair_statement_type afile_asection_pair_statement;
@@ -259,86 +314,208 @@ typedef union lang_statement_union
   lang_object_symbols_statement_type object_symbols_statement;
   lang_fill_statement_type fill_statement;
   lang_padding_statement_type padding_statement;
+  lang_group_statement_type group_statement;
 } lang_statement_union_type;
 
-
-
-PROTO(void,lang_init,(void));
-PROTO(struct memory_region_struct ,
-      *lang_memory_region_lookup,(CONST
-                                 char *CONST));
-
-
-PROTO(void ,lang_map,(FILE *));
-PROTO(void,lang_set_flags,(lang_section_flags_type *, CONST char *));
-PROTO(void,lang_add_output,(CONST char *));
-
-PROTO(void,lang_final,(void));
-PROTO(struct symbol_cache_entry *,create_symbol,(CONST char *, unsigned int, struct sec *));
-PROTO(void ,lang_process,(void));
-PROTO(void ,lang_section_start,(CONST char *, union etree_union *));
-PROTO(void,lang_add_entry,(CONST char *));
-PROTO(void,lang_add_target,(CONST char *));
-PROTO(void,lang_add_wild,(CONST char *CONST , CONST char *CONST));
-PROTO(void,lang_add_map,(CONST char *));
-PROTO(void,lang_add_fill,(int));
-PROTO(void,lang_add_assignment,(union etree_union *));
-PROTO(void,lang_add_attribute,(enum statement_enum));
-PROTO(void,lang_startup,(CONST char *));
-PROTO(void,lang_float,(enum boolean));
-PROTO(void,lang_leave_output_section_statement,(bfd_vma, CONST char *));
-PROTO(void,lang_abs_symbol_at_end_of,(CONST char *, CONST char *));
-PROTO(void,lang_abs_symbol_at_beginning_of,(CONST char *, CONST char *));
-PROTO(void,lang_statement_append,(struct statement_list *, union lang_statement_union *, union lang_statement_union **));
-PROTO(void, lang_for_each_file,(void (*dothis)(lang_input_statement_type *)));
-
-     
-#define LANG_FOR_EACH_INPUT_STATEMENT(statement)               \
-  extern lang_statement_list_type file_chain;                  \
-  lang_input_statement_type *statement;                                \
-  for (statement = (lang_input_statement_type *)file_chain.head;\
-       statement != (lang_input_statement_type *)NULL;         \
-       statement = (lang_input_statement_type *)statement->next)\
-
-#define LANG_FOR_EACH_INPUT_SECTION(statement, abfd, section, x) \
-{ extern lang_statement_list_type file_chain;                  \
-  lang_input_statement_type *statement;                                \
-  for (statement = (lang_input_statement_type *)file_chain.head;\
-       statement != (lang_input_statement_type *)NULL;         \
-       statement = (lang_input_statement_type *)statement->next)\
-    {                                                          \
-      asection *section;                                       \
-      bfd *abfd = statement->the_bfd;                          \
-      for (section = abfd->sections;                           \
-          section != (asection *)NULL;                         \
-          section = section->next) {                           \
-       x;                                                      \
-      }                                                                \
-    }                                                          \
- }             
-
-#define LANG_FOR_EACH_OUTPUT_SECTION(section, x)               \
- { extern bfd *output_bfd;                                     \
-   asection *section;                                          \
-   for (section = output_bfd->sections;                                \
-       section != (asection *)NULL;                            \
-       section = section->next)                                \
-       { x; }                                                  \
- }
-                                       
-
-PROTO(void, lang_process,(void));
-PROTO(void, ldlang_add_file,(lang_input_statement_type *));
-
-PROTO(lang_output_section_statement_type
-      *,lang_output_section_find,(CONST char * CONST));
-
-PROTO(lang_input_statement_type *,
-       lang_add_input_file,(char *name,
-                           lang_input_file_enum_type file_type,
-                           char *target));
-PROTO(lang_output_section_statement_type *,
-lang_output_section_statement_lookup,(CONST char * CONST name));
-
-PROTO(void, ldlang_add_undef,(CONST char *CONST name));
-PROTO(void, lang_add_output_format,(CONST char *));
+/* This structure holds information about a program header, from the
+   PHDRS command in the linker script.  */
+
+struct lang_phdr {
+  struct lang_phdr *next;
+  const char *name;
+  unsigned long type;
+  bfd_boolean filehdr;
+  bfd_boolean phdrs;
+  etree_type *at;
+  etree_type *flags;
+};
+
+/* This structure is used to hold a list of sections which may not
+   cross reference each other.  */
+
+struct lang_nocrossref {
+  struct lang_nocrossref *next;
+  const char *name;
+};
+
+/* The list of nocrossref lists.  */
+
+struct lang_nocrossrefs {
+  struct lang_nocrossrefs *next;
+  struct lang_nocrossref *list;
+};
+
+extern struct lang_nocrossrefs *nocrossref_list;
+
+/* This structure is used to hold a list of input section names which
+   will not match an output section in the linker script.  */
+
+struct unique_sections {
+  struct unique_sections *next;
+  const char *name;
+};
+
+extern struct unique_sections *unique_section_list;
+
+extern lang_output_section_statement_type *abs_output_section;
+extern lang_statement_list_type lang_output_section_statement;
+extern bfd_boolean lang_has_input_file;
+extern etree_type *base;
+extern lang_statement_list_type *stat_ptr;
+extern bfd_boolean delete_output_file_on_failure;
+
+extern struct bfd_sym_chain entry_symbol;
+extern const char *entry_section;
+extern bfd_boolean entry_from_cmdline;
+extern lang_statement_list_type file_chain;
+
+extern void lang_init
+  PARAMS ((void));
+extern struct memory_region_struct *lang_memory_region_lookup
+  PARAMS ((const char *const));
+extern struct memory_region_struct *lang_memory_region_default
+  PARAMS ((asection *));
+extern void lang_map
+  PARAMS ((void));
+extern void lang_set_flags
+  PARAMS ((lang_memory_region_type *, const char *, int));
+extern void lang_add_output
+  PARAMS ((const char *, int from_script));
+extern lang_output_section_statement_type *lang_enter_output_section_statement
+  PARAMS ((const char *output_section_statement_name,
+          etree_type *address_exp,
+          enum section_type sectype,
+          bfd_vma block_value,
+          etree_type *align,
+          etree_type *subalign,
+          etree_type *));
+extern void lang_final
+  PARAMS ((void));
+extern void lang_process
+  PARAMS ((void));
+extern void lang_section_start
+  PARAMS ((const char *, union etree_union *));
+extern void lang_add_entry
+  PARAMS ((const char *, bfd_boolean));
+extern void lang_add_target
+  PARAMS ((const char *));
+extern void lang_add_wild
+  PARAMS ((struct wildcard_spec *, struct wildcard_list *, bfd_boolean));
+extern void lang_add_map
+  PARAMS ((const char *));
+extern void lang_add_fill
+  PARAMS ((fill_type *));
+extern lang_assignment_statement_type * lang_add_assignment
+  PARAMS ((union etree_union *));
+extern void lang_add_attribute
+  PARAMS ((enum statement_enum));
+extern void lang_startup
+  PARAMS ((const char *));
+extern void lang_float
+  PARAMS ((bfd_boolean));
+extern void lang_leave_output_section_statement
+  PARAMS ((fill_type *, const char *, struct lang_output_section_phdr_list *,
+           const char *));
+extern void lang_abs_symbol_at_end_of
+  PARAMS ((const char *, const char *));
+extern void lang_abs_symbol_at_beginning_of
+  PARAMS ((const char *, const char *));
+extern void lang_statement_append
+  PARAMS ((struct statement_list *, union lang_statement_union *,
+          union lang_statement_union **));
+extern void lang_for_each_input_file
+  PARAMS ((void (*dothis) (lang_input_statement_type *)));
+extern void lang_for_each_file
+  PARAMS ((void (*dothis) (lang_input_statement_type *)));
+extern void lang_reset_memory_regions
+  PARAMS ((void));
+extern bfd_vma lang_do_assignments
+  PARAMS ((lang_statement_union_type * s,
+          lang_output_section_statement_type *output_section_statement,
+          fill_type *fill,
+          bfd_vma dot));
+
+#define LANG_FOR_EACH_INPUT_STATEMENT(statement)                       \
+  lang_input_statement_type *statement;                                        \
+  for (statement = (lang_input_statement_type *) file_chain.head;      \
+       statement != (lang_input_statement_type *) NULL;                        \
+       statement = (lang_input_statement_type *) statement->next)      \
+
+extern void lang_process
+  PARAMS ((void));
+extern void ldlang_add_file
+  PARAMS ((lang_input_statement_type *));
+extern lang_output_section_statement_type *lang_output_section_find
+  PARAMS ((const char * const));
+extern lang_input_statement_type *lang_add_input_file
+  PARAMS ((const char *name, lang_input_file_enum_type file_type,
+          const char *target));
+extern void lang_add_keepsyms_file
+  PARAMS ((const char *filename));
+extern lang_output_section_statement_type *
+  lang_output_section_statement_lookup
+  PARAMS ((const char * const name));
+extern void ldlang_add_undef
+  PARAMS ((const char *const name));
+extern void lang_add_output_format
+  PARAMS ((const char *, const char *, const char *, int from_script));
+extern void lang_list_init
+  PARAMS ((lang_statement_list_type*));
+extern void lang_add_data
+  PARAMS ((int type, union etree_union *));
+extern void lang_add_reloc
+  PARAMS ((bfd_reloc_code_real_type reloc, reloc_howto_type *howto,
+          asection *section, const char *name, union etree_union *addend));
+extern void lang_for_each_statement
+  PARAMS ((void (*func) (lang_statement_union_type *)));
+extern PTR stat_alloc
+  PARAMS ((size_t size));
+extern void dprint_statement
+  PARAMS ((lang_statement_union_type *, int));
+extern bfd_vma lang_size_sections
+  PARAMS ((lang_statement_union_type *s,
+          lang_output_section_statement_type *output_section_statement,
+          lang_statement_union_type **prev, fill_type *fill,
+          bfd_vma dot, bfd_boolean *relax));
+extern void lang_enter_group
+  PARAMS ((void));
+extern void lang_leave_group
+  PARAMS ((void));
+extern void lang_add_section
+  PARAMS ((lang_statement_list_type *ptr, asection *section,
+          lang_output_section_statement_type *output,
+          lang_input_statement_type *file));
+extern void lang_new_phdr
+  PARAMS ((const char *, etree_type *, bfd_boolean, bfd_boolean, etree_type *,
+          etree_type *));
+extern void lang_add_nocrossref
+  PARAMS ((struct lang_nocrossref *));
+extern void lang_enter_overlay
+  PARAMS ((etree_type *));
+extern void lang_enter_overlay_section
+  PARAMS ((const char *));
+extern void lang_leave_overlay_section
+  PARAMS ((fill_type *, struct lang_output_section_phdr_list *));
+extern void lang_leave_overlay
+  PARAMS ((etree_type *, int, fill_type *, const char *,
+          struct lang_output_section_phdr_list *, const char *));
+
+extern struct bfd_elf_version_tree *lang_elf_version_info;
+
+extern struct bfd_elf_version_expr *lang_new_vers_pattern
+  PARAMS ((struct bfd_elf_version_expr *, const char *, const char *));
+extern struct bfd_elf_version_tree *lang_new_vers_node
+  PARAMS ((struct bfd_elf_version_expr *, struct bfd_elf_version_expr *));
+extern struct bfd_elf_version_deps *lang_add_vers_depend
+  PARAMS ((struct bfd_elf_version_deps *, const char *));
+extern void lang_register_vers_node
+  PARAMS ((const char *, struct bfd_elf_version_tree *,
+          struct bfd_elf_version_deps *));
+bfd_boolean unique_section_p
+  PARAMS ((const char *));
+extern void lang_add_unique
+  PARAMS ((const char *));
+extern const char *lang_get_output_target
+  PARAMS ((void));
+
+#endif
This page took 0.03192 seconds and 4 git commands to generate.