[mirror_ubuntu-jammy-kernel.git] / arch / sparc / boot / piggyback.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
   Simple utility to make a single-image install kernel with initial ramdisk
   for Sparc tftpbooting without need to set up nfs.

   Copyright (C) 1996,1997 Jakub Jelinek (jj@sunsite.mff.cuni.cz)
   Pete Zaitcev <zaitcev@yahoo.com> endian fixes for cross-compiles, 2000.
   Copyright (C) 2011 Sam Ravnborg <sam@ravnborg.org>

 */

#include <dirent.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <ctype.h>
#include <errno.h>
#include <fcntl.h>
#include <stdio.h>

#include <sys/types.h>
#include <sys/stat.h>

/*
 * Note: run this on an a.out kernel (use elftoaout for it),
 * as PROM looks for a.out image only.
 */

#define AOUT_TEXT_OFFSET   32

static int is64bit = 0;

/* align to power-of-two size */
static int align(int n)
{
	if (is64bit)
		return (n + 0x1fff) & ~0x1fff;
	else
		return (n + 0xfff) & ~0xfff;
}

/* read two bytes as big endian */
static unsigned short ld2(char *p)
{
	return (p[0] << 8) | p[1];
}

/* save 4 bytes as big endian */
static void st4(char *p, unsigned int x)
{
	p[0] = x >> 24;
	p[1] = x >> 16;
	p[2] = x >> 8;
	p[3] = x;
}

static void die(const char *str)
{
	perror(str);
	exit(1);
}

static void usage(void)
{
	/* fs_img.gz is an image of initial ramdisk. */
	fprintf(stderr, "Usage: piggyback bits vmlinux.aout System.map fs_img.gz\n");
	fprintf(stderr, "\tKernel image will be modified in place.\n");
	exit(1);
}

static int start_line(const char *line)
{
	if (strcmp(line + 10, " _start\n") == 0)
		return 1;
	else if (strcmp(line + 18, " _start\n") == 0)
		return 1;
	return 0;
}

static int end_line(const char *line)
{
	if (strcmp(line + 10, " _end\n") == 0)
		return 1;
	else if (strcmp (line + 18, " _end\n") == 0)
		return 1;
	return 0;
}

/*
 * Find address for start and end in System.map.
 * The file looks like this:
 * f0004000 ... _start
 * f0379f79 ... _end
 * 1234567890123456
 * ^coloumn 1
 * There is support for 64 bit addresses too.
 *
 * Return 0 if either start or end is not found
 */
static int get_start_end(const char *filename, unsigned int *start,
                                               unsigned int *end)
{
	FILE *map;
	char buffer[1024];

	*start = 0;
	*end = 0;
	map = fopen(filename, "r");
	if (!map)
		die(filename);
	while (fgets(buffer, 1024, map)) {
		if (start_line(buffer))
			*start = strtoul(buffer, NULL, 16);
		else if (end_line(buffer))
			*end = strtoul(buffer, NULL, 16);
	}
	fclose (map);

	if (*start == 0 || *end == 0)
		return 0;

	return 1;
}

#define LOOKBACK (128 * 4)
#define BUFSIZE 1024
/*
 * Find the HdrS entry from head_32/head_64.
 * We check if it is at the beginning of the file (sparc64 case)
 * and if not we search for it.
 * When we search do so in steps of 4 as HdrS is on a 4-byte aligned
 * address (it is on same alignment as sparc instructions)
 * Return the offset to the HdrS entry (as off_t)
 */
static off_t get_hdrs_offset(int kernelfd, const char *filename)
{
	char buffer[BUFSIZE];
	off_t offset;
	int i;

	if (lseek(kernelfd, 0, SEEK_SET) < 0)
		die("lseek");
	if (read(kernelfd, buffer, BUFSIZE) != BUFSIZE)
		die(filename);

	if (buffer[40] == 'H' && buffer[41] == 'd' &&
	    buffer[42] == 'r' && buffer[43] == 'S') {
		return 40;
	} else {
		/*  Find the gokernel label */
		/* Decode offset from branch instruction */
		offset = ld2(buffer + AOUT_TEXT_OFFSET + 2) << 2;
		/* Go back 512 bytes so we do not miss HdrS */
		offset -= LOOKBACK;
		/* skip a.out header */
		offset += AOUT_TEXT_OFFSET;
		if (lseek(kernelfd, offset, SEEK_SET) < 0)
			die("lseek");
		if (read(kernelfd, buffer, BUFSIZE) != BUFSIZE)
			die(filename);

		for (i = 0; i < LOOKBACK; i += 4) {
			if (buffer[i + 0] == 'H' && buffer[i + 1] == 'd' &&
			    buffer[i + 2] == 'r' && buffer[i + 3] == 'S') {
				return offset + i;
			}
		}
	}
	fprintf (stderr, "Couldn't find headers signature in %s\n", filename);
	exit(1);
}

