xref: /illumos-gate/usr/src/lib/libsmbios/common/smb_lib.c (revision 1566bc3431383e39ac9bc7fb7f00feff9c06acda)

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 * Copyright (c) 2018, Joyent, Inc.
 */

#include <sys/types.h>
#include <sys/smbios_impl.h>
#include <sys/sysmacros.h>
#include <sys/stat.h>
#include <sys/mman.h>

#include <alloca.h>
#include <limits.h>
#include <unistd.h>
#include <strings.h>
#include <stdlib.h>
#include <errno.h>
#include <fcntl.h>
#include <libdevinfo.h>

#pragma init(smb_init)
static void
smb_init(void)
{
	_smb_debug = getenv("SMB_DEBUG") != NULL;
}

static smbios_hdl_t *
smb_fileopen(int fd, int version, int flags, int *errp)
{
	smbios_entry_t *ep = alloca(SMB_ENTRY_MAXLEN);
	smbios_entry_point_t ep_type;
	smbios_hdl_t *shp = NULL;
	uint32_t smbe_stlen;
	off64_t smbe_staddr;
	ssize_t n, elen;
	void *stbuf;

	if ((n = pread64(fd, ep, sizeof (*ep), 0)) != sizeof (*ep))
		return (smb_open_error(shp, errp, n < 0 ? errno : ESMB_NOHDR));

	if (strncmp(ep->ep21.smbe_eanchor, SMB_ENTRY_EANCHOR,
	    SMB_ENTRY_EANCHORLEN) == 0) {
		ep_type = SMBIOS_ENTRY_POINT_21;
		elen = MIN(ep->ep21.smbe_elen, SMB_ENTRY_MAXLEN);
	} else if (strncmp(ep->ep30.smbe_eanchor, SMB3_ENTRY_EANCHOR,
	    SMB3_ENTRY_EANCHORLEN) == 0) {
		ep_type = SMBIOS_ENTRY_POINT_30;
		elen = MIN(ep->ep30.smbe_elen, SMB_ENTRY_MAXLEN);
	} else {
		return (smb_open_error(shp, errp, ESMB_HEADER));
	}

	if ((n = pread64(fd, ep, elen, 0)) != elen)
		return (smb_open_error(shp, errp, n < 0 ? errno : ESMB_NOHDR));

	if (ep_type == SMBIOS_ENTRY_POINT_21) {
		smbe_stlen = ep->ep21.smbe_stlen;
		smbe_staddr = (off64_t)ep->ep21.smbe_staddr;
	} else {
		smbe_stlen = ep->ep30.smbe_stlen;
		smbe_staddr = (off64_t)ep->ep30.smbe_staddr;
	}
	stbuf = smb_alloc(smbe_stlen);

	if (stbuf == NULL)
		return (smb_open_error(shp, errp, ESMB_NOMEM));

	if ((n = pread64(fd, stbuf, smbe_stlen, smbe_staddr)) != smbe_stlen) {
		smb_free(stbuf, smbe_stlen);
		return (smb_open_error(shp, errp, n < 0 ? errno : ESMB_NOSTAB));
	}

	shp = smbios_bufopen(ep, stbuf, smbe_stlen, version, flags, errp);

	if (shp != NULL)
		shp->sh_flags |= SMB_FL_BUFALLOC;
	else
		smb_free(stbuf, smbe_stlen);

	return (shp);
}

