da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin/*
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * CDDL HEADER START
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin *
3e14f97f673e8a630f076077de35afdd43dc1587Roger A. Faulkner * The contents of this file are subject to the terms of the
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * Common Development and Distribution License (the "License").
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * You may not use this file except in compliance with the License.
7c2fbfb345896881c631598ee3852ce9ce33fb07April Chin *
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * or http://www.opensolaris.org/os/licensing.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * See the License for the specific language governing permissions
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * and limitations under the License.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin *
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * When distributing Covered Code, include this CDDL HEADER in each
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * If applicable, add the following below this CDDL HEADER, with the
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * fields enclosed by brackets "[]" replaced with your own identifying
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * information: Portions Copyright [yyyy] [name of copyright owner]
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin *
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * CDDL HEADER END
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin */
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin/*
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * Use is subject to license terms.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin */
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin#pragma ident "%Z%%M% %I% %E% SMI"
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin#include "libdevinfo.h"
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin#include <strings.h>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin#include <sys/modctl.h>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin/*
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin *
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * This file contains interfaces to translate <driver><instance><minorname>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * information into /devices and /dev paths. It does this using interfaces to
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * the kernel instance tree so that it can provide translations for devices
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * which are no longer present. An example consumer of these interfaces is
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * iostat(1M) - which shows, in its first iteration, activity since reboot.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * With persistant kstats, a device which was busy a long time ago can still
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * have a decaying presence in iostat output, and that output, when '-n' is
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * used, should show the public name.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin */
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chintypedef struct {
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin di_devlink_handle_t i_devlink_hdl;
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin} *idim_t;
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chindi_dim_t
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chindi_dim_init()
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin{
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin idim_t idim;
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin if ((idim = (idim_t)malloc(sizeof (*idim))) == NULL)
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin return (NULL);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin idim->i_devlink_hdl = di_devlink_init(NULL, 0);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin if (idim->i_devlink_hdl == NULL) {
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin free(idim);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin return (NULL);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin }
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin return ((di_dim_t)idim);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin}
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chinvoid
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chindi_dim_fini(di_dim_t dim)
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin{
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin idim_t idim = (idim_t)dim;
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin if (idim->i_devlink_hdl) {
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin (void) di_devlink_fini(&idim->i_devlink_hdl);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin }
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin free(idim);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin}
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin/*ARGSUSED*/
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chinchar *
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chindi_dim_path_devices(di_dim_t dim, char *drv_name, int instance,
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin char *minor_name)
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin{
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin major_t major;
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin int len;
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin int mlen;
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin char *devices;
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin /* convert drv_name to major_t */
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin if (modctl(MODGETMAJBIND, drv_name, strlen(drv_name) + 1, &major) < 0)
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin return (NULL);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin /* find the length of the devices path given major,instance */
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin if (modctl(MODGETDEVFSPATH_MI_LEN, major, instance, &len) != 0)
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin return (NULL);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin /*
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * MODGETDEVFSPATH_MI_LEN result includes '\0' termination, but we
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * may need to add space for ":<minor_name>"
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin */
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin if (minor_name)
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin mlen = len + 1 + strlen(minor_name);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin else
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin mlen = len;
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin if ((devices = (char *)malloc(mlen)) == NULL)
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin return (NULL);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin if (modctl(MODGETDEVFSPATH_MI, major, instance, len, devices) != 0) {
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin free(devices);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin return (NULL);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin }
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin if (minor_name) {
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin /* add ':<minot_name>' to the end of /devices path */
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin (void) strcat(devices, ":");
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin (void) strcat(devices, minor_name);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin }
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin return (devices);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin}
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin/* di_dim_path_dev di_devlink callback */
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chinstatic int
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chindi_dim_path_dev_callback(di_devlink_t dl, void *arg)
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin{
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin char **devp = (char **)arg;
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin char *devpath = (char *)di_devlink_path(dl);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin if (devpath)
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin *devp = strdup(devpath);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin return (DI_WALK_TERMINATE);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin}
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chinchar *
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chindi_dim_path_dev(di_dim_t dim, char *drv_name, int instance, char *minor_name)
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin{
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin idim_t idim = (idim_t)dim;
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin char *devices;
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin char *dev = NULL;
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin /* we must have a minor_name to resolve to a public name */
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin if (minor_name == NULL)
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin return (NULL);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin /* convert <driver><instance><minor_name> to /devices path */
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin devices = di_dim_path_devices(dim, drv_name, instance, minor_name);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin if (devices == NULL)
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin return (NULL);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin /* convert /devices path to /dev path */
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin (void) di_devlink_walk(idim->i_devlink_hdl, NULL,
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin devices, DI_PRIMARY_LINK, (void *)&dev, di_dim_path_dev_callback);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin free(devices);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin return (dev);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin}
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin