[linux-2.6-block.git] / scripts / mod / modpost.h

/* SPDX-License-Identifier: GPL-2.0 */
#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <string.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/mman.h>
#include <fcntl.h>
#include <unistd.h>
#include <elf.h>

#include "elfconfig.h"

/* On BSD-alike OSes elf.h defines these according to host's word size */
#undef ELF_ST_BIND
#undef ELF_ST_TYPE
#undef ELF_R_SYM
#undef ELF_R_TYPE

#if KERNEL_ELFCLASS == ELFCLASS32

#define Elf_Ehdr    Elf32_Ehdr
#define Elf_Shdr    Elf32_Shdr
#define Elf_Sym     Elf32_Sym
#define Elf_Addr    Elf32_Addr
#define Elf_Sword   Elf64_Sword
#define Elf_Section Elf32_Half
#define ELF_ST_BIND ELF32_ST_BIND
#define ELF_ST_TYPE ELF32_ST_TYPE

#define Elf_Rel     Elf32_Rel
#define Elf_Rela    Elf32_Rela
#define ELF_R_SYM   ELF32_R_SYM
#define ELF_R_TYPE  ELF32_R_TYPE
#else

#define Elf_Ehdr    Elf64_Ehdr
#define Elf_Shdr    Elf64_Shdr
#define Elf_Sym     Elf64_Sym
#define Elf_Addr    Elf64_Addr
#define Elf_Sword   Elf64_Sxword
#define Elf_Section Elf64_Half
#define ELF_ST_BIND ELF64_ST_BIND
#define ELF_ST_TYPE ELF64_ST_TYPE

#define Elf_Rel     Elf64_Rel
#define Elf_Rela    Elf64_Rela
#define ELF_R_SYM   ELF64_R_SYM
#define ELF_R_TYPE  ELF64_R_TYPE
#endif

/* The 64-bit MIPS ELF ABI uses an unusual reloc format. */
typedef struct
{
	Elf32_Word    r_sym;	/* Symbol index */
	unsigned char r_ssym;	/* Special symbol for 2nd relocation */
	unsigned char r_type3;	/* 3rd relocation type */
	unsigned char r_type2;	/* 2nd relocation type */
	unsigned char r_type1;	/* 1st relocation type */
} _Elf64_Mips_R_Info;

typedef union
{
	Elf64_Xword		r_info_number;
	_Elf64_Mips_R_Info	r_info_fields;
} _Elf64_Mips_R_Info_union;

#define ELF64_MIPS_R_SYM(i) \
  ((__extension__ (_Elf64_Mips_R_Info_union)(i)).r_info_fields.r_sym)

#define ELF64_MIPS_R_TYPE(i) \
  ((__extension__ (_Elf64_Mips_R_Info_union)(i)).r_info_fields.r_type1)

#if KERNEL_ELFDATA != HOST_ELFDATA

static inline void __endian(const void *src, void *dest, unsigned int size)
{
	unsigned int i;
	for (i = 0; i < size; i++)
		((unsigned char*)dest)[i] = ((unsigned char*)src)[size - i-1];
}

#define TO_NATIVE(x)						\
({								\
	typeof(x) __x;						\
	__endian(&(x), &(__x), sizeof(__x));			\
	__x;							\
})

#else /* endianness matches */

#define TO_NATIVE(x) (x)

#endif

#define NOFAIL(ptr)   do_nofail((ptr), #ptr)
void *do_nofail(void *ptr, const char *expr);

struct buffer {
	char *p;
	int pos;
	int size;
};

void __attribute__((format(printf, 2, 3)))
buf_printf(struct buffer *buf, const char *fmt, ...);

void
buf_write(struct buffer *buf, const char *s, int len);

struct namespace_list {
	struct namespace_list *next;
	char namespace[0];
};

struct module {
	struct module *next;
	const char *name;
	int gpl_compatible;
	struct symbol *unres;
	int seen;
	int skip;
	int has_init;
	int has_cleanup;
	struct buffer dev_table_buf;
	char	     srcversion[25];
	int is_dot_o;
	// Missing namespace dependencies
	struct namespace_list *missing_namespaces;
	// Actual imported namespaces
	struct namespace_list *imported_namespaces;
};

