Lgrp/pod/Lgrp.pod

5 # Common Development and Distribution License (the "License").
11 # and limitations under the License.
14 # file and include the License file at usr/src/OPENSOLARIS.LICENSE.
111 This module provides access to the C<liblgrp(3LIB)> library and to various
112 constants and functions defined in C<sys/lgrp_sys.h> header file. It provides
113 both the procedural and object interface to the library. The procedural
122 context and B<undef> is returned in the scalar context.
170 description is given for the corresponding functions in this module and a
173 highlighted and fully documented here.
179 The function initializes the lgroup interface and takes a snapshot of the lgroup
188 B<undef> and sets B<$!> to indicate the error.
195 by L<lgrp_init()>, and cleans up anything else set up by L<lgrp_init()>. After
197 longer be valid and should not be used.
199 Upon successful completion, 1 is returned. Otherwise, B<undef> is returned and
207 and returns the snapshot's view of the lgroup hierarchy.
216 returned and C<$!> is set.
223 should be C<P_PID> to specify a process and the B<$id> argument should be its
225 thread and the B<$id> argument should be its LWP id. The value C<P_MYID> can be
229 the specified process or thread. Otherwise, B<undef> is returned and B<$!> is
237 stale. Otherwise, it returns B<undef> and sets B<$!> to indicate the error.
246 The function takes a cookie representing a snapshot of the lgroup hierarchy and
267 In case of error B<undef> is returned in scalar context and B<$!> is set to
268 indicate the error. In list context the empty list is returned and B<$!> is set.
274 The function takes a cookie representing a snapshot of the lgroup hierarchy and
280 In case of error B<undef> or empty list is returned and B<$!> is set to indicate
287 The function takes a cookie representing a snapshot of the lgroup hierarchy and
293 In case of error B<undef> or empty list is returned and B<$!> is set to indicate
304 In case of error B<undef> is returned and B<$!> is set to EINVAL indicatng that
312 and B<$!> is set to EINVAL indicatng that the cookie is not valid.
354 is returned and B<$!> is set to indicate the error.
360 The function takes an interface version number, B$version>, as an argument and
382 The function sets of LWPs specified by the B<$idtype> and B<$id> arguments have
386 and $id have for the given lgroup. The lgroup affinity can be set to
416 returns B<undef> and set B<$!> to indicate the error.
429 The function takes a cookie representing a snapshot of the lgroup hierarchy and
440 returns B<undef> and set B<$!> to indicate the error. For LGRP API version 1 the
449 may be freed and reallocated, this function may not be able to provide a
459 contains CPU and/or memory resources.
475 In case of error B<undef> or empty list is returned and B<$!> is set to indicate
478 This function is only available for API version 2 and will return B<undef> or
479 empty list for API version 1 and set $! to C<EINVAL>.
582 Sets of LWPs specified by the $idtype and $id arguments have for the given lgroup.
605 version 1 of liblgrp(3LIB) and L<lgrp_latency_cookie()> for newer versions.
612 to selectively import constants and functions defined in this module:
665 and its real or effective user ID does not match the real or effective user ID
679 Version 2 of the lgrpp_user API introduced the following constants and
698 The C<LGRP_RSRC_CPU> and C<LGRP_RSRC_MEM> are not defined for version 1. The