908f1e1388f616898b4e515d343c0414f2a6472esd * CDDL HEADER START
908f1e1388f616898b4e515d343c0414f2a6472esd * The contents of this file are subject to the terms of the
908f1e1388f616898b4e515d343c0414f2a6472esd * Common Development and Distribution License (the "License").
908f1e1388f616898b4e515d343c0414f2a6472esd * You may not use this file except in compliance with the License.
908f1e1388f616898b4e515d343c0414f2a6472esd * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
908f1e1388f616898b4e515d343c0414f2a6472esd * See the License for the specific language governing permissions
908f1e1388f616898b4e515d343c0414f2a6472esd * and limitations under the License.
908f1e1388f616898b4e515d343c0414f2a6472esd * When distributing Covered Code, include this CDDL HEADER in each
908f1e1388f616898b4e515d343c0414f2a6472esd * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
908f1e1388f616898b4e515d343c0414f2a6472esd * If applicable, add the following below this CDDL HEADER, with the
908f1e1388f616898b4e515d343c0414f2a6472esd * fields enclosed by brackets "[]" replaced with your own identifying
908f1e1388f616898b4e515d343c0414f2a6472esd * information: Portions Copyright [yyyy] [name of copyright owner]
908f1e1388f616898b4e515d343c0414f2a6472esd * CDDL HEADER END
fc33347812f84907261f6fd501e2409da108b8d8Tom Pothier * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
908f1e1388f616898b4e515d343c0414f2a6472esd * Walk the LDOM PRI component nodes and create appropriate topology nodes
908f1e1388f616898b4e515d343c0414f2a6472esd * Allow for custom topo node creation routines based on topo-hc-name.
3f1e69bef33050bee99ea1e9992af13fc467281fCheng Sean Yeextern topo_method_t pi_cpu_methods[], pi_mem_methods[];
908f1e1388f616898b4e515d343c0414f2a6472esd * List of custom enumerators for PRI nodes that require them. The most
908f1e1388f616898b4e515d343c0414f2a6472esd * common nodes are listed first.
3f1e69bef33050bee99ea1e9992af13fc467281fCheng Sean Ye/* List of methods that will be registered in the nodes. */
908f1e1388f616898b4e515d343c0414f2a6472esd * In order to create a topology node from a PRI MDE node we need to know the
908f1e1388f616898b4e515d343c0414f2a6472esd * topology parent node that should be used. So, after creating a topology
908f1e1388f616898b4e515d343c0414f2a6472esd * node from an MDE node, we associate children of the MDE node with the new
908f1e1388f616898b4e515d343c0414f2a6472esd * topology node. Thus, when the children are visited we can know the
908f1e1388f616898b4e515d343c0414f2a6472esd * appropriate parent topology node to use.
908f1e1388f616898b4e515d343c0414f2a6472esd * We take advantage of the libtopo threading model here, which guarantees a
908f1e1388f616898b4e515d343c0414f2a6472esd * single thread and a single invocation at a time for an enumerator. This
908f1e1388f616898b4e515d343c0414f2a6472esd * makes using a file-global safe.
908f1e1388f616898b4e515d343c0414f2a6472esd/* The routine called for each node in the PRI while walking the graph */
908f1e1388f616898b4e515d343c0414f2a6472esdstatic int pi_walker_node(md_t *, mde_cookie_t, mde_cookie_t, void *);
908f1e1388f616898b4e515d343c0414f2a6472esd * Create a sub-range for a given PRI node and associate the given topology
908f1e1388f616898b4e515d343c0414f2a6472esd * node with the children.
908f1e1388f616898b4e515d343c0414f2a6472esdstatic int pi_walker_node_range(topo_mod_t *, md_t *, tnode_t *, mde_cookie_t);
908f1e1388f616898b4e515d343c0414f2a6472esdstatic int pi_walker_node_create(topo_mod_t *, md_t *, mde_cookie_t, tnode_t *,
908f1e1388f616898b4e515d343c0414f2a6472esd/* Routines to handle the list of topology parents and mde_nodes */
908f1e1388f616898b4e515d343c0414f2a6472esdstatic int pi_walkerlist_compare(const void *, const void *, void *);
908f1e1388f616898b4e515d343c0414f2a6472esdstatic int pi_walkerlist_add(topo_mod_t *, tnode_t *, mde_cookie_t);
908f1e1388f616898b4e515d343c0414f2a6472esdstatic int pi_walkerlist_addtype(topo_mod_t *, nvlist_t *, char *, uint32_t,
908f1e1388f616898b4e515d343c0414f2a6472esdstatic int pi_walkerlist_find(topo_mod_t *, mde_cookie_t, tnode_t **);
908f1e1388f616898b4e515d343c0414f2a6472esd result = topo_mod_nvalloc(mod, &pi_enum_fns, NV_UNIQUE_NAME);
3f1e69bef33050bee99ea1e9992af13fc467281fCheng Sean Ye result |= topo_mod_nvalloc(mod, &pi_meths, NV_UNIQUE_NAME);
908f1e1388f616898b4e515d343c0414f2a6472esd if (result != 0) {
908f1e1388f616898b4e515d343c0414f2a6472esd return (-1);
908f1e1388f616898b4e515d343c0414f2a6472esd /* Add the builtin functions to the list */
3f1e69bef33050bee99ea1e9992af13fc467281fCheng Sean Ye result |= nvlist_add_uint64(pi_enum_fns, fp->hc_name, faddr);
3f1e69bef33050bee99ea1e9992af13fc467281fCheng Sean Ye /* Add the builtin methods to the list */
3f1e69bef33050bee99ea1e9992af13fc467281fCheng Sean Ye result |= nvlist_add_uint64(pi_meths, mp->hc_name, maddr);
3f1e69bef33050bee99ea1e9992af13fc467281fCheng Sean Ye topo_mod_dprintf(mod, "pi_walker_init failed\n");
908f1e1388f616898b4e515d343c0414f2a6472esd return (0);
908f1e1388f616898b4e515d343c0414f2a6472esd * Begin to walk the machine description array starting at the given PRI node.
908f1e1388f616898b4e515d343c0414f2a6472esdpi_walker(pi_enum_t *pip, tnode_t *t_parent, const char *hc_name,
908f1e1388f616898b4e515d343c0414f2a6472esd mde_cookie_t mde_node, mde_str_cookie_t component_cookie,
908f1e1388f616898b4e515d343c0414f2a6472esd return (-1);
908f1e1388f616898b4e515d343c0414f2a6472esd topo_mod_dprintf(mod, "walker starting at node_0x%llx\n",
908f1e1388f616898b4e515d343c0414f2a6472esd * Create a list to store topology nodes and their associated machine
908f1e1388f616898b4e515d343c0414f2a6472esd * description index. This allows the code to know the parent of a
908f1e1388f616898b4e515d343c0414f2a6472esd * node when creating topology entries.
908f1e1388f616898b4e515d343c0414f2a6472esd if (result != 0) {
908f1e1388f616898b4e515d343c0414f2a6472esd /* Create a walker node for the parent of the start node */
908f1e1388f616898b4e515d343c0414f2a6472esd if (result != 0) {
186d582bd9dbcd38e0aeea49036d47d3426a3536Surya Prakki (void) topo_mod_seterrno(mod, EMOD_UKNOWN_ENUM);
908f1e1388f616898b4e515d343c0414f2a6472esd * This is a top-level node. Make sure we call the top level
908f1e1388f616898b4e515d343c0414f2a6472esd * enumerator if there is not already a custom enumerator registered.
908f1e1388f616898b4e515d343c0414f2a6472esd * There is no enumerator function registered for this
908f1e1388f616898b4e515d343c0414f2a6472esd * hc name. Automatically register the top level node
908f1e1388f616898b4e515d343c0414f2a6472esd * enumerator function.
908f1e1388f616898b4e515d343c0414f2a6472esd if (result != 0) {
908f1e1388f616898b4e515d343c0414f2a6472esd "walker could not register enumerator for type "
186d582bd9dbcd38e0aeea49036d47d3426a3536Surya Prakki (void) topo_mod_seterrno(mod, EMOD_UKNOWN_ENUM);
908f1e1388f616898b4e515d343c0414f2a6472esd return (-1);
908f1e1388f616898b4e515d343c0414f2a6472esd "walker registered pi_enum_top enumerator for type %s\n",
908f1e1388f616898b4e515d343c0414f2a6472esd /* Walk the machine description list starting at the given node */
908f1e1388f616898b4e515d343c0414f2a6472esd result = md_walk_dag(pip->mdp, mde_node, component_cookie, arc_cookie,
908f1e1388f616898b4e515d343c0414f2a6472esd switch (result) {
908f1e1388f616898b4e515d343c0414f2a6472esd /* Successful completion */
908f1e1388f616898b4e515d343c0414f2a6472esd /* DO NOTHING */
908f1e1388f616898b4e515d343c0414f2a6472esd * Store that we have a partial enumeration and return
908f1e1388f616898b4e515d343c0414f2a6472esd * that we have encountered an error.
186d582bd9dbcd38e0aeea49036d47d3426a3536Surya Prakki (void) topo_mod_seterrno(mod, EMOD_PARTIAL_ENUM);
908f1e1388f616898b4e515d343c0414f2a6472esd * This should not happen. We want to always produce
908f1e1388f616898b4e515d343c0414f2a6472esd * as complete a topology as possible, even in the face
908f1e1388f616898b4e515d343c0414f2a6472esd * of errors, however, so set an error and continue.
908f1e1388f616898b4e515d343c0414f2a6472esd "walker encountered invalid result: %d. "
186d582bd9dbcd38e0aeea49036d47d3426a3536Surya Prakki (void) topo_mod_seterrno(mod, EMOD_UKNOWN_ENUM);
908f1e1388f616898b4e515d343c0414f2a6472esd /* Destroy the walker list, which is no longer necessary */
908f1e1388f616898b4e515d343c0414f2a6472esd topo_mod_dprintf(mod, "walker done with node_0x%llx\n", mde_node);
908f1e1388f616898b4e515d343c0414f2a6472esd * Visited once for each node in the machine description. Creates a topo
908f1e1388f616898b4e515d343c0414f2a6472esd * node for the machine description node and associates it with it's parent,
908f1e1388f616898b4e515d343c0414f2a6472esd * by calling an appropriate creation routine for the node type.
908f1e1388f616898b4e515d343c0414f2a6472esd * This routine returns MDE_WALK_NEXT, MDE_WALK_DONE or MDE_WALK_ERROR
908f1e1388f616898b4e515d343c0414f2a6472esdpi_walker_node(md_t *mdp, mde_cookie_t parent_mde_node, mde_cookie_t mde_node,
908f1e1388f616898b4e515d343c0414f2a6472esd /* Make sure we have our private data */
908f1e1388f616898b4e515d343c0414f2a6472esd "walker processing node_0x%llx parent node 0x%llx\n",
908f1e1388f616898b4e515d343c0414f2a6472esd /* Should we skip this node ? */
908f1e1388f616898b4e515d343c0414f2a6472esd /* Skip this node and continue to the next node */
908f1e1388f616898b4e515d343c0414f2a6472esd if (result != 0) {
908f1e1388f616898b4e515d343c0414f2a6472esd * No ID available to place this mde node in the topology so
908f1e1388f616898b4e515d343c0414f2a6472esd * we cannot create a topology node.
186d582bd9dbcd38e0aeea49036d47d3426a3536Surya Prakki (void) topo_mod_seterrno(mod, EMOD_PARTIAL_ENUM);
908f1e1388f616898b4e515d343c0414f2a6472esd * Find the parent topo node for this machine description node.
908f1e1388f616898b4e515d343c0414f2a6472esd * If found, the element will also be removed from the list and the
908f1e1388f616898b4e515d343c0414f2a6472esd * memory used to keep track of it released. We will only visit an
908f1e1388f616898b4e515d343c0414f2a6472esd * MDE node once and so the memory is no longer needed.
908f1e1388f616898b4e515d343c0414f2a6472esd * No parent was found or a NULL parent encountered. We
908f1e1388f616898b4e515d343c0414f2a6472esd * cannot create a new topology node without a parent (
908f1e1388f616898b4e515d343c0414f2a6472esd * even for top level nodes). We associate children of
908f1e1388f616898b4e515d343c0414f2a6472esd * this MDE node with a NULL parent to silently skip the
908f1e1388f616898b4e515d343c0414f2a6472esd * remainder of this MDE branch.
908f1e1388f616898b4e515d343c0414f2a6472esd topo_mod_dprintf(mod, "no topo parent found for node_0x%llx\n",
186d582bd9dbcd38e0aeea49036d47d3426a3536Surya Prakki (void) topo_mod_seterrno(mod, EMOD_PARTIAL_ENUM);
908f1e1388f616898b4e515d343c0414f2a6472esd * We have the mde node instance and parent information.
908f1e1388f616898b4e515d343c0414f2a6472esd * Attempt to create a topology node for this mde node.
908f1e1388f616898b4e515d343c0414f2a6472esd result = pi_walker_node_create(mod, mdp, mde_node, t_parent, inst,
908f1e1388f616898b4e515d343c0414f2a6472esd * We have failed to create a new topology node based on
908f1e1388f616898b4e515d343c0414f2a6472esd * the current MDE node. We set partial enumeration and
908f1e1388f616898b4e515d343c0414f2a6472esd * return without associating the children of this MDE
908f1e1388f616898b4e515d343c0414f2a6472esd * node with a topology parent. This will propgate the
908f1e1388f616898b4e515d343c0414f2a6472esd * creation error down this MDE branch.
186d582bd9dbcd38e0aeea49036d47d3426a3536Surya Prakki (void) topo_mod_seterrno(mod, EMOD_PARTIAL_ENUM);
908f1e1388f616898b4e515d343c0414f2a6472esd * Associate the new topology node with any children of this mde node.
908f1e1388f616898b4e515d343c0414f2a6472esd result = pi_walker_node_range(mod, mdp, t_node, mde_node);
908f1e1388f616898b4e515d343c0414f2a6472esd topo_mod_dprintf(mod, "walker completed node_0x%llx result = %d\n",
908f1e1388f616898b4e515d343c0414f2a6472esdpi_walker_node_create(topo_mod_t *mod, md_t *mdp, mde_cookie_t mde_node,
908f1e1388f616898b4e515d343c0414f2a6472esd tnode_t *t_parent, topo_instance_t inst, tnode_t **t_node)
908f1e1388f616898b4e515d343c0414f2a6472esd * A parent topology node is required even for top-level
908f1e1388f616898b4e515d343c0414f2a6472esd * Find the topo-hc-name for this node which is used to find
908f1e1388f616898b4e515d343c0414f2a6472esd * the specific creation function
908f1e1388f616898b4e515d343c0414f2a6472esd /* Cannot get the hc-name */
908f1e1388f616898b4e515d343c0414f2a6472esd /* Determine the topology node creation routine to use */
908f1e1388f616898b4e515d343c0414f2a6472esd result = nvlist_lookup_uint64(pi_enum_fns, hc_name, &faddr);
908f1e1388f616898b4e515d343c0414f2a6472esd if (result == 0) {
908f1e1388f616898b4e515d343c0414f2a6472esd * A function is registered for this node. Convert the
908f1e1388f616898b4e515d343c0414f2a6472esd * address to a pointer to function
908f1e1388f616898b4e515d343c0414f2a6472esd * Create a topology node for this mde node by calling the identified
908f1e1388f616898b4e515d343c0414f2a6472esd * enumeration function
908f1e1388f616898b4e515d343c0414f2a6472esd result = (func)(mod, mdp, mde_node, inst, t_parent, hc_name, t_node);
908f1e1388f616898b4e515d343c0414f2a6472esd if (result != 0) {
908f1e1388f616898b4e515d343c0414f2a6472esd "failed to create topo entry for node_0x%llx type %s\n",
908f1e1388f616898b4e515d343c0414f2a6472esd * Scan the children of a given MDE node and find all the sets of topo-hc-name
908f1e1388f616898b4e515d343c0414f2a6472esd * types and their instance ranges. From this information we create topology
908f1e1388f616898b4e515d343c0414f2a6472esd * node ranges on the given parent so that when the children are visited and a
908f1e1388f616898b4e515d343c0414f2a6472esd * topology node is created, the range exists and the creation will succeed.
908f1e1388f616898b4e515d343c0414f2a6472esdpi_walker_node_range(topo_mod_t *mod, md_t *mdp, tnode_t *t_parent,
908f1e1388f616898b4e515d343c0414f2a6472esd "walker failed to create node range with a NULL parent\n");
908f1e1388f616898b4e515d343c0414f2a6472esd /* Determine how many children the given node has */
908f1e1388f616898b4e515d343c0414f2a6472esd num_arcs = md_get_prop_arcs(mdp, mde_node, MD_STR_FWD, NULL, 0);
908f1e1388f616898b4e515d343c0414f2a6472esd if (num_arcs == 0) {
908f1e1388f616898b4e515d343c0414f2a6472esd /* This node has no children */
908f1e1388f616898b4e515d343c0414f2a6472esd /* Get the indexes for all the child nodes and put them in an array */
908f1e1388f616898b4e515d343c0414f2a6472esd num_arcs = md_get_prop_arcs(mdp, mde_node, MD_STR_FWD, arcp, arcsize);
908f1e1388f616898b4e515d343c0414f2a6472esd * The children of the given node may have multiple types.
908f1e1388f616898b4e515d343c0414f2a6472esd * Potentially, each child may have a different type and we need to
908f1e1388f616898b4e515d343c0414f2a6472esd * create a topo node range for each one.
908f1e1388f616898b4e515d343c0414f2a6472esd * We loop through the children and collect the type information for
908f1e1388f616898b4e515d343c0414f2a6472esd * each one and associate the child with the given parent topo node.
908f1e1388f616898b4e515d343c0414f2a6472esd result = topo_mod_nvalloc(mod, &typelist, NV_UNIQUE_NAME);
908f1e1388f616898b4e515d343c0414f2a6472esd if (result != 0) {
908f1e1388f616898b4e515d343c0414f2a6472esd /* Should this node be skipped? */
908f1e1388f616898b4e515d343c0414f2a6472esd /* Skip this node */
908f1e1388f616898b4e515d343c0414f2a6472esd /* Get the type of this node */
908f1e1388f616898b4e515d343c0414f2a6472esd /* Increment the count of nodes with this type */
908f1e1388f616898b4e515d343c0414f2a6472esd if (rc != 0) {
908f1e1388f616898b4e515d343c0414f2a6472esd * We have not visited this type yet. Create
908f1e1388f616898b4e515d343c0414f2a6472esd * a new range based on this nodes instance
908f1e1388f616898b4e515d343c0414f2a6472esd * information.
908f1e1388f616898b4e515d343c0414f2a6472esd if (result != 0) {
908f1e1388f616898b4e515d343c0414f2a6472esd * This error can only if there was a
908f1e1388f616898b4e515d343c0414f2a6472esd * memory failure of some kind. Stop
908f1e1388f616898b4e515d343c0414f2a6472esd * the walk or it will just get worse.
908f1e1388f616898b4e515d343c0414f2a6472esd * We know the list exists now or the above
908f1e1388f616898b4e515d343c0414f2a6472esd * would have failed. Just look it up.
908f1e1388f616898b4e515d343c0414f2a6472esd /* Re-calculate the range minimums and maximums */
908f1e1388f616898b4e515d343c0414f2a6472esd * Associate this node with the given topo parent even if it
908f1e1388f616898b4e515d343c0414f2a6472esd * has no instance. We do this so that later an error with
908f1e1388f616898b4e515d343c0414f2a6472esd * the PRI node will be reported instead of an internal
908f1e1388f616898b4e515d343c0414f2a6472esd * error about not being able to find the parent of a node
908f1e1388f616898b4e515d343c0414f2a6472esd if (rc != 0) {
908f1e1388f616898b4e515d343c0414f2a6472esd "could not add node_0x%llx to walker list\n",
908f1e1388f616898b4e515d343c0414f2a6472esd * We have associated all the child nodes with the given topo parent
908f1e1388f616898b4e515d343c0414f2a6472esd * in the walker list. Now we need to create topo ranges for each
908f1e1388f616898b4e515d343c0414f2a6472esd * set of child types under the parent.
908f1e1388f616898b4e515d343c0414f2a6472esd /* Get the type name and count from the list element */
908f1e1388f616898b4e515d343c0414f2a6472esd * We have the number of children with this type.
908f1e1388f616898b4e515d343c0414f2a6472esd * Create an appropriate range.
908f1e1388f616898b4e515d343c0414f2a6472esd "creating instance range %d to %d of type %s\n",
908f1e1388f616898b4e515d343c0414f2a6472esd if (rc != 0) {
908f1e1388f616898b4e515d343c0414f2a6472esd "failed to created node range %d to %d for "
908f1e1388f616898b4e515d343c0414f2a6472esd /* Check the next node */
908f1e1388f616898b4e515d343c0414f2a6472esdpi_walkerlist_addtype(topo_mod_t *mod, nvlist_t *typelist, char *hc_name,
908f1e1388f616898b4e515d343c0414f2a6472esd if (result != 0) {
908f1e1388f616898b4e515d343c0414f2a6472esd /* Create min and max elements in this list */
908f1e1388f616898b4e515d343c0414f2a6472esd return (-1);
908f1e1388f616898b4e515d343c0414f2a6472esd return (0);
908f1e1388f616898b4e515d343c0414f2a6472esd/* ARGSUSED */
908f1e1388f616898b4e515d343c0414f2a6472esdpi_walkerlist_compare(const void *left, const void *right, void *private)
908f1e1388f616898b4e515d343c0414f2a6472esd return (1);
908f1e1388f616898b4e515d343c0414f2a6472esd return (-1);
908f1e1388f616898b4e515d343c0414f2a6472esd return (0);
908f1e1388f616898b4e515d343c0414f2a6472esd /* Initialize the uutil list structure */
908f1e1388f616898b4e515d343c0414f2a6472esd sizeof (pi_walkernode_t), offsetof(pi_walkernode_t, walker_node),
908f1e1388f616898b4e515d343c0414f2a6472esd return (-1);
908f1e1388f616898b4e515d343c0414f2a6472esd return (-1);
908f1e1388f616898b4e515d343c0414f2a6472esd return (0);
908f1e1388f616898b4e515d343c0414f2a6472esdstatic void
908f1e1388f616898b4e515d343c0414f2a6472esd /* Destroy our list of items */
908f1e1388f616898b4e515d343c0414f2a6472esd * First, we empty the list of elements and free each one.
908f1e1388f616898b4e515d343c0414f2a6472esd * We do not free the data elements as they are libtopo nodes
908f1e1388f616898b4e515d343c0414f2a6472esd * and will be freed by libtopo
908f1e1388f616898b4e515d343c0414f2a6472esdpi_walkerlist_add(topo_mod_t *mod, tnode_t *t_parent, mde_cookie_t mde_node)
908f1e1388f616898b4e515d343c0414f2a6472esd topo_mod_dprintf(mod, "failed to add node_0x%llx parent %p\n",
908f1e1388f616898b4e515d343c0414f2a6472esd return (-1);
908f1e1388f616898b4e515d343c0414f2a6472esd uu_list_node_init(wnp, &(wnp->walker_node), walker_pool);
908f1e1388f616898b4e515d343c0414f2a6472esd return (0);
908f1e1388f616898b4e515d343c0414f2a6472esd * Find the parent topo node for this machine description node.
908f1e1388f616898b4e515d343c0414f2a6472esd * Nodes are removed from the list as they are found. They are only
908f1e1388f616898b4e515d343c0414f2a6472esd * visited once and this eliminates the need for a separate routine
908f1e1388f616898b4e515d343c0414f2a6472esd * that walks the list to free elements later.
908f1e1388f616898b4e515d343c0414f2a6472esdpi_walkerlist_find(topo_mod_t *mod, mde_cookie_t mde_node, tnode_t **tpp)
908f1e1388f616898b4e515d343c0414f2a6472esd result = uu_list_find(walker_list, &search_criteria, NULL, &idx);
908f1e1388f616898b4e515d343c0414f2a6472esd return (-1);
908f1e1388f616898b4e515d343c0414f2a6472esd /* Remove this element from the list */
908f1e1388f616898b4e515d343c0414f2a6472esd uu_list_node_fini(result, &(result->walker_node), walker_pool);
908f1e1388f616898b4e515d343c0414f2a6472esd return (0);