struct elf_info {
	unsigned long size;
	Elf_Ehdr     *hdr;
	Elf_Shdr     *sechdrs;
	Elf_Sym      *symtab_start;
	Elf_Sym      *symtab_stop;
	Elf_Section  export_sec;
	Elf_Section  export_unused_sec;
	Elf_Section  export_gpl_sec;
	Elf_Section  export_unused_gpl_sec;
	Elf_Section  export_gpl_future_sec;
	char         *strtab;
	char	     *modinfo;
	unsigned int modinfo_len;

	/* support for 32bit section numbers */

	unsigned int num_sections; /* max_secindex + 1 */
	unsigned int secindex_strings;
	/* if Nth symbol table entry has .st_shndx = SHN_XINDEX,
	 * take shndx from symtab_shndx_start[N] instead */
	Elf32_Word   *symtab_shndx_start;
	Elf32_Word   *symtab_shndx_stop;
};

static inline int is_shndx_special(unsigned int i)
{
	return i != SHN_XINDEX && i >= SHN_LORESERVE && i <= SHN_HIRESERVE;
}

/*
 * Move reserved section indices SHN_LORESERVE..SHN_HIRESERVE out of
 * the way to -256..-1, to avoid conflicting with real section
 * indices.
 */
#define SPECIAL(i) ((i) - (SHN_HIRESERVE + 1))

/* Accessor for sym->st_shndx, hides ugliness of "64k sections" */
static inline unsigned int get_secindex(const struct elf_info *info,
					const Elf_Sym *sym)
{
	if (is_shndx_special(sym->st_shndx))
		return SPECIAL(sym->st_shndx);
	if (sym->st_shndx != SHN_XINDEX)
		return sym->st_shndx;
	return info->symtab_shndx_start[sym - info->symtab_start];
}

/* file2alias.c */
extern unsigned int cross_build;
void handle_moddevtable(struct module *mod, struct elf_info *info,
			Elf_Sym *sym, const char *symname);
void add_moddevtable(struct buffer *buf, struct module *mod);

/* sumversion.c */
void maybe_frob_rcs_version(const char *modfilename,
			    char *version,
			    void *modinfo,
			    unsigned long modinfo_offset);
void get_src_version(const char *modname, char sum[], unsigned sumlen);

/* from modpost.c */
void *grab_file(const char *filename, unsigned long *size);
char* get_next_line(unsigned long *pos, void *file, unsigned long size);
void release_file(void *file, unsigned long size);

void fatal(const char *fmt, ...);
void warn(const char *fmt, ...);
void merror(const char *fmt, ...);
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	#include <stdio.h>
	3	#include <stdlib.h>
	4	#include <stdarg.h>
	5	#include <string.h>
	6	#include <sys/types.h>
	7	#include <sys/stat.h>
	8	#include <sys/mman.h>
	9	#include <fcntl.h>
	10	#include <unistd.h>
	11	#include <elf.h>
	12
	13	#include "elfconfig.h"
	14
3c0561e0 PF	15	/* On BSD-alike OSes elf.h defines these according to host's word size */
	16	#undef ELF_ST_BIND
	17	#undef ELF_ST_TYPE
	18	#undef ELF_R_SYM
	19	#undef ELF_R_TYPE
	20
1da177e4 LT	21	#if KERNEL_ELFCLASS == ELFCLASS32
1da177e4 LT	22
62070fa4 SR	23	#define Elf_Ehdr Elf32_Ehdr
62070fa4 SR	24	#define Elf_Shdr Elf32_Shdr
1da177e4	25	#define Elf_Sym Elf32_Sym
b39927cf	26	#define Elf_Addr Elf32_Addr
9ad21c3f	27	#define Elf_Sword Elf64_Sword
4f4c4ee1	28	#define Elf_Section Elf32_Half
1da177e4 LT	29	#define ELF_ST_BIND ELF32_ST_BIND
	30	#define ELF_ST_TYPE ELF32_ST_TYPE
	31
