libmpscsi_vhci/common/MP_GetMultipathLusPlugin.c

	MP_GetMultipathLusPlugin.c revision 0c034175550709323575bc82b80a835256239e86
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy/*
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * CDDL HEADER START
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * The contents of this file are subject to the terms of the
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * Common Development and Distribution License (the "License").
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * You may not use this file except in compliance with the License.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * or http://www.opensolaris.org/os/licensing.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * See the License for the specific language governing permissions
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * and limitations under the License.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * When distributing Covered Code, include this CDDL HEADER in each
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * If applicable, add the following below this CDDL HEADER, with the
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * fields enclosed by brackets "[]" replaced with your own identifying
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * information: Portions Copyright [yyyy] [name of copyright owner]
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * CDDL HEADER END
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy */
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy/*
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * Copyright (c) 2006, 2010, Oracle and/or its affiliates. All rights reserved.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy */
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy#include <syslog.h>
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy#include <errno.h>
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy#include <unistd.h>
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy#include <stropts.h>
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy#include "mp_utils.h"
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy#include <libdevinfo.h>
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy/*
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * Checks whether there is online path or not.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *  - no path found returns -1.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *  - online/standby path found returns 1.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *  - path exists but no online/standby path found returns 0.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy */
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedystatic int checkAvailablePath(di_node_t node)
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy{
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy    di_path_t path;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy    di_path_state_t state;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy    if ((path = di_path_client_next_path(node, DI_PATH_NIL))
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy        == DI_PATH_NIL) {
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy        log(LOG_INFO, "checkAvailalblePath()",
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy            " - No path found");
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy        return (-1);
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy    }
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy    do {
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy        /* ignore the path that is neither online nor standby. */
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy        if (((state = di_path_state(path)) == DI_PATH_STATE_ONLINE) ||
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy            (state == DI_PATH_STATE_STANDBY)) {
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy            return (1);
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy        }
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy    } while ((path = di_path_client_next_path(node, path)) != DI_PATH_NIL);
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy    /* return 0 for the case that there is no online path to the node. */
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy    log(LOG_INFO, "checkAvailalblePath()", " - No online path found");
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy    return (0);
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy}
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedystatic int getOidList(di_node_t root_node, MP_OID_LIST *pOidList)
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy{
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy    int numNodes = 0, state;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy    int instNum;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy    int majorNum;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy    MP_UINT64 osn;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy    di_node_t sv_node   = DI_NODE_NIL;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy    di_node_t sv_child_node = DI_NODE_NIL;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy    int haveList = (NULL != pOidList);
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy    log(LOG_INFO, "getOidList()", " - enter");
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy    sv_node = di_drv_first_node("scsi_vhci", root_node);
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy    if (DI_NODE_NIL == sv_node) {
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy        log(LOG_INFO, "getOidList()",
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy            " - di_drv_first_node() failed");
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy        return (-1);
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy    }
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy    sv_child_node = di_child_node(sv_node);
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy    while (DI_NODE_NIL != sv_child_node) {
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy        /* skip the node which is offline, down or detached. */
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy        state = di_state(sv_child_node);
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy        if ((state & DI_DEVICE_DOWN) ||
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy            (state & DI_DEVICE_OFFLINE)) {
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy            sv_child_node = di_sibling_node(sv_child_node);
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy            continue;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy        }
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy        /*
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy         * skip if the node doesn't have any path avaialble.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy         * If any path is found from the DINFOCACHE snaphost
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy         * that means the driver keeps track of the path regadless
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy         * of state.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy         */
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy        if (checkAvailablePath(sv_child_node) == -1) {
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy            sv_child_node = di_sibling_node(sv_child_node);
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy            continue;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy        }
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy        if (haveList && (numNodes < pOidList->oidCount)) {
            instNum = di_instance(sv_child_node);
            majorNum = di_driver_major(sv_child_node);

            log(LOG_INFO, "getOidList()",
                "instNum = %d", instNum);
            log(LOG_INFO, "getOidList()",
                "majorNum = %d", majorNum);

            osn = 0;
            osn = MP_STORE_INST_TO_ID(instNum, osn);
            osn = MP_STORE_MAJOR_TO_ID(majorNum, osn);

            pOidList->oids[numNodes].objectType =
                MP_OBJECT_TYPE_MULTIPATH_LU;

            pOidList->oids[numNodes].ownerId =
                g_pluginOwnerID;

            pOidList->oids[numNodes].objectSequenceNumber =
                osn;
        }

        ++numNodes;

        sv_child_node = di_sibling_node(sv_child_node);
    }

    log(LOG_INFO,
        "getOidList()",
        " - numNodes: %d",
        numNodes);


    log(LOG_INFO, "getOidList()", " - exit");

    return (numNodes);
}


