include/elf/reloc-macros.h

   1 /* Generic relocation support for BFD.
   2    Copyright (C) 1998 Free Software Foundation, Inc.
   3
   4    This file is part of BFD, the Binary File Descriptor library.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, write to the Free Software Foundation,
  18    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  19
  20 /* These macros are used by the various elf/*.h target specific header
  21    files to either generate an enum containing all the known relocations
  22    for that target, or if RELOC_MACROS_GEN_FUNC is defined, a recognition
  23    function is generated instead.  (This is used by binutils/readelf.c)
  24
  25    Given a header file like this:
  26
  27         START_RELOC_NUMBERS (foo)
  28             RELOC_NUMBER (R_foo_NONE,    0)
  29             RELOC_NUMBER (R_foo_32,      1)
  30             FAKE_RELOC   (R_foo_illegal, 2)
  31             EMPTY_RELOC  (R_foo_max)
  32         END_RELOC_NUMBERS
  33
  34    Then the following will be produced by default (ie if
  35    RELOC_MACROS_GEN_FUNC is *not* defined).
  36
  37         enum foo {
  38           R_foo_NONE = 0,
  39           R_foo_32 = 1,
  40           R_foo_illegal = 2,
  41           R_foo_max
  42         };
  43
  44    If RELOC_MACROS_GEN_FUNC *is* defined, then instead the
  45    following function will be generated:
  46
  47         static char * foo PARAMS ((unsigned long rtype));
  48         static char *
  49         foo (rtype)
  50             unsigned long rtype;
  51         {
  52            switch (rtype)
  53            {
  54            case 0: return "R_foo_NONE";
  55            case 1: return "R_foo_32";
  56            default: return NULL;
  57            }
  58         }
  59    */
  60
  61 #ifndef _RELOC_MACROS_H
  62 #define _RELOC_MACROS_H
  63
  64 #ifdef RELOC_MACROS_GEN_FUNC
  65
  66 /* This function takes the relocation number and returns the
  67    string version name of the name of that relocation.  If
  68    the relocation is not recognised, NULL is returned.  */
  69
  70 #define START_RELOC_NUMBERS(name)                               \
  71 static const char * name    PARAMS ((unsigned long rtype));     \
  72 static const char *                                             \
  73 name (rtype)                                                    \
  74         unsigned long rtype;                                    \
  75 {                                                               \
  76   switch (rtype)                                                \
  77   {
  78
  79 #ifdef __STDC__
  80 #define RELOC_NUMBER(name, number)  case number : return #name ;
  81 #else
  82 #define RELOC_NUMBER(name, number)  case number : return "name" ;
  83 #endif
  84
  85 #define FAKE_RELOC(name, number)
  86 #define EMPTY_RELOC(name)
  87
  88 #define END_RELOC_NUMBERS               default: return NULL;   \
  89                                         }                       \
  90                                     }
  91
  92
  93 #else /* default to generating enum */
  94
  95 #define START_RELOC_NUMBERS(name)   enum name {
  96 #define RELOC_NUMBER(name, number)  name = number ,
  97 #define FAKE_RELOC(name, number)    name = number ,
  98 #define EMPTY_RELOC(name)           name ,
  99 #define END_RELOC_NUMBERS           };
 100
 101 #endif
 102
 103 #endif /* RELOC_MACROS_H */