2c1a51f3	32	#define Elf_Rel Elf32_Rel
b39927cf SR	33	#define Elf_Rela Elf32_Rela
	34	#define ELF_R_SYM ELF32_R_SYM
	35	#define ELF_R_TYPE ELF32_R_TYPE
1da177e4 LT	36	#else
1da177e4 LT	37
62070fa4 SR	38	#define Elf_Ehdr Elf64_Ehdr
62070fa4 SR	39	#define Elf_Shdr Elf64_Shdr
1da177e4	40	#define Elf_Sym Elf64_Sym
b39927cf	41	#define Elf_Addr Elf64_Addr
9ad21c3f	42	#define Elf_Sword Elf64_Sxword
4f4c4ee1	43	#define Elf_Section Elf64_Half
1da177e4 LT	44	#define ELF_ST_BIND ELF64_ST_BIND
	45	#define ELF_ST_TYPE ELF64_ST_TYPE
	46
2c1a51f3	47	#define Elf_Rel Elf64_Rel
b39927cf SR	48	#define Elf_Rela Elf64_Rela
	49	#define ELF_R_SYM ELF64_R_SYM
	50	#define ELF_R_TYPE ELF64_R_TYPE
1da177e4 LT	51	#endif
1da177e4 LT	52
eae07ac6 AN	53	/* The 64-bit MIPS ELF ABI uses an unusual reloc format. */
	54	typedef struct
	55	{
	56	Elf32_Word r_sym; /* Symbol index */
	57	unsigned char r_ssym; /* Special symbol for 2nd relocation */
	58	unsigned char r_type3; /* 3rd relocation type */
	59	unsigned char r_type2; /* 2nd relocation type */
	60	unsigned char r_type1; /* 1st relocation type */
	61	} _Elf64_Mips_R_Info;
	62
	63	typedef union
	64	{
	65	Elf64_Xword r_info_number;
	66	_Elf64_Mips_R_Info r_info_fields;
	67	} _Elf64_Mips_R_Info_union;
	68
	69	#define ELF64_MIPS_R_SYM(i) \
	70	((__extension__ (_Elf64_Mips_R_Info_union)(i)).r_info_fields.r_sym)
	71
ae4ac123 AN	72	#define ELF64_MIPS_R_TYPE(i) \
	73	((__extension__ (_Elf64_Mips_R_Info_union)(i)).r_info_fields.r_type1)
	74
1da177e4 LT	75	#if KERNEL_ELFDATA != HOST_ELFDATA
	76
	77	static inline void __endian(const void src, void dest, unsigned int size)
	78	{
	79	unsigned int i;
	80	for (i = 0; i < size; i++)
	81	((unsigned char)dest)[i] = ((unsigned char)src)[size - i-1];
	82	}
	83
1da177e4 LT	84	#define TO_NATIVE(x) \
	85	({ \
	86	typeof(x) __x; \
	87	__endian(&(x), &(__x), sizeof(__x)); \
	88	__x; \
	89	})
	90
	91	#else /* endianness matches */
	92
	93	#define TO_NATIVE(x) (x)
	94
	95	#endif
	96
	97	#define NOFAIL(ptr) do_nofail((ptr), #ptr)
	98	void do_nofail(void ptr, const char *expr);
	99
	100	struct buffer {
	101	char *p;
	102	int pos;
	103	int size;
	104	};
	105
	106	void __attribute__((format(printf, 2, 3)))
	107	buf_printf(struct buffer buf, const char fmt, ...);
	108
	109	void
	110	buf_write(struct buffer buf, const char s, int len);
	111
cb9b55d2 MM	112	struct namespace_list {
	113	struct namespace_list *next;
	114	char namespace[0];
	115	};
	116
