[people/arne_f/kernel.git] / scripts / sortextable.c

/*
 * sortextable.c: Sort the kernel's exception table
 *
 * Copyright 2011 - 2012 Cavium, Inc.
 *
 * Based on code taken from recortmcount.c which is:
 *
 * Copyright 2009 John F. Reiser <jreiser@BitWagon.com>.  All rights reserved.
 * Licensed under the GNU General Public License, version 2 (GPLv2).
 *
 * Restructured to fit Linux format, as well as other updates:
 *  Copyright 2010 Steven Rostedt <srostedt@redhat.com>, Red Hat Inc.
 */

/*
 * Strategy: alter the vmlinux file in-place.
 */

#include <sys/types.h>
#include <sys/mman.h>
#include <sys/stat.h>
#include <getopt.h>
#include <elf.h>
#include <fcntl.h>
#include <setjmp.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>

#include <tools/be_byteshift.h>
#include <tools/le_byteshift.h>

#ifndef EM_AARCH64
#define EM_AARCH64	183
#endif

static int fd_map;	/* File descriptor for file being modified. */
static int mmap_failed; /* Boolean flag. */
static void *ehdr_curr; /* current ElfXX_Ehdr *  for resource cleanup */
static struct stat sb;	/* Remember .st_size, etc. */
static jmp_buf jmpenv;	/* setjmp/longjmp per-file error escape */

/* setjmp() return values */
enum {
	SJ_SETJMP = 0,  /* hardwired first return */
	SJ_FAIL,
	SJ_SUCCEED
};

/* Per-file resource cleanup when multiple files. */
static void
cleanup(void)
{
	if (!mmap_failed)
		munmap(ehdr_curr, sb.st_size);
	close(fd_map);
}

static void __attribute__((noreturn))
fail_file(void)
{
	cleanup();
	longjmp(jmpenv, SJ_FAIL);
}

/*
 * Get the whole file as a programming convenience in order to avoid
 * malloc+lseek+read+free of many pieces.  If successful, then mmap
 * avoids copying unused pieces; else just read the whole file.
 * Open for both read and write.
 */
static void *mmap_file(char const *fname)
{
	void *addr;

	fd_map = open(fname, O_RDWR);
	if (fd_map < 0 || fstat(fd_map, &sb) < 0) {
		perror(fname);
		fail_file();
	}
	if (!S_ISREG(sb.st_mode)) {
		fprintf(stderr, "not a regular file: %s\n", fname);
		fail_file();
	}
	addr = mmap(0, sb.st_size, PROT_READ|PROT_WRITE, MAP_SHARED,
		    fd_map, 0);
	if (addr == MAP_FAILED) {
		mmap_failed = 1;
		fprintf(stderr, "Could not mmap file: %s\n", fname);
		fail_file();
	}
	return addr;
}

static uint64_t r8be(const uint64_t *x)
{
	return get_unaligned_be64(x);
}
static uint32_t rbe(const uint32_t *x)
{
	return get_unaligned_be32(x);
}
static uint16_t r2be(const uint16_t *x)
{
	return get_unaligned_be16(x);
}
static uint64_t r8le(const uint64_t *x)
{
	return get_unaligned_le64(x);
}
static uint32_t rle(const uint32_t *x)
{
	return get_unaligned_le32(x);
}
static uint16_t r2le(const uint16_t *x)
{
	return get_unaligned_le16(x);
}

static void w8be(uint64_t val, uint64_t *x)
{
	put_unaligned_be64(val, x);
}
static void wbe(uint32_t val, uint32_t *x)
{
	put_unaligned_be32(val, x);
}
static void w2be(uint16_t val, uint16_t *x)
{
	put_unaligned_be16(val, x);
}
static void w8le(uint64_t val, uint64_t *x)
{
	put_unaligned_le64(val, x);
}
static void wle(uint32_t val, uint32_t *x)
{
	put_unaligned_le32(val, x);
}
static void w2le(uint16_t val, uint16_t *x)
{
	put_unaligned_le16(val, x);
}

static uint64_t (*r8)(const uint64_t *);
static uint32_t (*r)(const uint32_t *);
static uint16_t (*r2)(const uint16_t *);
static void (*w8)(uint64_t, uint64_t *);
static void (*w)(uint32_t, uint32_t *);
static void (*w2)(uint16_t, uint16_t *);

typedef void (*table_sort_t)(char *, int);

/*
 * 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))

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

/* Accessor for sym->st_shndx, hides ugliness of "64k sections" */
static inline unsigned int get_secindex(unsigned int shndx,
					unsigned int sym_offs,
					const Elf32_Word *symtab_shndx_start)
{
	if (is_shndx_special(shndx))
		return SPECIAL(shndx);
	if (shndx != SHN_XINDEX)
		return shndx;
	return r(&symtab_shndx_start[sym_offs]);
}

