platform_external_dtc/tests/testutils.c

// SPDX-License-Identifier: LGPL-2.1-or-later
/*
 * libfdt - Flat Device Tree manipulation
 *	Testcase common utility functions
 * Copyright (C) 2006 David Gibson, IBM Corporation.
 */

#define _GNU_SOURCE /* for strsignal() in glibc.  FreeBSD has it either way */

#include <stdio.h>
#include <stdlib.h>
#include <stdint.h>
#include <limits.h>
#include <string.h>
#include <errno.h>
#include <signal.h>
#include <unistd.h>
#include <fcntl.h>

#if NO_VALGRIND
static inline void VALGRIND_MAKE_MEM_UNDEFINED(void *p, size_t len)
{
}

static inline void VALGRIND_MAKE_MEM_DEFINED(void *p, size_t len)
{
}
#else
#include <valgrind/memcheck.h>
#endif

#include <libfdt.h>

#include "tests.h"
#include "testdata.h"

/* For FDT_SW_MAGIC */
#include "libfdt_internal.h"

int verbose_test = 1;
char *test_name;

void  __attribute__((weak)) cleanup(void)
{
}

static void sigint_handler(int signum, siginfo_t *si, void *uc)
{
	cleanup();
	fprintf(stderr, "%s: %s (pid=%d)\n", test_name,
		strsignal(signum), getpid());
	exit(RC_BUG);
}

void test_init(int argc, char *argv[])
{
	int err;
	struct sigaction sa_int = {
		.sa_sigaction = sigint_handler,
	};

	test_name = argv[0];

	err = sigaction(SIGINT, &sa_int, NULL);
	if (err)
		FAIL("Can't install SIGINT handler");

	if (getenv("QUIET_TEST"))
		verbose_test = 0;

	verbose_printf("Starting testcase \"%s\", pid %d\n",
		       test_name, getpid());
}

void check_mem_rsv(void *fdt, int n, uint64_t addr, uint64_t size)
{
	int err;
	uint64_t addr_v, size_v;

	err = fdt_get_mem_rsv(fdt, n, &addr_v, &size_v);
	if (err < 0)
		FAIL("fdt_get_mem_rsv(%d): %s", n, fdt_strerror(err));
	if ((addr_v != addr) || (size_v != size))
		FAIL("fdt_get_mem_rsv() returned (0x%llx,0x%llx) "
		     "instead of (0x%llx,0x%llx)",
		     (unsigned long long)addr_v, (unsigned long long)size_v,
		     (unsigned long long)addr, (unsigned long long)size);
}

void check_property(void *fdt, int nodeoffset, const char *name,
		    unsigned int len, const void *val)
{
	const struct fdt_property *prop;
	int retlen, namelen;
	uint32_t tag, nameoff, proplen;
	const char *propname;

	verbose_printf("Checking property \"%s\"...", name);
	prop = fdt_get_property(fdt, nodeoffset, name, &retlen);
	verbose_printf("pointer %p\n", prop);
	if (! prop)
		FAIL("Error retrieving \"%s\" pointer: %s", name,
		     fdt_strerror(retlen));
	if (retlen < 0)
		FAIL("negative name length (%d) for returned property\n",
		     retlen);

	tag = fdt32_to_cpu(prop->tag);
	nameoff = fdt32_to_cpu(prop->nameoff);
	proplen = fdt32_to_cpu(prop->len);

	if (tag != FDT_PROP)
		FAIL("Incorrect tag 0x%08x on property \"%s\"", tag, name);

	propname = fdt_get_string(fdt, nameoff, &namelen);
	if (!propname)
		FAIL("Couldn't get property name: %s", fdt_strerror(namelen));
	if (namelen < 0)
		FAIL("negative name length (%d) for returned string\n",
		     namelen);
	if ((unsigned)namelen != strlen(propname))
		FAIL("Incorrect prop name length: %d instead of %zd",
		     namelen, strlen(propname));
	if (!streq(propname, name))
		FAIL("Property name mismatch \"%s\" instead of \"%s\"",
		     propname, name);
	if (proplen != (unsigned)retlen)
		FAIL("Length retrieved for \"%s\" by fdt_get_property()"
		     " differs from stored length (%d != %d)",
		     name, retlen, proplen);
	if (proplen != len)
		FAIL("Size mismatch on property \"%s\": %d insead of %d",
		     name, proplen, len);
	if (len && memcmp(val, prop->data, len) != 0)
		FAIL("Data mismatch on property \"%s\"", name);
}

