Blame util.c

Packit 2ad57b
/*
Packit 2ad57b
 * Copyright 2011 The Chromium Authors, All Rights Reserved.
Packit 2ad57b
 * Copyright 2008 Jon Loeliger, Freescale Semiconductor, Inc.
Packit 2ad57b
 *
Packit 2ad57b
 * util_is_printable_string contributed by
Packit 2ad57b
 *	Pantelis Antoniou <pantelis.antoniou AT gmail.com>
Packit 2ad57b
 *
Packit 2ad57b
 * This program is free software; you can redistribute it and/or
Packit 2ad57b
 * modify it under the terms of the GNU General Public License as
Packit 2ad57b
 * published by the Free Software Foundation; either version 2 of the
Packit 2ad57b
 * License, or (at your option) any later version.
Packit 2ad57b
 *
Packit 2ad57b
 *  This program is distributed in the hope that it will be useful,
Packit 2ad57b
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit 2ad57b
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit 2ad57b
 *  General Public License for more details.
Packit 2ad57b
 *
Packit 2ad57b
 *  You should have received a copy of the GNU General Public License
Packit 2ad57b
 *  along with this program; if not, write to the Free Software
Packit 2ad57b
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
Packit 2ad57b
 *                                                                   USA
Packit 2ad57b
 */
