Blame view

include/linux/elfnote.h 3.5 KB
9c9b8b388   Jeremy Fitzhardinge   [PATCH] x86: put ...
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
  #ifndef _LINUX_ELFNOTE_H
  #define _LINUX_ELFNOTE_H
  /*
   * Helper macros to generate ELF Note structures, which are put into a
   * PT_NOTE segment of the final vmlinux image.  These are useful for
   * including name-value pairs of metadata into the kernel binary (or
   * modules?) for use by external programs.
   *
   * Each note has three parts: a name, a type and a desc.  The name is
   * intended to distinguish the note's originator, so it would be a
   * company, project, subsystem, etc; it must be in a suitable form for
   * use in a section name.  The type is an integer which is used to tag
   * the data, and is considered to be within the "name" namespace (so
   * "FooCo"'s type 42 is distinct from "BarProj"'s type 42).  The
   * "desc" field is the actual data.  There are no constraints on the
   * desc field's contents, though typically they're fairly small.
   *
   * All notes from a given NAME are put into a section named
   * .note.NAME.  When the kernel image is finally linked, all the notes
   * are packed into a single .notes section, which is mapped into the
   * PT_NOTE segment.  Because notes for a given name are grouped into
   * the same section, they'll all be adjacent the output file.
   *
   * This file defines macros for both C and assembler use.  Their
   * syntax is slightly different, but they're semantically similar.
   *
   * See the ELF specification for more detail about ELF notes.
   */
  
  #ifdef __ASSEMBLER__
  /*
   * Generate a structure with the same shape as Elf{32,64}_Nhdr (which
   * turn out to be the same size and shape), followed by the name and
5091e7468   Ian Campbell   [PATCH] Translate...
34
35
36
37
38
39
   * desc data with appropriate padding.  The 'desctype' argument is the
   * assembler pseudo op defining the type of the data e.g. .asciz while
   * 'descdata' is the data itself e.g.  "hello, world".
   *
   * e.g. ELFNOTE(XYZCo, 42, .asciz, "forty-two")
   *      ELFNOTE(XYZCo, 12, .long, 0xdeadbeef)
9c9b8b388   Jeremy Fitzhardinge   [PATCH] x86: put ...
40
   */
810bab448   Jeremy Fitzhardinge   use elfnote.h to ...
41
42
43
  #define ELFNOTE_START(name, type, flags)	\
  .pushsection .note.name, flags,@note	;	\
    .balign 4				;	\
5091e7468   Ian Campbell   [PATCH] Translate...
44
    .long 2f - 1f		/* namesz */	;	\
810bab448   Jeremy Fitzhardinge   use elfnote.h to ...
45
    .long 4484f - 3f	/* descsz */	;	\
5091e7468   Ian Campbell   [PATCH] Translate...
46
    .long type				;	\
03df4f6ee   Jeremy Fitzhardinge   [PATCH] i386: Cle...
47
  1:.asciz #name				;	\
810bab448   Jeremy Fitzhardinge   use elfnote.h to ...
48
49
50
51
52
  2:.balign 4				;	\
  3:
  
  #define ELFNOTE_END				\
  4484:.balign 4				;	\
5091e7468   Ian Campbell   [PATCH] Translate...
53
  .popsection				;
810bab448   Jeremy Fitzhardinge   use elfnote.h to ...
54
55
56
57
58
  
  #define ELFNOTE(name, type, desc)		\
  	ELFNOTE_START(name, type, "")		\
  		desc			;	\
  	ELFNOTE_END
9c9b8b388   Jeremy Fitzhardinge   [PATCH] x86: put ...
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
  #else	/* !__ASSEMBLER__ */
  #include <linux/elf.h>
  /*
   * Use an anonymous structure which matches the shape of
   * Elf{32,64}_Nhdr, but includes the name and desc data.  The size and
   * type of name and desc depend on the macro arguments.  "name" must
   * be a literal string, and "desc" must be passed by value.  You may
   * only define one note per line, since __LINE__ is used to generate
   * unique symbols.
   */
  #define _ELFNOTE_PASTE(a,b)	a##b
  #define _ELFNOTE(size, name, unique, type, desc)			\
  	static const struct {						\
  		struct elf##size##_note _nhdr;				\
  		unsigned char _name[sizeof(name)]			\
  		__attribute__((aligned(sizeof(Elf##size##_Word))));	\
  		typeof(desc) _desc					\
  			     __attribute__((aligned(sizeof(Elf##size##_Word)))); \
  	} _ELFNOTE_PASTE(_note_, unique)				\
3ff6eecca   Adrian Bunk   remove __attribut...
78
  		__used							\
9c9b8b388   Jeremy Fitzhardinge   [PATCH] x86: put ...
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
  		__attribute__((section(".note." name),			\
  			       aligned(sizeof(Elf##size##_Word)),	\
  			       unused)) = {				\
  		{							\
  			sizeof(name),					\
  			sizeof(desc),					\
  			type,						\
  		},							\
  		name,							\
  		desc							\
  	}
  #define ELFNOTE(size, name, type, desc)		\
  	_ELFNOTE(size, name, __LINE__, type, desc)
  
  #define ELFNOTE32(name, type, desc) ELFNOTE(32, name, type, desc)
  #define ELFNOTE64(name, type, desc) ELFNOTE(64, name, type, desc)
  #endif	/* __ASSEMBLER__ */
  
  #endif /* _LINUX_ELFNOTE_H */