newlib/include/elf/reloc-macros.h

130 lines
4.0 KiB
C
Raw Normal View History

1999-05-03 09:29:06 +02:00
/* Generic relocation support for BFD.
2011-06-02 15:43:23 +02:00
Copyright 1998, 1999, 2000, 2003, 2010, 2011 Free Software Foundation, Inc.
1999-05-03 09:29:06 +02:00
This file is part of BFD, the Binary File Descriptor library.
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
2010-04-15 12:26:09 +02:00
the Free Software Foundation; either version 3 of the License, or
1999-05-03 09:29:06 +02:00
(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. */
1999-05-03 09:29:06 +02:00
/* These macros are used by the various *.h target specific header
files to either generate an enum containing all the known relocations
for that target, or if RELOC_MACROS_GEN_FUNC is defined, a recognition
function is generated instead. (This is used by binutils/readelf.c)
Given a header file like this:
START_RELOC_NUMBERS (foo)
RELOC_NUMBER (R_foo_NONE, 0)
RELOC_NUMBER (R_foo_32, 1)
EMPTY_RELOC (R_foo_good)
FAKE_RELOC (R_foo_illegal, 9)
END_RELOC_NUMBERS (R_foo_count)
1999-05-03 09:29:06 +02:00
Then the following will be produced by default (ie if
RELOC_MACROS_GEN_FUNC is *not* defined).
enum foo
{
R_foo_NONE = 0,
R_foo_32 = 1,
R_foo_good,
R_foo_illegal = 9,
R_foo_count
1999-05-03 09:29:06 +02:00
};
Note: The value of the symbol defined in the END_RELOC_NUMBERS
macro (R_foo_count in the case of the example above) will be
2011-06-02 15:43:23 +02:00
set to the value of the whichever *_RELOC macro precedes it plus
one. Therefore if you intend to use the symbol as a sentinel for
the highest valid macro value you should make sure that the
2011-06-02 15:43:23 +02:00
preceding *_RELOC macro is the highest valid number. ie a
declaration like this:
START_RELOC_NUMBERS (foo)
RELOC_NUMBER (R_foo_NONE, 0)
RELOC_NUMBER (R_foo_32, 1)
FAKE_RELOC (R_foo_illegal, 9)
FAKE_RELOC (R_foo_synonym, 0)
END_RELOC_NUMBERS (R_foo_count)
will result in R_foo_count having a value of 1 (R_foo_synonym + 1)
rather than 10 or 2 as might be expected.
Alternatively you can assign a value to END_RELOC_NUMBERS symbol
explicitly, like this:
START_RELOC_NUMBERS (foo)
RELOC_NUMBER (R_foo_NONE, 0)
RELOC_NUMBER (R_foo_32, 1)
FAKE_RELOC (R_foo_illegal, 9)
FAKE_RELOC (R_foo_synonym, 0)
END_RELOC_NUMBERS (R_foo_count = 2)
1999-05-03 09:29:06 +02:00
If RELOC_MACROS_GEN_FUNC *is* defined, then instead the
following function will be generated:
2003-08-07 04:25:50 +02:00
static const char *foo (unsigned long rtype);
1999-05-28 12:47:30 +02:00
static const char *
2003-08-07 04:25:50 +02:00
foo (unsigned long rtype)
1999-05-03 09:29:06 +02:00
{
switch (rtype)
{
case 0: return "R_foo_NONE";
case 1: return "R_foo_32";
default: return NULL;
}
}
*/
2000-06-03 03:57:29 +02:00
1999-05-03 09:29:06 +02:00
#ifndef _RELOC_MACROS_H
#define _RELOC_MACROS_H
#ifdef RELOC_MACROS_GEN_FUNC
/* This function takes the relocation number and returns the
string version name of the name of that relocation. If
the relocation is not recognised, NULL is returned. */
#define START_RELOC_NUMBERS(name) \
2003-08-07 04:25:50 +02:00
static const char *name (unsigned long rtype); \
1999-05-03 09:29:06 +02:00
static const char * \
2003-08-07 04:25:50 +02:00
name (unsigned long rtype) \
1999-05-03 09:29:06 +02:00
{ \
switch (rtype) \
2003-08-07 04:25:50 +02:00
{
1999-05-03 09:29:06 +02:00
2003-08-07 04:25:50 +02:00
#define RELOC_NUMBER(name, number) \
case number: return #name;
1999-05-03 09:29:06 +02:00
2000-06-03 03:57:29 +02:00
#define FAKE_RELOC(name, number)
1999-05-03 09:29:06 +02:00
#define EMPTY_RELOC(name)
2000-06-03 03:57:29 +02:00
#define END_RELOC_NUMBERS(name) \
1999-05-03 09:29:06 +02:00
default: return NULL; \
2003-08-07 04:25:50 +02:00
} \
1999-05-03 09:29:06 +02:00
}
#else /* Default to generating enum. */
#define START_RELOC_NUMBERS(name) enum name {
#define RELOC_NUMBER(name, number) name = number,
#define FAKE_RELOC(name, number) name = number,
#define EMPTY_RELOC(name) name,
#define END_RELOC_NUMBERS(name) name };
1999-05-03 09:29:06 +02:00
#endif
2007-02-06 15:50:58 +01:00
#endif /* _RELOC_MACROS_H */