int main(int argc,char **argv)
{
	static char aout_magic[] = { 0x01, 0x03, 0x01, 0x07 };
	char buffer[1024];
	unsigned int i, start, end;
	off_t offset;
	struct stat s;
	int image, tail;

	if (argc != 5)
		usage();
	if (strcmp(argv[1], "64") == 0)
		is64bit = 1;
	if (stat (argv[4], &s) < 0)
		die(argv[4]);

	if (!get_start_end(argv[3], &start, &end)) {
		fprintf(stderr, "Could not determine start and end from %s\n",
		        argv[3]);
		exit(1);
	}
	if ((image = open(argv[2], O_RDWR)) < 0)
		die(argv[2]);
	if (read(image, buffer, 512) != 512)
		die(argv[2]);
	if (memcmp(buffer, aout_magic, 4) != 0) {
		fprintf (stderr, "Not a.out. Don't blame me.\n");
		exit(1);
	}
	/*
	 * We need to fill in values for
	 * sparc_ramdisk_image + sparc_ramdisk_size
	 * To locate these symbols search for the "HdrS" text which appear
	 * in the image a little before the gokernel symbol.
	 * See definition of these in init_32.S
	 */

	offset = get_hdrs_offset(image, argv[2]);
	/* skip HdrS + LINUX_VERSION_CODE + HdrS version */
	offset += 10;

	if (lseek(image, offset, 0) < 0)
		die("lseek");

	/*
	 * root_flags = 0
	 * root_dev = 1 (RAMDISK_MAJOR)
	 * ram_flags = 0
	 * sparc_ramdisk_image = "PAGE aligned address after _end")
	 * sparc_ramdisk_size = size of image
	 */
	st4(buffer, 0);
	st4(buffer + 4, 0x01000000);
	st4(buffer + 8, align(end + 32));
	st4(buffer + 12, s.st_size);

	if (write(image, buffer + 2, 14) != 14)
		die(argv[2]);

	/* For sparc64 update a_text and clear a_data + a_bss */
	if (is64bit)
	{
		if (lseek(image, 4, 0) < 0)
			die("lseek");
		/* a_text */
		st4(buffer, align(end + 32 + 8191) - (start & ~0x3fffffUL) +
		            s.st_size);
		/* a_data */
		st4(buffer + 4, 0);
		/* a_bss */
		st4(buffer + 8, 0);
		if (write(image, buffer, 12) != 12)
			die(argv[2]);
	}

	/* seek page aligned boundary in the image file and add boot image */
	if (lseek(image, AOUT_TEXT_OFFSET - start + align(end + 32), 0) < 0)
		die("lseek");
	if ((tail = open(argv[4], O_RDONLY)) < 0)
		die(argv[4]);
	while ((i = read(tail, buffer, 1024)) > 0)
		if (write(image, buffer, i) != i)
			die(argv[2]);
	if (close(image) < 0)
		die("close");
	if (close(tail) < 0)
		die("close");
	return 0;
}
Commit	Line	Data
74ba9207	1	// SPDX-License-Identifier: GPL-2.0-or-later
88278ca2	2	/*
1da177e4 LT	3	Simple utility to make a single-image install kernel with initial ramdisk
	4	for Sparc tftpbooting without need to set up nfs.
	5
05085588	6	Copyright (C) 1996,1997 Jakub Jelinek (jj@sunsite.mff.cuni.cz)
1da177e4	7	Pete Zaitcev <zaitcev@yahoo.com> endian fixes for cross-compiles, 2000.
05085588	8	Copyright (C) 2011 Sam Ravnborg <sam@ravnborg.org>
1da177e4	9
74ba9207	10	*/
2fe74fa9 SR	11
	12	#include <dirent.h>
	13	#include <stdlib.h>
1da177e4	14	#include <string.h>
2fe74fa9	15	#include <unistd.h>
1da177e4 LT	16	#include <ctype.h>
	17	#include <errno.h>
	18	#include <fcntl.h>
2fe74fa9 SR	19	#include <stdio.h>
2fe74fa9 SR	20
1da177e4 LT	21	#include <sys/types.h>
	22	#include <sys/stat.h>
	23
	24	/*
	25	* Note: run this on an a.out kernel (use elftoaout for it),
	26	* as PROM looks for a.out image only.
	27	*/
	28
9c239053 SR	29	#define AOUT_TEXT_OFFSET 32
9c239053 SR	30
a020bb17 SR	31	static int is64bit = 0;
	32
	33	/* align to power-of-two size */
	34	static int align(int n)
	35	{
	36	if (is64bit)
	37	return (n + 0x1fff) & ~0x1fff;
	38	else
	39	return (n + 0xfff) & ~0xfff;
	40	}
	41