const void *check_getprop(void *fdt, int nodeoffset, const char *name,
			  int len, const void *val)
{
	const void *propval;
	int proplen;

	propval = fdt_getprop(fdt, nodeoffset, name, &proplen);
	if (! propval)
		FAIL("fdt_getprop(\"%s\"): %s", name, fdt_strerror(proplen));

	if (proplen != len)
		FAIL("Size mismatch on property \"%s\": %d insead of %d",
		     name, proplen, len);
	if (len && memcmp(val, propval, len) != 0)
		FAIL("Data mismatch on property \"%s\"", name);

	return propval;
}

const void *check_get_prop_offset(void *fdt, int poffset, const char *exp_name,
				  int exp_len, const void *exp_val)
{
	const void *propval;
	const char *name;
	int proplen;

	propval = fdt_getprop_by_offset(fdt, poffset, &name, &proplen);
	if (!propval)
		FAIL("fdt_getprop(\"%s\"): %s", name, fdt_strerror(proplen));

	/* Not testing for this field, so ignore */
	if (strcmp(name, exp_name))
		return NULL;

	if (proplen != exp_len)
		FAIL("Size mismatch on property \"%s\": %d insead of %d",
		     name, proplen, exp_len);
	if (exp_len && memcmp(exp_val, propval, exp_len))
		FAIL("Data mismatch on property \"%s\"", name);

	return propval;
}

const void *check_getprop_addrrange(void *fdt, int parent, int nodeoffset,
				    const char *name, int num)
{
	const void *propval;
	int xac, xsc, buf_size, cells, i;
	char *buf, *p;
	uint64_t addr, size;
	fdt32_t val;

	xac = fdt_address_cells(fdt, parent);
	xsc = fdt_size_cells(fdt, parent);

	if (xac <= 0)
		FAIL("Couldn't identify #address-cells: %s",
		     fdt_strerror(xac));
	if (xsc <= 0)
		FAIL("Couldn't identify #size-cells: %s",
		     fdt_strerror(xsc));

	buf_size = (xac + xsc) * sizeof(fdt32_t) * num;
	buf = malloc(buf_size);
	if (!buf)
		FAIL("Couldn't allocate temporary buffer");

	/* expected value */
	addr = TEST_MEMREGION_ADDR;
	if (xac > 1)
		addr += TEST_MEMREGION_ADDR_HI;
	size = TEST_MEMREGION_SIZE;
	if (xsc > 1)
		size += TEST_MEMREGION_SIZE_HI;
	for (p = buf, i = 0; i < num; i++) {
		cells = xac;
		while (cells) {
			val = cpu_to_fdt32(addr >> (32 * (--cells)));
			memcpy(p, &val, sizeof(val));
			p += sizeof(val);
		}
		cells = xsc;
		while (cells) {
			val = cpu_to_fdt32(size >> (32 * (--cells)));
			memcpy(p, &val, sizeof(val));
			p += sizeof(val);
		}

		addr += size;
		size += TEST_MEMREGION_SIZE_INC;
	}

	/* check */
	propval = check_getprop(fdt, nodeoffset, name, buf_size,
				(const void *)buf);

	free(buf);

	return propval;
}

int nodename_eq(const char *s1, const char *s2)
{
	int len = strlen(s2);

	if (strncmp(s1, s2, len) != 0)
		return 0;
	if (s1[len] == '\0')
		return 1;
	else if (!memchr(s2, '@', len) && (s1[len] == '@'))
		return 1;
	else
		return 0;
}