1da177e4 LT	117	struct module {
	118	struct module *next;
	119	const char *name;
b817f6fe	120	int gpl_compatible;
1da177e4 LT	121	struct symbol *unres;
	122	int seen;
	123	int skip;
	124	int has_init;
	125	int has_cleanup;
	126	struct buffer dev_table_buf;
	127	char srcversion[25];
258f7426	128	int is_dot_o;
bbc55bde MY	129	// Missing namespace dependencies
bbc55bde MY	130	struct namespace_list *missing_namespaces;
cb9b55d2 MM	131	// Actual imported namespaces
cb9b55d2 MM	132	struct namespace_list *imported_namespaces;
1da177e4 LT	133	};
	134
	135	struct elf_info {
	136	unsigned long size;
	137	Elf_Ehdr *hdr;
	138	Elf_Shdr *sechdrs;
	139	Elf_Sym *symtab_start;
	140	Elf_Sym *symtab_stop;
bd5cbced	141	Elf_Section export_sec;
c96fca21	142	Elf_Section export_unused_sec;
bd5cbced	143	Elf_Section export_gpl_sec;
c96fca21	144	Elf_Section export_unused_gpl_sec;
bd5cbced	145	Elf_Section export_gpl_future_sec;
7d02b490	146	char *strtab;
1da177e4 LT	147	char *modinfo;
1da177e4 LT	148	unsigned int modinfo_len;
1ce53adf DV	149
	150	/* support for 32bit section numbers */
	151
	152	unsigned int num_sections; /* max_secindex + 1 */
	153	unsigned int secindex_strings;
	154	/* if Nth symbol table entry has .st_shndx = SHN_XINDEX,
	155	* take shndx from symtab_shndx_start[N] instead */
	156	Elf32_Word *symtab_shndx_start;
	157	Elf32_Word *symtab_shndx_stop;
1da177e4 LT	158	};
1da177e4 LT	159
1ce53adf DV	160	static inline int is_shndx_special(unsigned int i)
	161	{
	162	return i != SHN_XINDEX && i >= SHN_LORESERVE && i <= SHN_HIRESERVE;
	163	}
	164
6845756b AK	165	/*
	166	* Move reserved section indices SHN_LORESERVE..SHN_HIRESERVE out of
	167	* the way to -256..-1, to avoid conflicting with real section
	168	* indices.
1ce53adf	169	*/
6845756b	170	#define SPECIAL(i) ((i) - (SHN_HIRESERVE + 1))
1ce53adf DV	171
	172	/* Accessor for sym->st_shndx, hides ugliness of "64k sections" */
	173	static inline unsigned int get_secindex(const struct elf_info *info,
	174	const Elf_Sym *sym)
	175	{
6845756b AK	176	if (is_shndx_special(sym->st_shndx))
6845756b AK	177	return SPECIAL(sym->st_shndx);
1ce53adf DV	178	if (sym->st_shndx != SHN_XINDEX)
1ce53adf DV	179	return sym->st_shndx;
6845756b	180	return info->symtab_shndx_start[sym - info->symtab_start];
1ce53adf DV	181	}
1ce53adf DV	182
cb80514d	183	/* file2alias.c */
4ce6efed	184	extern unsigned int cross_build;
1da177e4 LT	185	void handle_moddevtable(struct module mod, struct elf_info info,
1da177e4 LT	186	Elf_Sym sym, const char symname);
1da177e4 LT	187	void add_moddevtable(struct buffer buf, struct module mod);
1da177e4 LT	188
cb80514d	189	/* sumversion.c */
1da177e4 LT	190	void maybe_frob_rcs_version(const char *modfilename,
	191	char *version,
	192	void *modinfo,
	193	unsigned long modinfo_offset);
	194	void get_src_version(const char *modname, char sum[], unsigned sumlen);
	195
cb80514d	196	/* from modpost.c */
1da177e4 LT	197	void grab_file(const char filename, unsigned long *size);
	198	char* get_next_line(unsigned long pos, void file, unsigned long size);
	199	void release_file(void *file, unsigned long size);
cb80514d SR	200
	201	void fatal(const char *fmt, ...);
	202	void warn(const char *fmt, ...);
2a116659	203	void merror(const char *fmt, ...);