2fe74fa9	42	/* read two bytes as big endian */
c843e315	43	static unsigned short ld2(char *p)
1da177e4 LT	44	{
	45	return (p[0] << 8) \| p[1];
	46	}
	47
2fe74fa9	48	/* save 4 bytes as big endian */
c843e315	49	static void st4(char *p, unsigned int x)
1da177e4 LT	50	{
	51	p[0] = x >> 24;
	52	p[1] = x >> 16;
	53	p[2] = x >> 8;
	54	p[3] = x;
	55	}
	56
2fe74fa9 SR	57	static void die(const char *str)
	58	{
	59	perror(str);
	60	exit(1);
	61	}
	62
c843e315	63	static void usage(void)
1da177e4 LT	64	{
1da177e4 LT	65	/* fs_img.gz is an image of initial ramdisk. */
a020bb17	66	fprintf(stderr, "Usage: piggyback bits vmlinux.aout System.map fs_img.gz\n");
1da177e4 LT	67	fprintf(stderr, "\tKernel image will be modified in place.\n");
	68	exit(1);
	69	}
	70
2fe74fa9	71	static int start_line(const char *line)
1da177e4	72	{
0032c857	73	if (strcmp(line + 10, " _start\n") == 0)
2fe74fa9	74	return 1;
0032c857	75	else if (strcmp(line + 18, " _start\n") == 0)
2fe74fa9 SR	76	return 1;
	77	return 0;
	78	}
	79
	80	static int end_line(const char *line)
	81	{
0032c857	82	if (strcmp(line + 10, " _end\n") == 0)
2fe74fa9	83	return 1;
0032c857	84	else if (strcmp (line + 18, " _end\n") == 0)
2fe74fa9 SR	85	return 1;
	86	return 0;
	87	}
	88
	89	/*
	90	* Find address for start and end in System.map.
	91	* The file looks like this:
0032c857 DM	92	* f0004000 ... _start
0032c857 DM	93	* f0379f79 ... _end
2fe74fa9 SR	94	* 1234567890123456
	95	* ^coloumn 1
	96	* There is support for 64 bit addresses too.
	97	*
	98	* Return 0 if either start or end is not found
	99	*/
1075c4ef SR	100	static int get_start_end(const char filename, unsigned int start,
1075c4ef SR	101	unsigned int *end)
2fe74fa9 SR	102	{
	103	FILE *map;
	104	char buffer[1024];
	105
	106	*start = 0;
	107	*end = 0;
	108	map = fopen(filename, "r");
	109	if (!map)
	110	die(filename);
	111	while (fgets(buffer, 1024, map)) {
	112	if (start_line(buffer))
	113	*start = strtoul(buffer, NULL, 16);
	114	else if (end_line(buffer))
	115	*end = strtoul(buffer, NULL, 16);
	116	}
	117	fclose (map);
	118
	119	if (start == 0 \|\| end == 0)
	120	return 0;
	121
	122	return 1;
1da177e4 LT	123	}
1da177e4 LT	124
1075c4ef SR	125	#define LOOKBACK (128 * 4)
	126	#define BUFSIZE 1024
	127	/*
	128	* Find the HdrS entry from head_32/head_64.
	129	* We check if it is at the beginning of the file (sparc64 case)
	130	* and if not we search for it.
	131	* When we search do so in steps of 4 as HdrS is on a 4-byte aligned
	132	* address (it is on same alignment as sparc instructions)
	133	* Return the offset to the HdrS entry (as off_t)
	134	*/
	135	static off_t get_hdrs_offset(int kernelfd, const char *filename)
	136	{
	137	char buffer[BUFSIZE];
	138	off_t offset;
	139	int i;
	140
	141	if (lseek(kernelfd, 0, SEEK_SET) < 0)
	142	die("lseek");
	143	if (read(kernelfd, buffer, BUFSIZE) != BUFSIZE)
	144	die(filename);
	145
	146	if (buffer[40] == 'H' && buffer[41] == 'd' &&
	147	buffer[42] == 'r' && buffer[43] == 'S') {
	148	return 40;
	149	} else {
	150	/* Find the gokernel label */
	151	/* Decode offset from branch instruction */
	152	offset = ld2(buffer + AOUT_TEXT_OFFSET + 2) << 2;
	153	/* Go back 512 bytes so we do not miss HdrS */
	154	offset -= LOOKBACK;
	155	/* skip a.out header */
	156	offset += AOUT_TEXT_OFFSET;
	157	if (lseek(kernelfd, offset, SEEK_SET) < 0)
	158	die("lseek");
	159	if (read(kernelfd, buffer, BUFSIZE) != BUFSIZE)
	160	die(filename);
	161
	162	for (i = 0; i < LOOKBACK; i += 4) {
	163	if (buffer[i + 0] == 'H' && buffer[i + 1] == 'd' &&
	164	buffer[i + 2] == 'r' && buffer[i + 3] == 'S') {
	165	return offset + i;
	166	}
	167	}
	168	}
	169	fprintf (stderr, "Couldn't find headers signature in %s\n", filename);
	170	exit(1);
	171	}
	172