void vg_prepare_blob(void *fdt, size_t bufsize)
{
	char *blob = fdt;
	int off_memrsv, off_strings, off_struct;
	int num_memrsv;
	size_t size_memrsv, size_strings, size_struct;

	off_memrsv = fdt_off_mem_rsvmap(fdt);
	num_memrsv = fdt_num_mem_rsv(fdt);
	if (num_memrsv < 0)
		size_memrsv = fdt_totalsize(fdt) - off_memrsv;
	else
		size_memrsv = (num_memrsv + 1)
			* sizeof(struct fdt_reserve_entry);

	VALGRIND_MAKE_MEM_UNDEFINED(blob, bufsize);
	VALGRIND_MAKE_MEM_DEFINED(blob, FDT_V1_SIZE);
	VALGRIND_MAKE_MEM_DEFINED(blob, fdt_header_size(fdt));

	if (fdt_magic(fdt) == FDT_MAGIC) {
		off_strings = fdt_off_dt_strings(fdt);
		if (fdt_version(fdt) >= 3)
			size_strings = fdt_size_dt_strings(fdt);
		else
			size_strings = fdt_totalsize(fdt) - off_strings;

		off_struct = fdt_off_dt_struct(fdt);
		if (fdt_version(fdt) >= 17)
			size_struct = fdt_size_dt_struct(fdt);
		else
			size_struct = fdt_totalsize(fdt) - off_struct;
	} else if (fdt_magic(fdt) == FDT_SW_MAGIC) {
		size_strings = fdt_size_dt_strings(fdt);
		off_strings = fdt_off_dt_strings(fdt) - size_strings;

		off_struct = fdt_off_dt_struct(fdt);
		size_struct = fdt_size_dt_struct(fdt);
		size_struct = fdt_totalsize(fdt) - off_struct;

	} else {
		CONFIG("Bad magic on vg_prepare_blob()");
	}

	VALGRIND_MAKE_MEM_DEFINED(blob + off_memrsv, size_memrsv);
	VALGRIND_MAKE_MEM_DEFINED(blob + off_strings, size_strings);
	VALGRIND_MAKE_MEM_DEFINED(blob + off_struct, size_struct);
}

void *load_blob(const char *filename)
{
	char *blob;
	size_t len;
	int ret = utilfdt_read_err(filename, &blob, &len);

	if (ret)
		CONFIG("Couldn't open blob from \"%s\": %s", filename,
		       strerror(ret));

	vg_prepare_blob(blob, len);

	return blob;
}

void *load_blob_arg(int argc, char *argv[])
{
	if (argc != 2)
		CONFIG("Usage: %s <dtb file>", argv[0]);
	return load_blob(argv[1]);
}

void save_blob(const char *filename, void *fdt)
{
	size_t size = fdt_totalsize(fdt);
	void *tmp;
	int ret;

	/* Make a temp copy of the blob so that valgrind won't check
	 * about uninitialized bits in the pieces between blocks */
	tmp = xmalloc(size);
	fdt_move(fdt, tmp, size);
	VALGRIND_MAKE_MEM_DEFINED(tmp, size);
	ret = utilfdt_write_err(filename, tmp);
	if (ret)
		CONFIG("Couldn't write blob to \"%s\": %s", filename,
		       strerror(ret));
	free(tmp);
}

void *open_blob_rw(void *blob)
{
	int err;
	void *buf = blob;

	err = fdt_open_into(blob, buf, fdt_totalsize(blob));
	if (err == -FDT_ERR_NOSPACE) {
		/* Ran out of space converting to v17 */
		int newsize = fdt_totalsize(blob) + 8;

		buf = xmalloc(newsize);
		err = fdt_open_into(blob, buf, newsize);
	}
	if (err)
		FAIL("fdt_open_into(): %s", fdt_strerror(err));
	return buf;
}