static smbios_hdl_t *
smb_biosopen(int fd, int version, int flags, int *errp)
{
	smbios_entry_t *ep = alloca(SMB_ENTRY_MAXLEN);
	smbios_entry_point_t ep_type;
	smbios_hdl_t *shp = NULL;
	size_t pgsize, pgmask, pgoff;
	void *stbuf, *bios, *p, *q;
	void *smb2, *smb3;
	di_node_t root;
	int64_t *val64;
	uint32_t smbe_stlen;
	off64_t smbe_staddr;

	bios = MAP_FAILED;
	if ((root = di_init("/", DINFOPROP)) != DI_NODE_NIL) {
		if (di_prop_lookup_int64(DDI_DEV_T_ANY, root,
		    "smbios-address", &val64) == 1) {
			bios = mmap(NULL, SMB_RANGE_LIMIT - SMB_RANGE_START + 1,
			    PROT_READ, MAP_SHARED, fd, (off_t)*val64);
		}
		di_fini(root);
	}
	if (bios == MAP_FAILED) {
		bios = mmap(NULL, SMB_RANGE_LIMIT - SMB_RANGE_START + 1,
		    PROT_READ, MAP_SHARED, fd, (uint32_t)SMB_RANGE_START);
	}

	if (bios == MAP_FAILED)
		return (smb_open_error(shp, errp, ESMB_MAPDEV));

	q = (void *)((uintptr_t)bios + SMB_RANGE_LIMIT - SMB_RANGE_START + 1);

	smb2 = smb3 = NULL;
	for (p = bios; p < q; p = (void *)((uintptr_t)p + SMB_SCAN_STEP)) {
		if (smb2 != NULL && smb3 != NULL)
			break;
		if (smb3 == NULL && strncmp(p, SMB3_ENTRY_EANCHOR,
		    SMB3_ENTRY_EANCHORLEN) == 0) {
			smb3 = p;
		} else if (smb2 == NULL && strncmp(p, SMB_ENTRY_EANCHOR,
		    SMB_ENTRY_EANCHORLEN) == 0) {
			smb2 = p;
		}
	}

	/*
	 * While they're not supposed to (as per the SMBIOS 3.2 spec), some
	 * vendors end up having a newer version in one of the two entry points
	 * than the other. If we found multiple tables then we will prefer the
	 * one with the newer version. If they're equivalent, we prefer the
	 * 32-bit version. If only one is present, then we use that.
	 */
	if (smb2 != NULL && smb3 != NULL) {
		uint8_t smb2maj, smb2min, smb3maj, smb3min;

		bcopy(smb2, ep, sizeof (smbios_entry_t));
		smb2maj = ep->ep21.smbe_major;
		smb2min = ep->ep21.smbe_minor;
		bcopy(smb3, ep, sizeof (smbios_entry_t));
		smb3maj = ep->ep30.smbe_major;
		smb3min = ep->ep30.smbe_minor;

		if (smb3maj > smb2maj ||
		    (smb3maj == smb2maj && smb3min > smb2min)) {
			ep_type = SMBIOS_ENTRY_POINT_30;
			p = smb3;
		} else {
			ep_type = SMBIOS_ENTRY_POINT_21;
			p = smb2;
		}
	} else if (smb3 != NULL) {
		ep_type = SMBIOS_ENTRY_POINT_30;
		p = smb3;
	} else if (smb2 != NULL) {
		ep_type = SMBIOS_ENTRY_POINT_21;
		p = smb2;
	} else {
		(void) munmap(bios, SMB_RANGE_LIMIT - SMB_RANGE_START + 1);
		return (smb_open_error(NULL, errp, ESMB_NOTFOUND));
	}

	bcopy(p, ep, sizeof (smbios_entry_t));

	switch (ep_type) {
	case SMBIOS_ENTRY_POINT_21:
		ep->ep21.smbe_elen = MIN(ep->ep21.smbe_elen, SMB_ENTRY_MAXLEN);
		bcopy(p, ep, ep->ep21.smbe_elen);
		smbe_stlen = ep->ep21.smbe_stlen;
		smbe_staddr = ep->ep21.smbe_staddr;
		break;
	case SMBIOS_ENTRY_POINT_30:
		ep->ep30.smbe_elen = MIN(ep->ep30.smbe_elen, SMB_ENTRY_MAXLEN);
		bcopy(p, ep, ep->ep30.smbe_elen);
		smbe_stlen = ep->ep30.smbe_stlen;
		smbe_staddr = ep->ep30.smbe_staddr;
		break;
	default:
		(void) munmap(bios, SMB_RANGE_LIMIT - SMB_RANGE_START + 1);
		return (smb_open_error(NULL, errp, ESMB_VERSION));
	}
	(void) munmap(bios, SMB_RANGE_LIMIT - SMB_RANGE_START + 1);

	pgsize = getpagesize();
	pgmask = ~(pgsize - 1);
	pgoff = smbe_staddr & ~pgmask;

	bios = mmap(NULL, smbe_stlen + pgoff,
	    PROT_READ, MAP_SHARED, fd, smbe_staddr & pgmask);

	if (bios == MAP_FAILED)
		return (smb_open_error(shp, errp, ESMB_MAPDEV));

	if ((stbuf = smb_alloc(smbe_stlen)) == NULL) {
		(void) munmap(bios, smbe_stlen + pgoff);
		return (smb_open_error(shp, errp, ESMB_NOMEM));
	}

	bcopy((char *)bios + pgoff, stbuf, smbe_stlen);
	(void) munmap(bios, smbe_stlen + pgoff);
	shp = smbios_bufopen(ep, stbuf, smbe_stlen, version, flags, errp);

	if (shp != NULL)
		shp->sh_flags |= SMB_FL_BUFALLOC;
	else
		smb_free(stbuf, smbe_stlen);

	return (shp);
}