/* 32 bit and 64 bit are very similar */
#include "sortextable.h"
#define SORTEXTABLE_64
#include "sortextable.h"

static int compare_relative_table(const void *a, const void *b)
{
	int32_t av = (int32_t)r(a);
	int32_t bv = (int32_t)r(b);

	if (av < bv)
		return -1;
	if (av > bv)
		return 1;
	return 0;
}

static void sort_relative_table(char *extab_image, int image_size)
{
	int i;

	/*
	 * Do the same thing the runtime sort does, first normalize to
	 * being relative to the start of the section.
	 */
	i = 0;
	while (i < image_size) {
		uint32_t *loc = (uint32_t *)(extab_image + i);
		w(r(loc) + i, loc);
		i += 4;
	}

	qsort(extab_image, image_size / 8, 8, compare_relative_table);

	/* Now denormalize. */
	i = 0;
	while (i < image_size) {
		uint32_t *loc = (uint32_t *)(extab_image + i);
		w(r(loc) - i, loc);
		i += 4;
	}
}

static void
do_file(char const *const fname)
{
	table_sort_t custom_sort;
	Elf32_Ehdr *ehdr = mmap_file(fname);

	ehdr_curr = ehdr;
	switch (ehdr->e_ident[EI_DATA]) {
	default:
		fprintf(stderr, "unrecognized ELF data encoding %d: %s\n",
			ehdr->e_ident[EI_DATA], fname);
		fail_file();
		break;
	case ELFDATA2LSB:
		r = rle;
		r2 = r2le;
		r8 = r8le;
		w = wle;
		w2 = w2le;
		w8 = w8le;
		break;
	case ELFDATA2MSB:
		r = rbe;
		r2 = r2be;
		r8 = r8be;
		w = wbe;
		w2 = w2be;
		w8 = w8be;
		break;
	}  /* end switch */
	if (memcmp(ELFMAG, ehdr->e_ident, SELFMAG) != 0
	||  r2(&ehdr->e_type) != ET_EXEC
	||  ehdr->e_ident[EI_VERSION] != EV_CURRENT) {
		fprintf(stderr, "unrecognized ET_EXEC file %s\n", fname);
		fail_file();
	}

	custom_sort = NULL;
	switch (r2(&ehdr->e_machine)) {
	default:
		fprintf(stderr, "unrecognized e_machine %d %s\n",
			r2(&ehdr->e_machine), fname);
		fail_file();
		break;
	case EM_386:
	case EM_X86_64:
	case EM_S390:
		custom_sort = sort_relative_table;
		break;
	case EM_ARM:
	case EM_AARCH64:
	case EM_MIPS:
		break;
	}  /* end switch */

	switch (ehdr->e_ident[EI_CLASS]) {
	default:
		fprintf(stderr, "unrecognized ELF class %d %s\n",
			ehdr->e_ident[EI_CLASS], fname);
		fail_file();
		break;
	case ELFCLASS32:
		if (r2(&ehdr->e_ehsize) != sizeof(Elf32_Ehdr)
		||  r2(&ehdr->e_shentsize) != sizeof(Elf32_Shdr)) {
			fprintf(stderr,
				"unrecognized ET_EXEC file: %s\n", fname);
			fail_file();
		}
		do32(ehdr, fname, custom_sort);
		break;
	case ELFCLASS64: {
		Elf64_Ehdr *const ghdr = (Elf64_Ehdr *)ehdr;
		if (r2(&ghdr->e_ehsize) != sizeof(Elf64_Ehdr)
		||  r2(&ghdr->e_shentsize) != sizeof(Elf64_Shdr)) {
			fprintf(stderr,
				"unrecognized ET_EXEC file: %s\n", fname);
			fail_file();
		}
		do64(ghdr, fname, custom_sort);
		break;
	}
	}  /* end switch */

	cleanup();
}

int
main(int argc, char *argv[])
{
	int n_error = 0;  /* gcc-4.3.0 false positive complaint */
	int i;

	if (argc < 2) {
		fprintf(stderr, "usage: sortextable vmlinux...\n");
		return 0;
	}

	/* Process each file in turn, allowing deep failure. */
	for (i = 1; i < argc; i++) {
		char *file = argv[i];
		int const sjval = setjmp(jmpenv);

		switch (sjval) {
		default:
			fprintf(stderr, "internal error: %s\n", file);
			exit(1);
			break;
		case SJ_SETJMP:    /* normal sequence */
			/* Avoid problems if early cleanup() */
			fd_map = -1;
			ehdr_curr = NULL;
			mmap_failed = 1;
			do_file(file);
			break;
		case SJ_FAIL:    /* error in do_file or below */
			++n_error;
			break;
		case SJ_SUCCEED:    /* premature success */
			/* do nothing */
			break;
		}  /* end switch */
	}
	return !!n_error;
}
Commit	Line	Data
a79f248b DD	1	/*
	2	* sortextable.c: Sort the kernel's exception table
	3	*
d59a1683	4	* Copyright 2011 - 2012 Cavium, Inc.
a79f248b DD	5	*
	6	* Based on code taken from recortmcount.c which is:
	7	*
	8	* Copyright 2009 John F. Reiser <jreiser@BitWagon.com>. All rights reserved.
	9	* Licensed under the GNU General Public License, version 2 (GPLv2).
	10	*
	11	* Restructured to fit Linux format, as well as other updates:
	12	* Copyright 2010 Steven Rostedt <srostedt@redhat.com>, Red Hat Inc.
	13	*/
	14
	15	/*
	16	* Strategy: alter the vmlinux file in-place.
	17	*/
	18
	19	#include <sys/types.h>
	20	#include <sys/mman.h>
	21	#include <sys/stat.h>
	22	#include <getopt.h>
	23	#include <elf.h>
	24	#include <fcntl.h>
	25	#include <setjmp.h>
	26	#include <stdio.h>
	27	#include <stdlib.h>
	28	#include <string.h>
	29	#include <unistd.h>
	30
d59a1683 DD	31	#include <tools/be_byteshift.h>
	32	#include <tools/le_byteshift.h>
	33
adace895 WD	34	#ifndef EM_AARCH64
	35	#define EM_AARCH64 183
	36	#endif
	37
a79f248b DD	38	static int fd_map; /* File descriptor for file being modified. */
	39	static int mmap_failed; /* Boolean flag. */
	40	static void ehdr_curr; / current ElfXX_Ehdr * for resource cleanup */
	41	static struct stat sb; /* Remember .st_size, etc. */
	42	static jmp_buf jmpenv; /* setjmp/longjmp per-file error escape */
	43
	44	/* setjmp() return values */
	45	enum {
	46	SJ_SETJMP = 0, /* hardwired first return */
	47	SJ_FAIL,
	48	SJ_SUCCEED
	49	};
	50
	51	/* Per-file resource cleanup when multiple files. */
	52	static void
	53	cleanup(void)
	54	{
	55	if (!mmap_failed)
	56	munmap(ehdr_curr, sb.st_size);
	57	close(fd_map);
	58	}
	59
	60	static void __attribute__((noreturn))
	61	fail_file(void)
	62	{
	63	cleanup();
	64	longjmp(jmpenv, SJ_FAIL);
	65	}
	66
a79f248b DD	67	/*
	68	* Get the whole file as a programming convenience in order to avoid
	69	* malloc+lseek+read+free of many pieces. If successful, then mmap
	70	* avoids copying unused pieces; else just read the whole file.
	71	* Open for both read and write.
	72	*/
	73	static void mmap_file(char const fname)
	74	{
	75	void *addr;
	76
	77	fd_map = open(fname, O_RDWR);
	78	if (fd_map < 0 \|\| fstat(fd_map, &sb) < 0) {
	79	perror(fname);
	80	fail_file();
	81	}
	82	if (!S_ISREG(sb.st_mode)) {
	83	fprintf(stderr, "not a regular file: %s\n", fname);
	84	fail_file();
	85	}
	86	addr = mmap(0, sb.st_size, PROT_READ\|PROT_WRITE, MAP_SHARED,
	87	fd_map, 0);
	88	if (addr == MAP_FAILED) {
	89	mmap_failed = 1;
	90	fprintf(stderr, "Could not mmap file: %s\n", fname);
	91	fail_file();
	92	}
	93	return addr;
	94	}
	95
d59a1683	96	static uint64_t r8be(const uint64_t *x)
a79f248b	97	{
d59a1683	98	return get_unaligned_be64(x);
a79f248b	99	}
d59a1683	100	static uint32_t rbe(const uint32_t *x)
a79f248b	101	{
d59a1683	102	return get_unaligned_be32(x);
a79f248b	103	}
d59a1683	104	static uint16_t r2be(const uint16_t *x)
a79f248b	105	{
d59a1683	106	return get_unaligned_be16(x);
a79f248b	107	}
d59a1683	108	static uint64_t r8le(const uint64_t *x)
a79f248b	109	{
d59a1683	110	return get_unaligned_le64(x);
a79f248b	111	}
d59a1683 DD	112	static uint32_t rle(const uint32_t *x)
	113	{
	114	return get_unaligned_le32(x);
	115	}
	116	static uint16_t r2le(const uint16_t *x)
