rocm-systems/src/pci_ids.c

/*
 * Copyright © 2020 Advanced Micro Devices, Inc.
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use, copy,
 * modify, merge, publish, distribute, sublicense, and/or sell copies
 * of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including
 * the next paragraph) shall be included in all copies or substantial
 * portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */

/*
 * Parse a pci.ids text file to extract 'device_name'
 * # Vendors, devices and subsystems. Please keep sorted.
 * # Syntax:
 * # vendor  vendor_name
 * #	device  device_name				<-- single tab
 * #		subvendor subdevice  subsystem_name	<-- two tabs
 */

/*
 * Example section of file. Searching for 1002/130c
 *
 * 1002  Advanced Micro Devices, Inc. [AMD/ATI]
 * # fields elided
 *	130a  Kaveri [Radeon R6 Graphics]
 *	130b  Kaveri [Radeon R4 Graphics]
 *
 *	130c  Kaveri [Radeon R7 Graphics] <- result
 * #          ^-------------------------^
 *
 *	130d  Kaveri [Radeon R6 Graphics]
 *	130e  Kaveri [Radeon R5 Graphics]
 * # fields elided
 * # next vendor region starts
 * 1003  ULSI Systems
 *	0201  US201
 */

#define _GNU_SOURCE
#include <string.h>

#include "pci_ids.h"

#include <assert.h>
#include <ctype.h>
#include <fcntl.h>
#include <stdbool.h>
#include <sys/mman.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>

#include <stdio.h>

static const char *const pci_ids_paths[] = {
	"/usr/share/hwdata/pci.ids", // update-pciids
	"/usr/share/misc/pci.ids", // debian
	"/usr/share/pci.ids", // redhat
	"/var/lib/pciutils/pci.ids", // also debian
	"pci.ids",
};

static struct pci_ids pci_ids_create_from_file(const char *path)
{
	struct pci_ids failure = {
		.fd = -1,
	};

	int fd = open(path, O_RDONLY, 0);

	if (fd == -1)
		return failure;

	struct stat sb;

	fstat(fd, &sb);
	size_t sz = sb.st_size;

	if (sz == 0) {
		close(fd);
		return failure;
	}

	sz = (sz < UINT32_MAX) ? sz : UINT32_MAX;
	void *addr = mmap(0, sz, PROT_READ, MAP_PRIVATE, fd, 0);

	if (addr == MAP_FAILED) {
		close(fd);
		return failure;
	}

	return (struct pci_ids){
		.fd = fd,
		.addr = addr,
		.size = sz,
	};
}

struct pci_ids pci_ids_create(void)
{
	size_t sz = sizeof(pci_ids_paths) / sizeof(pci_ids_paths[0]);

	for (size_t i = 0; i < sz; i++) {
		struct pci_ids res = pci_ids_create_from_file(pci_ids_paths[i]);

		if (res.fd != -1)
			return res;
	}

	return (struct pci_ids){ .fd = -1 };
}

void pci_ids_destroy(struct pci_ids f)
{
	if (f.fd != -1) {
		munmap(f.addr, f.size);
		close(f.fd);
	}
}

struct range {
	// Iterator pair, start <= end. Can dereference [start end)
	unsigned char *start;
	unsigned char *end;
};
static bool empty_range(struct range r)
{
	return r.start == r.end;
}

static void write_as_hex(uint16_t x, char *b)
{
	static const char digits[] = "0123456789abcdef";

	for (unsigned int i = 0; i < 4; i++) {
		unsigned int index = 0xf & (x >> 4 * (3 - i));

		b[i] = digits[index];
	}
}

static struct range find_vendor(struct range r, uint16_t VendorId)

{
	if (empty_range(r))
		return r;

	char needle[5] = { '\n' };

	write_as_hex(VendorId, &needle[1]);
	unsigned char *s =
		memmem(r.start, r.end - r.start, needle, sizeof(needle));

	if (s) {
		r.start = s;
	} else {
		r.start = r.end;
		assert(empty_range(r));
	}
	return r;
}

static struct range trim_whitespace(struct range r)
{
	while (!empty_range(r) && isspace(r.start[0]))
		r.start++;

	while (!empty_range(r) && isspace(r.end[-1]))
		r.end--;

	return r;
}

static struct range skip_vendor_id(struct range r)
{
	const struct range failure = { 0, 0 };

	assert(!empty_range(r));
	// Expect an initial newline to skip over
	if (r.start[0] != '\n')
		return failure;

	r.start++;
	if (empty_range(r))
		return failure;

	// Skip rest of line
	r.start = memchr(r.start, '\n', r.end - r.start);
	if (!r.start)
		return failure;

	return r;
}

static struct range find_device(struct range r, uint16_t DeviceId)
{
	struct range failure = { 0, 0 };

	if (empty_range(r))
		return failure;

	r = skip_vendor_id(r);
	if (empty_range(r))
		return failure;

	assert(r.start[0] == '\n');

	char needle[6] = { '\n', '\t' };

	write_as_hex(DeviceId, &needle[2]);

	for (;;) {
		size_t width = r.end - r.start;

		if (width < sizeof(needle))
			return failure;

		unsigned char *line_end = memchr(r.start + 1, '\n', width - 1);

		if (!line_end) {
			// File may not end with a newline
			line_end = r.end;
		}

		if (memcmp(r.start, needle, sizeof(needle)) == 0) {
			// Success
			r.start += sizeof(needle);
			r.end = line_end;
			return trim_whitespace(r);
		}

		if (isxdigit(r.start[1])) {
			// Reached the end of this region
			return failure;
		}

		// Otherwise ignore whatever is on the line, e.g. '#'
		r.start = line_end;
	}
}

static void copy_range_to_buffer(struct range r, char *buf, size_t size)
{
	assert(!empty_range(r));
	size_t to_copy = (r.end - r.start);

	to_copy = to_copy < (size - 1) ? to_copy : size - 1;

	memcpy(buf, r.start, to_copy);
	buf[to_copy] = '\0';
}

static void write_fallback_to_buffer(char *buf, size_t size, uint16_t DeviceId)
{
	char tmp[] = "Device xxxx";

	_Static_assert(sizeof(tmp) == 12, "");
	write_as_hex(DeviceId, &tmp[7]);

	size_t to_copy = (sizeof(tmp) <= size) ? sizeof(tmp) : size;

	memcpy(buf, tmp, to_copy);
	buf[size - 1] = '\0';
}

char *pci_ids_lookup(struct pci_ids f, char *buf, size_t size,
		     uint16_t VendorId, uint16_t DeviceId)
{
	if (f.fd == -1) {
		write_fallback_to_buffer(buf, size, DeviceId);
		return buf;
	}

	struct range whole_file = {
		.start = f.addr,
		.end = (unsigned char *)f.addr + f.size,
	};

	struct range vendor = find_vendor(whole_file, VendorId);

	struct range device = find_device(vendor, DeviceId);

	if (!empty_range(device))
		copy_range_to_buffer(device, buf, size);
	else
		write_fallback_to_buffer(buf, size, DeviceId);

	return buf;
}