c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# CDDL HEADER START
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# The contents of this file are subject to the terms of the
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# Common Development and Distribution License (the "License").
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# You may not use this file except in compliance with the License.
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# See the License for the specific language governing permissions
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# and limitations under the License.
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# When distributing Covered Code, include this CDDL HEADER in each
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# If applicable, add the following below this CDDL HEADER, with the
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# fields enclosed by brackets "[]" replaced with your own identifying
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# information: Portions Copyright [yyyy] [name of copyright owner]
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# CDDL HEADER END
df0345f7d6cc87cde9e532e8362f1aca053d98ccJohn Sonnenschein# Copyright 2008 Sun Microsystems, Inc. All rights reserved.
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# Use is subject to license terms.
c9f77c52c0735e65aa2534394c5151cdb963cbefAndy Stormont# Copyright (c) 2014 Racktop Systems.
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# Lgrp.pm provides procedural and object-oriented interface to the Solaris
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# liblgrp(3LIB) library.
c9f77c52c0735e65aa2534394c5151cdb963cbefAndy Stormontrequire 5.0010;
c64027834c5ffc60c557c2b12555e0cd4d30320cakolbuse warnings;
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# Things to export
c64027834c5ffc60c557c2b12555e0cd4d30320cakolbmy @lgrp_constants = qw(LGRP_AFF_NONE LGRP_AFF_STRONG LGRP_AFF_WEAK
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb LGRP_MEM_SZ_FREE LGRP_MEM_SZ_INSTALLED LGRP_VER_CURRENT
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# Define symbolic names for various subsets of export lists
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# Define things that are ok ot export.
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# _usage(): print error message and terminate the program.
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb my $msg = shift;
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# lgrp_isleaf($cookie, $lgrp)
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# Returns T if lgrp is leaf, F otherwise.
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb return (!lgrp_children(shift, shift));
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# lgrp_lgrps($cookie, [$lgrp])
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# Returns: list of lgrps in a subtree starting from $lgrp.
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# If $root is not specified, use lgrp_root.
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# undef on failure.
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb scalar @_ > 0 or _usage("lgrp_lgrps(cookie, [lgrp])");
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb my $cookie = shift;
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb my $root = shift;
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb return unless defined $root;
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb # Concatenate root with subtrees for every children. Every subtree is
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb # obtained by calling lgrp_lgrps recursively with each of the children
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb # as the argument.
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# lgrp_leaves($cookie, [$lgrp])
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# Returns: list of leaves in the hierarchy starting from $lgrp.
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# If $lgrp is not specified, use lgrp_root.
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# undef on failure.
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb scalar @_ > 0 or _usage("lgrp_leaves(cookie, [lgrp])");
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb my $cookie = shift;
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb my $root = shift;
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb return unless defined $root;
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb my @result = grep {
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb######################################################################
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# Object-Oriented interface.
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb######################################################################
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# cookie: extract cookie from the argument.
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# If the argument is scalar, it is the cookie itself, otherwise it is the
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# reference to the object and the cookie value is in $self->{COOKIE}.
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb my $self = shift;
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# new: The object constructor
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb my $class = shift;
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb $self->{COOKIE} = ($view ? lgrp_init($view) : lgrp_init()) or
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb croak("lgrp_init: $!\n"), return;
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# DESTROY: the object destructor.
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb############################################################
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# Wrapper methods.
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb scalar @_ == 4 or _usage("mem_size(class, lgrp, type, content)");
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb return (lgrp_mem_size(cookie(shift), shift, shift, shift));
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb scalar @_ == 3 or _usage("cpus(class, lgrp, content)");
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb scalar @_ == 3 or _usage("resources(class, lgrp, resource)");
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb return (lgrp_latency_cookie(cookie(shift), shift, shift));
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb# Methods that do not require cookie
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb return (lgrp_home(shift, shift));
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb scalar @_ == 4 or _usage("affinity_get(class, idtype, id, lgrp)");
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb return (lgrp_affinity_get(shift, shift, shift));
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb scalar @_ == 5 or
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb _usage("affinity_set(class, idtype, id, lgrp, affinity)");
c64027834c5ffc60c557c2b12555e0cd4d30320cakolb return (lgrp_affinity_set(shift, shift, shift, shift));