smbios_hdl_t *
smbios_fdopen(int fd, int version, int flags, int *errp)
{
	struct stat64 st1, st2;

	if (stat64(SMB_BIOS_DEVICE, &st1) == 0 && fstat64(fd, &st2) == 0 &&
	    S_ISCHR(st2.st_mode) && st1.st_rdev == st2.st_rdev)
		return (smb_biosopen(fd, version, flags, errp));
	else
		return (smb_fileopen(fd, version, flags, errp));
}

smbios_hdl_t *
smbios_open(const char *file, int version, int flags, int *errp)
{
	smbios_hdl_t *shp;
	int fd;

	if ((fd = open64(file ? file : SMB_SMBIOS_DEVICE, O_RDONLY)) == -1) {
		if ((errno == ENOENT || errno == ENXIO) &&
		    (file == NULL || strcmp(file, SMB_SMBIOS_DEVICE) == 0))
			errno = ESMB_NOTFOUND;
		return (smb_open_error(NULL, errp, errno));
	}

	shp = smbios_fdopen(fd, version, flags, errp);
	(void) close(fd);
	return (shp);
}

static int
smbios_xwrite(smbios_hdl_t *shp, int fd, const void *buf, size_t buflen)
{
	ssize_t resid = buflen;
	ssize_t len;

	while (resid != 0) {
		if ((len = write(fd, buf, resid)) <= 0)
			return (smb_set_errno(shp, errno));
		resid -= len;
		buf = (uchar_t *)buf + len;
	}

	return (0);
}

int
smbios_write(smbios_hdl_t *shp, int fd)
{
	smbios_entry_t ep;
	off64_t off = lseek64(fd, 0, SEEK_CUR) + P2ROUNDUP(sizeof (ep), 16);

	if (off > UINT32_MAX)
		return (smb_set_errno(shp, EOVERFLOW));

	bcopy(&shp->sh_ent, &ep, sizeof (ep));
	if (shp->sh_ent_type == SMBIOS_ENTRY_POINT_21)
		ep.ep21.smbe_staddr = (uint32_t)off;
	else if (shp->sh_ent_type == SMBIOS_ENTRY_POINT_30)
		ep.ep30.smbe_staddr = (uint64_t)off;
	else
		return (-1);

	smbios_checksum(shp, &ep);

	if (smbios_xwrite(shp, fd, &ep, sizeof (ep)) == -1 ||
	    lseek64(fd, off, SEEK_SET) != off ||
	    smbios_xwrite(shp, fd, shp->sh_buf, shp->sh_buflen) == -1)
		return (-1);

	return (0);
}