Open64: osprey/common/com/em

00001 /*
00002  * Copyright 2004, 2005, 2006 PathScale, Inc.  All Rights Reserved.
00003  */
00004 
00005 /*
00006 
00007   Copyright (C) 2000, 2001 Silicon Graphics, Inc.  All Rights Reserved.
00008 
00009   This program is free software; you can redistribute it and/or modify it
00010   under the terms of version 2 of the GNU General Public License as
00011   published by the Free Software Foundation.
00012 
00013   This program is distributed in the hope that it would be useful, but
00014   WITHOUT ANY WARRANTY; without even the implied warranty of
00015   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  
00016 
00017   Further, this software is distributed without any warranty that it is
00018   free of the rightful claim of any third person regarding infringement 
00019   or the like.  Any license provided herein, whether implied or 
00020   otherwise, applies only to this software file.  Patent licenses, if 
00021   any, provided herein do not apply to combinations of this program with 
00022   other software, or any other product whatsoever.  
00023 
00024   You should have received a copy of the GNU General Public License along
00025   with this program; if not, write the Free Software Foundation, Inc., 59
00026   Temple Place - Suite 330, Boston MA 02111-1307, USA.
00027 
00028   Contact information:  Silicon Graphics, Inc., 1600 Amphitheatre Pky,
00029   Mountain View, CA 94043, or:
00030 
00031   http://www.sgi.com
00032 
00033   For further information regarding this notice, see:
00034 
00035   http://oss.sgi.com/projects/GenInfo/NoticeExplan
00036 
00037 */
00038 
00039 
00040 #ifndef em_elf_INCLUDED
00041 #define em_elf_INCLUDED
00042 #ifdef __cplusplus
00043 extern "C" {
00044 #endif
00045 
00046 /* ====================================================================
00047  * ====================================================================
00048  *
00049  * Module: em_elf.h
00050  * $Revision: 1.1.1.1 $
00051  * $Date: 2005/10/21 19:00:00 $
00052  * $Author: marcel $
00053  * $Source: /proj/osprey/CVS/open64/osprey1.0/common/com/em_elf.h,v $
00054  *
00055  * Description:
00056  *
00057  * External interface to write out an elf object file.
00058  *
00059  * ====================================================================
00060  * ====================================================================
00061  */
00062 
00063 /* the default gp value for gprel and reginfo */
00064 extern INT GP_DISP;
00065 
00066 #define Roundup(_value,_align)        ((_value+(_align-1)) & (~(_align-1)))
00067 
00068 typedef struct section_info SCNINFO, *pSCNINFO;
00069 
00070 extern pSCNINFO Symtab_Info;
00071 extern BOOL     Sixtyfour_Bit;
00072 extern pSCNINFO Options_Scn;
00073 
00074 /* Given a file name 'ofilename', this procedure opens the file. If the 
00075    flag 'update' is true, it opens the already existing elf file for
00076    updating. Otherwise it creates a new file. The 'elf64' argument 
00077    is true if a 64bit object file is to be created. If the 'elf_trace'
00078    argument is true, some tracing output is generated.
00079 
00080    It returns the file descriptor for the object file opened.
00081 */
00082 extern INT
00083 Em_Begin_File (
00084     char *ofilename, 
00085     BOOL update, 
00086     BOOL elf64, 
00087     BOOL old_abi,
00088     INT  isa, 
00089     BOOL big_endian,
00090     BOOL pic,
00091     BOOL cpic,
00092     BOOL xgot,
00093     BOOL gp_groups,
00094     BOOL elf_trace);
00095 
00096 
00097 /* Write out the elf object file */
00098 extern void 
00099 Em_End_File (void);
00100 
00101 
00102 /* Create a new section. Its attributes are described in the arguments.
00103    It returns a pointer to the SCNINFO for the new section.
00104 */
00105 extern pSCNINFO 
00106 Em_New_Section (
00107     const char *scnname,
00108     Elf64_Word scntype,
00109     Elf64_Xword scnflags,
00110     Elf64_Xword scnentsize,
00111     Elf64_Xword scnalign);
00112 
00113 
00114 /* Finish processing of the section 'scninfo'. */
00115 extern void 
00116 Em_End_Section (pSCNINFO scninfo);
00117 
00118 
00119 /* Initialize a new buffer with the given 'size' and 'alignment' in the 
00120    section 'scninfo'. This is used in the cases where we know apriori
00121    the size of the buffer to be written out. It helps by reducing the 
00122    number of reallocs needed as we add bytes to the section.
00123 */
00124 extern void
00125 Em_New_Data_Buffer (pSCNINFO scninfo, Elf64_Xword size, INT alignment);
00126 
00127 /* Add an entry to the .symtab section. Returns the index for the entry */
00128 extern Elf64_Word
00129 Em_Add_New_Symbol (
00130     char *symname,
00131     Elf64_Addr symvalue,
00132     Elf64_Xword symsize,
00133     unsigned char symbind,
00134     unsigned char symtype,
00135     unsigned char symother,
00136     Elf64_Half symshndx);
00137 
00138 
00139 /* enter a symbol with name 'symname', symbol binding 'symbind' and
00140    type 'symtype'  as UNDEFINED into the symbol table.
00141 */
00142 extern Elf64_Word
00143 Em_Add_New_Undef_Symbol (
00144     char *symname, 
00145     unsigned char symbind,
00146     unsigned char symtype,
00147     unsigned char symother);
00148 
00149 
00150 /* Add a new symbol with name 'symname', size 'symsize' and symbol 
00151    binding 'symbind' to the symbol table as a COMMON symbol.
00152 */
00153 extern Elf64_Word 
00154 Em_Add_New_Common_Symbol (
00155     char *symname, 
00156     Elf64_Xword symsize, 
00157     unsigned char symbind,
00158     unsigned char symother);
00159 
00160 /* Add a new weak symbol entry with the name 'weakname'. Use the same
00161    attributes as the symbol table entry with index 'symindex'.
00162 */
00163 extern Elf64_Word
00164 Em_Add_New_Weak_Symbol (
00165     char *weakname, 
00166     unsigned char symtype,
00167     unsigned char symother,
00168     Elf64_Word symindex);
00169 
00170 
00171 /* Define the symbol with index 'symindex' to have the value 'symvalue' and
00172    the size 'symsize' in the section 'scninfo'. This is to define a symbol 
00173    that was earlier entered as undefined.
00174 */
00175 extern void
00176 Em_Define_Symbol (
00177     Elf64_Word symindex,
00178     Elf64_Addr symvalue,
00179     Elf64_Xword symsize,
00180     pSCNINFO scninfo);
00181 
00182 /* Undefine a symbol that was previously entered */
00183 extern void Em_Undefine_Symbol (Elf64_Word symindex);
00184 
00185 /* Set the binding for a symbol that was previously entered */
00186 extern void Em_Set_Symbol_Binding (Elf64_Word symindex, unsigned char symbind);
00187 
00188 extern Elf64_Addr
00189 Em_Get_Symbol_Value (Elf64_Word symindex);
00190 
00191 extern char *
00192 Em_Get_Symbol_Name (Elf64_Word symindex);
00193 
00194 /* Add a new relocation entry to the section 'scninfo'. */
00195 extern void 
00196 Em_Add_New_Rel (
00197     Elf64_Word symindex,
00198     unsigned char reltype,
00199     Elf64_Addr reloffset,
00200     pSCNINFO scninfo);
00201 
00202 
00203 /* Add a new entry to the Rela section for the section 'scninfo'. */
00204 extern void 
00205 Em_Add_New_Rela (
00206     Elf64_Word symindex,
00207     unsigned char reltype,
00208     Elf64_Addr reloffset,
00209     Elf64_Sxword addend,
00210     pSCNINFO scninfo);
00211 
00212 /* Add a new composite relocation entry to the Rela section.
00213  * For the 32bit case, emit multiple relocations.
00214  */
00215 extern void
00216 Em_Add_New_Composite_Rela ( Elf64_AltRela *preloc, pSCNINFO scninfo );
00217 
00218 /* Change the origin for the section.  Subsequent calls to
00219  * Em_Add_Bytes_To_Scn will add stuff at the new origin.
00220  */
00221 extern void
00222 Em_Change_Section_Origin ( pSCNINFO scn, Elf64_Xword scn_ofst );
00223 
00224 /* Change the section alignment, if it is less than 'scn_align'. */
00225 extern void
00226 Em_Change_Section_Alignment ( pSCNINFO scn, Elf64_Word scn_align );
00227 
00228 
00229 /* write out 'length' number of bytes from the buffer 'input_buf',  to the 
00230    section 'scninfo' with the alignment 'align'. Any empty space is padded 
00231    with zeros. 
00232 
00233    This routine can be called with 'length' equal to 0 to just align 
00234    the current location in the section to the specified alignment 'align'
00235    without acutally writing out any bytes.
00236 */
00237 extern Elf64_Xword 
00238 Em_Add_Bytes_To_Scn (
00239     pSCNINFO scninfo,
00240     const void *input_buf,
00241     Elf64_Xword length,
00242     Elf64_Word align);
00243 
00244 
00245 /* write out 'length' number of bytes containing zero to the section
00246    'scninfo' with alignment 'align.
00247 */
00248 extern Elf64_Xword
00249 Em_Add_Zeros_To_Scn (
00250     pSCNINFO scninfo,
00251     Elf64_Word length,
00252     Elf64_Word align);
00253 
00254 
00255 /* Write out an "symbol + constant" expression at the current location in 
00256    the section 'scninfo'. The 'symindex' points to the symbol and 'addend'
00257    is the constant value.
00258 */
00259 extern Elf64_Xword
00260 Em_Add_Address_To_Scn (
00261     pSCNINFO scninfo,
00262     Elf64_Word symindex,
00263     Elf64_Sxword addend,
00264     Elf64_Word align);
00265 
00266 /* Write out a section displacement expression at the current location in 
00267    the section 'scninfo'. The 'symindex' points to the symbol and 'addend'
00268    is the constant value.
00269 */
00270 extern Elf64_Xword
00271 Em_Add_Displacement_To_Scn (
00272     pSCNINFO scninfo,
00273     Elf64_Word symindex,
00274     Elf64_Sxword addend,
00275     Elf64_Word align);
00276 
00277 /* Set the sh_link field of a section. */
00278 extern void Em_Set_sh_link (pSCNINFO scn, Elf64_Word link);
00279 
00280 /* Set the sh_info field of a section. */
00281 extern void Em_Set_sh_info (pSCNINFO scn, Elf64_Word info);
00282 
00283 /* For a given 'scn' return its elf section index. */
00284 extern size_t Em_Get_Section_Index (pSCNINFO scn);
00285 
00286 /* For a given 'scn' return its section offset */
00287 extern Elf64_Xword Em_Get_Section_Offset (pSCNINFO scn);
00288 
00289 extern char *Em_Get_Section_Name (pSCNINFO scn);
00290 extern Elf64_Word Em_Get_Section_Type (pSCNINFO scn);
00291 extern Elf64_Word Em_Get_Section_Flags (pSCNINFO scn);
00292 extern Elf64_Word Em_Get_Section_Entsize (pSCNINFO scn);
00293 extern Elf64_Word Em_Get_Section_Align (pSCNINFO scn);
00294 extern Elf64_Word Em_Get_Section_Info (pSCNINFO scn);
00295 
00296 /* Create a section symbol for the given section, if it does not already
00297    exist. In any case, return the symindex of the section symbol. */
00298 extern Elf64_Word Em_Create_Section_Symbol (pSCNINFO scninfo);
00299 
00300 extern void
00301 Em_Write_Reginfo (
00302     Elf64_Addr gprvalue, 
00303     Elf64_Word gprmask, 
00304     Elf64_Word fprmask,
00305     BOOL pure_abi);
00306 
00307 /* Add a new event to the .events section. The 'operand1' and 'operand2'
00308    parameters are not needed for most of the event kinds. For those
00309    cases, the caller should pass 0 for these arguments. All offsets 
00310    passed as parameters should be byte offsets. The following event
00311    kinds need valid operands:
00312 
00313       EK_IF_ENTRY:             operand1 is offset in interface scn.
00314  
00315       EK_FCALL_LOCAL,
00316       EK_FCALL_EXTERN,
00317       EK_FCALL_EXTERN_BIG:     operand1 is elf symbol index of called proc.
00318 
00319       EK_SWITCH_{32,64}:  operand1 is gprel boolean, 
00320         operand2 is jumptable address,
00321         operand3 is number of table entries.
00322 */
00323 extern void 
00324 Em_Add_New_Event (
00325     Elf64_Word ev_kind,
00326     Elf64_Word ev_ofst,
00327     Elf64_Word operand1,
00328     Elf64_Word operand2,
00329     Elf64_Word operand3,
00330     pSCNINFO scn);
00331 
00332 /* Add a new entry to the .contents section. */
00333 extern void
00334 Em_Add_New_Content (
00335     Elf64_Word con_kind,
00336     Elf64_Xword con_ofst,
00337     Elf64_Word operand1,
00338     Elf64_Word operand2,
00339     pSCNINFO scn);
00340 
00341 /* Add a new entry to the .options section. */
00342 extern void
00343 Em_Add_New_Option (
00344     Elf32_Byte option_kind,
00345     Elf32_Section option_section,
00346     Elf32_Word option_info,
00347     void *buffer,
00348     Elf32_Byte length);
00349 
00350 /* Add a new entry to the .interface section. */
00351 
00352 extern void
00353 Em_Add_New_Interface (
00354     Elf64_Word length,
00355     Elf64_Byte *data);
00356 
00357 /* Add a comment string;
00358  * if the string contains no colons (':'),
00359  * then assume we are only passing the toolname,
00360  * and this routine will go ahead and add the version information.
00361  * E.g. can pass "be" or "be::4.00:".
00362  */
00363 extern void Em_Add_Comment (char *s);
00364 
00365 /* end unwind section (if any). 
00366  * must be called before Em_End_File.
00367  * if trace_file is set then will dump ascii form to file.
00368  */
00369 extern void Em_End_Unwind (FILE *trace_file, pSCNINFO text_scn);
00370 
00371 /* must be called after Em_End_File */
00372 extern void Em_Cleanup_Unwind (void);
00373 
00374 #ifdef __cplusplus
00375 }
00376 #endif
00377 #endif /* em_elf_INCLUDED */
osprey/common/com/em_elf.h