1da177e4 LT	173	int main(int argc,char **argv)
	174	{
	175	static char aout_magic[] = { 0x01, 0x03, 0x01, 0x07 };
1075c4ef SR	176	char buffer[1024];
	177	unsigned int i, start, end;
	178	off_t offset;
1da177e4 LT	179	struct stat s;
	180	int image, tail;
	181
a020bb17	182	if (argc != 5)
2fe74fa9	183	usage();
a020bb17 SR	184	if (strcmp(argv[1], "64") == 0)
	185	is64bit = 1;
	186	if (stat (argv[4], &s) < 0)
	187	die(argv[4]);
2fe74fa9	188
a020bb17	189	if (!get_start_end(argv[3], &start, &end)) {
1075c4ef SR	190	fprintf(stderr, "Could not determine start and end from %s\n",
1075c4ef SR	191	argv[3]);
1da177e4 LT	192	exit(1);
1da177e4 LT	193	}
a020bb17 SR	194	if ((image = open(argv[2], O_RDWR)) < 0)
a020bb17 SR	195	die(argv[2]);
2fe74fa9	196	if (read(image, buffer, 512) != 512)
a020bb17	197	die(argv[2]);
571e08f6 SR	198	if (memcmp(buffer, aout_magic, 4) != 0) {
571e08f6 SR	199	fprintf (stderr, "Not a.out. Don't blame me.\n");
1da177e4 LT	200	exit(1);
1da177e4 LT	201	}
9c239053	202	/*
1075c4ef SR	203	* We need to fill in values for
1075c4ef SR	204	* sparc_ramdisk_image + sparc_ramdisk_size
9c239053 SR	205	* To locate these symbols search for the "HdrS" text which appear
	206	* in the image a little before the gokernel symbol.
	207	* See definition of these in init_32.S
	208	*/
	209
1075c4ef SR	210	offset = get_hdrs_offset(image, argv[2]);
	211	/* skip HdrS + LINUX_VERSION_CODE + HdrS version */
	212	offset += 10;
	213
2fe74fa9 SR	214	if (lseek(image, offset, 0) < 0)
2fe74fa9 SR	215	die("lseek");
1da177e4	216
9c239053 SR	217	/*
	218	* root_flags = 0
	219	* root_dev = 1 (RAMDISK_MAJOR)
	220	* ram_flags = 0
	221	* sparc_ramdisk_image = "PAGE aligned address after _end")
	222	* sparc_ramdisk_size = size of image
	223	*/
1da177e4 LT	224	st4(buffer, 0);
1da177e4 LT	225	st4(buffer + 4, 0x01000000);
a020bb17	226	st4(buffer + 8, align(end + 32));
1da177e4 LT	227	st4(buffer + 12, s.st_size);
1da177e4 LT	228
2fe74fa9	229	if (write(image, buffer + 2, 14) != 14)
a020bb17	230	die(argv[2]);
9c239053	231
1075c4ef SR	232	/* For sparc64 update a_text and clear a_data + a_bss */
	233	if (is64bit)
	234	{
	235	if (lseek(image, 4, 0) < 0)
	236	die("lseek");
	237	/* a_text */
	238	st4(buffer, align(end + 32 + 8191) - (start & ~0x3fffffUL) +
	239	s.st_size);
	240	/* a_data */
	241	st4(buffer + 4, 0);
	242	/* a_bss */
	243	st4(buffer + 8, 0);
	244	if (write(image, buffer, 12) != 12)
	245	die(argv[2]);
	246	}
	247
9c239053	248	/* seek page aligned boundary in the image file and add boot image */
a020bb17	249	if (lseek(image, AOUT_TEXT_OFFSET - start + align(end + 32), 0) < 0)
2fe74fa9	250	die("lseek");
a020bb17 SR	251	if ((tail = open(argv[4], O_RDONLY)) < 0)
a020bb17 SR	252	die(argv[4]);
9c239053	253	while ((i = read(tail, buffer, 1024)) > 0)
2fe74fa9	254	if (write(image, buffer, i) != i)
a020bb17	255	die(argv[2]);
2fe74fa9 SR	256	if (close(image) < 0)
	257	die("close");
	258	if (close(tail) < 0)
	259	die("close");
	260	return 0;
1da177e4	261	}