a79f248b	117	{
d59a1683	118	return get_unaligned_le16(x);
a79f248b DD	119	}
a79f248b DD	120
d59a1683 DD	121	static void w8be(uint64_t val, uint64_t *x)
	122	{
	123	put_unaligned_be64(val, x);
	124	}
	125	static void wbe(uint32_t val, uint32_t *x)
	126	{
	127	put_unaligned_be32(val, x);
	128	}
	129	static void w2be(uint16_t val, uint16_t *x)
	130	{
	131	put_unaligned_be16(val, x);
	132	}
	133	static void w8le(uint64_t val, uint64_t *x)
	134	{
	135	put_unaligned_le64(val, x);
	136	}
	137	static void wle(uint32_t val, uint32_t *x)
	138	{
	139	put_unaligned_le32(val, x);
	140	}
	141	static void w2le(uint16_t val, uint16_t *x)
a79f248b	142	{
d59a1683	143	put_unaligned_le16(val, x);
a79f248b DD	144	}
a79f248b DD	145
d59a1683 DD	146	static uint64_t (r8)(const uint64_t );
	147	static uint32_t (r)(const uint32_t );
	148	static uint16_t (r2)(const uint16_t );
	149	static void (w8)(uint64_t, uint64_t );
	150	static void (w)(uint32_t, uint32_t );
	151	static void (w2)(uint16_t, uint16_t );
a79f248b	152
d59a1683	153	typedef void (table_sort_t)(char , int);
a79f248b	154
59c36455 JI	155	/*
	156	* Move reserved section indices SHN_LORESERVE..SHN_HIRESERVE out of
	157	* the way to -256..-1, to avoid conflicting with real section
	158	* indices.
	159	*/
	160	#define SPECIAL(i) ((i) - (SHN_HIRESERVE + 1))
	161
	162	static inline int is_shndx_special(unsigned int i)
	163	{
	164	return i != SHN_XINDEX && i >= SHN_LORESERVE && i <= SHN_HIRESERVE;
	165	}
	166
	167	/* Accessor for sym->st_shndx, hides ugliness of "64k sections" */
	168	static inline unsigned int get_secindex(unsigned int shndx,
	169	unsigned int sym_offs,
	170	const Elf32_Word *symtab_shndx_start)
	171	{
	172	if (is_shndx_special(shndx))
	173	return SPECIAL(shndx);
	174	if (shndx != SHN_XINDEX)
	175	return shndx;
	176	return r(&symtab_shndx_start[sym_offs]);
	177	}
	178
a79f248b DD	179	/* 32 bit and 64 bit are very similar */
	180	#include "sortextable.h"
	181	#define SORTEXTABLE_64
	182	#include "sortextable.h"
	183
eb608fb3	184	static int compare_relative_table(const void a, const void b)
d59a1683 DD	185	{
	186	int32_t av = (int32_t)r(a);
	187	int32_t bv = (int32_t)r(b);
	188
	189	if (av < bv)
	190	return -1;
	191	if (av > bv)
	192	return 1;
	193	return 0;
	194	}
	195
eb608fb3	196	static void sort_relative_table(char *extab_image, int image_size)
d59a1683 DD	197	{
	198	int i;
	199
	200	/*
	201	* Do the same thing the runtime sort does, first normalize to
	202	* being relative to the start of the section.
	203	*/
	204	i = 0;
	205	while (i < image_size) {
	206	uint32_t loc = (uint32_t )(extab_image + i);
	207	w(r(loc) + i, loc);
	208	i += 4;
	209	}
	210
eb608fb3	211	qsort(extab_image, image_size / 8, 8, compare_relative_table);
d59a1683 DD	212
	213	/* Now denormalize. */
	214	i = 0;
	215	while (i < image_size) {
	216	uint32_t loc = (uint32_t )(extab_image + i);
	217	w(r(loc) - i, loc);
	218	i += 4;
	219	}
	220	}
