269473047d747f7815af570197e4ef7322d3632cEvan Yan * CDDL HEADER START
269473047d747f7815af570197e4ef7322d3632cEvan Yan * The contents of this file are subject to the terms of the
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Common Development and Distribution License (the "License").
269473047d747f7815af570197e4ef7322d3632cEvan Yan * You may not use this file except in compliance with the License.
269473047d747f7815af570197e4ef7322d3632cEvan Yan * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
269473047d747f7815af570197e4ef7322d3632cEvan Yan * See the License for the specific language governing permissions
269473047d747f7815af570197e4ef7322d3632cEvan Yan * and limitations under the License.
269473047d747f7815af570197e4ef7322d3632cEvan Yan * When distributing Covered Code, include this CDDL HEADER in each
269473047d747f7815af570197e4ef7322d3632cEvan Yan * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
269473047d747f7815af570197e4ef7322d3632cEvan Yan * If applicable, add the following below this CDDL HEADER, with the
269473047d747f7815af570197e4ef7322d3632cEvan Yan * fields enclosed by brackets "[]" replaced with your own identifying
269473047d747f7815af570197e4ef7322d3632cEvan Yan * information: Portions Copyright [yyyy] [name of copyright owner]
269473047d747f7815af570197e4ef7322d3632cEvan Yan * CDDL HEADER END
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Use is subject to license terms.
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Define structures for a path-to-usage lookup table.
269473047d747f7815af570197e4ef7322d3632cEvan Yantypedef struct {
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Define callback argument used when getting resources.
269473047d747f7815af570197e4ef7322d3632cEvan Yantypedef struct {
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Define callback argument used when merging info.
269473047d747f7815af570197e4ef7322d3632cEvan Yantypedef struct {
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Local functions.
269473047d747f7815af570197e4ef7322d3632cEvan Yanstatic int merge_rcm_info(hp_node_t root, rcm_info_t *info);
269473047d747f7815af570197e4ef7322d3632cEvan Yanstatic int get_rcm_usage(char **rsrcs, rcm_info_t **info_p);
269473047d747f7815af570197e4ef7322d3632cEvan Yanstatic int build_table(rcm_info_t *info, info_table_t **tablep,
269473047d747f7815af570197e4ef7322d3632cEvan Yanstatic void free_table(info_table_t *table, size_t table_len);
269473047d747f7815af570197e4ef7322d3632cEvan Yanstatic int resource_callback(hp_node_t node, void *argp);
269473047d747f7815af570197e4ef7322d3632cEvan Yanstatic int merge_callback(hp_node_t node, void *argp);
269473047d747f7815af570197e4ef7322d3632cEvan Yanstatic int compare_info(const void *a, const void *b);
269473047d747f7815af570197e4ef7322d3632cEvan Yan * copy_usage()
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Given an information snapshot, get the corresponding
269473047d747f7815af570197e4ef7322d3632cEvan Yan * RCM usage information and merge it into the snapshot.
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Get resource names */
269473047d747f7815af570197e4ef7322d3632cEvan Yan log_err("Cannot get RCM resources (%s)\n", strerror(rv));
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Do nothing if no resources */
269473047d747f7815af570197e4ef7322d3632cEvan Yan return (0);
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Get RCM usage information */
269473047d747f7815af570197e4ef7322d3632cEvan Yan log_err("Cannot get RCM information (%s)\n", strerror(rv));
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Done with resource names */
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* If there is RCM usage information, merge it in */
269473047d747f7815af570197e4ef7322d3632cEvan Yan return (0);
269473047d747f7815af570197e4ef7322d3632cEvan Yan * rcm_resources()
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Given the root of a hotplug information snapshot,
269473047d747f7815af570197e4ef7322d3632cEvan Yan * construct a list of RCM compatible resource names.
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Initialize results */
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Traverse snapshot to get resources */
269473047d747f7815af570197e4ef7322d3632cEvan Yan (void) memset(&arg, 0, sizeof (resource_cb_arg_t));
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Check for errors */
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Success */
269473047d747f7815af570197e4ef7322d3632cEvan Yan return (0);
269473047d747f7815af570197e4ef7322d3632cEvan Yan * free_rcm_resources()
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Free a table of RCM resource names.
269473047d747f7815af570197e4ef7322d3632cEvan Yan * rcm_offline()
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Implement an RCM offline request.
269473047d747f7815af570197e4ef7322d3632cEvan Yan * NOTE: errors from RCM will be merged into the snapshot.
269473047d747f7815af570197e4ef7322d3632cEvan Yanrcm_offline(char **rsrcs, uint_t flags, hp_node_t root)
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Set flags */
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Allocate RCM handle */
269473047d747f7815af570197e4ef7322d3632cEvan Yan if (rcm_alloc_handle(NULL, 0, NULL, &handle) != RCM_SUCCESS) {
269473047d747f7815af570197e4ef7322d3632cEvan Yan log_err("Cannot allocate RCM handle (%s)\n", strerror(errno));
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Request RCM offline */
269473047d747f7815af570197e4ef7322d3632cEvan Yan if (rcm_request_offline_list(handle, rsrcs, rcm_flags,
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* RCM handle is no longer needed */
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Check if RCM returned any information tuples. If so,
269473047d747f7815af570197e4ef7322d3632cEvan Yan * then also check if the RCM operation failed, and possibly
269473047d747f7815af570197e4ef7322d3632cEvan Yan * merge the RCM info into the caller's hotplug snapshot.
269473047d747f7815af570197e4ef7322d3632cEvan Yan * rcm_online()
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Implement an RCM online notification.
269473047d747f7815af570197e4ef7322d3632cEvan Yan if (rcm_alloc_handle(NULL, 0, NULL, &handle) != RCM_SUCCESS) {
269473047d747f7815af570197e4ef7322d3632cEvan Yan log_err("Cannot allocate RCM handle (%s)\n", strerror(errno));
269473047d747f7815af570197e4ef7322d3632cEvan Yan (void) rcm_notify_online_list(handle, rsrcs, 0, &info);
269473047d747f7815af570197e4ef7322d3632cEvan Yan * rcm_remove()
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Implement an RCM remove notification.
269473047d747f7815af570197e4ef7322d3632cEvan Yan if (rcm_alloc_handle(NULL, 0, NULL, &handle) != RCM_SUCCESS) {
269473047d747f7815af570197e4ef7322d3632cEvan Yan log_err("Cannot allocate RCM handle (%s)\n", strerror(errno));
269473047d747f7815af570197e4ef7322d3632cEvan Yan (void) rcm_notify_remove_list(handle, rsrcs, 0, &info);
269473047d747f7815af570197e4ef7322d3632cEvan Yan * get_rcm_usage()
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Lookup usage information for a set of resources from RCM.
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* No-op if no RCM resources */
269473047d747f7815af570197e4ef7322d3632cEvan Yan return (0);
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Allocate RCM handle */
269473047d747f7815af570197e4ef7322d3632cEvan Yan if (rcm_alloc_handle(NULL, RCM_NOPID, NULL, &handle) != RCM_SUCCESS) {
269473047d747f7815af570197e4ef7322d3632cEvan Yan log_err("Cannot allocate RCM handle (%s)\n", strerror(errno));
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Get usage information from RCM */
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* RCM handle is no longer needed */
269473047d747f7815af570197e4ef7322d3632cEvan Yan * merge_rcm_info()
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Merge RCM information into a hotplug information snapshot.
269473047d747f7815af570197e4ef7322d3632cEvan Yan * First a lookup table is built to map lists of RCM usage to
269473047d747f7815af570197e4ef7322d3632cEvan Yan * pathnames. Then during a full traversal of the snapshot,
269473047d747f7815af570197e4ef7322d3632cEvan Yan * the lookup table is used for each node to find matching
269473047d747f7815af570197e4ef7322d3632cEvan Yan * RCM info tuples for each path in the snapshot.
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Build a lookup table, mapping paths to usage information */
269473047d747f7815af570197e4ef7322d3632cEvan Yan if ((rv = build_table(info, &table, &table_len)) != 0) {
269473047d747f7815af570197e4ef7322d3632cEvan Yan log_err("Cannot build RCM lookup table (%s)\n", strerror(rv));
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Stop if no valid entries were inserted in table */
269473047d747f7815af570197e4ef7322d3632cEvan Yan return (0);
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Initialize callback argument */
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Perform a merge traversal */
269473047d747f7815af570197e4ef7322d3632cEvan Yan (void) hp_traverse(root, (void *)&arg, merge_callback);
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Done with the table */
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Check for errors */
269473047d747f7815af570197e4ef7322d3632cEvan Yan log_err("Cannot merge RCM information (%s)\n", strerror(rv));
269473047d747f7815af570197e4ef7322d3632cEvan Yan return (0);
269473047d747f7815af570197e4ef7322d3632cEvan Yan * resource_callback()
269473047d747f7815af570197e4ef7322d3632cEvan Yan * A callback function for hp_traverse() that builds an RCM
269473047d747f7815af570197e4ef7322d3632cEvan Yan * compatible list of resource path names. The array has
269473047d747f7815af570197e4ef7322d3632cEvan Yan * been pre-allocated based on results from the related
269473047d747f7815af570197e4ef7322d3632cEvan Yan * callback resource_count_callback().
269473047d747f7815af570197e4ef7322d3632cEvan Yan resource_cb_arg_t *arg = (resource_cb_arg_t *)argp;
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Get node type */
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Prune OFFLINE ports */
269473047d747f7815af570197e4ef7322d3632cEvan Yan if ((type == HP_NODE_PORT) && HP_IS_OFFLINE(hp_state(node)))
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Skip past non-devices */
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Lookup resource path */
269473047d747f7815af570197e4ef7322d3632cEvan Yan if (hp_path(node, arg->path, arg->connection) != 0) {
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Insert "/devices" to path name */
269473047d747f7815af570197e4ef7322d3632cEvan Yan (void) snprintf(arg->dev_path, MAXPATHLEN, "/devices%s", arg->path);
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Grow resource array to accomodate new /devices path.
269473047d747f7815af570197e4ef7322d3632cEvan Yan * NOTE: include an extra NULL pointer at end of array.
269473047d747f7815af570197e4ef7322d3632cEvan Yan new_rsrcs = (char **)realloc(arg->rsrcs, new_size);
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Initialize new entries */
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Check for errors */
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Increment resource count */
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Do not visit children */
269473047d747f7815af570197e4ef7322d3632cEvan Yan * merge_callback()
269473047d747f7815af570197e4ef7322d3632cEvan Yan * A callback function for hp_traverse() that merges RCM information
269473047d747f7815af570197e4ef7322d3632cEvan Yan * tuples into an existing hotplug information snapshot. The RCM
269473047d747f7815af570197e4ef7322d3632cEvan Yan * information will be turned into HP_NODE_USAGE nodes.
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Only process device nodes (other nodes cannot have usage) */
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Get path of current node, using buffer provided in 'arg' */
269473047d747f7815af570197e4ef7322d3632cEvan Yan if ((rv = hp_path(node, arg->path, arg->connection)) != 0) {
269473047d747f7815af570197e4ef7322d3632cEvan Yan log_err("Cannot lookup hotplug path (%s)\n", strerror(rv));
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Check the lookup table for associated usage */
269473047d747f7815af570197e4ef7322d3632cEvan Yan if ((slot = bsearch(&lookup, arg->table, arg->table_len,
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Usage information was found. Append HP_NODE_USAGE nodes. */
269473047d747f7815af570197e4ef7322d3632cEvan Yan for (entry = slot->entries; entry != NULL; entry = entry->next) {
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Allocate a new usage node */
269473047d747f7815af570197e4ef7322d3632cEvan Yan usage = (hp_node_t)calloc(1, sizeof (struct hp_node));
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Initialize the usage node's contents */
269473047d747f7815af570197e4ef7322d3632cEvan Yan if ((usage->hp_name = strdup(entry->rsrc)) == NULL) {
269473047d747f7815af570197e4ef7322d3632cEvan Yan log_err("Cannot allocate hotplug usage node name.\n");
269473047d747f7815af570197e4ef7322d3632cEvan Yan if ((usage->hp_usage = strdup(entry->usage)) == NULL) {
269473047d747f7815af570197e4ef7322d3632cEvan Yan log_err("Cannot allocate hotplug usage node info.\n");
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Link the usage node as a child of the device node */
269473047d747f7815af570197e4ef7322d3632cEvan Yan * build_table()
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Build a lookup table that will be used to map paths to their
269473047d747f7815af570197e4ef7322d3632cEvan Yan * corresponding RCM information tuples.
269473047d747f7815af570197e4ef7322d3632cEvan Yanbuild_table(rcm_info_t *info, info_table_t **tablep, size_t *table_lenp)
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Initialize results */
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Count the RCM info tuples to determine the table's size */
269473047d747f7815af570197e4ef7322d3632cEvan Yan for (tuple = NULL; (tuple = rcm_info_next(info, tuple)) != NULL; )
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* If the table would be empty, then do nothing */
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Allocate the lookup table */
269473047d747f7815af570197e4ef7322d3632cEvan Yan table = (info_table_t *)calloc(table_len, sizeof (info_table_t));
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Fill in the lookup table. Fill one slot in the table
269473047d747f7815af570197e4ef7322d3632cEvan Yan * for each device path that has a set of associated RCM
269473047d747f7815af570197e4ef7322d3632cEvan Yan * information tuples. In some cases multiple tuples will
269473047d747f7815af570197e4ef7322d3632cEvan Yan * be joined together within the same slot.
269473047d747f7815af570197e4ef7322d3632cEvan Yan for (tuple = NULL; (tuple = rcm_info_next(info, tuple)) != NULL; ) {
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Extract RCM resource name and usage description.
269473047d747f7815af570197e4ef7322d3632cEvan Yan * NOTE: skip invalid tuples to return as much as possible.
269473047d747f7815af570197e4ef7322d3632cEvan Yan log_err("RCM returned invalid resource or usage.\n");
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Try to convert the RCM resource name to a hotplug path.
269473047d747f7815af570197e4ef7322d3632cEvan Yan * If conversion succeeds and this path differs from the
269473047d747f7815af570197e4ef7322d3632cEvan Yan * current slot in the table, then initialize the next
269473047d747f7815af570197e4ef7322d3632cEvan Yan * slot in the table.
269473047d747f7815af570197e4ef7322d3632cEvan Yan ((slot == NULL) || (strcmp(slot->path, path) != 0))) {
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Append current usage to entry list in the current slot */
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Allocate new entry */
269473047d747f7815af570197e4ef7322d3632cEvan Yan entry = (info_entry_t *)malloc(sizeof (info_entry_t));
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Link entry into current slot list */
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Initialize entry values */
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Check if valid entries were inserted in table */
269473047d747f7815af570197e4ef7322d3632cEvan Yan return (0);
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Sort the lookup table by hotplug path */
269473047d747f7815af570197e4ef7322d3632cEvan Yan qsort(table, table_len, sizeof (info_table_t), compare_info);
269473047d747f7815af570197e4ef7322d3632cEvan Yan return (0);
269473047d747f7815af570197e4ef7322d3632cEvan Yan * free_table()
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Destroy a lookup table.
269473047d747f7815af570197e4ef7322d3632cEvan Yan * rsrc2path()
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Convert from an RCM resource name to a hotplug device path.
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Only convert /dev and /devices paths */
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Follow symbolic links for /dev paths */
269473047d747f7815af570197e4ef7322d3632cEvan Yan return (-1);
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Remove the leading "/devices" part */
269473047d747f7815af570197e4ef7322d3632cEvan Yan (void) strlcpy(path, &tmp[strlen(S_DEVICES)], MAXPATHLEN);
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Remove any trailing minor node part */
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Successfully converted */
269473047d747f7815af570197e4ef7322d3632cEvan Yan return (0);
269473047d747f7815af570197e4ef7322d3632cEvan Yan /* Not converted */
269473047d747f7815af570197e4ef7322d3632cEvan Yan return (-1);
269473047d747f7815af570197e4ef7322d3632cEvan Yan * compare_info()
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Compare two slots in the lookup table that maps paths to usage.
269473047d747f7815af570197e4ef7322d3632cEvan Yan * NOTE: for use with qsort() and bsearch().