MP_STATUS
MP_GetMultipathLusPlugin(MP_OID_LIST **ppList)
{
    di_node_t root_node = DI_NODE_NIL;
    MP_OID_LIST *pOidList   = NULL;

    int numNodes = 0;
    int i = 0;

    log(LOG_INFO, "MP_GetMultipathLusPlugin()", " - enter");


    root_node = di_init("/", DINFOCACHE);
    if (DI_NODE_NIL == root_node) {
        log(LOG_INFO, "MP_GetMultipathLusPlugin()",
            " - di_init() failed");

        return (MP_STATUS_FAILED);
    }

    numNodes = getOidList(root_node, NULL);

    if (numNodes < 0) {

        log(LOG_INFO,
            "MP_GetMultipathLusPlugin()",
            " - unable to get OID list.");

        log(LOG_INFO, "MP_GetMultipathLusPlugin()",
            " - error exit");

        di_fini(root_node);

        return (MP_STATUS_FAILED);
    }

    if (0 == numNodes) {

        pOidList = createOidList(1);
        if (NULL == pOidList) {

            log(LOG_INFO,
                "MP_GetMultipathLusPlugin()",
                " - unable to create OID list.");

            di_fini(root_node);

            return (MP_STATUS_INSUFFICIENT_MEMORY);
        }

        pOidList->oids[0].objectType =
            MP_OBJECT_TYPE_MULTIPATH_LU;

        pOidList->oids[0].ownerId =
            g_pluginOwnerID;

        *ppList = pOidList;

        log(LOG_INFO, "MP_GetMultipathLusPlugin()",
            " - returning empty list.");

        di_fini(root_node);

        return (MP_STATUS_SUCCESS);
    }

    *ppList = createOidList(numNodes);
    if (NULL == *ppList) {
        log(LOG_INFO, "MP_GetMultipathLusPlugin()",
            "no memory for *ppList");
        log(LOG_INFO, "MP_GetMultipathLusPlugin()",
            " - error exit");
        return (MP_STATUS_INSUFFICIENT_MEMORY);
    }

    (*ppList)->oidCount = numNodes;

    numNodes = getOidList(root_node, *ppList);

    for (i = 0; i < (*ppList)->oidCount; i++) {

        log(LOG_INFO, "MP_GetMultipathLusPlugin()",
            "(*ppList)->oids[%d].objectType           = %d",
            i, (*ppList)->oids[i].objectType);
        log(LOG_INFO, "MP_GetMultipathLusPlugin()",
            "(*ppList)->oids[%d].ownerId              = %d",
            i, (*ppList)->oids[i].ownerId);
        log(LOG_INFO, "MP_GetMultipathLusPlugin()",
            "(*ppList)->oids[%d].objectSequenceNumber = %llx",
            i, (*ppList)->oids[i].objectSequenceNumber);
    }


    di_fini(root_node);

    log(LOG_INFO, "MP_GetMultipathLusPlugin()", " - exit");

    return (MP_STATUS_SUCCESS);

}