Packit 2ad57b
Packit 2ad57b
#include <ctype.h>
Packit 2ad57b
#include <stdio.h>
Packit 2ad57b
#include <stdlib.h>
Packit 2ad57b
#include <stdarg.h>
Packit 2ad57b
#include <string.h>
Packit 2ad57b
#include <assert.h>
Packit 2ad57b
Packit 2ad57b
#include <errno.h>
Packit 2ad57b
#include <fcntl.h>
Packit 2ad57b
#include <unistd.h>
Packit 2ad57b
Packit 2ad57b
#include "libfdt.h"
Packit 2ad57b
#include "util.h"
Packit 2ad57b
#include "version_gen.h"
Packit 2ad57b
Packit 2ad57b
char *xstrdup(const char *s)
Packit 2ad57b
{
Packit 2ad57b
	int len = strlen(s) + 1;
Packit 2ad57b
	char *d = xmalloc(len);
Packit 2ad57b
Packit 2ad57b
	memcpy(d, s, len);
Packit 2ad57b
Packit 2ad57b
	return d;
Packit 2ad57b
}
Packit 2ad57b
Packit 2ad57b
/* based in part from (3) vsnprintf */
Packit 2ad57b
int xasprintf(char **strp, const char *fmt, ...)
Packit 2ad57b
{
Packit 2ad57b
	int n, size = 128;	/* start with 128 bytes */
Packit 2ad57b
	char *p;
Packit 2ad57b
	va_list ap;
Packit 2ad57b
Packit 2ad57b
	/* initial pointer is NULL making the fist realloc to be malloc */
Packit 2ad57b
	p = NULL;
Packit 2ad57b
	while (1) {
Packit 2ad57b
		p = xrealloc(p, size);
Packit 2ad57b
Packit 2ad57b
		/* Try to print in the allocated space. */
Packit 2ad57b
		va_start(ap, fmt);
Packit 2ad57b
		n = vsnprintf(p, size, fmt, ap);
Packit 2ad57b
		va_end(ap);
Packit 2ad57b
Packit 2ad57b
		/* If that worked, return the string. */
Packit 2ad57b
		if (n > -1 && n < size)
Packit 2ad57b
			break;
Packit 2ad57b
		/* Else try again with more space. */
Packit 2ad57b
		if (n > -1)	/* glibc 2.1 */
Packit 2ad57b
			size = n + 1; /* precisely what is needed */
Packit 2ad57b
		else		/* glibc 2.0 */
Packit 2ad57b
			size *= 2; /* twice the old size */
Packit 2ad57b
	}
Packit 2ad57b
	*strp = p;
Packit 2ad57b
	return strlen(p);
Packit 2ad57b
}
Packit 2ad57b
Packit 2ad57b
char *join_path(const char *path, const char *name)
Packit 2ad57b
{
Packit 2ad57b
	int lenp = strlen(path);
Packit 2ad57b
	int lenn = strlen(name);
Packit 2ad57b
	int len;
Packit 2ad57b
	int needslash = 1;
Packit 2ad57b
	char *str;
Packit 2ad57b
Packit 2ad57b
	len = lenp + lenn + 2;
Packit 2ad57b
	if ((lenp > 0) && (path[lenp-1] == '/')) {
Packit 2ad57b
		needslash = 0;
Packit 2ad57b
		len--;
Packit 2ad57b
	}
Packit 2ad57b
Packit 2ad57b
	str = xmalloc(len);
Packit 2ad57b
	memcpy(str, path, lenp);
Packit 2ad57b
	if (needslash) {
Packit 2ad57b
		str[lenp] = '/';
Packit 2ad57b
		lenp++;
Packit 2ad57b
	}
Packit 2ad57b
	memcpy(str+lenp, name, lenn+1);
Packit 2ad57b
	return str;
Packit 2ad57b
}
Packit 2ad57b
Packit 2ad57b
bool util_is_printable_string(const void *data, int len)
Packit 2ad57b
{
Packit 2ad57b
	const char *s = data;
Packit 2ad57b
	const char *ss, *se;
Packit 2ad57b
Packit 2ad57b
	/* zero length is not */
Packit 2ad57b
	if (len == 0)
Packit 2ad57b
		return 0;
Packit 2ad57b
Packit 2ad57b
	/* must terminate with zero */
Packit 2ad57b
	if (s[len - 1] != '\0')
Packit 2ad57b
		return 0;
Packit 2ad57b
Packit 2ad57b
	se = s + len;
Packit 2ad57b
Packit 2ad57b
	while (s < se) {
Packit 2ad57b
		ss = s;
Packit 2ad57b
		while (s < se && *s && isprint((unsigned char)*s))
Packit 2ad57b
			s++;
Packit 2ad57b
Packit 2ad57b
		/* not zero, or not done yet */
Packit 2ad57b
		if (*s != '\0' || s == ss)
Packit 2ad57b
			return 0;
Packit 2ad57b
Packit 2ad57b
		s++;
Packit 2ad57b
	}
Packit 2ad57b
Packit 2ad57b
	return 1;
Packit 2ad57b
}
Packit 2ad57b
Packit 2ad57b
/*
Packit 2ad57b
 * Parse a octal encoded character starting at index i in string s.  The
Packit 2ad57b
 * resulting character will be returned and the index i will be updated to
Packit 2ad57b
 * point at the character directly after the end of the encoding, this may be
Packit 2ad57b
 * the '\0' terminator of the string.
Packit 2ad57b
 */
Packit 2ad57b
static char get_oct_char(const char *s, int *i)
Packit 2ad57b
{
Packit 2ad57b
	char x[4];
Packit 2ad57b
	char *endx;
Packit 2ad57b
	long val;
Packit 2ad57b
Packit 2ad57b
	x[3] = '\0';
Packit 2ad57b
	strncpy(x, s + *i, 3);
Packit 2ad57b
Packit 2ad57b
	val = strtol(x, &endx, 8);
Packit 2ad57b
Packit 2ad57b
	assert(endx > x);
Packit 2ad57b
Packit 2ad57b
	(*i) += endx - x;
Packit 2ad57b
	return val;
Packit 2ad57b
}
Packit 2ad57b
Packit 2ad57b
/*
Packit 2ad57b
 * Parse a hexadecimal encoded character starting at index i in string s.  The
Packit 2ad57b
 * resulting character will be returned and the index i will be updated to
Packit 2ad57b
 * point at the character directly after the end of the encoding, this may be
Packit 2ad57b
 * the '\0' terminator of the string.
Packit 2ad57b
 */