a79f248b DD	221
	222	static void
	223	do_file(char const *const fname)
	224	{
d59a1683 DD	225	table_sort_t custom_sort;
d59a1683 DD	226	Elf32_Ehdr *ehdr = mmap_file(fname);
a79f248b DD	227
a79f248b DD	228	ehdr_curr = ehdr;
a79f248b	229	switch (ehdr->e_ident[EI_DATA]) {
a79f248b DD	230	default:
	231	fprintf(stderr, "unrecognized ELF data encoding %d: %s\n",
	232	ehdr->e_ident[EI_DATA], fname);
	233	fail_file();
	234	break;
	235	case ELFDATA2LSB:
d59a1683 DD	236	r = rle;
	237	r2 = r2le;
	238	r8 = r8le;
	239	w = wle;
	240	w2 = w2le;
	241	w8 = w8le;
a79f248b DD	242	break;
a79f248b DD	243	case ELFDATA2MSB:
d59a1683 DD	244	r = rbe;
	245	r2 = r2be;
	246	r8 = r8be;
	247	w = wbe;
	248	w2 = w2be;
	249	w8 = w8be;
a79f248b DD	250	break;
	251	} /* end switch */
	252	if (memcmp(ELFMAG, ehdr->e_ident, SELFMAG) != 0
d59a1683	253	\|\| r2(&ehdr->e_type) != ET_EXEC
a79f248b DD	254	\|\| ehdr->e_ident[EI_VERSION] != EV_CURRENT) {
	255	fprintf(stderr, "unrecognized ET_EXEC file %s\n", fname);
	256	fail_file();
	257	}
	258
d59a1683 DD	259	custom_sort = NULL;
d59a1683 DD	260	switch (r2(&ehdr->e_machine)) {
a79f248b DD	261	default:
a79f248b DD	262	fprintf(stderr, "unrecognized e_machine %d %s\n",
d59a1683	263	r2(&ehdr->e_machine), fname);
a79f248b DD	264	fail_file();
	265	break;
	266	case EM_386:
a79f248b	267	case EM_X86_64:
3193a98d	268	case EM_S390:
eb608fb3 HC	269	custom_sort = sort_relative_table;
eb608fb3 HC	270	break;
ee951c63	271	case EM_ARM:
adace895	272	case EM_AARCH64:
d59a1683	273	case EM_MIPS:
a79f248b DD	274	break;
	275	} /* end switch */
	276
	277	switch (ehdr->e_ident[EI_CLASS]) {
	278	default:
	279	fprintf(stderr, "unrecognized ELF class %d %s\n",
	280	ehdr->e_ident[EI_CLASS], fname);
	281	fail_file();
	282	break;
	283	case ELFCLASS32:
d59a1683 DD	284	if (r2(&ehdr->e_ehsize) != sizeof(Elf32_Ehdr)
d59a1683 DD	285	\|\| r2(&ehdr->e_shentsize) != sizeof(Elf32_Shdr)) {
a79f248b DD	286	fprintf(stderr,
	287	"unrecognized ET_EXEC file: %s\n", fname);
	288	fail_file();
	289	}
d59a1683	290	do32(ehdr, fname, custom_sort);
a79f248b DD	291	break;
	292	case ELFCLASS64: {
	293	Elf64_Ehdr const ghdr = (Elf64_Ehdr )ehdr;
d59a1683 DD	294	if (r2(&ghdr->e_ehsize) != sizeof(Elf64_Ehdr)
d59a1683 DD	295	\|\| r2(&ghdr->e_shentsize) != sizeof(Elf64_Shdr)) {
a79f248b DD	296	fprintf(stderr,
	297	"unrecognized ET_EXEC file: %s\n", fname);
	298	fail_file();
	299	}
d59a1683	300	do64(ghdr, fname, custom_sort);
a79f248b DD	301	break;
	302	}
	303	} /* end switch */
	304
	305	cleanup();
	306	}
	307
	308	int
	309	main(int argc, char *argv[])
	310	{
	311	int n_error = 0; /* gcc-4.3.0 false positive complaint */
	312	int i;
	313
	314	if (argc < 2) {
	315	fprintf(stderr, "usage: sortextable vmlinux...\n");
	316	return 0;
	317	}
	318
	319	/* Process each file in turn, allowing deep failure. */
	320	for (i = 1; i < argc; i++) {
	321	char *file = argv[i];
	322	int const sjval = setjmp(jmpenv);
	323
	324	switch (sjval) {
	325	default:
	326	fprintf(stderr, "internal error: %s\n", file);
	327	exit(1);
	328	break;
	329	case SJ_SETJMP: /* normal sequence */
	330	/* Avoid problems if early cleanup() */
	331	fd_map = -1;
	332	ehdr_curr = NULL;
	333	mmap_failed = 1;
	334	do_file(file);
	335	break;
	336	case SJ_FAIL: /* error in do_file or below */
	337	++n_error;
	338	break;
	339	case SJ_SUCCEED: /* premature success */
	340	/* do nothing */
	341	break;
	342	} /* end switch */
	343	}
	344	return !!n_error;
	345	}