Packit 2ad57b
static char get_hex_char(const char *s, int *i)
Packit 2ad57b
{
Packit 2ad57b
	char x[3];
Packit 2ad57b
	char *endx;
Packit 2ad57b
	long val;
Packit 2ad57b
Packit 2ad57b
	x[2] = '\0';
Packit 2ad57b
	strncpy(x, s + *i, 2);
Packit 2ad57b
Packit 2ad57b
	val = strtol(x, &endx, 16);
Packit 2ad57b
	if (!(endx  > x))
Packit 2ad57b
		die("\\x used with no following hex digits\n");
Packit 2ad57b
Packit 2ad57b
	(*i) += endx - x;
Packit 2ad57b
	return val;
Packit 2ad57b
}
Packit 2ad57b
Packit 2ad57b
char get_escape_char(const char *s, int *i)
Packit 2ad57b
{
Packit 2ad57b
	char	c = s[*i];
Packit 2ad57b
	int	j = *i + 1;
Packit 2ad57b
	char	val;
Packit 2ad57b
Packit 2ad57b
	switch (c) {
Packit 2ad57b
	case 'a':
Packit 2ad57b
		val = '\a';
Packit 2ad57b
		break;
Packit 2ad57b
	case 'b':
Packit 2ad57b
		val = '\b';
Packit 2ad57b
		break;
Packit 2ad57b
	case 't':
Packit 2ad57b
		val = '\t';
Packit 2ad57b
		break;
Packit 2ad57b
	case 'n':
Packit 2ad57b
		val = '\n';
Packit 2ad57b
		break;
Packit 2ad57b
	case 'v':
Packit 2ad57b
		val = '\v';
Packit 2ad57b
		break;
Packit 2ad57b
	case 'f':
Packit 2ad57b
		val = '\f';
Packit 2ad57b
		break;
Packit 2ad57b
	case 'r':
Packit 2ad57b
		val = '\r';
Packit 2ad57b
		break;
Packit 2ad57b
	case '0':
Packit 2ad57b
	case '1':
Packit 2ad57b
	case '2':
Packit 2ad57b
	case '3':
Packit 2ad57b
	case '4':
Packit 2ad57b
	case '5':
Packit 2ad57b
	case '6':
Packit 2ad57b
	case '7':
Packit 2ad57b
		j--; /* need to re-read the first digit as
Packit 2ad57b
		      * part of the octal value */
Packit 2ad57b
		val = get_oct_char(s, &j);
Packit 2ad57b
		break;
Packit 2ad57b
	case 'x':
Packit 2ad57b
		val = get_hex_char(s, &j);
Packit 2ad57b
		break;
Packit 2ad57b
	default:
Packit 2ad57b
		val = c;
Packit 2ad57b
	}
Packit 2ad57b
Packit 2ad57b
	(*i) = j;
Packit 2ad57b
	return val;
Packit 2ad57b
}
Packit 2ad57b
Packit 2ad57b
int utilfdt_read_err_len(const char *filename, char **buffp, off_t *len)
Packit 2ad57b
{
Packit 2ad57b
	int fd = 0;	/* assume stdin */
Packit 2ad57b
	char *buf = NULL;
Packit 2ad57b
	off_t bufsize = 1024, offset = 0;
Packit 2ad57b
	int ret = 0;
Packit 2ad57b
Packit 2ad57b
	*buffp = NULL;
Packit 2ad57b
	if (strcmp(filename, "-") != 0) {
Packit 2ad57b
		fd = open(filename, O_RDONLY);
Packit 2ad57b
		if (fd < 0)
Packit 2ad57b
			return errno;
Packit 2ad57b
	}
Packit 2ad57b
Packit 2ad57b
	/* Loop until we have read everything */
Packit 2ad57b
	buf = xmalloc(bufsize);
Packit 2ad57b
	do {
Packit 2ad57b
		/* Expand the buffer to hold the next chunk */
Packit 2ad57b
		if (offset == bufsize) {
Packit 2ad57b
			bufsize *= 2;
Packit 2ad57b
			buf = xrealloc(buf, bufsize);
Packit 2ad57b
		}
Packit 2ad57b
Packit 2ad57b
		ret = read(fd, &buf[offset], bufsize - offset);
Packit 2ad57b
		if (ret < 0) {
Packit 2ad57b
			ret = errno;
Packit 2ad57b
			break;
Packit 2ad57b
		}
Packit 2ad57b
		offset += ret;
Packit 2ad57b
	} while (ret != 0);
Packit 2ad57b
Packit 2ad57b
	/* Clean up, including closing stdin; return errno on error */
Packit 2ad57b
	close(fd);
Packit 2ad57b
	if (ret)
Packit 2ad57b
		free(buf);
Packit 2ad57b
	else
Packit 2ad57b
		*buffp = buf;
Packit 2ad57b
	*len = bufsize;
Packit 2ad57b
	return ret;
Packit 2ad57b
}
Packit 2ad57b
Packit 2ad57b
int utilfdt_read_err(const char *filename, char **buffp)
Packit 2ad57b
{
Packit 2ad57b
	off_t len;
Packit 2ad57b
	return utilfdt_read_err_len(filename, buffp, &len;;
Packit 2ad57b
}
Packit 2ad57b
Packit 2ad57b
char *utilfdt_read_len(const char *filename, off_t *len)
Packit 2ad57b
{
Packit 2ad57b
	char *buff;
Packit 2ad57b
	int ret = utilfdt_read_err_len(filename, &buff, len);
Packit 2ad57b
Packit 2ad57b
	if (ret) {
Packit 2ad57b
		fprintf(stderr, "Couldn't open blob from '%s': %s\n", filename,
Packit 2ad57b
			strerror(ret));
Packit 2ad57b
		return NULL;
Packit 2ad57b
	}
Packit 2ad57b
	/* Successful read */
Packit 2ad57b
	return buff;
Packit 2ad57b
}
Packit 2ad57b
Packit 2ad57b
char *utilfdt_read(const char *filename)
Packit 2ad57b
{
Packit 2ad57b
	off_t len;
Packit 2ad57b
	return utilfdt_read_len(filename, &len;;
Packit 2ad57b
}
Packit 2ad57b
Packit 2ad57b
int utilfdt_write_err(const char *filename, const void *blob)
Packit 2ad57b
{
Packit 2ad57b
	int fd = 1;	/* assume stdout */
Packit 2ad57b
	int totalsize;
Packit 2ad57b
	int offset;
Packit 2ad57b
	int ret = 0;
Packit 2ad57b
	const char *ptr = blob;
Packit 2ad57b
Packit 2ad57b
	if (strcmp(filename, "-") != 0) {
Packit 2ad57b
		fd = open(filename, O_WRONLY | O_CREAT | O_TRUNC, 0666);
Packit 2ad57b
		if (fd < 0)
Packit 2ad57b
			return errno;
Packit 2ad57b
	}
Packit 2ad57b
Packit 2ad57b
	totalsize = fdt_totalsize(blob);
Packit 2ad57b
	offset = 0;
Packit 2ad57b
Packit 2ad57b
	while (offset < totalsize) {
Packit 2ad57b
		ret = write(fd, ptr + offset, totalsize - offset);
Packit 2ad57b
		if (ret < 0) {
Packit 2ad57b
			ret = -errno;
Packit 2ad57b
			break;
Packit 2ad57b
		}
Packit 2ad57b
		offset += ret;
Packit 2ad57b
	}
Packit 2ad57b
	/* Close the file/stdin; return errno on error */
Packit 2ad57b
	if (fd != 1)
Packit 2ad57b
		close(fd);
Packit 2ad57b
	return ret < 0 ? -ret : 0;
Packit 2ad57b
}
Packit 2ad57b
Packit 2ad57b
Packit 2ad57b
int utilfdt_write(const char *filename, const void *blob)
Packit 2ad57b
{
Packit 2ad57b
	int ret = utilfdt_write_err(filename, blob);
Packit 2ad57b
Packit 2ad57b
	if (ret) {
Packit 2ad57b
		fprintf(stderr, "Couldn't write blob to '%s': %s\n", filename,
Packit 2ad57b
			strerror(ret));
Packit 2ad57b
	}
Packit 2ad57b
	return ret ? -1 : 0;
Packit 2ad57b
}
Packit 2ad57b
Packit 2ad57b
int utilfdt_decode_type(const char *fmt, int *type, int *size)
Packit 2ad57b
{
Packit 2ad57b
	int qualifier = 0;
Packit 2ad57b
Packit 2ad57b
	if (!*fmt)
Packit 2ad57b
		return -1;
Packit 2ad57b
Packit 2ad57b
	/* get the conversion qualifier */
Packit 2ad57b
	*size = -1;
Packit 2ad57b
	if (strchr("hlLb", *fmt)) {
Packit 2ad57b
		qualifier = *fmt++;
Packit 2ad57b
		if (qualifier == *fmt) {
Packit 2ad57b
			switch (*fmt++) {
Packit 2ad57b
/* TODO:		case 'l': qualifier = 'L'; break;*/
Packit 2ad57b
			case 'h':
Packit 2ad57b
				qualifier = 'b';
Packit 2ad57b
				break;
Packit 2ad57b
			}
Packit 2ad57b
		}
Packit 2ad57b
	}
Packit 2ad57b
Packit 2ad57b
	/* we should now have a type */
Packit 2ad57b
	if ((*fmt == '\0') || !strchr("iuxs", *fmt))
Packit 2ad57b
		return -1;
Packit 2ad57b
Packit 2ad57b
	/* convert qualifier (bhL) to byte size */
Packit 2ad57b
	if (*fmt != 's')
Packit 2ad57b
		*size = qualifier == 'b' ? 1 :
Packit 2ad57b
				qualifier == 'h' ? 2 :
Packit 2ad57b
				qualifier == 'l' ? 4 : -1;
Packit 2ad57b
	*type = *fmt++;
Packit 2ad57b
Packit 2ad57b
	/* that should be it! */
Packit 2ad57b
	if (*fmt)
Packit 2ad57b
		return -1;
Packit 2ad57b
	return 0;
Packit 2ad57b
}
Packit 2ad57b
Packit 2ad57b
void utilfdt_print_data(const char *data, int len)
Packit 2ad57b
{
Packit 2ad57b
	int i;
Packit 2ad57b
	const char *s;
Packit 2ad57b
Packit 2ad57b
	/* no data, don't print */
Packit 2ad57b
	if (len == 0)
Packit 2ad57b
		return;
Packit 2ad57b
Packit 2ad57b
	if (util_is_printable_string(data, len)) {
Packit 2ad57b
		printf(" = ");
Packit 2ad57b
Packit 2ad57b
		s = data;
Packit 2ad57b
		do {
Packit 2ad57b
			printf("\"%s\"", s);
Packit 2ad57b
			s += strlen(s) + 1;
Packit 2ad57b
			if (s < data + len)
Packit 2ad57b
				printf(", ");
Packit 2ad57b
		} while (s < data + len);
Packit 2ad57b
Packit 2ad57b
	} else if ((len % 4) == 0) {
Packit 2ad57b
		const fdt32_t *cell = (const fdt32_t *)data;
Packit 2ad57b
Packit 2ad57b
		printf(" = <");
Packit 2ad57b
		for (i = 0, len /= 4; i < len; i++)
Packit 2ad57b
			printf("0x%08x%s", fdt32_to_cpu(cell[i]),
Packit 2ad57b
			       i < (len - 1) ? " " : "");
Packit 2ad57b
		printf(">");
Packit 2ad57b
	} else {
Packit 2ad57b
		const unsigned char *p = (const unsigned char *)data;
Packit 2ad57b
		printf(" = [");
Packit 2ad57b
		for (i = 0; i < len; i++)
Packit 2ad57b
			printf("%02x%s", *p++, i < len - 1 ? " " : "");
Packit 2ad57b
		printf("]");
Packit 2ad57b
	}
Packit 2ad57b
}
Packit 2ad57b
Packit 2ad57b
void NORETURN util_version(void)
Packit 2ad57b
{
Packit 2ad57b
	printf("Version: %s\n", DTC_VERSION);
Packit 2ad57b
	exit(0);
Packit 2ad57b
}
Packit 2ad57b
Packit 2ad57b
void NORETURN util_usage(const char *errmsg, const char *synopsis,
Packit 2ad57b
			 const char *short_opts,
Packit 2ad57b
			 struct option const long_opts[],
Packit 2ad57b
			 const char * const opts_help[])
Packit 2ad57b
{
Packit 2ad57b
	FILE *fp = errmsg ? stderr : stdout;
Packit 2ad57b
	const char a_arg[] = "<arg>";
Packit 2ad57b
	size_t a_arg_len = strlen(a_arg) + 1;
Packit 2ad57b
	size_t i;
Packit 2ad57b
	int optlen;
Packit 2ad57b
Packit 2ad57b
	fprintf(fp,
Packit 2ad57b
		"Usage: %s\n"
Packit 2ad57b
		"\n"
Packit 2ad57b
		"Options: -[%s]\n", synopsis, short_opts);
Packit 2ad57b
Packit 2ad57b
	/* prescan the --long opt length to auto-align */
Packit 2ad57b
	optlen = 0;
Packit 2ad57b
	for (i = 0; long_opts[i].name; ++i) {
Packit 2ad57b
		/* +1 is for space between --opt and help text */
Packit 2ad57b
		int l = strlen(long_opts[i].name) + 1;
Packit 2ad57b
		if (long_opts[i].has_arg == a_argument)
Packit 2ad57b
			l += a_arg_len;
Packit 2ad57b
		if (optlen < l)
Packit 2ad57b
			optlen = l;
Packit 2ad57b
	}
Packit 2ad57b
Packit 2ad57b
	for (i = 0; long_opts[i].name; ++i) {
Packit 2ad57b
		/* helps when adding new applets or options */
Packit 2ad57b
		assert(opts_help[i] != NULL);
Packit 2ad57b
Packit 2ad57b
		/* first output the short flag if it has one */
Packit 2ad57b
		if (long_opts[i].val > '~')
Packit 2ad57b
			fprintf(fp, "      ");
Packit 2ad57b
		else
Packit 2ad57b
			fprintf(fp, "  -%c, ", long_opts[i].val);
Packit 2ad57b
Packit 2ad57b
		/* then the long flag */
Packit 2ad57b
		if (long_opts[i].has_arg == no_argument)
Packit 2ad57b
			fprintf(fp, "--%-*s", optlen, long_opts[i].name);
Packit 2ad57b
		else
Packit 2ad57b
			fprintf(fp, "--%s %s%*s", long_opts[i].name, a_arg,
Packit 2ad57b
				(int)(optlen - strlen(long_opts[i].name) - a_arg_len), "");
Packit 2ad57b
Packit 2ad57b
		/* finally the help text */
Packit 2ad57b
		fprintf(fp, "%s\n", opts_help[i]);
Packit 2ad57b
	}
Packit 2ad57b
Packit 2ad57b
	if (errmsg) {
Packit 2ad57b
		fprintf(fp, "\nError: %s\n", errmsg);
Packit 2ad57b
		exit(EXIT_FAILURE);
Packit 2ad57b
	} else
Packit 2ad57b
		exit(EXIT_SUCCESS);
Packit 2ad57b
}